muffin_man 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a50a949121a2dbd7a3b4b6ba0862d8d3bf9336957164fe78c81a08bf5f508f8
-  data.tar.gz: 5a288706a99e4e9820dd22307cbfb22820ce4ca23f662f25b6e1089adba2ba1c
+  metadata.gz: a65842148ee282b6d12a552b0c55495a445b183e5a7e5c38a7418de04992f999
+  data.tar.gz: 383a57d029e7f7938d451698a69a60b808f6fccc9fab074fa0e2d710df3acd2a
 SHA512:
-  metadata.gz: bc2bab060e40d070cf093647e557a674e7f8c2cea7adb6039bc79553fce3412b2f22f72822065ee213b1fbb782d5559be48ac4476ddb3d748a8d0ba1e038fea4
-  data.tar.gz: 7037a0e94bdbd7fc918ef8548b5c39a395b0ea8b740f55c04f3b02762fdf422e7f4b441c9ee79fe91a56ff35e18c4105b18d61cd92531eefdddc80512c43891b
+  metadata.gz: 7993f0f6103ab852b70a457a4b5d29b028e40a3b53c98c169a28336653035dbb70ebdb988000fb6df04595362257924164b63a1cc2e0ea76dc1ba201c8a57245
+  data.tar.gz: 8f7ccf13026f77ea995fabf36d0c753714daea1ccfdfee63276a17693e86ed8d25466246a00017832050915ada192fa4dfd677d342cbcee1c88d5afeafa029e1

data/.rubocop_todo.yml

@@ -159,6 +159,7 @@ Lint/MissingSuper:
   Exclude:
     - 'lib/muffin_man/request_helpers/inbound_shipment_plan_request_item.rb'
 
+
 # Offense count: 17
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
@@ -254,6 +255,7 @@ RSpec/FilePath:
     - 'spec/muffin_man/solicitations_spec.rb'
     - 'spec/muffin_man/tokens_spec.rb'
 
