gun_broker 0.4.1 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c615953eb407df3dfa91c322f4f903401ce37371
-  data.tar.gz: 4eea32e2531e6517d755ec14fc3e2fb4b5b5d867
+  metadata.gz: 657189493f5cfb8faf699f3100fe60bd18190012
+  data.tar.gz: c1ccb2b44db024453638d5fa70204da06ce128fb
 SHA512:
-  metadata.gz: f5dff34088eb750ff1dd38a36d9c629704bb0550abf1ec092faaba518e6abf82686cd6036d494c38ae85072c97ec87809902e7db4e457f785d550ce00554d231
-  data.tar.gz: c92686ccc9e33528dbb4115a8b443230ac1d0c4f633525721882f5eaea22c80b7fc1343d102b52fd8f73745d9f8e21f50feaedbc1a18c0019d3a79da82fd4431
+  metadata.gz: 72ce3a15f96a354f2e93f378a6639b011386418123716304a6be15b839b54a5581a67d3f9bc92566126034166047dd485dc50c5616aea717df42b60c217462e6
+  data.tar.gz: 4c85034d8ebf42def28fb7aa2316326c2fb02f1eea25092ac52e5b85ab05abdc4fe6ff8b1db20cd8910d5de83f87193e3281b394bea7e4ddd453636d9c1d0171

data/README.md

@@ -34,8 +34,10 @@ GunBroker.dev_key = 'your-sekret-dev-key'
 
 ### GunBroker::User
 
-Authentication requires a `username` and an 'auth options' hash that requires **at least** a `password`
-*or* `token`. If a password is given, you must call `User#authenticate!` to obtain an access token.
+#### Authentication
+
+Authentication requires a `username` and an 'auth options' hash that requires **at least** a `:password`
+*or* `:token`. If a password is given, you must call `User#authenticate!` to obtain an access token.
 
 ```ruby
 # By username/password:
@@ -49,16 +51,6 @@ user = GunBroker::User.new('username', token: 'user-access-token')
 user.token  # => 'user-access-token'
 ```
 
-Once the User has an access token, you can then grab all of their items (listings).  All items methods
-return an array of `GunBroker::Item` instances.
-
-```ruby
-user.items.all     # => [GunBroker::Item, ...]
-user.items.unsold  # => [GunBroker::Item, ...]
-user.items.sold    # => [GunBroker::Item, ...]
-user.items.won     # => [GunBroker::Item, ...]
-```
-
 To revoke the access token, call `User#deauthenticate!`.  This method is also aliased as `#revoke_access_token!`.
 
 ```ruby
@@ -67,6 +59,24 @@ user.deauthenticate!
 user.token  # => nil
 ```
 
+#### Items
+
+You can access a User's Items through the `User#items` method, which returns an instance of `User::ItemsDelegate`.
+
+```ruby
+user.items.all   # => [GunBroker::Item, ...]
+user.items.sold  # => [GunBroker::Item, ...]
+```
+
+To find a specific Item by its ID, use `#find`. This will return a `GunBroker::Item` instance or `nil` if no item found.
+
+```ruby
+item = user.items.find(123)
+```
+
+To raise a `GunBroker::Error::NotFound` exception if no Item can be found, use `#find!`.
+
+
 ### GunBroker::Item
 
 Represents an item (listing) on GunBroker.  The `Item#id` method returns the value of the `itemID` attribute
@@ -74,12 +84,27 @@ from the response.  All other attributes can be accessed through the `Item#[]` m
 
 ```ruby
 item.id  # => '1234567'
-item['title']  # => 'Super Awesome Scope'
+item.title  # => 'Super Awesome Scope'
+item.category  # => GunBroker::Category
+item['description']  # => 'This scope is really awesome.'
+```
+
+You can find an Item belonging to the authenticated User with `user.items.find` or any Item with `Item.find`.
+
+```ruby
+# Returns the Item or nil, if the User has no Item with that ID.
+user.items.find(123)
+
+# Find any Item by its ID.
+GunBroker::Item.find(123)
 ```
 
+To raise a `GunBroker::Error::NotFound` exception if no Item can be found, use `Item.find!`.
+
+
 ### GunBroker::Category
 
-Returns GunBroker category responses.  To get an array of all categories, call `Category#all()`.
+Returns GunBroker category responses.  To get an array of all categories, call `Category.all`.
 
 ```ruby
 GunBroker::Category.all
@@ -95,12 +120,22 @@ GunBroker::Category.all(firearms)
 # => [GunBroker::Category, ...]
 ```
 
