gun_broker 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 347f961fc6d333472e7ed636d8efffc6d32ddcd2
-  data.tar.gz: 39281a14096480b8af69bff867da86c924d04df7
+  metadata.gz: b3863aa8529ca0b094ac8b6e55dae3662dc8ed7c
+  data.tar.gz: 5df89b9753c627c7923cce828c66b11f9bc3ccf6
 SHA512:
-  metadata.gz: 487335ffc8f42a330cd94a9dffd4e0bbc732bc00a4082cdefe894f516a77788f793cffc66a0c32d65f370d3b4e0a71a6d235538549f70378abfb9767fe4aff75
-  data.tar.gz: 1d2530240790e86fbf4cc1024997a261f1b953f176d6ea6d3c0e3a6dae5c91fab18a589b9a2360c74350b33708d9bfa4c752c76d92616fb82bcdb22c536d9ae7
+  metadata.gz: 6166eabf7ad30445180a92dac8661132ee20403f5438fa8a4e43ae134df0a869ea67956bf6d37308291cbe0d9f723b9c9f86248e7ebe692a3059df326538587d
+  data.tar.gz: 01c86da2dda79b0936e0cdabda65ca0597e332e439cd1737b78b3379bf060a2eb46d812ff4c5d5f4ef716bc723e8e4088c850c0c6fff0f896f505fc48f7011c0

data/lib/gun_broker/item/constants.rb

@@ -1,6 +1,5 @@
 module GunBroker
   class Item
-    # Holds constant values for Item.
     module Constants
 
       # Options for auto-relisting.
@@ -93,14 +92,6 @@ 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/order.rb

@@ -96,6 +96,11 @@ module GunBroker
       @attrs['paymentMethod'].values
     end
 
+    # @return [Integer] Status key for this Order.
+    def status_key
+      @attrs['status'].keys.first.to_i
+    end
+
     # @param key [String] An Order attribute name (from the JSON response).
     # @return The value of the given `key` or `nil`.
     def [](key)

data/lib/gun_broker/order/constants.rb

@@ -0,0 +1,18 @@
+module GunBroker
+  class Order
+    module Constants
+
+      # The carrier responsible for shipping.
+      # The keys of this hash should be sent as the `carrier` param when updating shipping on an Order.
+      SHIPPING_CARRIERS = {
+        1 => 'FedEx',
+        2 => 'UPS',
+        3 => 'USPS',
+      }
+
+      # The flags that are allowed to be toggled (true/false) on an Order.
+      ACCEPTED_FLAG_KEYS = %i( payment_received ffl_received order_shipped )
+
+    end
+  end
+end

data/lib/gun_broker/user/orders_delegate.rb

@@ -1,5 +1,5 @@
 require 'gun_broker/token_header'
-require 'gun_broker/item/constants'
+require 'gun_broker/order/constants'
 
 module GunBroker
   class User
@@ -7,7 +7,7 @@ module GunBroker
     class OrdersDelegate
 
       include GunBroker::TokenHeader
-      include GunBroker::Item::Constants
+      include GunBroker::Order::Constants
 
       # @param user [User] A {User} instance to scope orders by.
       def initialize(user)
@@ -63,13 +63,34 @@ module GunBroker
         carrier_key = SHIPPING_CARRIERS.find { |k, v| v.casecmp(carrier_name).zero? }.try(:first)
         params = {
           'TrackingNumber' => tracking_number,
-          'Carrier' => carrier_key,
+          'Carrier'        => carrier_key,
         }
 
         GunBroker::API.put("/Orders/#{order_id}/Shipping", cleanup_nil_params(params), token_header(@user.token))
         find!(order_id)
       end
 
+      # Sets any of 3 available Order flags.
+      # @param order_id [Integer, String] ID of the Order to update.
+      # @param flags [hash] Keys with boolean values of flags to update on Order.
+      # @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 set_flags!(order_id, flags = {})
+        unless flags.keys.all? { |k| ACCEPTED_FLAG_KEYS.include?(k) }
+          raise ArgumentError.new("Only accepted keys for flag toggling are #{ACCEPTED_FLAG_KEYS.to_sentence}")
+        end
+
+        params = {
+          'PaymentReceived' => flags[:payment_received],
+          'FFLReceived'     => flags[:ffl_received],
+          'OrderShipped'    => flags[:order_shipped],
+        }
+
+        GunBroker::API.put("/Orders/#{order_id}/Flags", 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.4"
+  VERSION = "1.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - lib/gun_broker/item/constants.rb
 - lib/gun_broker/items_as_page.rb
 - lib/gun_broker/order.rb
+- lib/gun_broker/order/constants.rb
 - lib/gun_broker/orders_as_page.rb
 - lib/gun_broker/response.rb
 - lib/gun_broker/token_header.rb