peddler 0.6.3 → 0.6.4

data/lib/mws/reports/client.rb

@@ -1,6 +1,249 @@
+require 'mws/reports/requests/report_request_list'
+require 'mws/reports/requests/report_request_info'
+require 'mws/reports/requests/report_request_count'
+require 'mws/reports/requests/report_requests'
+require 'mws/reports/requests/report_list'
+require 'mws/reports/requests/report_count'
+require 'mws/reports/requests/report'
+require 'mws/reports/requests/report_scheduler'
+require 'mws/reports/requests/report_schedule_list'
+require 'mws/reports/requests/report_schedule_count'
+require 'mws/reports/requests/report_acknowledgements'
+require 'peddler/client'
+
 module MWS
   module Reports
+    # The Reports API lets you request reports about your inventory and orders.
     class Client < ::Peddler::Client
+      # Public: Create a report request.
+      #
+      # type    - The String type of report to request.
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.request_report('_GET_ORDERS_DATA_')
+      #
+      # Returns the Report Request Info.
+      def_delegator :report_request_info, :request, :request_report
+
+      # Public: Get a list of report requests submitted during a specified time
+      # frame.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_report_request_list(submitted_from_date: 1.week.ago)
+      #
+      # Returns an enumerable Report Request List.
+      def_delegator :report_request_list, :get, :get_report_request_list
+
+      # Public: List the next page of the list of report requests.
+      #
+      # token - A String token (default: The token returned in the last
+      #         request).
+      #
+      # Examples
+      #
+      #   client.get_report_request_list_by_next_token
+      #
+      # Returns an enumerable Report Request List.
+      def_delegator :report_request_list, :get_by_next_token, :get_report_request_list_by_next_token
+
+      # Public: Get a count of the reports requested during a specified time
+      # frame.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_report_request_count(submitted_from_date: 1.week.ago)
+      #
+      # Returns the Report Request Count.
+      def_delegator :report_request_count, :get, :get_report_request_count
+
+      # Public: Cancel one or more report requests.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.cancel_report_requests(submitted_to_date: 1.hour.ago)
+      #
+      # Returns the canceled report requests and their count.
+      def_delegator :report_requests, :cancel, :cancel_report_requests
+
+      # Public: Get a list of reports created during a specified time frame.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_report_list
+      #
+      # Returns an enumerable Report List.
+      def_delegator :report_list, :get, :get_report_list
+
+      # Public: List the next page of the list of reports.
+      #
+      # token - A String token (default: The token returned in the last
+      #         request).
+      #
+      # Examples
+      #
+      #   client.get_report_list_by_next_token
+      #
+      # Returns an enumerable Report List.
+      def_delegator :report_list, :get_by_next_token, :get_report_list_by_next_token
+
+      # Public: Get a count of the reports created during a specified time
+      # frame, with a status of _DONE_ and that are available for download.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Reports API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_report_count
+      #
+      # Returns a Report Count.
+      def_delegator :report_count, :get, :get_report_count
+
+      # Public: Get the contents of a report and the Content-MD5 header for the
+      # returned report body.
+      #
+      # id - The String generated report id.
+      #
+      # Examples
+      #
+      #   client.get_report('123456')
+      #
+      # Returns a Report.
+      def_delegator :report, :get, :get_report
+
+      # Public: Create, update, or delete a report request schedule.
+      #
+      # type         - The String report type.
+      # schedule     - The String value that indicates how often a report
+      #                request should be created.
+      # scheduled_at - The Time when the next report request is scheduled to be
+      #                submitted (default: Now).
+      #
+      # Examples
+      #
+      #   client.manage_report_schedule('_GET_ORDERS_DATA_', '_1_HOUR_')
+      #
+      # Returns a Report Schedule.
+      def_delegator :report_scheduler, :manage, :manage_report_schedule
+
+      # Public: Delete a report request schedule.
+      #
+      # type - The String report type.
+      #
+      # Examples
+      #
+      #   client.delete_report_schedule('_GET_ORDERS_DATA_')
+      #
+      # Returns a Report Schedule.
+      def_delegator :report_scheduler, :delete, :delete_report_schedule
+
+      # Public: Get a list of order report requests that are scheduled to be
+      # submitted to MWS for processing.
+      #
+      # types - One or more String report types (default: all report types).
+      #
+      # Examples
+      #
+      #   client.get_report_schedule_list
+      #
+      # Returns a Report Schedule List.
+      def_delegator :report_schedule_list, :get, :get_report_schedule_list
+
+      # Public: Get a count of order report requests  that are scheduled to be
+      # submitted to MWS.
+      #
+      # types - One or more String report types (default: all report types).
+      #
+      # Examples
+      #
+      #   client.get_report_schedule_count
+      #
+      # Returns the Report Schedule Count.
+      def_delegator :report_schedule_count, :get, :get_report_schedule_count
+
+      # Public: Update acknowledged status of one or more reports to true.
+      #
+      # ids - One or more Integer report ids.
+      #
+      # Examples
+      #
+      #   client.acknowledge_reports(123)
+      #
+      # Returns Report Acknowledgements.
+      def_delegator :report_acknowledgements, :acknowledge, :acknowledge_reports
+
+      # Public: Update acknowledged status of one or more reports to false.
+      #
+      # ids - One or more Integer report ids.
+      #
+      # Examples
+      #
+      #   client.unacknowledge_reports(123)
+      #
+      # Returns Report Acknowledgements.
+      def_delegator :report_acknowledgements, :unacknowledge, :unacknowledge_reports
+
+      private
+
+      def report_request_info
+        @report_request_info ||= Requests::ReportRequestInfo.new(self)
+      end
+
+      def report_request_list
+        @report_request_list ||= Requests::ReportRequestList.new(self)
+      end
+
+      def report_request_count
+        @report_request_count ||= Requests::ReportRequestCount.new(self)
+      end
+
+      def report_requests
+        @report_requests ||= Requests::ReportRequests.new(self)
+      end
+
+      def report_list
+        @report_list ||= Requests::ReportList.new(self)
+      end
+
+      def report_count
+        @report_count ||= Requests::ReportCount.new(self)
+      end
+
+      def report
+        @report ||= Requests::Report.new(self)
+      end
+
+      def report_scheduler
+        @report_scheduler ||= Requests::ReportScheduler.new(self)
+      end
+
+      def report_schedule_list
+        @report_schedule_list ||= Requests::ReportScheduleList.new(self)
+      end
+
+      def report_schedule_count
+        @report_schedule_count ||= Requests::ReportScheduleCount.new(self)
+      end
+
+      def report_acknowledgements
+        @report_acknowledgements ||= Requests::ReportAcknowledgements.new(self)
+      end
     end
   end
 end