+To find a Category by a specific ID, use either `Category.find` or `Category.find!`.
+
+```ruby
+GunBroker::Category.find(123)
+# => Returns the Category or nil
+GunBroker::Category.find!(123)
+# => Returns the Category or raises GunBroker::Error::NotFound
+```
+
 Much like GunBroker::Item, the `Category#id` method returns the `categoryID` attribute from the response.
 All other attributes can be accessed with `Category#[]`.
 
 ```ruby
 category.id  # => '123'
-category['categoryName']  # => 'Firearms'
+category.name  # => 'Firearms'
+category['description']  # => 'Modern Firearms are defined ...'
 ```
 
 ### GunBroker::API
@@ -133,8 +168,9 @@ GunBroker::API.delete('/some/resource', {}, { 'X-TestHeader' => 'FooBar' })
 ### Error Handling
 
 Methods that require authorization (with an access token) will raise a `GunBroker::Error::NotAuthorized`
-exception if the token isn't valid.  Otherwise, if there is some other issue with the request (namely,
-the response status code is not in the `2xx` range), a `GunBroker::Error::RequestError` will be raised.
+exception if the token isn't valid.  If the response is an HTTP `404` status, a `GunBroker::Error::NotFound`
+will be raised.  Otherwise, if there is some other issue with the request (namely, the response status
+code is not in the `2xx` range), a `GunBroker::Error::RequestError` will be raised.
 
 ## Contributing
 

data/lib/gun_broker.rb

@@ -4,7 +4,7 @@ require 'gun_broker/api'
 require 'gun_broker/category'
 require 'gun_broker/error'
 require 'gun_broker/item'
-require 'gun_broker/items_delegate'
+require 'gun_broker/response'
 require 'gun_broker/user'
 
 module GunBroker
@@ -23,6 +23,21 @@ module GunBroker
     @@dev_key
   end
 
+  # Returns a hash containing the time on GunBroker's servers in UTC
+  # and the current version of the GunBroker API.
+  #
+  # For example:
+  #
+  #     {
+  #       "gunBrokerTime" => "2015-02-06T20:23:08Z",
+  #       "gunBrokerVersion" => "6 4.4.2.12"
+  #     }
+  #
+  # @return [Hash] Containing the time and API version.
+  def self.time
+    GunBroker::API.get('/GunBrokerTime')
+  end
+
   private
 
   def self.dev_key_present?

data/lib/gun_broker/api.rb

@@ -1,5 +1,5 @@
 require 'json'
-require 'net/https'
+require 'net/http'
 
 module GunBroker
   # Generic REST adapter for the GunBroker API.
@@ -12,7 +12,7 @@ module GunBroker
     # @param params [Hash] (optional) URL params for GET requests; form params for POST request.
     # @param headers [Hash] (optional) Additional headers sent with the request.
     def initialize(path, params = {}, headers = {})
-      raise "Path must start with '/': #{path}" unless path.start_with?('/')
+      raise GunBroker::Error.new("Path must start with '/': #{path}") unless path.start_with?('/')
 
       @path = path
       @params = params
@@ -41,7 +41,7 @@ module GunBroker
     def delete!
       request = Net::HTTP::Delete.new(uri)
       response = get_response(request)
-      handle_response(response)
+      GunBroker::Response.new(response)
     end
 
     # Sends a GET request to the given `path`.
@@ -50,7 +50,7 @@ module GunBroker
 
       request = Net::HTTP::Get.new(uri)
       response = get_response(request)
-      handle_response(response)
+      GunBroker::Response.new(response)
     end
 
     # Sends a POST request to the given `path`.
@@ -59,7 +59,7 @@ module GunBroker
       request.body = @params.to_json
 
       response = get_response(request)
-      handle_response(response)
+      GunBroker::Response.new(response)
     end
 
     private
@@ -77,17 +77,6 @@ module GunBroker
       end
     end
 
-    def handle_response(response)
-      case response
-      when Net::HTTPOK, Net::HTTPSuccess
-        JSON.parse(response.body)
-      when Net::HTTPUnauthorized
-        raise GunBroker::Error::NotAuthorized.new(response)
-      else
-        raise GunBroker::Error::RequestError.new(response)
-      end
-    end
-
     def uri
       @uri ||= URI([GUNBROKER_API, @path].join)
     end

data/lib/gun_broker/category.rb

@@ -13,8 +13,18 @@ module GunBroker
     end
 
     # @param category_id [Integer, String] The ID of the Category to find.
-    # @return [Category] A Category instance.
+    # @return [Category] A Category instance or `nil` if no Category with `category_id` exists.
     def self.find(category_id)
+      find!(category_id)
+    rescue GunBroker::Error::NotFound
+      nil
+    end
+
+    # Same as {.find} but raises GunBroker::Error::NotFound if no Category is found.
+    # @param (see .find)
+    # @raise [GunBroker::Error::NotFound] If no Category with `category_id` exists.
+    # @return (see .find)
+    def self.find!(category_id)
       new(GunBroker::API.get("/Categories/#{category_id}"))
     end
 
@@ -28,6 +38,11 @@ module GunBroker
       @attrs['categoryID']
     end
 
+    # @return [String] The Category name.
+    def name
+      @attrs['categoryName']
+    end
+
     # @param key [String] A Category attribute name (from the JSON response).
     # @return The value of the given `key` or `nil`.
     def [](key)

data/lib/gun_broker/item.rb

@@ -1,10 +1,27 @@
+require 'gun_broker/item/constants'
+
 module GunBroker
   # Represents a GunBroker item (listing).
   class Item
 
+    include GunBroker::Item::Constants
+
+    # @return [Hash] Attributes parsed from the JSON response.
+    attr_reader :attrs
+
     # @param item_id [Integer, String] The ID of the Item to find.
-    # @return [Item] An Item instance.
+    # @return [Item] An Item instance or `nil` if no Item with `item_id` exists.
     def self.find(item_id)
+      find!(item_id)
+    rescue GunBroker::Error::NotFound
+      nil
+    end
+
+    # Same as {.find} but raises GunBroker::Error::NotFound if no Item is found.
+    # @param (see .find)
+    # @raise [GunBroker::Error::NotFound] If no Item with `item_id` exists.
+    # @return (see .find)
+    def self.find!(item_id)
       new(GunBroker::API.get("/Items/#{item_id}"))
     end
 
@@ -18,6 +35,21 @@ module GunBroker
       @attrs['itemID']
     end
 
+    # @return [Hash] Attributes parsed from the JSON response.
+    def attributes
+      @attrs
+    end
+
+    # @return [Category] This Items Category.
+    def category
+      GunBroker::Category.find(@attrs['categoryID'])
+    end
+
+    # @return [String] Title of this Item.
+    def title
+      @attrs['title']
+    end
+
     # @param key [String] An Item attribute name (from the JSON response).
     # @return The value of the given `key` or `nil`.
     def [](key)

data/lib/gun_broker/item/constants.rb