+
 # Offense count: 15
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/LeadingSubject:

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 - Support for getInventorySummaries [#36](https://github.com/patterninc/muffin_man/pull/36)
 
+# 1.5.3
+
+- Support for Fulfillment Outbound  [#34](https://github.com/patterninc/muffin_man/pull/34)
+
 # 1.5.2
 
 - Support for Feeds and Notifications [#33](https://github.com/patterninc/muffin_man/pull/33)

data/README.md

@@ -12,6 +12,7 @@ As of now, this gem only supports portions of the following APIs with more to co
 - `product_fees`
 - `product_pricing`
 - `fulfillment_inbound`
+- `fulfillment_outbound`
 - `feeds`
 - `notifications`
 

data/lib/muffin_man/fulfillment_outbound/v20200701.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module FulfillmentOutbound
+    class V20200701 < SpApiClient
+      # @param [MuffinMan::RequestHelpers::OutboundFulFillment::FulfillmentPreviewRequest] fulfillment_preview_request
+      # in the form of object
+      def get_fulfillment_preview(fulfillment_preview_request)
+        return unprocessable_entity(fulfillment_preview_request&.errors) unless fulfillment_preview_request&.valid?
+
+        @local_var_path = "/fba/outbound/2020-07-01/fulfillmentOrders/preview"
+        @request_body = fulfillment_preview_request.to_camelize
+        @request_type = "POST"
+        call_api
+      end
+
+      # @param [MuffinMan::RequestHelpers::OutboundFulFillment::FulfillmentOrderRequest] fulfillment_order_request
+      # in the form of object
+      def create_fulfillment_order(fulfillment_order_request)
+        return unprocessable_entity(fulfillment_order_request&.errors) unless fulfillment_order_request&.valid?
+
+        @local_var_path = "/fba/outbound/2020-07-01/fulfillmentOrders"
+        @request_body = fulfillment_order_request.to_camelize
+        @request_type = "POST"
+        call_api
+      end
+
+      # @param [String] query_start_date optional
+      # @param [String] next_token optional
+      def list_all_fulfillment_orders(query_start_date: nil, next_token: nil)
+        @local_var_path = "/fba/outbound/2020-07-01/fulfillmentOrders"
+
+        @query_params = {} unless query_start_date.nil? && next_token.nil?
+
+        @query_params[:queryStartDate] = query_start_date unless query_start_date.nil?
+        @query_params[:nextToken] = next_token unless next_token.nil?
+        @request_type = "GET"
+        call_api
+      end
+
+      # @param [String] seller_fulfillment_order_id
+      def get_fulfillment_order(seller_fulfillment_order_id)
+        @local_var_path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}"
+        @request_type = "GET"
+        call_api
+      end
+
+      # @param [String] seller_fulfillment_order_id
+      def cancel_fulfillment_order(seller_fulfillment_order_id)
+        @local_var_path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/cancel"
+        @request_type = "PUT"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers/base.rb

@@ -1,3 +1,6 @@
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash"
+
 module MuffinMan
   module RequestHelpers
     class Base

data/lib/muffin_man/request_helpers/outbound_fulfillment/address.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module RequestHelpers
+    module OutboundFulfillment
+      class Address < MuffinMan::RequestHelpers::Base
+        attr_accessor :name, :address_line1, :address_line2, :address_line3, :city,
+                      :district_or_county, :state_or_region, :country_code, :postal_code, :phone
+
+        # Initializes the object
+        # @param [Hash] attributes Model attributes in the form of hash
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        def initialize(attributes = {})
+          super
+          return unless attributes.is_a?(Hash)
+
+          attributes = attributes.with_indifferent_access
+
+          self.name = attributes["name"] if attributes.key?("name")
+
+          if attributes.key?("address_line1") || attributes.key?("line1")
+            self.address_line1 = attributes["address_line1"] || attributes["line1"]
+          end
+
+          if attributes.key?("address_line2") || attributes.key?("line2")
+            self.address_line2 = attributes["address_line2"] || attributes["line2"]
+          end
+
+          if attributes.key?("address_line3") || attributes.key?("line3")
+            self.address_line3 = attributes["address_line3"] || attributes("line3")
+          end
+
+          self.city = attributes["city"] if attributes.key?("city")
+
+          self.district_or_county = attributes["district_or_county"] if attributes.key?("district_or_county")
+
+          if attributes.key?("state_or_region") || attributes.key?("state_or_province_code")
+            self.state_or_region = attributes["state_or_region"] || attributes["state_or_province_code"]
+          end
+
+          self.postal_code = attributes["postal_code"] if attributes.key?("postal_code")
+
+          self.country_code = attributes["country_code"] if attributes.key?("country_code")
+
+          self.phone = attributes["phone"] if attributes.key?("phone")
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/PerceivedComplexity
+
+        # return true if the model is valid
+        def valid?
+          return false if name.blank?
+          return false if address_line1.blank?
+          return false if state_or_region.blank?
+          return false if country_code.blank?
+
+          true
+        end
+
+        # Show invalid properties with the reasons.
+        # return Array for invalid properties with the reasons
+        def errors
+          errors = []
+          errors.push('"name" cannot be nil.') if name.blank?
+          errors.push('"address_line1" cannot be nil.') if address_line1.blank?
+          errors.push('"state_or_region" cannot be nil.') if state_or_region.blank?
+          errors.push('"country_code" cannot be nil.') if country_code.blank?
+
+          errors
+        end
+
+        # Format request object in sp-api request format
+        # @return hash for sp-api request format
+        def to_camelize
+          {
+            "name" => name,
+            "addressLine1" => address_line1,
+            "addressLine2" => address_line2,
+            "addressLine3" => address_line3,
+            "city" => city,
+            "districtOrCounty" => district_or_county,
+            "stateOrRegion" => state_or_region,
+            "countryCode" => country_code,
+            "postalCode" => postal_code,
+            "phone" => phone
+          }
+        end
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers/outbound_fulfillment/fulfillment_order_request.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module RequestHelpers
+    module OutboundFulfillment
+      class FulfillmentOrderRequest < MuffinMan::RequestHelpers::Base
+        attr_accessor :seller_fulfillment_order_id, :displayable_order_id, :displayable_order_date_time,
+                      :displayable_order_comment, :shipping_speed_category, :destination_address, :items,
+                      :optional_params
+
+        OPTIONAL_CREATE_FULFILLMENT_ORDER_PARAMS = %w[
+          marketplaceId
+          deliveryWindow
+          fulfillmentAction
+          fulfillmentPolicy
+          codSettings
+          shipFromCountryCode
+          notificationEmails
+          featureConstraints
+        ].freeze
+
+        # Initializes the object
+        # @param [String] seller_fulfillment_order_id
+        # @param [String] displayable_order_id
+        # @param [String] displayable_order_date_time
+        # @param [String] displayable_order_comment
+        # @param [String] shipping_speed_category
+        # @param [MuffinMan::RequestHelpers::OutboundFulfillment::Address] destination_address in form of object
+        # @param [MuffinMan::RequestHelpers::OutboundFulfillment::Item] items in the form of list of items objects
+        # @param [Hash] optional_params optional sp-api attributes in the form of hash
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(seller_fulfillment_order_id, displayable_order_id, displayable_order_date_time,
+                       displayable_order_comment, shipping_speed_category, destination_address, items,
+                       optional_params = {})
+          super
+          @seller_fulfillment_order_id = seller_fulfillment_order_id
+          @displayable_order_id = displayable_order_id
+          @displayable_order_date_time = displayable_order_date_time
+          @displayable_order_comment = displayable_order_comment
+          @shipping_speed_category = shipping_speed_category
+          @destination_address = destination_address
+          @items = items
+          @optional_params = optional_params
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        # Check to see if the all the properties in the model are valid
+        # @return true if the model is valid
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        def valid?
+          return false if seller_fulfillment_order_id.blank?
+          return false if displayable_order_id.blank?
+          return false if displayable_order_date_time.blank?
+          return false if displayable_order_comment.blank?
+          return false if shipping_speed_category.blank?
+          return false if destination_address.blank?
+          return false if items.blank?
+          return false if destination_address.present? && !destination_address.valid?
+          return false if items.present? && items.map(&:valid?).include?(false)
+
+          true
+        end
+
+        # Show invalid properties with the reasons.
+        # @return Array for invalid properties with the
+        def errors
+          errors = []
+          errors.push('"seller_fulfillment_order_id" cannot be nil.') if seller_fulfillment_order_id.blank?
+          errors.push('"displayable_order_id" cannot be nil.') if displayable_order_id.blank?
+          errors.push('"displayable_order_date_time" cannot be nil.') if displayable_order_date_time.blank?
+          errors.push('"displayable_order_comment" cannot be nil.') if displayable_order_comment.blank?
+          errors.push('"shipping_speed_category" cannot be nil.') if shipping_speed_category.blank?
+          errors.push('"destination_address" cannot be nil.') if destination_address.blank?
+          errors.push('"items" cannot be nil.') if items.blank?
+
+          if !destination_address.nil? && !destination_address.valid?
+            errors.push("invalid value for \"destination_address\", #{destination_address.errors}")
+          end
+
+          errors.push('invalid value for "items"') if !items.nil? && items.map(&:valid?).include?(false)
+
+          errors
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/PerceivedComplexity
+
+        # Format request object in sp-api request format
+        # @return hash for sp-api request format
+        def to_camelize
+          {
+            "sellerFulfillmentOrderId" => seller_fulfillment_order_id,
+            "displayableOrderId" => displayable_order_id,
+            "displayableOrderDate" => displayable_order_date_time,
+            "displayableOrderComment" => displayable_order_comment,
+            "shippingSpeedCategory" => shipping_speed_category,
+            "destinationAddress" => destination_address,
+            "items" => items.map(&:to_camelize)
+          }.merge!(optional_params.slice(*OPTIONAL_CREATE_FULFILLMENT_ORDER_PARAMS))
+        end
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers/outbound_fulfillment/fulfillment_preview_request.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module RequestHelpers
+    module OutboundFulfillment
+      class FulfillmentPreviewRequest < MuffinMan::RequestHelpers::Base
+        attr_accessor :address, :items, :optional_params
+
+        OPTIONAL_FULFILLMENT_PREVIEW_PARAMS = %w[
+          marketplaceId
+          shippingSpeedCategories
+          includeCODFulfillmentPreview
+          includeDeliveryWindows
+          featureConstraints
+        ].freeze
+
+        # Initializes the object
+        # @param [MuffinMan::RequestHelpers::OutboundFulfillment::Address] address in the form of object
+        # @param[MuffinMan::RequestHelpers::OutboundFulfillment::Item] items in the form of list of items objects
+        # @param [Hash] optional_params optional sp-api attributes in the form of hash
+        def initialize(address, items, optional_params = {})
+          super
+          @address = address
+          @items = items
+          @optional_params = optional_params
+        end
+
+        # Check to see if the all the properties in the model are valid
+        # @return true if the model is valid
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def valid?
+          return false if address.blank? || !address.is_a?(MuffinMan::RequestHelpers::OutboundFulfillment::Address)
+          return false if items.blank? || !items.is_a?(Array)
+
+          return false if !address.valid? || items.map(&:valid?).include?(false)
+
+          true
+        end
+
+        # Show invalid properties with the reasons.
+        # @return Array for invalid properties with the reasons
+        def errors
+          errors = []
+          errors.push('"address" cannot be nil.') if address.blank?
+          errors.push('"items" cannot be nil.') if items.blank?
+          errors.push("invalid value for \"address\",#{address.errors}") if address.present? && !address.valid?
+          errors.push('invalid value for "items"') if items.present? && items.map(&:valid?).include?(false)
+
+          errors
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        # Format request object in sp-api request format
+        # @return hash for sp-api request format
+        def to_camelize
+          {
+            "address" => address.to_camelize,
+            "items" => items.map(&:to_camelize)
+          }.merge!(optional_params.slice(*OPTIONAL_FULFILLMENT_PREVIEW_PARAMS))
+        end
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers/outbound_fulfillment/item.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module RequestHelpers
+    module OutboundFulfillment
+      class Item < MuffinMan::RequestHelpers::Base
+        attr_accessor :seller_sku, :seller_fulfillment_order_item_id, :quantity, :optional_params
+
+        OPTIONAL_ITEM_PARAMS = %w[
+          perUnitDeclaredValue
+          giftMessage
+          displayableComment
+          fulfillmentNetworkSku
+          perUnitDeclaredValue
+          perUnitPrice
+          perUnitTax
+        ].freeze
+
+        # Initializes the object
+        # @param [Hash] attributes Model attributes in the form of hash
+        def initialize(attributes = {})
+          super
+          return unless attributes.is_a?(Hash)
+
+          attributes = attributes.with_indifferent_access
+
+          @seller_sku = attributes["seller_sku"] if attributes.key?("seller_sku")
+
+          if attributes.key?("seller_fulfillment_order_item_id")
+            @seller_fulfillment_order_item_id = attributes["seller_fulfillment_order_item_id"]
+          end
+
+          @quantity = attributes["quantity"] if attributes.key?("quantity")
+
+          @optional_params = attributes.slice(*OPTIONAL_ITEM_PARAMS)
+        end
+
+        # Check to see if the all the properties in the model are valid
+        # @return true if the model is valid
+        def valid?
+          return false if seller_sku.blank?
+          return false if seller_fulfillment_order_item_id.blank?
+          return false if quantity.blank?
+
+          true
+        end
+
+        # Show invalid properties with the reasons.
+        # @return Array for invalid properties with the reasons
+        def errors
+          errors = []
+          errors.push('"seller_sku" cannot be nil.') if seller_sku.blank?
+          errors.push('"seller_fulfillment_order_item_id" cannot be nil.') if seller_fulfillment_order_item_id.blank?
+          errors.push('"quantity" cannot be nil.') if quantity.blank?
+
+          errors
+        end
+
+        def to_camelize
+          {
+            "sellerSku" => seller_sku,
+            "sellerFulfillmentOrderItemId" => seller_fulfillment_order_item_id,
+            "quantity" => quantity
+          }.merge!(optional_params.slice(*OPTIONAL_ITEM_PARAMS))
+        end
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers/outbound_fulfillment/v20200701.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module RequestHelpers
+    module OutboundFulfillment
+      class V20200701
+        def self.address_request(name, address_line1, state_or_region, country_code, optional_params = {})
+          Address.new({
+            "name" => name,
+            "address_line1" => address_line1,
+            "state_or_region" => state_or_region,
+            "country_code" => country_code
+          }.merge(optional_params))
+        end
+
+        def self.item_request(seller_sku, seller_fulfillment_order_item_id, quantity, optional_params = {})
+          Item.new({
+            "seller_sku" => seller_sku,
+            "seller_fulfillment_order_item_id" => seller_fulfillment_order_item_id,
+            "quantity" => quantity
+          }.merge(optional_params))
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        def self.fulfillment_order_request(seller_fulfillment_order_id, displayable_order_id,
+                                           displayable_order_date_time,
+                                           displayable_order_comment, shipping_speed_category,
+                                           destination_address, items, optional_params = {})
+          FulfillmentOrderRequest.new(seller_fulfillment_order_id, displayable_order_id, displayable_order_date_time,
+                                      displayable_order_comment, shipping_speed_category, destination_address,
+                                      items, optional_params)
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        def self.fulfillment_preview_request(address, items, optional_params = {})
+          FulfillmentPreviewRequest.new(address, items, optional_params)
+        end
+      end
+    end
+  end
+end

data/lib/muffin_man/request_helpers.rb

@@ -1,2 +1,3 @@
 require 'muffin_man/request_helpers/base'
 require 'muffin_man/request_helpers/inbound_shipment_plan_request_item'
+require 'muffin_man/request_helpers/outbound_fulfillment/v20200701'

data/lib/muffin_man/sp_api_client.rb

@@ -20,6 +20,8 @@ module MuffinMan
       "fe" => "us-west-2"
     }.freeze
 
+    UNPROCESSABLE_ENTITY_STATUS_CODE = 422
+
     def initialize(credentials, sandbox = false)
       @refresh_token = credentials[:refresh_token]
       @client_id = credentials[:client_id]
@@ -183,6 +185,10 @@ module MuffinMan
       @aws_region
     end
 
+    def unprocessable_entity(errors)
+      Typhoeus::Response.new(code: UNPROCESSABLE_ENTITY_STATUS_CODE, body: { errors: errors.to_s }.to_json)
+    end
+
     def sp_api_params(params)
       params.to_h.transform_keys { |key| key.to_s.split("_").map.with_index { |x, i| i.positive? ? x.capitalize : x }.join }
     end

data/lib/muffin_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuffinMan
-  VERSION = "1.5.2"
+  VERSION = "1.5.3"
 end

data/lib/muffin_man.rb

@@ -14,9 +14,11 @@ require "muffin_man/product_pricing/v0"
 require "muffin_man/listings/v20210801"
 require "muffin_man/fulfillment_inbound/v0"
 require "muffin_man/fulfillment_inbound/v1"
+require "muffin_man/fulfillment_outbound/v20200701"
+require "muffin_man/fba_inventory/v1"
+require "muffin_man/request_helpers"
 require "muffin_man/feeds/v20210630"
 require "muffin_man/notifications/v1"
-require "muffin_man/fba_inventory/v1"
 
 module MuffinMan
   class Error < StandardError; end

data/muffin_man.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   spec.add_runtime_dependency 'aws-sigv4', '>= 1.1'
   spec.add_runtime_dependency 'aws-sdk-core', '>= 2.4.4'
+  spec.add_runtime_dependency 'activesupport'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Gavin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -116,6 +116,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - gavin@pattern.com
@@ -148,6 +162,7 @@ files:
 - lib/muffin_man/finances/v0.rb
 - lib/muffin_man/fulfillment_inbound/v0.rb
 - lib/muffin_man/fulfillment_inbound/v1.rb
+- lib/muffin_man/fulfillment_outbound/v20200701.rb
 - lib/muffin_man/listings/v20210801.rb
 - lib/muffin_man/lwa/auth_helper.rb
 - lib/muffin_man/notifications/v1.rb
@@ -158,6 +173,11 @@ files:
 - lib/muffin_man/request_helpers.rb
 - lib/muffin_man/request_helpers/base.rb
 - lib/muffin_man/request_helpers/inbound_shipment_plan_request_item.rb
+- lib/muffin_man/request_helpers/outbound_fulfillment/address.rb
+- lib/muffin_man/request_helpers/outbound_fulfillment/fulfillment_order_request.rb
+- lib/muffin_man/request_helpers/outbound_fulfillment/fulfillment_preview_request.rb
+- lib/muffin_man/request_helpers/outbound_fulfillment/item.rb
+- lib/muffin_man/request_helpers/outbound_fulfillment/v20200701.rb
 - lib/muffin_man/solicitations/v1.rb
 - lib/muffin_man/sp_api_client.rb
 - lib/muffin_man/tokens/v20210301.rb