gun_broker 1.2.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 320dc1e2ff0d54dbfebd167be835b5c0f9e6125f
-  data.tar.gz: 7f5cc2cb8aa382175ff9dda7e9fe0f335b52d2ad
+  metadata.gz: d6a5514db1a0faf10391363483a843c4566e5d8a
+  data.tar.gz: a249bf76f5d92a7ad4fba9a1d87d798eec830512
 SHA512:
-  metadata.gz: ba0685164c1e8cc0023a9cd57df64a0d636cd7571ca2ba768311cbc4a40dbb2f92313876eb871d50493e55ec9954e93e507ba0e43ebe2f18f0236080db645fe4
-  data.tar.gz: 9d8236d50a5cb8f91709d1af63afa5bd6593942760de6082c2bce84cb171d350be5dced8505dbfad3c4c27fdb10c0fefc761d0d7690163e33f520076099e2307
+  metadata.gz: fa2b60ad095be332d187c3038fd344de3d3b269d8bea02bda64b83fa2cb925556ed850ed9f05b9e99ec3f8fbabdbe95ba3173572a297939710bbaf0f743597a4
+  data.tar.gz: c5ec2af3222e2b7239f52caff4da01c69c6e44777ee6a86d14910f5b391a4b2d4a5c47984542a37f1e6a474f2653316cb3159b6a4ad84920409f9d7e39989fb9

data/README.md

@@ -114,6 +114,19 @@ GunBroker::Item.find(123)
 To raise a `GunBroker::Error::NotFound` exception if no Item can be found, use `Item.find!`.
 
 
+### GunBroker::ItemsAsPage
+
+Represents a page of items (listings) on GunBroker, allowing for querying to be done in chunks to prevent memory leaks.  The `ItemsAsPage#fetch_items` method fetches the associated items for the given page.
+
+```ruby
+items_as_pages.each do |page_of_items|
+  page_of_items.fetch_items.each do |item|
+    puts item.id
+  end
+end
+```
+
+
 ### GunBroker::Category
 
 Returns GunBroker category responses.  To get an array of all categories, call `Category.all`.

data/lib/gun_broker.rb

@@ -5,6 +5,7 @@ require 'gun_broker/category'
 require 'gun_broker/error'
 require 'gun_broker/feedback'
 require 'gun_broker/item'
+require 'gun_broker/items_as_page'
 require 'gun_broker/response'
 require 'gun_broker/user'
 

data/lib/gun_broker/items_as_page.rb

@@ -0,0 +1,22 @@
+module GunBroker
+  # Represents a page of GunBroker items (listings).
+  class ItemsAsPage
+
+    # @param attrs [Hash] The attributes required to fetch items from the API.
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    # @return [Array<Item>]
+    def fetch_items
+      @attributes[:params].merge!({
+        'PageIndex' => @attributes[:page_index],
+        'PageSize'  => @attributes[:page_size]
+      })
+      response = GunBroker::API.get(@attributes[:endpoint], @attributes[:params], @attributes[:token_header])
+
+      response['results'].map { |result| GunBroker::Item.new(result) }
+    end
+
+  end
+end

data/lib/gun_broker/user.rb

@@ -1,5 +1,6 @@
 require 'gun_broker/token_header'
 require 'gun_broker/user/items_delegate'
+require 'gun_broker/user/items_as_pages_delegate'
 
 module GunBroker
   # Represents a GunBroker User.
@@ -86,6 +87,13 @@ module GunBroker
       @items_delegate ||= ItemsDelegate.new(self)
     end
 
+    # (see ItemsAsPagesDelegate)
+    # See the {ItemsAsPagesDelegate} docs.
+    # @return [ItemsAsPagesDelegate]
+    def items_as_pages(options = {})
+      @items_as_pages_delegate ||= ItemsAsPagesDelegate.new(self, options)
+    end
+
     private
 
     # @return [Boolean] `true` if `@username` is present and either `@password` *or* `@token` is present.

data/lib/gun_broker/user/items_as_pages_delegate.rb

@@ -0,0 +1,98 @@
+require 'gun_broker/token_header'
+
+module GunBroker
+  class User
+    # Used to scope {ItemsAsPage} actions by {User}.
+    class ItemsAsPagesDelegate
+
+      include GunBroker::TokenHeader
+
+      # @param user [User] A {User} instance to scope item pages by.
+      # @param options [Hash] { items_per_page => <number of desired items per page> (Integer) }.
+      def initialize(user, options = {})
+        max_page_size = GunBroker::API::PAGE_SIZE
+        @user = user
+        @items_per_page = options.fetch(:items_per_page, max_page_size)
+
+        if @items_per_page > max_page_size
+          raise ArgumentError.new("`items_per_page` may not exceed #{max_page_size}")
+        end
+      end
+
+      # Returns pages for all the the User's items (both selling and not selling).
+      # @note {API#get! GET} /Items
+      # @return [Array<ItemsAsPage>]
+      def all
+        # NOTE: this endpoint will not return items that were sold
+        @all ||= build_pages_for(:Items, { 'SellerName' => @user.username })
+      end
+
+      # Returns pages for all items the User has bid on.
+      # @note {API#get! GET} /ItemsBidOn
+      # @return [Array<ItemsAsPage>]
+      def bid_on
+        @bid_on ||= build_pages_for(:ItemsBidOn)
+      end
+
+      # Returns pages for items the User has bid on, but not won.
+      # @note {API#get! GET} /ItemsNotWon
+      # @return [Array<ItemsAsPage>]
+      def not_won
+        @not_won ||= build_pages_for(:ItemsNotWon)
+      end
+
+      # Returns pages for items that are currently selling.
+      # @note {API#get! GET} /Items
+      # @return [Array<ItemsAsPage>]
+      def selling
+        @selling ||= build_pages_for(:Items, { 'SellerName' => @user.username })
+      end
+
+      # Returns pages for items the User has sold.
+      # @note {API#get! GET} /ItemsSold
+      # @return [Array<ItemsAsPage>]
+      def sold
+        @sold ||= build_pages_for(:ItemsSold)
+      end
+
+      # Returns pages for items that were listed, but not sold.
+      # @note {API#get! GET} /ItemsUnsold
+      # @return [Array<ItemsAsPage>]
+      def unsold
+        @unsold ||= build_pages_for(:ItemsUnsold)
+      end
+
+      # Returns pages for items the User has won.
+      # @note {API#get! GET} /ItemsWon
+      # @return [Array<ItemsAsPage>]
+      def won
+        @won ||= build_pages_for(:ItemsWon)
+      end
+
+      private
+
+      def build_pages_for(endpoint, params = {})
+        endpoint = ['/', endpoint.to_s].join
+        _token_header = token_header(@user.token)
+        response = GunBroker::API.get(endpoint, params.merge({ 'PageSize' => 1 }), _token_header)
+        number_of_pages = (response['count'] / @items_per_page.to_f).ceil
+        items_as_pages = []
+
+        number_of_pages.times do |page_number|
+          page_number += 1
+          attrs = {
+            page_size:    @items_per_page,
+            page_index:   page_number,
+            endpoint:     endpoint,
+            params:       params,
+            token_header: _token_header
+          }
+
+          items_as_pages << GunBroker::ItemsAsPage.new(attrs)
+        end
+
+        items_as_pages
+      end
+    end
+  end
+end

data/lib/gun_broker/user/items_delegate.rb

@@ -19,20 +19,14 @@ module GunBroker
       # @return [Array<Item>]
       def all
         # NOTE: this endpoint will not return items that were sold
-        endpoint = :Items
-        params = { 'SellerName' => @user.username }
-
-        @all ||= fetch_items(endpoint, params)
+        @all ||= fetch_items(:Items, { 'SellerName' => @user.username })
       end
 
       # Returns all the items the User has bid on.
       # @note {API#get! GET} /ItemsBidOn
-      # @raise (see #all)
       # @return [Array<Item>]
       def bid_on
-        endpoint = :ItemsBidOn
-
-        @bid_on ||= fetch_items(endpoint)
+        @bid_on ||= fetch_items(:ItemsBidOn)
       end
 
       # Sends a multipart/form-data POST request to create an Item with the given `attributes`.
@@ -66,7 +60,6 @@ module GunBroker
       end
 
       # Same as {#find} but raises GunBroker::Error::NotFound if no item is found.
-      # @raise (see #all)
       # @raise [GunBroker::Error::NotFound] If the User has no Item with `item_id`.
       # @return [Item] Returns the Item or `nil` if no Item found.
       def find!(item_id)