@@ -0,0 +1,94 @@
+module GunBroker
+  class Item
+    # Holds constant values for Item.
+    module Constants
+
+      # Options for auto-relisting.
+      AUTO_RELIST = {
+        1 => 'Do Not Relist',
+        2 => 'Relist Until Sold',
+        3 => 'Relist Fixed Count',
+      }
+
+      # Condition options.
+      CONDITION = {
+        1 => 'Factory New',
+        2 => 'New Old Stock',
+        3 => 'Used',
+      }
+
+      # The return policy / inspection period for the item.
+      INSPECTION_PERIOD = {
+        1  => 'AS IS - No refund or exchange',
+        2  => 'No refund but item can be returned for exchange or store credit within fourteen days',
+        3  => 'No refund but item can be returned for exchange or store credit within thirty days',
+        4  => 'Three Days from the date the item is received',
+        5  => 'Three Days from the date the item is received, including the cost of shipping',
+        6  => 'Five Days from the date the item is received',
+        7  => 'Five Days from the date the item is received, including the cost of shipping',
+        8  => 'Seven Days from the date the item is received',
+        9  => 'Seven Days from the date the item is received, including the cost of shipping',
+        10 => 'Fourteen Days from the date the item is received',
+        11 => 'Fourteen Days from the date the item is received, including the cost of shipping',
+        12 => '30 day money back guarantee',
+        13 => '30 day money back guarantee including the cost of shipping',
+      }
+
+      # How long before the listing ends.
+      LISTING_DURATION = {
+        1  => 'One day',
+        3  => 'Three days',
+        5  => 'Five days',
+        7  => 'Seven days',
+        9  => 'Nine days',
+        10 => 'Ten days',
+        11 => 'Eleven days',
+        12 => 'Twelve days',
+        13 => 'Thirteen days',
+        14 => 'Fourteen days',
+        30 => 'Thirty days (Fixed price items only)',
+        60 => 'Sixty days (Fixed price items only)',
+        90 => 'Ninety days (Fixed price items only)',
+      }
+
+      # The payment methods accepted by the seller for this Item.
+      # The keys of this hash should be sent as `true` or `false` in the `paymentMethods` param.
+      PAYMENT_METHODS = {
+        'SeeItemDesc' => 'See Item Description',
+        'Amex' => 'American Express',
+        'COD' => 'Cash on Delivery',
+        'CertifiedCheck' => 'Certified Check',
+        'Check' => 'Check',
+        'Discover' => 'Discover Card',
+        'Escrow' => 'Escrow',
+        'MoneyOrder' => 'Money Order',
+        'PayPal' => 'PayPal',
+        'USPSMoneyOrder' => 'USPS Money Order',
+        'VisaMastercard' => 'Visa / Mastercard',
+      }
+
+      # The type of shipping offered by the seller of this Item.
+      # The keys of this hash should be sent as `true` or `false` in the `shippingClassesSupported` param.
+      SHIPPING_CLASSES = {
+        'Overnight' => 'Overnight',
+        'TwoDay' => 'Two Day',
+        'ThreeDay' => 'Three Day',
+        'Ground' => 'Ground',
+        'FirstClass' => 'First Class',
+        'Priority' => 'Priority',
+        'Other' => 'Other',
+      }
+
+      # Who pays for shipping.
+      # The key should be sent as the `whoPaysForShipping` param.
+      SHIPPING_PAYER = {
+        1  => 'See item description',
+        2  => 'Seller pays for shipping',
+        4  => 'Buyer pays actual shipping cost',
+        8  => 'Buyer pays fixed amount',
+        16 => 'Use shipping profile',
+      }
+
+    end
+  end
+end

data/lib/gun_broker/response.rb

@@ -0,0 +1,28 @@
+module GunBroker
+  # Wrapper class for the GunBroker API response JSON.
+  class Response
+
+    # @param response [Net::HTTPResponse] Response returned from the API.
+    def initialize(response)
+      @response = response
+
+      case @response
+      when Net::HTTPOK, Net::HTTPSuccess
+        @data = JSON.parse(@response.body)
+      when Net::HTTPUnauthorized
+        raise GunBroker::Error::NotAuthorized.new(@response)
+      when Net::HTTPNotFound
+        raise GunBroker::Error::NotFound.new(@response)
+      else
+        raise GunBroker::Error::RequestError.new(@response)
+      end
+    end
+
+    # @param key [String] Key from the response JSON to read.
+    # @return [String, Array, Hash] Whatever object is the value of `key` or `nil` if the key doesn't exist.
+    def [](key)
+      @data[key]
+    end
+
+  end
+end

data/lib/gun_broker/user.rb

@@ -1,4 +1,5 @@
 require 'gun_broker/token_header'
+require 'gun_broker/user/items_delegate'
 
 module GunBroker
   # Represents a GunBroker User.

data/lib/gun_broker/user/items_delegate.rb

