mws_rb 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6984f02c386959b4ed60082b2b1f733b069ce0f3
+  data.tar.gz: aa2c13fc770dcb14c5e0d3a0e4f0ee3a4bc304f8
+SHA512:
+  metadata.gz: c02ac371ce06c65d342090c382adfe33497b039dcb8bfd1caa048a795974df716a324717fe745662cad9b8306f0ddeba2f8d570a3d81a062cbe092ce378c5b0a
+  data.tar.gz: 59f664c80f238b037435013eae1350b1a04ed078a4526b2a097667a55b87d49aa17747d80ab298e84251300872235d78524652f8c09f6a18dcdb1d6f2f3a5285

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 500

data/.ruby-gemset

@@ -0,0 +1 @@
+mws-rb

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+
+rvm:
+ - 2.2.3
+
+script:
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+Changelog
+=========
+
+Version 0.0.2 (February 2, 2015)
+-----------------------------
+
+* Completed Orders API
+* Completed Products API
+* Completed Sellers API
+* Completed Recommendations API
+* Completed FulfillmentInventory API
+* Completed FulfillmentInboundShipment API
+* Completed FulfillmentOutboundShipment API
+* Completed Feeds API
+* Completed Subscriptions API
+
+Version 0.0.3 (February 21, 2015)
+-----------------------------
+
+* Fix Orders API spec
+* Add default timeout for requests
+
+Version 0.0.4 (April 7, 2015)
+-----------------------------
+
+* Add support of MWS Auth Token
+* Add global reference to the location of XSD files
+
+Version 0.0.5 (May 29, 2015)
+-----------------------------
+
+* Fix signature generation
+* Add support text based feeds
+
+Version 0.0.6 (Next release)
+-----------------------------
+
+* Add missing specs
+* Update rspec expectations
+* Update dependencies
+* Fix query action SKU|ASIN capitalization
+* Default connection params to ENV variables
+* Enforce ruby guidelines using Rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+  watch(%r{^spec/(.+)\.rb$}) { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jhimy Fernandes Villar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,73 @@
+# mws_rb
+
+This gem is a complete wrapper for Amazon.com's Marketplace Web Service (MWS) API extracted from http://veeqo.com
+
+## Installation
+
+Using with a Gemfile:
+
+    gem 'mws_rb', require: 'mws'
+    bundle install
+
+Using in a simple ruby file:
+
+    gem install mws_rb
+    require 'mws'
+
+## Initialization
+
+```ruby
+    mws_api = MWS.new(
+      host: "mws-eu.amazonservices.com",
+      aws_access_key_id: "Your access key id",
+      aws_secret_access_key: "Your secret access key",
+      seller_id: "Your seller/merchant id"
+    )
+```
+
+## Using
+
+To access the apis you can use:
+
+```ruby
+     mws_api._api_name_._action_to_calll(params={})
+```
+
+Let's say we want to retrieve a list of orders using MWS orders api:
+
+```ruby
+    mws_api.orders.list_orders(
+      "MarketplaceId.Id.1" => "marketplace id",
+      created_after: Time.new(2013, 1, 1)
+    )
+```
+
+Here is a list of all available APIS:
+
+- mws_api.feeds
+- mws_api.orders
+- mws_api.reports
+- mws_api.products
+- mws_api.sellers
+- mws_api.recommendations
+- mws_api.fulfillment_inventory
+- mws_api.fulfillment_inbound_shipment
+- mws_api.fulfillment_outbound_shipment
+
+## API docs/actions/params
+
+You can check on the MWS documentation section all actions and params needed:
+
+- http://docs.developer.amazonservices.com/en_US/feeds/index.html
+- http://docs.developer.amazonservices.com/en_US/reports/index.html
+- http://docs.developer.amazonservices.com/en_US/fba_inbound/index.html
+- http://docs.developer.amazonservices.com/en_US/fba_inventory/index.html
+- http://docs.developer.amazonservices.com/en_US/fba_outbound/index.html
+- http://docs.developer.amazonservices.com/en_US/orders/index.html
+- http://docs.developer.amazonservices.com/en_US/products/index.html
+- http://docs.developer.amazonservices.com/en_US/recommendations/index.html
+- http://docs.developer.amazonservices.com/en_US/sellers/index.html
+
+## LICENSE
+
+Copyright (c) Jhimy Fernandes Villar

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mws.rb

@@ -0,0 +1,51 @@
+# rubocop:disable all
+require 'httparty'
+require 'base64'
+require 'openssl'
+require 'active_support/core_ext'
+require 'builder'
+require 'nokogiri'
+
+require_relative 'mws/query'
+require_relative 'mws/connection'
+require_relative 'mws/api/base'
+require_relative 'mws/api/orders'
+require_relative 'mws/api/reports'
+require_relative 'mws/api/products'
+require_relative 'mws/api/sellers'
+require_relative 'mws/api/subscriptions'
+require_relative 'mws/api/recommendations'
+require_relative 'mws/api/fulfillment_inventory'
+require_relative 'mws/api/fulfillment_inbound_shipment'
+require_relative 'mws/api/fulfillment_outbound_shipment'
+require_relative 'mws/api/feeds'
+require_relative 'mws/api/feeds/envelope'
+
+module MWS
+  @@aws_access_key_id = nil
+  @@aws_secret_access_key = nil
+
+  def self.aws_access_key_id=(key_id)
+    @@aws_access_key_id = key_id
+  end
+
+  def self.aws_access_key_id
+    @@aws_access_key_id
+  end
+
+  def self.aws_secret_access_key=(secret_key)
+    @@aws_secret_access_key = secret_key
+  end
+
+  def self.aws_secret_access_key
+    @@aws_secret_access_key
+  end
+
+  def self.new(options = {})
+    @connection = MWS::Connection.new(options)
+  end
+
+  def self.config
+    yield self
+  end
+end

data/lib/mws/api/base.rb

@@ -0,0 +1,55 @@
+module MWS
+  module API
+    # Base Class
+    class Base
+      attr_reader :connection, :uri, :version, :verb
+
+      # TODO: Temporary solution, move to configuration
+      DEFAULT_TIMEOUT = 2000
+
+      def initialize(connection)
+        @verb ||= :get
+        @connection = connection
+      end
+
+      def call(action, params = {})
+        @verb ||= params.delete(:verb)
+        query = build_query_from_params(action, params)
+
+        case @verb.to_s.upcase
+        when 'GET'
+          HTTParty.get(query.request_uri, http_request_options)
+        when 'POST'
+          HTTParty.post(query.request_uri, (params[:request_params] || {}).merge(http_request_options))
+        end
+      end
+
+      def build_query_from_params(action, params)
+        Query.new(verb: @verb,
+                  uri: @uri,
+                  host: @connection.host,
+                  aws_access_key_id: @connection.aws_access_key_id,
+                  aws_secret_access_key: @connection.aws_secret_access_key,
+                  seller_id: @connection.seller_id,
+                  mws_auth_token: @connection.mws_auth_token,
+                  action: action.to_s.camelize,
+                  version: @version,
+                  params: params.except(:request_params))
+      end
+
+      def method_missing(name, *args)
+        if self.class::ACTIONS.include?(name)
+          call(name, *args)
+        else
+          super
+        end
+      end
+
+      def http_request_options
+        {
+          timeout: DEFAULT_TIMEOUT
+        }
+      end
+    end
+  end
+end

data/lib/mws/api/feeds.rb

@@ -0,0 +1,30 @@
+module MWS
+  module API
+    # Feeds
+    class Feeds < Base
+      XSD_PATH = File.join(File.dirname(__FILE__), 'feeds', 'xsd')
+
+      ACTIONS = [:get_feed_submission_list, :get_feed_submission_list_by_next_token,
+                 :get_feed_submission_count, :cancel_feed_submissions, :get_feed_submission_result]
+
+      def initialize(connection)
+        @uri = '/'
+        @version = '2009-01-01'
+        @verb = :post
+        super
+      end
+
+      def submit_feed(params = {})
+        xml_envelope = Envelope.new(params.merge!(merchant_id: connection.seller_id))
+        params = params.except(:merchant_id, :message_type, :message, :messages, :skip_schema_validation)
+        call(:submit_feed, params.merge!(
+                             request_params: {
+                               format: :xml,
+                               headers: { 'Content-MD5' => xml_envelope.md5 },
+                               body: xml_envelope.to_s
+                             }
+        ))
+      end
+    end
+  end
+end

data/lib/mws/api/feeds/envelope.rb

@@ -0,0 +1,84 @@
+module MWS
+  module API
+    class Feeds
+      # Envelope
+      class Envelope
+        def initialize(params = {})
+          if params[:type].to_s == 'text'
+            @type = :text
+            @envelope = params[:message]
+          else
+            @type = :xml
+            @envelope = build_envelope(params)
+          end
+          validate! unless params[:skip_schema_validation] || @type == :text
+        end
+
+        def valid?
+          errors.count == 0
+        end
+
+        def validate!
+          fail "Invalid XML:\n" + errors.join("\n") unless valid?
+        end
+
+        def md5
+          Digest::MD5.base64digest(self)
+        end
+
+        def to_str
+          to_s
+        end
+
+        def to_s
+          if @type == :text
+            result = @envelope
+          else
+            result = @envelope.target!
+            result.gsub!('<Items type="array">', '')
+            result.gsub!('</Items>', '')
+            result.gsub!('<Inventories type="array">', '')
+            result.gsub!('</Inventories>', '')
+          end
+          result
+        end
+
+        def xsd
+          Nokogiri::XML::Schema(File.open(File.join(MWS::API::Feeds::XSD_PATH, 'amzn-envelope.xsd')))
+        end
+
+        def errors
+          @errors ||= xsd.validate(Nokogiri::XML(self))
+        end
+
+        private
+
+        # rubocop:disable all
+        def build_envelope(params = {})
+          xml = Builder::XmlMarkup.new
+          xml.AmazonEnvelope do
+            xml.Header do
+              xml.DocumentVersion '1.01'
+              xml.MerchantIdentifier params[:merchant_id]
+            end
+            xml.MessageType params[:message_type].to_s.camelize
+            xml.PurgeAndReplace params[:purge_and_replace] || false
+            messages_array(params).each { |message| xml << message_xml(message) }
+          end; xml
+        end
+
+        def messages_array(params)
+          get_array(params[:message]) + get_array(params[:messages])
+        end
+
+        def get_array(parameter)
+          [parameter].flatten.compact
+        end
+
+        def message_xml(message)
+          message.to_xml(skip_instruct: true, root: 'Message')
+        end
+      end
+    end
+  end
+end

data/lib/mws/api/feeds/xsd/AdditionalProductInformation.xsd

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Revision="$Revision: #1 $" -->
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+    <!--
+  			 $Date: 2012/09/11/ $      
+         AMAZON.COM CONFIDENTIAL.  This document and the information contained in it are
+         confidential and proprietary information of Amazon.com and may not be reproduced,
+         distributed or used, in whole or in part, for any purpose other than as necessary 
+         to list products for sale on the www.amazon.com web site pursuant to an agreement
+         with Amazon.com.
+	-->
+    <xsd:include schemaLocation="amzn-base.xsd"/>
+    <xsd:element name="AdditionalProductInformation">
+        <xsd:complexType>
+            <xsd:sequence>
+                <xsd:element name="MaterialFabric" type="HundredString" minOccurs="0" maxOccurs="3"/>
+                <xsd:element name="ImportDesignation" type="HundredString" minOccurs="0"/>
+                <xsd:element name="CountryAsLabeled" type="CountryOfOriginType" minOccurs="0"/>
+                <xsd:element name="FurDescription" type="HundredString" minOccurs="0"/>
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+</xsd:schema>