@@ -77,12 +70,9 @@ module GunBroker
 
       # Items the User has bid on, but not won.
       # @note {API#get! GET} /ItemsNotWon
-      # @raise (see #all)
       # @return [Array<Item>]
       def not_won
-        endpoint = :ItemsNotWon
-
-        @not_won ||= fetch_items(endpoint)
+        @not_won ||= fetch_items(:ItemsNotWon)
       end
 
       # Returns Items that are currently selling.
@@ -92,40 +82,35 @@ module GunBroker
       # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
       # @return [Array<Item>]
       def selling(options = {})
-        endpoint = :Items
         params = {
-          'ItemID'        => (options[:item_id] || options["ItemID"]),
-          'SellerName'    => @user.username,
+          'ItemID'     => (options[:item_id] || options["ItemID"]),
+          'SellerName' => @user.username,
         }.delete_if { |k, v| v.nil? }
 
-        @selling ||= fetch_items(endpoint, params)
+        @selling ||= fetch_items(:Items, params)
       end
 
       # Items the User has sold.
       # @param options [Hash] {ItemID=>ItemID}.
       # @note {API#get! GET} /ItemsSold
-      # @raise (see #all)
       # @return [Array<Item>]
       def sold(options = {})
-        endpoint = :ItemsSold
         params = {
-          'ItemID'   => (options[:item_id] || options["ItemID"])
+          'ItemID' => (options[:item_id] || options["ItemID"])
         }.delete_if { |k, v| v.nil? }
 
-        @sold ||= fetch_items(endpoint, params)
+        @sold ||= fetch_items(:ItemsSold, params)
       end
 
       # Items that were listed, but not sold.
       # @note {API#get! GET} /ItemsUnsold
-      # @raise (see #all)
       # @return [Array<Item>]
       def unsold(options = {})
-        endpoint = :ItemsUnsold
         params = {
-          'ItemID'   => (options[:item_id] || options["ItemID"])
+          'ItemID' => (options[:item_id] || options["ItemID"])
         }.delete_if { |k, v| v.nil? }
 
-        @unsold ||= fetch_items(endpoint, params)
+        @unsold ||= fetch_items(:ItemsUnsold, params)
       end
 
       # Updates an {Item} with the given attributes.
@@ -150,12 +135,9 @@ module GunBroker
 
       # Items the User has won.
       # @note {API#get! GET} /ItemsWon
-      # @raise (see #all)
       # @return [Array<Item>]
       def won
-        endpoint = :ItemsWon
-
-        @won ||= fetch_items(endpoint)
+        @won ||= fetch_items(:ItemsWon)
       end
 
       private
@@ -164,16 +146,16 @@ module GunBroker
         endpoint = ['/', endpoint.to_s].join
         params.merge!({ 'PageSize' => GunBroker::API::PAGE_SIZE })
         response = GunBroker::API.get(endpoint, params, token_header(@user.token))
-        pages = (response['count'] / GunBroker::API::PAGE_SIZE.to_f).ceil
+        number_of_pages = (response['count'] / GunBroker::API::PAGE_SIZE.to_f).ceil
 
-        if pages > 1
+        if number_of_pages > 1
           _items_from_results = items_from_results(response['results'])
 
-          pages.times do |page|
-            page += 1
-            next if page == 1
+          number_of_pages.times do |page_number|
+            page_number += 1
+            next if page_number == 1
 
-            params.merge!({ 'PageIndex' => page })
+            params.merge!({ 'PageIndex' => page_number })
             response = GunBroker::API.get(endpoint, params, token_header(@user.token))
             _items_from_results.concat(items_from_results(response['results']))
           end

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "1.2.1.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 1.2.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,9 +136,11 @@ files:
 - lib/gun_broker/feedback.rb
 - lib/gun_broker/item.rb
 - lib/gun_broker/item/constants.rb
+- lib/gun_broker/items_as_page.rb
 - lib/gun_broker/response.rb
 - lib/gun_broker/token_header.rb
 - lib/gun_broker/user.rb
+- lib/gun_broker/user/items_as_pages_delegate.rb
 - lib/gun_broker/user/items_delegate.rb
 - lib/gun_broker/version.rb
 - spec/fixtures/authenticate.json