data/lib/mws/reports/parsers/report.rb

@@ -0,0 +1,10 @@
+require 'peddler/parsers/text'
+
+module MWS
+  module Reports
+    module Parsers
+      class Report < ::Peddler::Parsers::Text
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_acknowledgements.rb

@@ -0,0 +1,20 @@
+require 'peddler/parsers/collection'
+require 'mws/reports/parsers/report_info'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportAcknowledgements < ::Peddler::Parsers::Collection
+        def each(&blk)
+          report_info_nodes.each { |node| yield ReportInfo.new(node) }
+        end
+
+        private
+
+        def report_info_nodes
+          xpath('ReportInfo')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_count.rb

@@ -0,0 +1,10 @@
+require 'peddler/parsers/counter'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportCount < ::Peddler::Parsers::Counter
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_info.rb

@@ -0,0 +1,29 @@
+require 'peddler/parsers/model'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportInfo < ::Peddler::Parsers::Model
+        value :id do
+          text_at_xpath('ReportId')
+        end
+
+        value :type do
+          text_at_xpath('ReportType')
+        end
+
+        value :request_id do
+          text_at_xpath('ReportRequestId')
+        end
+
+        value :available_at do
+          time_at_xpath('AvailableDate')
+        end
+
+        value :acknowledged? do
+          boolean_at_xpath('Acknowledged')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_list.rb

@@ -0,0 +1,23 @@
+require 'peddler/parsers/collection'
+require 'mws/reports/parsers/report_info'
+require 'peddler/parsers/tokenable'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportList < ::Peddler::Parsers::Collection
+        include ::Peddler::Parsers::Tokenable
+
+        def each(&blk)
+          report_info_nodes.each { |node| yield ReportInfo.new(node) }
+        end
+
+        private
+
+        def report_info_nodes
+          xpath('ReportInfo')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_request_count.rb

@@ -0,0 +1,10 @@
+require 'peddler/parsers/counter'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportRequestCount < ::Peddler::Parsers::Counter
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_request_info.rb

@@ -0,0 +1,49 @@
+require 'peddler/parsers/model'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportRequestInfo < ::Peddler::Parsers::Model
+        value :id do
+          text_at_xpath('ReportRequestId')
+        end
+
+        value :type do
+          text_at_xpath('ReportType')
+        end
+
+        value :started_at do
+          time_at_xpath('StartDate')
+        end
+
+        value :ended_at do
+          time_at_xpath('EndDate')
+        end
+
+        value :scheduled? do
+          boolean_at_xpath('Scheduled')
+        end
+
+        value :submitted_at do
+          time_at_xpath('SubmittedDate')
+        end
+
+        value :processing_status do
+          text_at_xpath('ReportProcessingStatus')
+        end
+
+        value :generated_report_id do
+          text_at_xpath('GeneratedReportId')
+        end
+
+        value :started_processing_at do
+          time_at_xpath('StartedProcessingDate')
+        end
+
+        value :completed_at do
+          time_at_xpath('CompletedDate')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_request_list.rb

