gun_broker 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1476980635cd1ec420f1a8dcc47d606f0d14880b
-  data.tar.gz: 68c93bfe39aba2cc4018a7487ff9cf86d71cdde4
+  metadata.gz: 347f961fc6d333472e7ed636d8efffc6d32ddcd2
+  data.tar.gz: 39281a14096480b8af69bff867da86c924d04df7
 SHA512:
-  metadata.gz: db55a3b5837fe047e13a9da6e64b0bf57d28accdf350c9851e30b02260263cbddc67fac434869e1459fc731c27ffbc6a7ec9b6e50eb0aeee35da5c608305c16d
-  data.tar.gz: 7d949f1b850fb68c85b4f9dac86486ee5a193d7bfc530f6aacf746f56f0b87226ea396eee1158e82da7af048ba7d73e9143cf9dec73a17aa86724a9e5b48ba11
+  metadata.gz: 487335ffc8f42a330cd94a9dffd4e0bbc732bc00a4082cdefe894f516a77788f793cffc66a0c32d65f370d3b4e0a71a6d235538549f70378abfb9767fe4aff75
+  data.tar.gz: 1d2530240790e86fbf4cc1024997a261f1b953f176d6ea6d3c0e3a6dae5c91fab18a589b9a2360c74350b33708d9bfa4c752c76d92616fb82bcdb22c536d9ae7

data/lib/gun_broker/item/constants.rb

@@ -93,6 +93,14 @@ module GunBroker
         16 => 'Use shipping profile',
       }
 
+      # The carrier responsible for shipping.
+      # The keys of this hash should be sent as the `carrier` param when updating shipping on an Item.
+      SHIPPING_CARRIERS = {
+        1 => 'FedEx',
+        2 => 'UPS',
+        3 => 'USPS',
+      }
+
     end
   end
 end

data/lib/gun_broker/user/orders_delegate.rb

@@ -1,4 +1,5 @@
 require 'gun_broker/token_header'
+require 'gun_broker/item/constants'
 
 module GunBroker
   class User
@@ -6,6 +7,7 @@ module GunBroker
     class OrdersDelegate
 
       include GunBroker::TokenHeader
+      include GunBroker::Item::Constants
 
       # @param user [User] A {User} instance to scope orders by.
       def initialize(user)
@@ -41,6 +43,33 @@ module GunBroker
         @sold ||= fetch_orders(:OrdersSold, params)
       end
 
+      # Submits shipping details for an {Order}.
+      # @param (see #submit_shipping!)
+      # @return [GunBroker::Order] The updated Order instance or `false` if update fails.
+      def submit_shipping(*args)
+        submit_shipping!(*args)
+      rescue GunBroker::Error
+        false
+      end
+
+      # Same as {#submit_shipping} but raises exceptions on error.
+      # @param order_id [Integer, String] ID of the Order to update.
+      # @param tracking_number [String] The tracking number of the shipment.
+      # @param carrier_name [String] The name of the carrier of the shipment.
+      # @raise [GunBroker::Error::NotAuthorized] If the {User#token `@user` token} isn't valid.
+      # @raise [GunBroker::Error::RequestError] If the Order attributes are not valid or required attributes are missing.
+      # @return [GunBroker::Order] The updated Order instance.
+      def submit_shipping!(order_id, tracking_number, carrier_name)
+        carrier_key = SHIPPING_CARRIERS.find { |k, v| v.casecmp(carrier_name).zero? }.try(:first)
+        params = {
+          'TrackingNumber' => tracking_number,
+          'Carrier' => carrier_key,
+        }
+
+        GunBroker::API.put("/Orders/#{order_id}/Shipping", cleanup_nil_params(params), token_header(@user.token))
+        find!(order_id)
+      end
+
       private
 
       def fetch_orders(endpoint, params = {})

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler