gun_broker 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263f58913c30a8bc6cd92e93f7639764e36d5419
-  data.tar.gz: b81f8988a611e475e3d0c2c5dba5ab27f2d77493
+  metadata.gz: ee763dfd6dc989b4a508ba5e8024dfc31a0a2451
+  data.tar.gz: 114c9fc33eb2b8ed81dd4a68abbea813379f1b93
 SHA512:
-  metadata.gz: 75d66025a4a1678065a866fd879edb113b5662a4fe02f99dbfa7cc13d41b4149397ca8f0e56721497a4b7e2625a72c9b7f776e59e33d64e0d77b03c60d888ce6
-  data.tar.gz: 7e3283d6755afd90d704bdbd502e495e9b00458875c4d4b2b6517de0197b43de23bcf02c62057a6ea243524452d11374bfa4591d8c78c94062cf421e0e8cecf1
+  metadata.gz: 2c3513dbaefad16934c3e9e96ac569ac8cc5fbd78f8ea1adbb16b910d2e9e46b204d96a58b90eefd5f40f18ab32e88cfecea9a966b2361bdf536b1cb28bd788b
+  data.tar.gz: f327aa604e32522f398582b516e0f37e48924a10849df6cda7b7d713757f357f75614691a5ec34a42fc37c77c277a48d9240cfc2821c0414f2f33be1bc700ec4

data/.yardopts

@@ -0,0 +1,3 @@
+--title "GunBroker API Documentation"
+--readme README.md
+--markup markdown

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
+### Documentation
+
+The full documentation is located here: http://www.rubydoc.info/gems/gun_broker
+
 ### Developer Token
 
 You **must** set a developer key obtained from GunBroker.com in order to use this library.
