peddler 2.4.5 → 3.0.0

data/lib/mws/shipment_invoicing/client.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module ShipmentInvoicing
-    # With the Shipment Invoicing API section, you can integrate invoicing into
-    # Amazon's shipping process for a seller's FBA order.
-    #
-    # @note This functionality is available only in the Brazil marketplace.
-    class Client < ::Peddler::Client
-      self.version = '2018-09-01'
-      self.path = "/ShipmentInvoicing/#{version}"
-
-      # Returns the information required to generate an invoice for the shipment
-      # of a Fulfillment by Amazon order
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentDetail.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @return [Peddler::XMLParser]
-      def get_fba_outbound_shipment_detail(marketplace_id, amazon_shipment_id)
-        operation('GetFBAOutboundShipmentDetail')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Submits shipment invoice data for a given shipment
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_SubmitFBAOutboundShipmentInvoice.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @param [String] invoice_content
-      # @return [Peddler::XMLParser]
-      def submit_fba_outbound_shipment_invoice(marketplace_id,
-                                               amazon_shipment_id,
-                                               invoice_content)
-        self.body = invoice_content
-
-        operation('SubmitFBAOutboundShipmentInvoice')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Gets the invoice processing status for the shipments that you specify
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentInvoiceStatus.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @return [Peddler::XMLParser]
-      def get_fba_outbound_shipment_invoice_status(marketplace_id,
-                                                   amazon_shipment_id)
-        operation('GetFBAOutboundShipmentInvoiceStatus')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Gets the operational status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-    end
-  end
-end

data/lib/mws/shipment_invoicing.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/shipment_invoicing/client'