@@ -0,0 +1,100 @@
+require 'gun_broker/token_header'
+
+module GunBroker
+  class User
+    # Used to scope {Item} lookup by {User}.
+    class ItemsDelegate
+
+      include GunBroker::TokenHeader
+
+      # @param user [User] A {User} instance to scope items by.
+      def initialize(user)
+        @user = user
+      end
+
+      # Returns all the User's items.
+      # @note {API#get! GET} /Items
+      # @raise [GunBroker::Error::NotAuthorized] If the {User#token} isn't valid.
+      # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
+      # @return [Array<Item>]
+      def all
+        response = GunBroker::API.get('/Items', { 'SellerName' => @user.username }, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      # Returns all the items the User has bid on.
+      # @note {API#get! GET} /ItemsBidOn
+      # @raise (see #all)
+      # @return [Array<Item>]
+      def bid_on
+        response = GunBroker::API.get('/ItemsBidOn', {}, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      # Finds a specific User's Item by ID. Calls {Item.find} to get full Item details.
+      # @raise (see #all)
+      # @return [Item] Returns the Item or `nil` if no Item found.
+      def find(item_id)
+        # HACK: This has to filter through `#all`, since the GunBroker API currently has no way to scope the `/Items/{itemID}` endpoint by user.
+        if all.select { |item| item.id.to_s == item_id.to_s }.first
+          GunBroker::Item.find(item_id)
+        else
+          nil
+        end
+      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)
+        item = find(item_id)
+        raise GunBroker::Error::NotFound.new("Couldn't find item with ID '#{item_id}'") if item.nil?
+        item
+      end
+
+      # Items the User has bid on, but not won.
+      # @note {API#get! GET} /ItemsNotWon
+      # @raise (see #all)
+      # @return [Array<Item>]
+      def not_won
+        response = GunBroker::API.get('/ItemsNotWon', {}, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      # Items the User has sold.
+      # @note {API#get! GET} /ItemsSold
+      # @raise (see #all)
+      # @return [Array<Item>]
+      def sold
+        response = GunBroker::API.get('/ItemsSold', {}, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      # Items that were listed, but not sold.
+      # @note {API#get! GET} /ItemsUnsold
+      # @raise (see #all)
+      # @return [Array<Item>]
+      def unsold
+        response = GunBroker::API.get('/ItemsUnsold', {}, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      # Items the User has won.
+      # @note {API#get! GET} /ItemsWon
+      # @raise (see #all)
+      # @return [Array<Item>]
+      def won
+        response = GunBroker::API.get('/ItemsWon', {}, token_header(@user.token))
+        items_from_results(response['results'])
+      end
+
+      private
+
+      def items_from_results(results)
+        results.map { |result| GunBroker::Item.new(result) }
+      end
+
+    end
+  end
+end

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "0.4.1"
+  VERSION = "0.4.6"
 end

data/spec/fixtures/test.json

@@ -0,0 +1 @@
+{"test":"value"}

data/spec/fixtures/time.json

@@ -0,0 +1 @@
+{"gunBrokerTime":"2015-02-06T20:40:16Z","gunBrokerVersion":"6 4.4.2.12","links":[]}

data/spec/gun_broker/api_spec.rb

@@ -7,6 +7,8 @@ describe GunBroker::API do
   let(:path)     { '/some/resource' }
   let(:endpoint) { [GunBroker::API::GUNBROKER_API, path].join }
 
+  let(:test_response) { JSON.parse(response_fixture('test')) }
+
   before(:all) do
     GunBroker.dev_key = 'test-dev-key'
   end
@@ -15,15 +17,29 @@ describe GunBroker::API do
     expect(GunBroker::API::GUNBROKER_API).not_to be_nil
   end
 
+  it "raises GunBroker::Error if path does not start with '/'" do
+    expect { GunBroker::API.new('foo/bar') }.to raise_error(GunBroker::Error)
+  end
+
+  context 'response' do
+    it 'should return an instance of GunBroker::Response' do
+      stub_request(:get, endpoint)
+        .to_return(body: response_fixture('test'))
+
+      response = GunBroker::API.get(path)
+      expect(response).to be_a(GunBroker::Response)
+    end
+  end
+
   context '.delete' do
     context 'on success' do
       it 'returns JSON parsed response' do
         stub_request(:delete, endpoint)
           .with(headers: headers('X-AccessToken' => token))
-          .to_return(body: response_fixture('deauthenticate'))
+          .to_return(body: response_fixture('test'))
 
         response = GunBroker::API.delete(path, {}, headers('X-AccessToken' => token))
-        expect(response).to eq(JSON.parse(response_fixture('deauthenticate')))
+        expect(response['test']).to eq(test_response['test'])
       end
     end
 
@@ -44,10 +60,10 @@ describe GunBroker::API do
       it 'returns JSON parsed response' do
         stub_request(:get, endpoint)
           .with(query: { 'SellerName' => 'test-user' })
-          .to_return(body: response_fixture('items'))
+          .to_return(body: response_fixture('test'))
 
         response = GunBroker::API.get(path, { 'SellerName' => 'test-user' })
-        expect(response).to eq(JSON.parse(response_fixture('items')))
+        expect(response['test']).to eq(test_response['test'])
       end
     end
 
@@ -70,10 +86,12 @@ describe GunBroker::API do
             headers: headers,
             body: { username: 'test-user' }
           )
-          .to_return(body: response_fixture('authenticate'))
+          .to_return(body: response_fixture('test'))
 
         response = GunBroker::API.post(path, { username: 'test-user' }, headers)
-        expect(response).to eq(JSON.parse(response_fixture('authenticate')))
+
+        expect(response).to be_a(GunBroker::Response)
+        expect(response['test']).to eq(test_response['test'])
       end
     end
 

data/spec/gun_broker/category_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe GunBroker::Category do
 
   let(:attrs) { JSON.parse(response_fixture('category')) }
+  let(:category) { GunBroker::Category.new(attrs) }
 
   before(:all) do
     GunBroker.dev_key = 'test-dev-key'
@@ -13,13 +14,15 @@ describe GunBroker::Category do
   end
 
   it 'should have an #id' do
-    category = GunBroker::Category.new(attrs)
     expect(category.id).to eq(attrs['categoryID'])
   end
 
+  it 'should have a #name' do
+    expect(category.name).to eq(attrs['categoryName'])
+  end
+
   context '#[]' do
     it 'should return the value from @attrs' do
-      category = GunBroker::Category.new(attrs)
       attrs.each { |k, v| expect(category[k]).to eq(v) }
     end
   end
@@ -43,7 +46,7 @@ describe GunBroker::Category do
     end
 
     context 'on failure' do
-      it 'should raise a GunBroker::Error::RequestError exception' do
+      it 'should raise a GunBroker::Error::NotAuthorized exception' do
         stub_request(:get, endpoint)
           .with(
             headers: headers,
@@ -74,13 +77,42 @@ describe GunBroker::Category do
     end
 
     context 'on failure' do
-      it 'should raise a GunBroker::Error::RequestError exception' do
+      it 'should return nil' do
         stub_request(:get, endpoint)
           .with(headers: headers)
-          .to_return(body: response_fixture('not_authorized'), status: 401)
+          .to_return(body: response_fixture('not_authorized'), status: 404)
+
+        id = attrs['categoryID']
+        expect(GunBroker::Category.find(id)).to be_nil
+      end
+    end
+  end
+
+  context '.find!' do
+    let(:attrs) { JSON.parse(response_fixture('category')) }
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, "/Categories/#{attrs['categoryID']}"].join }
+
+    context 'on success' do
+      it 'returns the Category' do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(body: response_fixture('category'))
+
+        id = attrs['categoryID']
+        category = GunBroker::Category.find!(id)
+        expect(category).to be_a(GunBroker::Category)
+        expect(category.id).to eq(id)
+      end
+    end
+
+    context 'on failure' do
+      it 'should raise a GunBroker::Error::NotFound exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(body: response_fixture('not_authorized'), status: 404)
 
         id = attrs['categoryID']
-        expect { GunBroker::Category.find(id) }.to raise_error(GunBroker::Error::NotAuthorized)
+        expect { GunBroker::Category.find!(id) }.to raise_error(GunBroker::Error::NotFound)
       end
     end
   end

data/spec/gun_broker/item/constants_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GunBroker::Item::Constants do
+
+  it 'has a AUTO_RELIST hash' do
+    expect(GunBroker::Item::AUTO_RELIST).to be_a(Hash)
+  end
+
+  it 'has a CONDITION hash' do
+    expect(GunBroker::Item::CONDITION).to be_a(Hash)
+  end
+
+  it 'has a INSPECTION_PERIOD hash' do
+    expect(GunBroker::Item::INSPECTION_PERIOD).to be_a(Hash)
+  end
+
+  it 'has a LISTING_DURATION hash' do
+    expect(GunBroker::Item::LISTING_DURATION).to be_a(Hash)
+  end
+
+  it 'has a PAYMENT_METHODS hash' do
+    expect(GunBroker::Item::PAYMENT_METHODS).to be_a(Hash)
+  end
+
+  it 'has a SHIPPING_CLASSES hash' do
+    expect(GunBroker::Item::SHIPPING_CLASSES).to be_a(Hash)
+  end
+
+  it 'has a SHIPPING_PAYER hash' do
+    expect(GunBroker::Item::SHIPPING_PAYER).to be_a(Hash)
+  end
+
+end

data/spec/gun_broker/item_spec.rb

@@ -3,21 +3,44 @@ require 'spec_helper'
 describe GunBroker::Item do
 
   let(:attrs) { JSON.parse(response_fixture('item')) }
+  let(:item) { GunBroker::Item.new(attrs) }
 
   it 'should have an #id' do
-    item = GunBroker::Item.new(attrs)
     expect(item.id).to eq(attrs['itemID'])
   end
 
   context '#[]' do
     it 'should return the value from @attrs' do
-      item = GunBroker::Item.new(attrs)
       attrs.each { |k, v| expect(item[k]).to eq(v) }
     end
   end
 
+  context '#attributes' do
+    it 'should provide access to @attrs' do
+      expect(item.attributes['title']).to eq(attrs['title'])
+    end
+  end
+
+  context '#category' do
+    it 'should return the Category' do
+      # Mock up the Category.
+      category = GunBroker::Category.new({
+        'categoryID' => attrs['categoryID'],
+        'categoryName' => attrs['categoryName'],
+      })
+
+      expect(GunBroker::Category).to receive(:find).with(attrs['categoryID']).and_return(category)
+      expect(item.category).to eq(category)
+    end
+  end
+
+  context '#title' do
+    it 'should return the item title' do
+      expect(item.title).to eq(attrs['title'])
+    end
+  end
+
   context '.find' do
-    let(:attrs) { JSON.parse(response_fixture('item')) }
     let(:endpoint) { [GunBroker::API::GUNBROKER_API, "/Items/#{attrs['itemID']}"].join }
 
     context 'on success' do
@@ -34,12 +57,39 @@ describe GunBroker::Item do
     end
 
     context 'on failure' do
-      it 'should raise an exception' do
+      it 'should return nil' do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(body: response_fixture('empty'), status: 404)
+
+        expect(GunBroker::Item.find(attrs['itemID'])).to be_nil
+      end
+    end
+  end
+
+  context '.find!' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, "/Items/#{attrs['itemID']}"].join }
+
+    context 'on success' do
+      it 'returns an Item' do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(body: response_fixture('item'))
+
+        id = attrs['itemID']
+        item = GunBroker::Item.find!(id)
+        expect(item).to be_a(GunBroker::Item)
+        expect(item.id).to eq(id)
+      end
+    end
+
+    context 'on failure' do
+      it 'should raise GunBroker::Error::NotFound' do
         stub_request(:get, endpoint)
           .with(headers: headers)
           .to_return(body: response_fixture('empty'), status: 404)
 
