Merge remote-tracking branch 'github/master' into github_master

braintree · Jan 21, 2021 · 2b36813 · 2b36813
2 parents e40844f + 8a0479a
commit 2b36813
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+##unreleased
+* Allows `ResourceCollection#first` to receive one argument and return that argument number of items
+
 ## 3.1.0
 * Add `acquirer_reference_number` to `Transaction`
 * Add `billing_agreement_id` to `PayPalDetails`

diff --git a/lib/braintree/resource_collection.rb b/lib/braintree/resource_collection.rb
@@ -22,9 +22,14 @@ def empty?
       @ids.empty?
     end
 
-    # Returns the first item in the collection or nil if the collection is empty
-    def first
-      @paging_block.call([@ids.first]).first
+    # Returns the first or the first N items in the collection or nil if the collection is empty
+    def first(amount = 1)
+      return nil if @ids.empty?
+      return @paging_block.call([@ids.first]).first if amount == 1
+
+      @ids.first(amount).each_slice(@page_size).flat_map do |page_of_ids|
+        @paging_block.call(page_of_ids)
+      end
     end
 
     # Only the maximum size of a resource collection can be determined since the data on the server can change while

diff --git a/spec/unit/braintree/resource_collection_spec.rb b/spec/unit/braintree/resource_collection_spec.rb
@@ -18,6 +18,35 @@
     end
   end
 
+  describe "#first" do
+    it 'returns nil with no results' do
+      values = %w(a b c d e)
+      collection = Braintree::ResourceCollection.new(:search_results => {:ids => [], :page_size => 2}) do |ids|
+        ids.map {|id| values[id] }
+      end
+
+      collection.first.should == nil
+    end
+
+    context 'with results' do
+      let(:collection) do
+        values = %w(a b c d e)
+
+        Braintree::ResourceCollection.new(:search_results => {:ids => [0,1,2,3,4], :page_size => 2}) do |ids|
+          ids.map {|id| values[id] }
+        end
+      end
+
+      it 'returns the first occourence' do
+        collection.first.should == 'a'
+      end
+
+      it 'returns the first N occourences' do
+        collection.first(4).should == ['a','b','c','d']
+      end
+    end
+  end
+
   describe "#ids" do
     it "returns a list of the resource collection ids" do
       collection = Braintree::ResourceCollection.new(:search_results => {:ids => [0,1,2,3,4], :page_size => 2})