amazon-mws-plus 0.1.3

data/lib/amazon/mws/request/feed_builder.rb

@@ -0,0 +1,83 @@
+require 'set'
+
+module Amazon
+  module MWS
+
+    class FeedBuilder
+      attr_accessor :xml
+
+      def initialize(message_type, messages = [], params = {})
+        @xml = Builder::XmlMarkup.new(:indent=>2)
+        @message_type = message_type
+        @messages = messages
+        @params = params
+        @merchant_id = params[:merchant_id]
+      end
+
+      def render
+        @xml.instruct!
+        @xml.AmazonEnvelope("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", "xsi:noNamespaceSchemaLocation"=>"amzn-envelope.xsd") do
+          render_header
+          
+          envelope_params = { :message_type => @message_type }
+          envelope_params.merge!({:purge => @params[:purge]}) if Feed::PRODUCT_MESSAGE_TYPES.include?(@message_type) && @params[:purge]==true
+          render_envelope(envelope_params)
+          
+          if !@messages.nil?
+            @messages.flatten.each_with_index do |message,i|
+              message = {'MessageID'=>i+1}.merge(message) if message[:MessageID].nil?
+              render_message(message, @params)
+            end
+          end
+        end
+      end
+
+      def render_header
+        @xml.Header do
+          @xml.DocumentVersion "1.01"
+          @xml.MerchantIdentifier @merchant_id
+        end
+      end
+
+      def render_envelope(params = {})
+        #@xml.EffectiveDate Time.now
+        @xml.MessageType(params[:message_type].to_s)
+        @xml.PurgeAndReplace(params[:purge]) if params[:purge]
+      end
+
+      def render_message(message, params = {})
+        if (message.is_a?(Hash) || message.is_a?(YAML::Omap))
+          @xml.Message do |xml|
+            build_xml(message, xml)
+          end
+        else
+          raise "Unknown type for: #{message.inspect}"
+        end
+      end
+
+      # Hack exceptional cases added for elements with 1 and 2 attributes
+      def build_xml(hash, xml)
+        hash.each {|key, value|
+          case value
+            when Hash then xml.tag!(key) {|xml| build_xml(value, xml) }
+            when YAML::Omap then xml.tag!(key) {|xml| build_xml(value, xml) }
+            #when Array then xml.tag!(key) {|xml| value.each {|v| build_xml(v, xml) } }
+            when Array then
+              case value.first
+                when Hash then xml.tag!(key) {|xml| value.each {|v| build_xml(v, xml) } }
+                else # array can include hashes for attributes, but not in the first slot
+                  if value.length==2 && value[1].is_a?(Hash) && value[1].length==1 # first slot is not a hash, second might be (for attribute)
+                    xml.tag!(key, value[0], value[1])
+                  elsif value.length==3 && value[1].is_a?(Hash) && value[1].length==1 && value[2].is_a?(Hash) && value[2].length==1
+                    xml.tag!(key, value[0], value[1], value[2])
+                  else
+                    value.each { |v| xml.tag!(key, v) } # accept array of non-hashes and create a <key>value_x</key> for each
+                  end
+              end
+            else xml.tag!(key, value)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/amazon/mws/request/fulfillment.rb

@@ -0,0 +1,50 @@
+module Amazon
+  module MWS
+    module Fulfillment
+
+      def get_fulfillment_order(fulfillment_order_id)
+        params = { "Action"   => "GetFulfillmentOrder", "SellerFulfillmentOrderId" => fulfillment_order_id }
+        response = post(fulfillment_path,params)
+        return response if params[:raw_xml]
+        GetFulfillmentOrderResponse.format(response)
+      end
+
+      def list_all_fulfillment_orders(start_date_time, fulfillment_method=nil)
+        params = { "Action"   => "ListAllFulfillmentOrders", "QueryStartDateTime" => start_date_time }
+        params.merge!("FulfillmentMethod" => fulfillment_method) if fulfillment_method
+        response = post(fulfillment_path,params)
+        return response if params[:raw_xml]
+        ListAllFulfillmentOrdersResponse.format(response)
+      end
+
+      def list_all_fulfillment_orders_by_next_token(token)
+        params = { "Action"   => "ListAllFulfillmentOrdersByNextToken", "NextToken" => token }
+        response = post(fulfillment_path,params)
+        return response if params[:raw_xml]
+        ListAllFulfillmentOrdersByNextTokenResponse.format(response)
+      end
+
+      def create_fulfillment_order(order_params)
+        required_params = ["SellerFulfillmentOrderId", "DisplayableOrderId",'DisplayableOrderDateTime','DisplayableOrderComment','ShippingSpeedCategory', 'DestinationAddress','Items']
+        raise InvalidParams.new(required_params) unless (order_params.keys - required_params).empty?
+        params = { "Action"   => "CreateFulfillmentOrder"}.merge(order_params)
+        response = post(fulfillment_path,params)
+        return response if params[:raw_xml]
+        CreateFulfillmentOrderResponse.format(response)
+      end 
+
+      def cancel_fulfillment_order(order_id)
+        params = { "Action"   => "CancelFulfillmentOrder", "SellerFulfillmentOrderId" => order_id }
+        response = post(fulfillment_path,params)
+        return response if params[:raw_xml]
+        CancelFulfillmentOrderResponse.format(response)
+      end 
+
+      private
+      def fulfillment_path
+        "/FulfillmentOutboundShipment/#{Authentication::FULFILLMENT_VERSION}"
+      end
+
+    end 
+  end 
+end 

data/lib/amazon/mws/request/orders.rb

@@ -0,0 +1,107 @@
+module Amazon
+  module MWS
+    module Orders
+
+      def get_orders_list(params ={})
+        query_params = { "Action"   => "ListOrders" }
+        query_params.merge!({"CreatedAfter" => params[:created_after]}) if params[:created_after]
+        query_params.merge!({"CreatedBefore" => params[:created_before]}) if params[:created_before]
+        query_params.merge!({"LastUpdatedAfter" =>params[:last_updated_after]}) if params[:last_updated_after]
+        query_params.merge!({"LastUpdatedBefore" => params[:last_updated_before]}) if params[:last_updated_before]
+        query_params.merge!({"BuyerEmail" => params[:buyer_email]}) if params[:buyer_email]
+        query_params.merge!({"SellerOrderId" => params[:seller_order_id]}) if params[:seller_order_id]
+        query_params.merge!({"MaxResultsPerPage" => params[:results_per_page]}) if params[:results_per_page]
+
+        if params[:fulfillment_channel]
+          params[:fulfillment_channel].to_a.each_with_index{|channel,i| query_params.merge!({"FulfillmentChannel.Channel.#{i+1}" => channel})}
+        end
+
+        if params[:order_status]
+          params[:order_status].to_a.each_with_index{|status,i| query_params.merge!({"OrderStatus.Status.#{i+1}" => status})}
+        end
+
+        if params[:marketplace_id]
+          params[:marketplace_id].to_a.each_with_index{|id,i| query_params.merge!({"MarketplaceId.Id.#{i+1}" => id})}
+        end
+
+        response = post(order_path, query_params)
+        if params[:raw_xml]
+          return response
+        end
+        RequestOrdersResponse.format(response)
+      end
+
+      def get_orders_list_by_next_token(params ={})
+        next_token = params[:next_token]
+
+        query_params = {
+          "Action"   => "ListOrdersByNextToken"
+        }
+        if next_token
+          query_params.merge!({"NextToken" => next_token})
+        end
+        response = post(order_path, query_params)
+        if params[:raw_xml]
+          return response
+        end
+        RequestOrdersByNextTokenResponse.format(response)
+      end
+
+      def get_list_order_items(params ={})
+        amazon_order_id = params[:amazon_order_id]
+
+        query_params = {
+          "Action"   => "ListOrderItems"
+        }
+        if amazon_order_id
+          query_params.merge!({"AmazonOrderId" => amazon_order_id})
+        end
+        response = post(order_path, query_params)
+        if params[:raw_xml]
+        	return response
+        end
+       	RequestOrderItemsResponse.format(response)
+      end
+
+      def get_list_order_items_by_next_token(params ={})
+        next_token = params[:next_token]
+
+        query_params = {
+          "Action"   => "ListOrderItemsByNextToken"
+        }
+
+        if next_token
+          query_params.merge!({"NextToken" => next_token})
+        end
+        response = post(order_path, query_params)
+        if params[:raw_xml]
+          return response
+        end
+        RequestOrderItemsByNextTokenResponse.format(response)
+      end
+
+      def get_orders(params ={})
+
+        query_params = {
+          "Action"   => "GetOrder"
+        }
+
+        if params[:amazon_order_id]
+          params[:amazon_order_id].to_a.each_with_index{|id,i| query_params.merge!({"AmazonOrderId.Id.#{i+1}" => id})}
+        end
+
+        response = post(order_path, query_params)
+        if params[:raw_xml]
+          return response
+        end
+        RequestGetOrderResponse.format(response)
+      end
+      
+      private
+      def order_path
+        "/Orders/#{Authentication::ORDERS_VERSION}"
+      end
+
+    end
+  end
+end

data/lib/amazon/mws/request/products.rb

@@ -0,0 +1,38 @@
+module Amazon
+  module MWS
+    module Products
+
+      def get_matching_product(asins, params={})
+        query_params = { "Action" => "GetMatchingProduct" }
+        query_params["MarketplaceId"] = params[:marketplace] || @connection.marketplace_id
+        asins.each_with_index{|id,i| query_params.merge!({"ASINList.ASIN.#{i+1}" => id})}
+
+        response = post(product_path, query_params)
+        
+        return response if params[:raw_xml]
+
+        GetMatchingProductResponse.format(response)
+      end
+
+      def get_matching_product_for_id(id_type, ids, params={})
+        query_params = { "Action" => "GetMatchingProductForId" }
+        query_params["MarketplaceId"] = params[:marketplace] || @connection.marketplace_id
+        query_params["IdType"] = id_type
+        ids.each_with_index{|id,i| query_params.merge!({"IdList.Id.#{i+1}" => id})}
+
+        response = post(product_path, query_params)
+        
+        return response if params[:raw_xml]
+
+        GetMatchingProductForIdResponse.format(response)
+      end
+
+      private
+      def product_path
+        "/Products/#{Authentication::PRODUCTS_VERSION}"
+      end
+
+
+    end
+  end
+end

data/lib/amazon/mws/request/report.rb

@@ -0,0 +1,330 @@
+module Amazon
+  module MWS
+
+    module Report
+
+        #https://mws.amazon.com/docs/devGuide/index.html?ReportType.html
+        REPORT_TYPES = {
+          :flat_file_open_listings    => '_GET_FLAT_FILE_OPEN_LISTINGS_DATA_',
+          :merchant_listing           => '_GET_MERCHANT_LISTINGS_DATA_',
+          :merchant_listings_lite     => '_GET_MERCHANT_LISTINGS_DATA_LITE_',
+          :merchant_listings_liter    => '_GET_MERCHANT_LISTINGS_DATA_LITER_',
+          :merchant_canceled_listings => '_GET_MERCHANT_CANCELLED_LISTINGS_DATA_',
+          :nemo_merchant_listings     => '_GET_NEMO_MERCHANT_LISTINGS_DATA_',
+          :afn_inventory              => '_GET_AFN_INVENTORY_DATA_',
+          :flat_file_actionable_order => '_GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_',
+          :orders                     => '_GET_ORDERS_DATA_', #API Function: ManageReportSchedule
+          :flat_file_order_report     => '_GET_FLAT_FILE_ORDER_REPORT_DATA_', #API Function: ManageReportSchedule
+          :flat_file_orders           => '_GET_FLAT_FILE_ORDERS_DATA_',
+          :converged_flat_file_order_report => '_GET_CONVERGED_FLAT_FILE_ORDER_REPORT_DATA_'
+        }
+
+        SCHEDULE = {
+          '15 minutes' =>  '_15_MINUTES_',
+          '30 minutes' =>  '_30_MINUTES_',
+          '1 hour'     => '_1_HOUR_',
+          '2 hours'     => '_2_HOURS_',
+          '4 hours'     => '_4_HOURS_',
+          '8 hours'     => '_8_HOURS_',
+          '12 hours'   => '_12_HOURS_',
+          '1 day'       => '_1_DAY_',
+          '2 days'     =>  '_2_DAYS_',
+          '3 days'     =>  '_72_HOURS_',
+          '7 days'     =>  '_7_DAYS_',
+          '14 days'     => '_14_DAYS_',
+          '15 days'     => '_15_DAYS_',
+          '30 days'     => '_30_DAYS_',
+          'Delete'     =>  '_NEVER_'
+        }
+
+      # The RequestReport operation requests the generation of a report, which
+      # creates a report request. Reports are retained for 90 days.
+      # Required Request Parameters
+      # ReportType - The type of report to request.
+      #
+      # Optional Request Parameters
+      # StartDate - Start of a date range used for selecting the data to report.
+      # EndDate - End of a date range used for selecting the data to report.
+
+      def request_report(report_type, params ={})
+        raise InvalidReportType if !REPORT_TYPES.include?(report_type)
+
+        query_params = { "Action"   => "RequestReport", "ReportType" => REPORT_TYPES[report_type] }
+        query_params.merge!({"StartDate" => params[:start_date]}) if params[:start_date]
+        query_params.merge!({"EndDate" => params[:end_date]}) if params[:end_date]
+        response = get("/", query_params)
+
+        RequestReportResponse.format(response)
+      end
+
+      # GetReportRequestList
+      # --------------------
+      # The GetReportRequestList operation returns a list of report requests
+      # that match the query parameters.
+      #
+      # Amazon MWS limits calls to 1,000 total calls per hour per seller
+      # account, including calls to GetReportRequestList.
+      #
+      # The maximum number of results that will be returned in one call is one
+      # hundred. If there are additional results to return, HasNext will be
+      # returned in the response with a true value. To retrieve all the
+      # results, you can use the value of the NextToken parameter to call
+      # GetReportRequestListByNextToken until HasNext is false.
+
+      # Optional Request Parameters
+      #
+      # ReportRequestIdList - A structured list of report request IDs. If you
+      # pass in explicit IDs in this call, the other conditions, if specified,
+      # will be ignored.
+      #
+      # ReportTypeList - A structured ReportType list by which to filter
+      # reports.
+      #
+      # ReportProcessingStatusList -A structured list of report processing
+      # statuses by which to filter report requests.
+      #
+      # ReportProcessingStatus values:
+      #
+      # _SUBMITTED_
+      # _IN_PROGRESS_
+      # _CANCELLED_
+      # _DONE_
+      # _DONE_NO_DATA_
+      #
+      # MaxCount - Maximum number of reports to return in the list. If you
+      # specify a number greater than 100, the call will be rejected.
+      #
+      # RequestedFromDate - The earliest date you are looking for, in ISO8601
+      # date format (for example, "2008-07-03T18:12:22Z" or
+      # "2008-07-03T18:12:22.093-07:00").
+      #
+      # RequestedToDate - The most recent date you are looking for.
+
+      def get_report_request_list(params = {})
+        response = get("/", {"Action" => "GetReportRequestList"}.merge(params))
+        GetReportRequestListResponse.format(response)
+      end
+      # add a nice method
+      alias_method :report_request_list, :get_report_request_list
+
+      # GetReportRequestListByNextToken
+      # Description
+      #
+      # The GetReportRequestListByNextToken operation returns a list of report
+      # requests that match the query parameters, using the NextToken, which
+      # was supplied by a previous call to either
+      # GetReportRequestListByNextToken or a call to GetReportRequestList,
+      # where the value of HasNext was true in that previous call.
+
+      # NextToken
+      # Token returned in a previous call to either GetReportRequestList or
+      # GetReportRequestListByNextToken when the value of HasNext was true.
+
+      def get_report_request_list_by_next_token(next_token)
+        response =
+         post("/", {
+           "Action"   => "GetReportRequestListByNextToken",
+           "NextToken" => next_token
+         })
+
+         GetReportRequestListByNextTokenResponse.format(response)
+      end
+
+      alias_method :report_request_list_by_next_token, :get_report_request_list_by_next_token
+
+      # GetReportRequestCount
+      # The GetReportRequestCount returns a count of report requests.
+
+      def get_report_request_count(params = {})
+        response = get("/", {"Action" => "GetReportRequestCount"})
+        GetReportRequestCountResponse.format(response)
+      end
+      # add a nice method
+      alias_method :report_request_count, :get_report_request_count
+
+      # CancelReportRequests
+      # The CancelReportRequests operation cancels one or more report
+      # requests, returning the count of the canceled report requests and the
+      # report request information. You can specify a number to cancel of
+      # greater than one hundred, but information will only be returned about
+      # the first one hundred report requests in the list. To return metadata
+      # about a greater number of canceled report requests, you can call
+      # GetReportRequestList. If report requests have already begun
+      # processing, they cannot be canceled.
+
+      #
+      # ReportRequestIdList
+      # A structured list of report request IDs. If you pass in explicit IDs in this call, the other conditions, if specified, will be ignored.
+      #
+      # ReportTypeList
+      # A structured ReportType list by which to filter reports.
+      #
+      # ReportProcessingStatusList
+      # A structured list of report processing statuses by which to filter report requests.
+      #
+      # ReportProcessingStatus
+      # _SUBMITTED_
+      # _IN_PROGRESS_
+      # _CANCELLED_
+      # _DONE_
+      # _DONE_NO_DATA_
+      #
+      # RequestedFromDate
+      # The earliest date you are looking for, in ISO8601 date format (for example, "2008-07-03T18:12:22Z" or "2008-07-03T18:12:22.093-07:00").
+      #
+      # RequestedToDate
+      # The most recent date you are looking for.
+
+      def cancel_report_requests(params = {})
+        response = get("/", {"Action" => "CancelReportRequests"}.merge(params))
+        CancelReportRequestsResponse.format(response)
+      end
+
+      # GetReportList
+      # The GetReportList operation returns a list of reports within the
+      # previous 90 days that match the query parameters. The maximum number
+      # of results that will be returned in one call is one hundred. If there
+      # are additional results to return, HasNext will be returned in the
+      # response with a true value. To retrieve all the results, you can use
+      # the value of the NextToken parameter to call GetReportListByNextToken
+      # until HasNext is false.
+      #
+      # Request Parameters
+
+      def get_report_list(params = {})
+        response = get("/", {"Action" => "GetReportList"}.merge(params))
+        GetReportListResponse.format(response)
+      end
+
+      alias_method :report_list, :get_report_list
+
+      # GetReportCount
+      # The GetReportCount operation returns a count of reports within the
+      # previous 90 days that are available for the seller to download.
+
+      #  ReportTypeList
+      # A structured ReportType list by which to filter reports.
+      #
+      # Acknowledged
+      # Set to true to list reports that have been acknowledged with a prior
+      # call to UpdateReportAcknowledgements. Set to false to list reports
+      # that have not been acknowledged.
+      #
+      # AvailableFromDate
+      # The earliest date you are looking for, in ISO8601 date format (for
+      # example, "2008-07-03T18:12:22Z" or "2008-07-03T18:12:22.093-07:00").
+      #
+      # AvailableToDate
+      # The most recent date you are looking for.
+
+      def get_report_count(params = {})
+        response = get("/", {"Action" => "GetReportCount"})
+        GetReportCountResponse.format(response)
+      end
+
+      alias_method :report_count, :get_report_count
+
+      # GetReport
+      # Description
+      #
+      # The GetReport operation returns the contents of a report and the
+      # Content-MD5 header for the returned body. Reports are retained for 90
+      # days from the time they have been generated.
+      #
+      # Amazon MWS limits calls to 1,000 total calls per hour per seller
+      # account, including a limit of 60 calls per hour to GetReport.
+      #
+      # You should compute the MD5 hash of the HTTP body and compare that with
+      # the returned Content-MD5 header value. If they do not match, which
+      # means the body was corrupted during transmission, you should discard
+      # the result and automatically retry the call for up to three more
+      # times. Please notify us if you ever see such a corrupted body. You can
+      # contact us by using the contact form at http://mws.amazon.com
+      # (http://mws.amazon.com). For more information, see Using the
+      # Content-MD5 Header with SubmitFeed.
+      #
+
+      def get_report(report_id, params = {})
+        response = get("/", {"Action" => "GetReport", "ReportId" => report_id})
+        #TODO format response
+      end
+      alias_method :report, :get_report
+
+      # ManageReportSchedule
+      # The ManageReportSchedule operation creates, updates, or deletes a
+      # report schedule for a particular report type. Currently, only order
+      # reports can be scheduled.
+      #
+      # Request Parameters
+      #
+      # ReportType
+      # The type of reports that you want to schedule generation of.
+      # Currently, only order reports can be scheduled.
+      #
+      # Schedule
+      # A string that describes how often a ReportRequest should be created.
+      # The list of enumerated values is found in the enumeration topic,
+      # Schedule.
+      #
+      # ScheduledDate
+      # The date when the next report is scheduled to run. Limited to no more
+      # than 366 days in the future.
+
+      def manage_report_schedule(report_type, schedule, params={})
+        raise InvalidReportType if !REPORT_TYPES.include?(report_type)
+        raise InvalidSchedule if !SCHEDULE.include?(schedule)
+
+        response =
+        get("/", {
+          "Action" => "ManageReportSchedule",
+          "Schedule" => SCHEDULE[schedule],
+          "ReportType" => REPORT_TYPES[report_type]
+        })
+
+        ManageReportScheduleResponse.format(response)
+      end
+
+      # GetReportScheduleList
+      # The GetReportScheduleList operation returns a list of report schedules
+      # that match the query parameters. Currently, only order reports can be
+      # scheduled.
+      #
+      # The maximum number of results that will be returned in one call is one
+      # hundred. If there are additional results to return, HasNext will be
+      # returned in the response with a true value. To retrieve all the
+      # results, you can use the value of the NextToken parameter to call
+      # GetReportScheduleListByNextToken until HasNext is false.
+      # [Note]  Note
+      #
+      # For this release of Amazon MWS, only order reports can be scheduled,
+      # so HasNext will always be False.
+
+      def get_report_schedule_list(params = {})
+        response = get("/", {"Action" => "GetReportScheduleList"}.merge(params))
+        GetReportScheduleListResponse.format(response)
+      end
+
+      alias_method :report_schedule_list, :get_report_schedule_list
+
+      def get_report_schedule_list_by_next_token(next_token)
+        response =
+         get("/", {
+           "Action"   => "GetReportScheduleListByNextToken",
+           "NextToken" => next_token
+         })
+
+         GetReportScheduleListByNextTokenResponse.format(response)
+      end
+
+      alias_method :report_schedule_list_by_next_token, :get_report_schedule_list_by_next_token
+
+      def get_report_schedule_count(params = {})
+        response = get("/", {"Action" => "GetReportScheduleCount"})
+        GetReportScheduleCountResponse.format(response)
+      end
+
+      alias_method :report_schedule_count, :get_report_schedule_count
+
+     end
+  end
+end