-        expect { GunBroker::Item.find(attrs['itemID']) }.to raise_error(GunBroker::Error::RequestError)
+        expect { GunBroker::Item.find!(attrs['itemID']) }.to raise_error(GunBroker::Error::NotFound)
       end
     end
   end

data/spec/gun_broker/{items_delegate_spec.rb → user/items_delegate_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe GunBroker::ItemsDelegate do
+describe GunBroker::User::ItemsDelegate do
   let(:username) { 'test-user' }
   let(:token)    { 'test-user-access-token' }
 
   let(:user)     { GunBroker::User.new(username, token: token) }
-  let(:delegate) { GunBroker::ItemsDelegate.new(user) }
+  let(:delegate) { GunBroker::User::ItemsDelegate.new(user) }
 
   context '#all' do
     let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Items'].join }

data/spec/gun_broker/user_spec.rb

@@ -117,7 +117,8 @@ describe GunBroker::User do
           )
           .to_return(body: response_fixture('contact_info'))
 
-        expect(user.contact_info).to eq(JSON.parse(response_fixture('contact_info')))
+        contact_info = JSON.parse(response_fixture('contact_info'))
+        expect(user.contact_info['userID']).to eq(contact_info['userID'])
       end
     end
 
@@ -140,7 +141,7 @@ describe GunBroker::User do
   context '#items' do
     it 'should return an ItemsDelegate instance' do
       user = GunBroker::User.new(username, token: token)