data/lib/mws/subscriptions/client.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Subscriptions
-    # The Amazon MWS Subscriptions API section enables you to subscribe to
-    # receive notifications that are relevant to your business with Amazon. With
-    # the operations in the Subscriptions API section, you can register to
-    # receive important information from Amazon without having to poll the
-    # Amazon MWS service. Instead, the information is sent directly to you when
-    # an event occurs to which you are subscribed.
-    class Client < ::Peddler::Client
-      self.version = '2013-07-01'
-      self.path = "/Subscriptions/#{version}"
-
-      # Registers a new destination to receive notifications
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_RegisterDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def register_destination(sqs_queue_url, marketplace_id)
-        operation('RegisterDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Removes an existing destination from the list of registered destinations
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeregisterDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def deregister_destination(sqs_queue_url, marketplace_id)
-        operation('DeregisterDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Lists all registered destinations
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListRegisteredDestinations.html
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def list_registered_destinations(marketplace_id)
-        operation('ListRegisteredDestinations')
-          .add('MarketplaceId' => marketplace_id)
-
-        run
-      end
-
-      # Sends a test notification to an existing destination
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_SendTestNotificationToDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def send_test_notification_to_destination(sqs_queue_url, marketplace_id)
-        operation('SendTestNotificationToDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Creates a new subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_CreateSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def create_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('CreateSubscription')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_subscription(notification_type, sqs_queue_url))
-
-        run
-      end
-
-      # Gets a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def get_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('GetSubscription')
-          .add('MarketplaceId' => marketplace_id,
-               'NotificationType' => notification_type)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Deletes a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeleteSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def delete_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('DeleteSubscription')
-          .add('MarketplaceId' => marketplace_id,
-               'NotificationType' => notification_type)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Lists current subscriptions
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListSubscriptions.html
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def list_subscriptions(marketplace_id)
-        operation('ListSubscriptions')
-          .add('MarketplaceId' => marketplace_id)
-
-        run
-      end
-
-      # Updates a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_UpdateSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [Boolean] enabled
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def update_subscription(notification_type, sqs_queue_url, enabled,
-                              marketplace_id)
-        operation('UpdateSubscription')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_subscription(notification_type, sqs_queue_url, enabled: enabled))
-
-        run
-      end
-
-      # Gets the service status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-
-      private
-
-      def build_destination(sqs_queue_url)
-        {
-          'Destination.DeliveryChannel' => 'SQS',
-          'Destination.AttributeList.member.1.Key' => 'sqsQueueUrl',
-          'Destination.AttributeList.member.1.Value' => sqs_queue_url
-        }
-      end
-
-      def build_subscription(notification_type, sqs_queue_url, enabled: true)
-        {
-          'Subscription.IsEnabled' => enabled,
-          'Subscription.NotificationType' => notification_type,
-          'Subscription.Destination.DeliveryChannel' => 'SQS',
-          'Subscription.Destination.AttributeList.member.1.Key' =>
-            'sqsQueueUrl',
-          'Subscription.Destination.AttributeList.member.1.Value' =>
-            sqs_queue_url
-        }
-      end
-    end
-  end
-end

data/lib/mws/subscriptions.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/subscriptions/client'

data/lib/mws.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'mws/easy_ship'
-require 'mws/feeds'
-require 'mws/finances'
-require 'mws/fulfillment_inbound_shipment'
-require 'mws/fulfillment_inventory'
-require 'mws/fulfillment_outbound_shipment'
-require 'mws/merchant_fulfillment'
-require 'mws/orders'
-require 'mws/products'
-require 'mws/recommendations'
-require 'mws/reports'
-require 'mws/sellers'
-require 'mws/shipment_invoicing'
-require 'mws/subscriptions'
-
-# The various Amazon MWS API sections.
-module MWS
-  class << self
-    extend Forwardable
-
-    MWS.constants.each do |klass|
-      method_name = klass.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
-      def_delegator MWS.const_get(klass).const_get(:Client), :new, method_name
-    end
-  end
-end

data/lib/peddler/client.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'jeff'
-require 'peddler/errors/builder'
-require 'peddler/marketplace'
-require 'peddler/operation'
-require 'peddler/parser'
-
-module Peddler
-  # An abstract client
-  #
-  # Subclass this to implement an MWS API section.
-  class Client
-    extend Forwardable
-    include Jeff
-
-    class << self
-      # @!visibility private
-      attr_accessor :parser, :path, :version
-
-      private
-
-      def inherited(base)
-        super
-        base.parser = parser
-        base.params params
-      end
-    end
-
-    params 'SellerId' => -> { merchant_id },
-           'MWSAuthToken' => -> { auth_token },
-           'Version' => -> { version }
-    self.parser = Parser
-
-    def_delegators :marketplace, :host, :encoding
-    def_delegators :'self.class', :parser, :version
-
-    # Creates a new client
-    # @param [Hash] opts
-    # @option opts [String] :aws_access_key_id
-    # @option opts [String] :aws_secret_access_key
-    # @option opts [String, Peddler::Marketplace] :marketplace
-    # @option opts [String] :merchant_id
-    # @option opts [String] :auth_token
-    def initialize(opts = {})
-      opts.each { |k, v| send("#{k}=", v) }
-    end
-
-    # The MWS Auth Token for a seller's account
-    # @note You can omit this if you are accessing your own seller account
-    # @return [String]
-    attr_accessor :auth_token
-
-    # The seller's Merchant ID
-    # @note Amazon also refers to this as Seller ID or Merchant Token
-    # @return [String]
-    attr_accessor :merchant_id
-
-    # The marketplace where you signed up as application developer
-    # @note You can pass the two-letter country code of the marketplace as
-    #   shorthand when setting
-    # @return [Peddler::Marketplace]
-    attr_reader :marketplace
-
-    # @!parse attr_writer :marketplace
-    def marketplace=(marketplace)
-      @marketplace =
-        if marketplace.is_a?(Marketplace)
-          marketplace
-        else
-          Marketplace.find(marketplace)
-        end
-    end
-
-    # The body of the HTTP request
-    # @return [String]
-    attr_reader :body
-
-    # @!parse attr_writer :body
-    def body=(str)
-      str ? add_content(str) : clear_content!
-    end
-
-    # @!visibility private
-    attr_writer :path
-
-    # @!visibility private
-    def path
-      @path ||= self.class.path
-    end
-
-    # @!visibility private
-    def defaults
-      @defaults ||= { expects: 200 }
-    end
-
-    # @!visibility private
-    def headers
-      @headers ||= {}
-    end
-
-    # @!visibility private
-    def aws_endpoint
-      "https://#{host}#{path}"
-    end
-
-    # @!visibility private
-    def operation(action = nil)
-      action ? @operation = Operation.new(action) : @operation
-    end
-
-    # @!visibility private
-    def run(&block)
-      opts = build_options
-      opts.store(:response_block, block) if block
-      res = post(opts)
-      self.body = nil if res.status == 200
-
-      parser.new(res, encoding)
-    rescue ::Excon::Error::HTTPStatus => e
-      handle_http_status_error(e)
-    end
-
-    private
-
-    def clear_content!
-      headers.delete('Content-Type')
-      @body = nil
-    end
-
-    def add_content(content)
-      @body = content
-      if content.encoding.names.include?('BINARY')
-        headers['Content-Type'] = 'application/octet-stream'
-      elsif content.start_with?('<?xml')
-        headers['Content-Type'] = 'text/xml'
-      else
-        headers['Content-Type'] =
-          "text/tab-separated-values; charset=#{encoding}"
-        @body = @body.encode(encoding)
-      end
-    end
-
-    def extract_options(args)
-      args.last.is_a?(Hash) ? args.pop : {}
-    end
-
-    def build_options
-      opts = defaults.merge(query: operation, headers: headers)
-      body ? opts.update(body: body) : opts
-    end
-
-    def handle_http_status_error(error)
-      new_error = Errors::Builder.call(error)
-      raise new_error || error
-    end
-  end
-end

data/lib/peddler/errors/builder.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'excon'
-require 'forwardable'
-require 'peddler/errors/class_generator'
-require 'peddler/errors/parser'
-
-module Peddler
-  module Errors
-    # @!visibility private
-    class Builder
-      extend Forwardable
-
-      DIGIT_AS_FIRST_CHAR = /^\d/.freeze
-      private_constant :DIGIT_AS_FIRST_CHAR
-
-      def_delegator :error, :response
-
-      def self.call(error)
-        new(error).build
-      end
-
-      attr_reader :error
-
-      def initialize(error)
-        @error = error
-      end
-
-      def build
-        parse_original_response
-        return if no_error_response?
-        return if bad_class_name?
-
-        error_class.new(error_message, error)
-      end
-
-      private
-
-      def bad_class_name?
-        error_name.match?(DIGIT_AS_FIRST_CHAR)
-      end
-
-      def no_error_response?
-        response.parse.nil?
-      end
-
-      def error_class
-        ClassGenerator.call(error_name)
-      end
-
-      def error_name
-        response.code
-      end
-
-      def error_message
-        response.message
-      end
-
-      def parse_original_response
-        error.instance_variable_set :@response, Parser.new(error.response)
-      end
-    end
-  end
-end

data/lib/peddler/errors/class_generator.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'singleton'
-require 'peddler/errors/error'
-
-module Peddler
-  module Errors
-    # @!visibility private
-    class ClassGenerator
-      include Singleton
-
-      def self.call(name)
-        instance.generate(name)
-      end
-
-      def initialize
-        @mutex = Mutex.new
-      end
-
-      def generate(name)
-        with_mutex do
-          if Errors.const_defined?(name)
-            error = Errors.const_get(name)
-            return error if error <= Error
-
-            raise TypeError, "#{name} must be a Peddler::Errors::Error"
-          end
-
-          Errors.const_set(name, Class.new(Error))
-        end
-      end
-
-      private
-
-      def with_mutex(&block)
-        @mutex.synchronize(&block)
-      end
-    end
-  end
-end

data/lib/peddler/errors/error.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-module Peddler
-  # @!visibility private
-  module Errors
-    # These error codes are common to all Amazon MWS API sections.
-    #
-    # @see https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Errors.html
-    #
-    # There are quite a few other error types they do not explicitly document
-    # above. I decided not to define any for the sake of consistency and future
-    # maintenance.
-    CODES = %w[
-      AccessDenied
-      InputStreamDisconnected
-      InternalError
-      InvalidAccessKeyId
-      InvalidAddress
-      InvalidParameterValue
-      QuotaExceeded
-      RequestThrottled
-      SignatureDoesNotMatch
-    ].freeze
-
-    # @!visibility private
-    class Error < StandardError
-      extend Forwardable
-
-      attr_reader :cause
-
-      def initialize(msg = nil, cause = nil)
-        @cause = cause
-        super msg
-      end
-
-      def_delegator :cause, :response
-    end
-
-    CODES.each do |name|
-      const_set name, Class.new(Error)
-    end
-  end
-end

data/lib/peddler/errors/parser.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/xml_parser'
-
-module Peddler
-  module Errors
-    # @!visibility private
-    class Parser < XMLParser
-      def message
-        parse['Message']
-      end
-
-      def type
-        parse['Type']
-      end
-
-      def code
-        parse['Code']
-      end
-
-      private
-
-      def find_data
-        xml.dig('ErrorResponse', 'Error')
-      end
-    end
-  end
-end

data/lib/peddler/flat_file_parser.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require 'delegate'
-require 'csv'
-require 'digest/md5'
-require 'peddler/headers'
-
-module Peddler
-  # @!visibility private
-  class FlatFileParser < SimpleDelegator
-    include Headers
-
-    # http://stackoverflow.com/questions/8073920/importing-csv-quoting-error-is-driving-me-nuts
-    OPTIONS = { col_sep: "\t", quote_char: "\x00", headers: true }.freeze
-    private_constant :OPTIONS
-
-    attr_reader :content, :summary
-
-    def initialize(res, encoding)
-      super(res)
-      scrub_body!(encoding)
-      extract_content_and_summary
-    end
-
-    def parse(&blk)
-      CSV.parse(content, **OPTIONS, &blk) unless content.empty?
-    end
-
-    def records_count
-      summarize if summary
-    end
-
-    def valid?
-      headers['Content-MD5'] == Digest::MD5.base64digest(body)
-    end
-
-    private
-
-    def scrub_body!(encoding)
-      return if body.encoding == Encoding::UTF_8
-
-      self.body = body.dup.force_encoding(content_charset || encoding)
-    end
-
-    def extract_content_and_summary
-      @content = body.encode('UTF-8', invalid: :replace, undef: :replace)
-      return unless @content.match?(/\t\t.*\n\n/)
-
-      @summary, @content = @content.split("\n\n", 2)
-    end
-
-    def summarize
-      summary.split("\n\t")[1, 2].map { |line| line.split("\t\t") }.to_h
-    end
-  end
-end