@@ -0,0 +1,23 @@
+require 'peddler/parsers/collection'
+require 'mws/reports/parsers/report_request_info'
+require 'peddler/parsers/tokenable'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportRequestList < ::Peddler::Parsers::Collection
+        include ::Peddler::Parsers::Tokenable
+
+        def each(&blk)
+          report_request_info_nodes.each { |node| yield ReportRequestInfo.new(node) }
+        end
+
+        private
+
+        def report_request_info_nodes
+          xpath('ReportRequestInfo')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_requests.rb

@@ -0,0 +1,18 @@
+require 'peddler/parsers/model'
+require 'mws/reports/parsers/report_request_info'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportRequests < ::Peddler::Parsers::Model
+        value :count do
+          integer_at_xpath('Count')
+        end
+
+        def report_request_infos
+          xpath('ReportRequestInfo').map { |node| ReportRequestInfo.new(node) }
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_schedule.rb

@@ -0,0 +1,21 @@
+require 'peddler/parsers/model'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportSchedule < ::Peddler::Parsers::Model
+        value :type do
+          text_at_xpath('ReportType')
+        end
+
+        value :schedule do
+          text_at_xpath('Schedule')
+        end
+
+        value :scheduled_at do
+          time_at_xpath('ScheduledDate')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_schedule_count.rb

@@ -0,0 +1,10 @@
+require 'peddler/parsers/counter'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportScheduleCount < ::Peddler::Parsers::Counter
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_schedule_list.rb

@@ -0,0 +1,23 @@
+require 'peddler/parsers/collection'
+require 'mws/reports/parsers/report_schedule'
+require 'peddler/parsers/tokenable'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportScheduleList < ::Peddler::Parsers::Collection
+        include ::Peddler::Parsers::Tokenable
+
+        def each(&blk)
+          report_schedule_nodes.each { |node| yield ReportSchedule.new(node) }
+        end
+
+        private
+
+        def report_schedule_nodes
+          xpath('ReportSchedule')
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/parsers/report_scheduler.rb

@@ -0,0 +1,19 @@
+require 'peddler/parsers/model'
+require 'mws/reports/parsers/report_schedule'
+
+module MWS
+  module Reports
+    module Parsers
+      class ReportScheduler < ::Peddler::Parsers::Model
+        value :count do
+          integer_at_xpath('Count')
+        end
+
+        value :report_schedule do
+          node = at_xpath('ReportSchedule')
+          ReportSchedule.new(node) if node
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report.rb

@@ -0,0 +1,18 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report'
+
+module MWS
+  module Reports
+    module Requests
+      class Report < ::Peddler::Request
+        def get(id)
+          parameters(:get_report)
+            .update(report_id: id)
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report_acknowledgements.rb

@@ -0,0 +1,27 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report_acknowledgements'
+
+module MWS
+  module Reports
+    module Requests
+      class ReportAcknowledgements < ::Peddler::Request
+        def update(acknowledged, *ids)
+          parameters(:update_report_acknowledgements)
+            .update(report_id_list: ids, acknowledged: acknowledged)
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+
+        def acknowledge(*ids)
+          update(true, *ids)
+        end
+
+        def unacknowledge(*ids)
+          update(false, *ids)
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report_count.rb

@@ -0,0 +1,20 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report_count'
+
+module MWS
+  module Reports
+    module Requests
+      class ReportCount < ::Peddler::Request
+        def get(options = {})
+          parameters(:get_report_count)
+            .update(options)
+            .timestamp!
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report_list.rb

@@ -0,0 +1,30 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report_list'
+
+module MWS
+  module Reports
+    module Requests
+      class ReportList < ::Peddler::Request
+        def get(options = {})
+          parameters(:get_report_list)
+            .update(options)
+            .timestamp!
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+
+        def get_by_next_token(token = next_token)
+          return false unless token
+
+          parameters(:get_report_list_by_next_token)
+            .update(next_token: token)
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report_request_count.rb

@@ -0,0 +1,20 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report_request_count'
+
+module MWS
+  module Reports
+    module Requests
+      class ReportRequestCount < ::Peddler::Request
+        def get(options = {})
+          parameters(:get_report_request_count)
+            .update(options)
+            .timestamp!
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/reports/requests/report_request_info.rb

@@ -0,0 +1,21 @@
+require 'peddler/request'
+require 'mws/reports/parsers/report_request_info'
+
+module MWS
+  module Reports
+    module Requests
+      class ReportRequestInfo < ::Peddler::Request
+        def request(type, options = {})
+          parameters(:request_report)
+            .update(type: type)
+            .update(options)
+            .timestamp!
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end