-      expect(user.items).to be_a(GunBroker::ItemsDelegate)
+      expect(user.items).to be_a(GunBroker::User::ItemsDelegate)
     end
   end
 

data/spec/gun_broker_spec.rb

@@ -25,4 +25,23 @@ describe GunBroker do
     end
   end
 
+  context '.time' do
+    before(:all) do
+      GunBroker.dev_key = 'test-dev-key'
+    end
+
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/GunBrokerTime'].join }
+    let(:response) { JSON.parse(response_fixture('time')) }
+
+    it 'should return the GunBroker time' do
+      stub_request(:get, endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('time'))
+
+      time = GunBroker.time
+      expect(time['gunBrokerTime']).to eq(response['gunBrokerTime'])
+      expect(time['gunBrokerVersion']).to eq(response['gunBrokerVersion'])
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.6
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,9 +102,11 @@ files:
 - lib/gun_broker/category.rb
 - lib/gun_broker/error.rb
 - lib/gun_broker/item.rb
-- lib/gun_broker/items_delegate.rb
+- lib/gun_broker/item/constants.rb
+- lib/gun_broker/response.rb
 - lib/gun_broker/token_header.rb
 - lib/gun_broker/user.rb
+- lib/gun_broker/user/items_delegate.rb
 - lib/gun_broker/version.rb
 - spec/fixtures/authenticate.json
 - spec/fixtures/categories.json