@@ -49,9 +53,10 @@ Once the User has an access token, you can then grab all of their items (listing
 return an array of `GunBroker::Item` instances.
 
 ```ruby
-user.items  # => [GunBroker::Item, ...]
-user.items_unsold  # => [GunBroker::Item, ...]
-user.items_sold  # => [GunBroker::Item, ...]
+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!`.

data/Rakefile

@@ -1,7 +1,20 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 task :default => :spec
 
 desc 'Run the specs'
 RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate API docs'
+YARD::Rake::YardocTask.new(:docs) do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+namespace :docs do
+  desc 'Run the docs server'
+  task :server do
+    $stdout.puts `yard server --reload --bind 0.0.0.0`
+  end
+end

data/gun_broker.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "yard", "~> 0.8"
 end

data/lib/gun_broker.rb

@@ -4,16 +4,22 @@ require 'gun_broker/api'
 require 'gun_broker/category'
 require 'gun_broker/error'
 require 'gun_broker/item'
+require 'gun_broker/items_delegate'
 require 'gun_broker/user'
 
 module GunBroker
 
+  # Sets the developer key obtained from GunBroker.com.
+  # @param dev_key [String]
   def self.dev_key=(dev_key)
     @@dev_key = dev_key
   end
 
+  # Returns the set developer key, or raises GunBroker::Error if not set.
+  # @raise [GunBroker::Error] If the {.dev_key} has not been set.
+  # @return [String] The developer key.
   def self.dev_key
-    raise 'GunBroker developer key not set.' unless dev_key_present?
+    raise GunBroker::Error.new('GunBroker developer key not set.') unless dev_key_present?
     @@dev_key
   end
 

data/lib/gun_broker/api.rb

@@ -2,10 +2,15 @@ require 'json'
 require 'net/https'
 
 module GunBroker
+  # Generic REST adapter for the GunBroker API.
   class API
 
+    # Root URL of the GunBroker API.
     GUNBROKER_API = 'https://api.gunbroker.com/v1'
 
+    # @param path [String] The requested API endpoint.
+    # @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?('/')
 
@@ -14,24 +19,32 @@ module GunBroker
       @headers = headers
     end
 
+    # Wrapper for {GunBroker::API#delete! `new(*args).delete!`}
+    # @param *args Splat arguments passed to {#initialize}.
     def self.delete(*args)
       new(*args).delete!
     end
 
+    # Wrapper for {GunBroker::API#get! `new(*args).get!`}
+    # @param *args Splat arguments passed to {#initialize}.
     def self.get(*args)
       new(*args).get!
     end
 
+    # Wrapper for {GunBroker::API#post! `new(*args).post!`}
+    # @param *args Splat arguments passed to {#initialize}.
     def self.post(*args)
       new(*args).post!
     end
 
+    # Sends a DELETE request to the given `path`.
     def delete!
       request = Net::HTTP::Delete.new(uri)
       response = get_response(request)
       handle_response(response)
     end
 
+    # Sends a GET request to the given `path`.
     def get!
       uri.query = URI.encode_www_form(@params)
 
@@ -40,6 +53,7 @@ module GunBroker
       handle_response(response)
     end
 
+    # Sends a POST request to the given `path`.
     def post!
       request = Net::HTTP::Post.new(uri)
       request.body = @params.to_json

data/lib/gun_broker/category.rb

@@ -1,25 +1,38 @@
 module GunBroker
+  # Represents a GunBroker category.
   class Category
 
     # The top-level category ID.
     ROOT_CATEGORY_ID = 0
 
+    # @param parent [Integer, String] (optional) Return all subcategories of the given parent Category ID; defaults to the root (top-level) categories.
+    # @return [Array<Category>] An array of GunBroker::Category instances.
     def self.all(parent = ROOT_CATEGORY_ID)
       response = GunBroker::API.get('/Categories', { 'ParentCategoryID' => parent })
       response['results'].map { |attrs| new(attrs) }
     end
 
+    # @param category_id [Integer, String] The ID of the Category to find.
+    # @return [Category] A Category instance.
     def self.find(category_id)
       new(GunBroker::API.get("/Categories/#{category_id}"))
     end
 
+    # @param attrs [Hash] The JSON attributes from the API response.
     def initialize(attrs = {})
       @attrs = attrs
     end
 
+    # @return [Integer] The Category ID.
     def id
       @attrs['categoryID']
     end
 
+    # @param key [String] A Category attribute name (from the JSON response).
+    # @return The value of the given `key` or `nil`.
+    def [](key)
+      @attrs[key]
+    end
+
   end
 end

data/lib/gun_broker/error.rb

@@ -2,6 +2,7 @@ module GunBroker
   class Error < StandardError
 
     class NotAuthorized < GunBroker::Error; end
+    class NotFound < GunBroker::Error; end
     class RequestError < GunBroker::Error; end
 
   end

data/lib/gun_broker/item.rb

@@ -1,14 +1,25 @@
 module GunBroker
+  # Represents a GunBroker item (listing).
   class Item
 
+    # @param item_id [Integer, String] The ID of the Item to find.
+    # @return [Item] An Item instance.
+    def self.find(item_id)
+      new(GunBroker::API.get("/Items/#{item_id}"))
+    end
+
+    # @param attrs [Hash] The JSON attributes from the API response.
     def initialize(attrs = {})
       @attrs = attrs
     end
 
+    # @return [Integer] The Item ID.
     def id
       @attrs['itemID']
     end
 
+    # @param key [String] An Item attribute name (from the JSON response).
+    # @return The value of the given `key` or `nil`.
     def [](key)
       @attrs[key]
     end

data/lib/gun_broker/items_delegate.rb

@@ -0,0 +1,98 @@
+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

data/lib/gun_broker/token_header.rb

@@ -0,0 +1,13 @@
+module GunBroker
+  # Holds helper methods dealing with a User's {User#token access token}.
+  module TokenHeader
+
+    protected
+
+    def token_header(token)
+      raise GunBroker::Error.new("No token given.") if token.nil?
+      { 'X-AccessToken' => token }
+    end
+
+  end
+end

data/lib/gun_broker/user.rb

@@ -1,41 +1,61 @@
+require 'gun_broker/token_header'
+
 module GunBroker
+  # Represents a GunBroker User.
   class User
 
+    include GunBroker::TokenHeader
+
+    # @return [String] The User's GunBroker.com username.
     attr_reader :username
+
+    # @return [String] The User's GunBroker access token obtained by calling {#authenticate!} or `nil` if not authenticated.
     attr_reader :token
 
+    # @param username [String]
+    # @param auth_options [Hash] Requires either a `:password` or `:token`.
+    # @option auth_options [String] :password The User's GunBroker.com password.
+    # @option auth_options [String] :token An existing access token previously obtained by calling {#authenticate!} with a username/password.
     def initialize(username, auth_options = {})
       @username = username
       @password = auth_options[:password] || auth_options['password']
       @token    = auth_options[:token]    || auth_options['token']
     end
 
+    # Authenticates with the GunBroker API server and saves the returned access {#token}.
+    # @note {API#post! POST} /Users/AccessToken
+    # @raise [GunBroker::Error::NotAuthorized] If the username/password is invalid.
+    # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
+    # @return [String] The access {#token} used in subsequent requests.
     def authenticate!
       response = GunBroker::API.post('/Users/AccessToken', { username: @username, password: @password })
       @token = response['accessToken']
     end
 
-    # Sends a DELETE request to deactivate the current access token.
+    # Sends a DELETE request to deactivate the current access {#token}.
+    # @note {API#delete! DELETE} /Users/AccessToken
+    # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
+    # @return [true] Explicitly returns `true` unless an exception is raised.
     def deauthenticate!
-      GunBroker::API.delete('/Users/AccessToken', {}, { 'X-AccessToken' => @token })
+      GunBroker::API.delete('/Users/AccessToken', {}, token_header(@token))
       @token = nil
       true  # Explicit `true` so this method won't return the `nil` set above.
     end
     alias_method :revoke_access_token!, :deauthenticate!
 
-    def items
-      response = GunBroker::API.get('/Items', { 'SellerName' => @username }, { 'X-AccessToken' => @token })
-      response['results'].map { |result| GunBroker::Item.new(result) }
+    # Returns the User's contact information.
+    # @note {API#get! GET} /Users/ContactInfo
+    # @raise [GunBroker::Error::RequestError] If there's an issue with the request (usually a `5xx` response).
+    # @return [Hash] From the JSON response.
+    def contact_info
+      GunBroker::API.get('/Users/ContactInfo', { 'UserName' => @username }, token_header(@token))
     end
 
-    def items_unsold
-      response = GunBroker::API.get('/ItemsUnsold', {}, { 'X-AccessToken' => @token })
-      response['results'].map { |result| GunBroker::Item.new(result) }
-    end
-
-    def items_sold
-      response = GunBroker::API.get('/ItemsSold', {}, { 'X-AccessToken' => @token })
-      response['results'].map { |result| GunBroker::Item.new(result) }
+    # (see ItemsDelegate)
+    # See the {ItemsDelegate} docs.
+    # @return [ItemsDelegate]
+    def items
+      ItemsDelegate.new(self)
     end
 
   end

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/spec/fixtures/contact_info.json

@@ -0,0 +1 @@
+{"userID":12345,"userName":"test-user","firstName":"Test","lastName":"User","address1":"123 Main St.","address2":null,"city":"Sometown","state":"SC","postalCode":"12345","countryCode":"US","phone":"123-456-7890","alternatePhone":"","faxPhone":"","email":"test.user@example.com","companyName":"","isBusinessAddress":false,"links":[]}

data/spec/gun_broker/category_spec.rb

@@ -17,6 +17,13 @@ describe GunBroker::Category do
     expect(category.id).to eq(attrs['categoryID'])
   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
+
   context '.all' do
     let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Categories'].join }
 

data/spec/gun_broker/item_spec.rb

@@ -16,4 +16,32 @@ describe GunBroker::Item do
     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
+      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 an exception' 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)
+      end
+    end
+  end
+
 end

data/spec/gun_broker/items_delegate_spec.rb

@@ -0,0 +1,236 @@
+require 'spec_helper'
+
+describe GunBroker::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) }
+
+  context '#all' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Items'].join }
+
+    context 'on success' do
+      it 'returns the User items' do
+        stub_request(:get, endpoint)
+          .with(
+            headers: headers('X-AccessToken' => token),
+            query: { 'SellerName' => user.username }
+          )
+          .to_return(body: response_fixture('items'))
+
+        expect(delegate.all).not_to be_empty
+        expect(delegate.all.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'should raise an exception' do
+        stub_request(:get, endpoint)
+          .with(
+            headers: headers('X-AccessToken' => token),
+            query: { 'SellerName' => user.username }
+          )
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        expect { delegate.all }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+  context '#bid_on' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsBidOn'].join }
+
+    context 'on success' do
+      it 'returns won Items' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('items'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.bid_on).not_to be_empty
+        expect(delegate.bid_on.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'raises an exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        user = GunBroker::User.new(username, token: token)
+        expect { delegate.bid_on }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+  context '#find' do
+    let(:attrs) { JSON.parse(response_fixture('item')) }
+    let(:all_endpoint) { [GunBroker::API::GUNBROKER_API, '/Items'].join }
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, "/Items/#{attrs['itemID']}"].join }
+
+    it 'returns a single Item' do
+      # First, stub the '/Items' request, since we have to use that to scope the Item find by user.
+      stub_request(:get, all_endpoint)
+        .with(
+          headers: headers('X-AccessToken' => token),
+          query: { 'SellerName' => user.username }
+        )
+        .to_return(body: response_fixture('items'))
+
+      # Now we stub the '/Items/:id' request.
+      stub_request(:get, endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('item'))
+
+      item = delegate.find(attrs['itemID'])
+      expect(item).to be_a(GunBroker::Item)
+      expect(item.id).to eq(attrs['itemID'])
+    end
+
+    it 'returns nil if no item found' do
+      stub_request(:get, all_endpoint)
+        .with(
+          headers: headers('X-AccessToken' => token),
+          query: { 'SellerName' => user.username }
+        )
+        .to_return(body: response_fixture('items'))
+
+      expect(delegate.find(666)).to be_nil
+    end
+  end
+
+  context '#find!' do
+    let(:all_endpoint) { [GunBroker::API::GUNBROKER_API, '/Items'].join }
+
+    it 'calls #find' do
+      item_id = 123
+      expect(delegate).to receive(:find).with(item_id).and_return(true)
+      delegate.find!(item_id)
+    end
+
+    it 'raises GunBroker::Error::NotFound if no item found' do
+      stub_request(:get, all_endpoint)
+        .with(
+          headers: headers('X-AccessToken' => token),
+          query: { 'SellerName' => user.username }
+        )
+        .to_return(body: response_fixture('items'))
+
+      item_id = 123
+      expect {
+        delegate.find!(item_id)
+      }.to raise_error(GunBroker::Error::NotFound)
+    end
+  end
+
+  context '#not_won' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsNotWon'].join }
+
+    context 'on success' do
+      it 'returns won Items' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('items'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.not_won).not_to be_empty
+        expect(delegate.not_won.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'raises an exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        user = GunBroker::User.new(username, token: token)
+        expect { delegate.not_won }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+  context '#sold' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsSold'].join }
+
+    context 'on success' do
+      it 'returns sold Items' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('items'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.sold).not_to be_empty
+        expect(delegate.sold.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'raises an exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        user = GunBroker::User.new(username, token: token)
+        expect { delegate.sold }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+  context '#unsold' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsUnsold'].join }
+
+    context 'on success' do
+      it 'returns unsold Items' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('items'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.unsold).not_to be_empty
+        expect(delegate.unsold.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'raises an exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        user = GunBroker::User.new(username, token: token)
+        expect { delegate.unsold }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+  context '#won' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsWon'].join }
+
+    context 'on success' do
+      it 'returns won Items' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('items'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.won).not_to be_empty
+        expect(delegate.won.first).to be_a(GunBroker::Item)
+      end
+    end
+
+    context 'on failure' do
+      it 'raises an exception' do
+        stub_request(:get, endpoint)
+          .with(headers: headers('X-AccessToken' => token))
+          .to_return(body: response_fixture('not_authorized'), status: 401)
+
+        user = GunBroker::User.new(username, token: token)
+        expect { delegate.won }.to raise_error(GunBroker::Error::NotAuthorized)
+      end
+    end
+  end
+
+end

data/spec/gun_broker/token_header_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GunBroker::TokenHeader do
+
+  let(:mock_class) { (Class.new { include GunBroker::TokenHeader }).new }
+
+  context '#token_header' do
+    it 'returns the access token Hash' do
+      token = 'test-user-access-token'
+      header = { 'X-AccessToken' => token }
+      expect(mock_class.send(:token_header, token)).to eq(header)
+    end
+
+    it 'raises an exception if token is nil' do
+      expect {
+        mock_class.send(:token_header, nil)
+      }.to raise_error(GunBroker::Error)
+    end
+  end
+
+end

data/spec/gun_broker/user_spec.rb

@@ -23,6 +23,13 @@ describe GunBroker::User do
     end
   end
 
+  context '#token_header' do
+    it 'raises an error if @token nil' do
+      user = GunBroker::User.new(username, token: nil)
+      expect { user.items.all }.to raise_error(GunBroker::Error)
+    end
+  end
+
   context '#authenticate!' do
     let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Users/AccessToken'].join }
 
@@ -96,90 +103,44 @@ describe GunBroker::User do
     end
   end
 
-  context '#items' do
-    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Items'].join }
+  context '#contact_info' do
+    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/Users/ContactInfo'].join }
 
     context 'on success' do
-      it 'returns the User items' do
-        stub_request(:get, endpoint)
-          .with(
-            headers: headers('X-AccessToken' => token),
-            query: { 'SellerName' => username }
-          )
-          .to_return(body: response_fixture('items'))
-
+      it 'returns a contact info hash' do
         user = GunBroker::User.new(username, token: token)
-        expect(user.items).not_to be_empty
-        expect(user.items.first).to be_a(GunBroker::Item)
-      end
-    end
 
-    context 'on failure' do
-      it 'should raise an exception' do
         stub_request(:get, endpoint)
           .with(
             headers: headers('X-AccessToken' => token),
-            query: { 'SellerName' => username }
+            query: { 'UserName' => user.username }
           )
-          .to_return(body: response_fixture('not_authorized'), status: 401)
-
-        user = GunBroker::User.new(username, token: token)
-        expect { user.items }.to raise_error(GunBroker::Error::NotAuthorized)
-      end
-    end
-  end
-
-  context '#items_unsold' do
-    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsUnsold'].join }
-
-    context 'on success' do
-      it 'returns unsold Items' do
-        stub_request(:get, endpoint)
-          .with(headers: headers('X-AccessToken' => token))
-          .to_return(body: response_fixture('items'))
+          .to_return(body: response_fixture('contact_info'))
 
-        user = GunBroker::User.new(username, token: token)
-        expect(user.items_unsold).not_to be_empty
-        expect(user.items_unsold.first).to be_a(GunBroker::Item)
+        expect(user.contact_info).to eq(JSON.parse(response_fixture('contact_info')))
       end
     end
 
     context 'on failure' do
       it 'raises an exception' do
-        stub_request(:get, endpoint)
-          .with(headers: headers('X-AccessToken' => token))
-          .to_return(body: response_fixture('not_authorized'), status: 401)
-
         user = GunBroker::User.new(username, token: token)
-        expect { user.items_unsold }.to raise_error(GunBroker::Error::NotAuthorized)
-      end
-    end
-  end
-
-  context '#items_sold' do
-    let(:endpoint) { [GunBroker::API::GUNBROKER_API, '/ItemsSold'].join }
 
-    context 'on success' do
-      it 'returns sold Items' do
         stub_request(:get, endpoint)
-          .with(headers: headers('X-AccessToken' => token))
-          .to_return(body: response_fixture('items'))
+          .with(
+            headers: headers('X-AccessToken' => token),
+            query: { 'UserName' => user.username }
+          )
+          .to_return(body: response_fixture('empty'), status: 401)
 
-        user = GunBroker::User.new(username, token: token)
-        expect(user.items_sold).not_to be_empty
-        expect(user.items_sold.first).to be_a(GunBroker::Item)
+        expect { user.contact_info }.to raise_error(GunBroker::Error::NotAuthorized)
       end
     end
+  end
 
-    context 'on failure' do
-      it 'raises an exception' do
-        stub_request(:get, endpoint)
-          .with(headers: headers('X-AccessToken' => token))
-          .to_return(body: response_fixture('not_authorized'), status: 401)
-
-        user = GunBroker::User.new(username, token: token)
-        expect { user.items_sold }.to raise_error(GunBroker::Error::NotAuthorized)
-      end
+  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)
     end
   end
 

data/spec/gun_broker_spec.rb

@@ -18,6 +18,11 @@ describe GunBroker do
       GunBroker.dev_key = key
       expect(GunBroker.dev_key).to eq(key)
     end
+
+    it 'raises an exception if @@dev_key is nil' do
+      GunBroker.class_variable_set(:@@dev_key, nil)
+      expect { GunBroker.dev_key }.to raise_error(GunBroker::Error)
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: ''
 email:
 - oshuma@gmail.com
@@ -77,6 +91,7 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,11 +102,14 @@ 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/token_header.rb
 - lib/gun_broker/user.rb
 - lib/gun_broker/version.rb
 - spec/fixtures/authenticate.json
 - spec/fixtures/categories.json
 - spec/fixtures/category.json
+- spec/fixtures/contact_info.json
 - spec/fixtures/deauthenticate.json
 - spec/fixtures/empty.json
 - spec/fixtures/item.json
@@ -100,6 +118,8 @@ files:
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_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_spec.rb
 - spec/gun_broker_spec.rb
 - spec/spec_helper.rb
@@ -133,6 +153,7 @@ test_files:
 - spec/fixtures/authenticate.json
 - spec/fixtures/categories.json
 - spec/fixtures/category.json
+- spec/fixtures/contact_info.json
 - spec/fixtures/deauthenticate.json
 - spec/fixtures/empty.json
 - spec/fixtures/item.json
@@ -141,8 +162,11 @@ test_files:
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_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_spec.rb
 - spec/gun_broker_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/headers.rb
+has_rdoc: