gun_broker 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ae985a2b69996d2bb39e0abfa56dbcc91b085c2
-  data.tar.gz: c69757e524eb002b6f3f54f4ad57197cdd4a6c7a
+  metadata.gz: 5d2b22b6ae3a52a176f7191944c75b34f1d1fe11
+  data.tar.gz: bd1e881cd614343cb8a441420b751ce7e8ce9314
 SHA512:
-  metadata.gz: 07f0b8d62dc2efdf80e7f68026d28e5c863e919df3a6256f8303f4e690133b28d54495bd7dc3f09d707a70f4770ca65aeb1227fb6d3065ceb69c980c3218963d
-  data.tar.gz: 12f1546ff053d27b9d048f8b89d51e7f97989b8af1799428bf56f87e6e9ab96e089eca395edc6a02207f6afec4a1bee8d55d545eea028d04291c761bc6823609
+  metadata.gz: 46ec9c38357f0a3e1daccfd5d16049b4b9aa610a253c6bd4a65672649b1f1b013593cff4b97c96e0920807d161a0be84c320a6b3ecf961bc4cd870c19693328c
+  data.tar.gz: b9d604c7aca3055a5e2a1347c7657dcebd685fa6df3135810a931fe542ff097780edf13d28c35fa4a92dc48dabc4421c7d572328829a451e8a76a93a6f7263d8

data/lib/gun_broker.rb

@@ -10,6 +10,21 @@ require 'gun_broker/user'
 
 module GunBroker
 
+  WEB_URL = "https://www.gunbroker.com"
+  WEB_URL_SANDBOX = "https://www.sandbox.gunbroker.com"
+
+  # Sets the developer key obtained from GunBroker.com.
+  # @param api [Boolean] whether to use api endpoint or public website endpoint
+  def self.base_url(api: true)
+    if sandbox?
+      return API::ROOT_URL_SANDBOX if api
+      WEB_URL_SANDBOX
+    else
+      return API::ROOT_URL if api
+      WEB_URL
+    end
+  end
+
   # Sets the developer key obtained from GunBroker.com.
   # @param dev_key [String]
   def self.dev_key=(dev_key)
@@ -36,6 +51,11 @@ module GunBroker
     defined?(@@sandbox) ? @@sandbox : false
   end
 
+  # An alias to {.sandbox} method
+  def self.sandbox?
+    sandbox
+  end
+
   # Returns a hash containing the time on GunBroker's servers in UTC
   # and the current version of the GunBroker API.
   #

data/lib/gun_broker/user/items_delegate.rb

@@ -96,27 +96,35 @@ module GunBroker
       end
 
       # Returns Items that are currently selling.
+      # @param options [Hash] {ItemID=>ItemID}.
       # @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 selling
-        response = GunBroker::API.get('/Items', {
-          'SellerName' => @user.username,
+      def selling(options = {})
+        parameters = {
+          'ItemID'        => (options[:item_id] || options["ItemID"]),
+          'PageSize'      => GunBroker::API::PAGE_SIZE,
+          'SellerName'    => @user.username,
           'SellingStatus' => SELLING_STATUS[:selling],
-          'PageSize' => GunBroker::API::PAGE_SIZE
-        }, token_header(@user.token))
+        }.delete_if { |k, v| v.nil? }
+
+        response = GunBroker::API.get('/Items', parameters, token_header(@user.token))
         items_from_results(response['results'])
       end
 
       # Items the User has sold.
+      # @param options [Hash] {ItemID=>ItemID}.
       # @note {API#get! GET} /ItemsSold
       # @raise (see #all)
       # @return [Array<Item>]
-      def sold
-        response = GunBroker::API.get('/ItemsSold', {
-          'PageSize' => GunBroker::API::PAGE_SIZE
-        }, token_header(@user.token))
+      def sold(options = {})
+        parameters = {
+          'PageSize' => GunBroker::API::PAGE_SIZE,
+          'ItemID'   => (options[:item_id] || options["ItemID"]),
+        }.delete_if { |k, v| v.nil? }
+
+        response = GunBroker::API.get('/ItemsSold', parameters, token_header(@user.token))
         items_from_results(response['results'])
       end
 
@@ -124,10 +132,13 @@ module GunBroker
       # @note {API#get! GET} /ItemsUnsold
       # @raise (see #all)
       # @return [Array<Item>]