@@ -115,11 +117,14 @@ files:
 - spec/fixtures/item.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
+- spec/fixtures/test.json
+- spec/fixtures/time.json
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_spec.rb
+- spec/gun_broker/item/constants_spec.rb
 - spec/gun_broker/item_spec.rb
-- spec/gun_broker/items_delegate_spec.rb
 - spec/gun_broker/token_header_spec.rb
+- spec/gun_broker/user/items_delegate_spec.rb
 - spec/gun_broker/user_spec.rb
 - spec/gun_broker_spec.rb
 - spec/spec_helper.rb
@@ -159,11 +164,14 @@ test_files:
 - spec/fixtures/item.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
+- spec/fixtures/test.json
+- spec/fixtures/time.json
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_spec.rb
+- spec/gun_broker/item/constants_spec.rb
 - spec/gun_broker/item_spec.rb
-- spec/gun_broker/items_delegate_spec.rb
 - spec/gun_broker/token_header_spec.rb
+- spec/gun_broker/user/items_delegate_spec.rb
 - spec/gun_broker/user_spec.rb
 - spec/gun_broker_spec.rb
 - spec/spec_helper.rb

data/lib/gun_broker/items_delegate.rb

@@ -1,98 +0,0 @@
-require 'gun_broker/token_header'
-
-module GunBroker
-  # Used to scope {Item} lookup by {User}.
-  class ItemsDelegate
-
-    include GunBroker::TokenHeader
-
-    # @param user [User] A {User} instance to scope items by.
-    def initialize(user)
-      @user = user
-    end
-
-    # Returns all the User's items.
-    # @note {API#get! GET} /Items
-    # @raise [GunBroker::Error::NotAuthorized] If the {User#token} isn't valid.
-    # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
-    # @return [Array<Item>]
-    def all
-      response = GunBroker::API.get('/Items', { 'SellerName' => @user.username }, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    # Returns all the items the User has bid on.
-    # @note {API#get! GET} /ItemsBidOn
-    # @raise (see #all)
-    # @return [Array<Item>]
-    def bid_on
-      response = GunBroker::API.get('/ItemsBidOn', {}, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    # Finds a specific User's Item by ID. Calls {Item.find} to get full Item details.
-    # @raise (see #all)
-    # @return [Item] Returns the Item or `nil` if no Item found.
-    def find(item_id)
-      # HACK: This has to filter through `#all`, since the GunBroker API currently has no way to scope the `/Items/{itemID}` endpoint by user.
-      if all.select { |item| item.id.to_s == item_id.to_s }.first
-        GunBroker::Item.find(item_id)
-      else
-        nil
-      end
-    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)
-      item = find(item_id)
-      raise GunBroker::Error::NotFound.new("Couldn't find item with ID '#{item_id}'") if item.nil?
-      item
-    end
-
-    # Items the User has bid on, but not won.
-    # @note {API#get! GET} /ItemsNotWon
-    # @raise (see #all)
-    # @return [Array<Item>]
-    def not_won
-      response = GunBroker::API.get('/ItemsNotWon', {}, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    # Items the User has sold.
-    # @note {API#get! GET} /ItemsSold
-    # @raise (see #all)
-    # @return [Array<Item>]
-    def sold
-      response = GunBroker::API.get('/ItemsSold', {}, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    # Items that were listed, but not sold.
-    # @note {API#get! GET} /ItemsUnsold
-    # @raise (see #all)
-    # @return [Array<Item>]
-    def unsold
-      response = GunBroker::API.get('/ItemsUnsold', {}, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    # Items the User has won.
-    # @note {API#get! GET} /ItemsWon
-    # @raise (see #all)
-    # @return [Array<Item>]
-    def won
-      response = GunBroker::API.get('/ItemsWon', {}, token_header(@user.token))
-      items_from_results(response['results'])
-    end
-
-    private
-
-    def items_from_results(results)
-      results.map { |result| GunBroker::Item.new(result) }
-    end
-
-  end
-end