-      def unsold
-        response = GunBroker::API.get('/ItemsUnsold', {
-          'PageSize' => GunBroker::API::PAGE_SIZE
-        }, token_header(@user.token))
+      def unsold(options = {})
+        parameters = {
+          'PageSize' => GunBroker::API::PAGE_SIZE,
+          'ItemID'   => (options[:item_id] || options["ItemID"]),
+        }.delete_if { |k, v| v.nil? }
+
+        response = GunBroker::API.get('/ItemsUnsold', parameters, token_header(@user.token))
         items_from_results(response['results'])
       end
 

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/spec/fixtures/item_id.json

@@ -0,0 +1 @@
+{"count":1,"pageIndex":1,"pageSize":25,"results":[{"itemID":465370483,"bids":0,"eligibleForImmediateCheckout":false,"endingDate":"2015-02-25T15:37:19Z","isFeaturedItem":false,"isFixedPrice":true,"isHighlighted":false,"isShowCaseItem":false,"isTitleBoldface":false,"hasBuyNow":false,"hasColor":false,"hasQuickLook":false,"hasPictures":true,"hasReserve":false,"hasReserveBeenMet":false,"highBidderID":0,"quantity":3,"price":49.9900,"serialNumber":"","sku":"","subTitle":"","thumbnailURL":"http://pics.gunbroker.com/GB/465370000/465370483/thumb.jpg","timeLeft":"P26DT18H52M28S","title":"Magpul STR Carbine Stock Mil Spec Black","titleColor":"#000000","links":[{"rel":"self","href":"https://api.gunbroker.com/v1/items/465370483","verb":"GET","title":"465370483"}]}],"categoryCounts":[{"id":3032,"name":"Rifle Stocks","count":1}],"links":[{"rel":"share","href":"http://www.gunbroker.com/All/BI.aspx?IncludeSellers=2266088&PageSize=25","verb":"GET","title":"Check out what I found on GunBroker.com!"}]}

data/spec/gun_broker/user/items_delegate_spec.rb

@@ -200,6 +200,22 @@ describe GunBroker::User::ItemsDelegate do
         expect(delegate.sold).not_to be_empty
         expect(delegate.sold.first).to be_a(GunBroker::Item)
       end
+
+      it 'returns one sold item when passed an `ItemID` option' do
+        stub_request(:get, endpoint)
+          .with(
+            headers: headers('X-AccessToken' => token),
+            query: { 
+              'PageSize' => GunBroker::API::PAGE_SIZE,
+              'ItemID'   => '123'
+            }
+          )
+          .to_return(body: response_fixture('item_id'))
+
+        user = GunBroker::User.new(username, token: token)
+        expect(delegate.sold(item_id: 123)).not_to be_empty
+        expect(delegate.sold(item_id: 123).first).to be_a(GunBroker::Item)
+      end
     end
 
     context 'on failure' do

data/spec/gun_broker_spec.rb

@@ -6,6 +6,24 @@ describe GunBroker do
     expect(GunBroker::VERSION).to be_a(String)
   end
 
+  context '.base_url' do
+    context 'in sandbox mode' do
+      it 'should return the proper sandbox api url' do
+        GunBroker.sandbox = false
+        expect(GunBroker.base_url).to eq("https://api.gunbroker.com/v1")
+        expect(GunBroker.base_url(api: false)).to eq("https://www.gunbroker.com")
+      end
+    end
+
+    context 'in live mode' do
+      it 'should return the proper api url' do
+        GunBroker.sandbox = true
+        expect(GunBroker.base_url).to eq("https://api.sandbox.gunbroker.com/v1")
+        expect(GunBroker.base_url(api: false)).to eq("https://www.sandbox.gunbroker.com")
+      end
+    end
+  end
+
   context '.dev_key' do
     let(:key) { 'foo' }
 
@@ -26,13 +44,10 @@ describe GunBroker do
   end
 
   context '.sandbox' do
-    it 'defaults to false' do
-      expect(GunBroker.sandbox).to eq(false)
-    end
-
     it 'sets @@sandbox to true' do
       GunBroker.sandbox = true
       expect(GunBroker.sandbox).to eq(true)
+      expect(GunBroker.sandbox?).to eq(true)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - spec/fixtures/feedback-summary.json
 - spec/fixtures/feedback.json
 - spec/fixtures/item.json
+- spec/fixtures/item_id.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
 - spec/fixtures/test.json
@@ -183,6 +184,7 @@ test_files:
 - spec/fixtures/feedback-summary.json
 - spec/fixtures/feedback.json
 - spec/fixtures/item.json
+- spec/fixtures/item_id.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
 - spec/fixtures/test.json