amazon-mws 0.1.0

data/examples/xsd/amzn-envelope.xsd

@@ -0,0 +1,98 @@
+<?xml version="1.0"?>
+<!-- Revision="$Revision: #6 $" -->
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+	<!--
+        $Date: 2007/01/18 $
+
+        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:include schemaLocation="amzn-header.xsd"/>
+	<xsd:include schemaLocation="FulfillmentCenter.xsd"/>
+	<xsd:include schemaLocation="Inventory.xsd"/>
+	<xsd:include schemaLocation="Listings.xsd"/>
+	<xsd:include schemaLocation="OrderAcknowledgement.xsd"/>
+	<xsd:include schemaLocation="OrderAdjustment.xsd"/>
+	<xsd:include schemaLocation="OrderFulfillment.xsd"/>
+	
+	<xsd:include schemaLocation="Override.xsd"/>
+	<xsd:include schemaLocation="Price.xsd"/>
+	<xsd:include schemaLocation="ProcessingReport.xsd"/>
+	<xsd:include schemaLocation="ProductImage.xsd"/>
+	<xsd:include schemaLocation="Product.xsd"/>
+	<xsd:include schemaLocation="Relationship.xsd"/>
+	<xsd:include schemaLocation="SettlementReport.xsd"/>
+	<xsd:element name="AmazonEnvelope">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Header"/>
+				<xsd:element name="MessageType">
+					<xsd:simpleType>
+						<xsd:restriction base="xsd:string">
+							<xsd:enumeration value="FulfillmentCenter"/>
+							<xsd:enumeration value="Inventory"/>
+							<xsd:enumeration value="Listings"/>
+							<xsd:enumeration value="OrderAcknowledgement"/>
+							<xsd:enumeration value="OrderAdjustment"/>
+							<xsd:enumeration value="OrderFulfillment"/>
+							<xsd:enumeration value="Override"/>
+							<xsd:enumeration value="Price"/>
+							<xsd:enumeration value="ProcessingReport"/>
+							<xsd:enumeration value="Product"/>
+							<xsd:enumeration value="ProductImage"/>
+							<xsd:enumeration value="Relationship"/>
+							<xsd:enumeration value="SettlementReport"/>
+						</xsd:restriction>
+					</xsd:simpleType>
+				</xsd:element>
+				<xsd:element ref="MarketplaceName" minOccurs="0">
+					<xsd:annotation>
+						<xsd:documentation>
+                                                The MarketplaceName is only supported for
+                                                Override feeds.
+                                                If included here, the MarketplaceName will
+                                                apply to all messages in the feed.
+                                                </xsd:documentation>
+					</xsd:annotation>
+				</xsd:element>
+				<xsd:element name="PurgeAndReplace" type="xsd:boolean" minOccurs="0"/>
+				<xsd:element name="EffectiveDate" type="xsd:dateTime" minOccurs="0"/>
+				<xsd:element name="Message" maxOccurs="unbounded">
+					<xsd:complexType>
+						<xsd:sequence>
+							<xsd:element name="MessageID" type="IDNumber"/>
+							<xsd:element name="OperationType" minOccurs="0">
+								<xsd:simpleType>
+									<xsd:restriction base="xsd:string">
+										<xsd:enumeration value="Update"/>
+										<xsd:enumeration value="Delete"/>
+										<xsd:enumeration value="PartialUpdate"/>
+									</xsd:restriction>
+								</xsd:simpleType>
+							</xsd:element>
+							<xsd:choice>
+								<xsd:element ref="FulfillmentCenter"/>
+								<xsd:element ref="Inventory"/>
+								<xsd:element ref="Listings"/>
+								<xsd:element ref="OrderAcknowledgement"/>
+								<xsd:element ref="OrderAdjustment"/>
+								<xsd:element ref="OrderFulfillment"/>
+								<xsd:element ref="Override"/>
+								<xsd:element ref="Price"/>
+								<xsd:element ref="ProcessingReport"/>
+								<xsd:element ref="Product"/>
+								<xsd:element ref="ProductImage"/>
+								<xsd:element ref="Relationship"/>
+								<xsd:element ref="SettlementReport"/>
+							</xsd:choice>
+						</xsd:sequence>
+					</xsd:complexType>
+				</xsd:element>
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+</xsd:schema>

data/examples/xsd/amzn-header.xsd

@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<!-- "$Revision: #3 $" -->
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+
+    <!--
+    $Date: 2005/04/01 $
+
+    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="Header">
+        <xsd:complexType>
+            <xsd:sequence>
+
+                <xsd:element name="DocumentVersion">
+                    <xsd:simpleType>
+                        <xsd:restriction base="xsd:string">
+                            <xsd:pattern value="\d{1,2}\.\d{1,2}"/>
+                        </xsd:restriction>
+                    </xsd:simpleType>
+                </xsd:element>
+
+                <xsd:element name="MerchantIdentifier" type="String"/>
+                
+                <xsd:element name="OverrideReleaseId" minOccurs="0">
+                    <xsd:simpleType>
+                        <xsd:restriction base="xsd:string">
+                            <xsd:pattern value="\d{1,4}\.\d{1,4}"/>
+                        </xsd:restriction>
+                    </xsd:simpleType>
+                </xsd:element>
+
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>
+
+

data/lib/amazon/mws.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'cgi'
+require 'uri'
+require 'openssl'
+require 'net/https'
+require 'time'
+require 'date'
+require 'hmac'
+require 'hmac-sha2'
+require 'base64'
+require 'builder'
+require "rexml/document"
+
+# ROXML - nokogiri and roxml are the only dependencies
+I_KNOW_I_AM_USING_AN_OLD_AND_BUGGY_VERSION_OF_LIBXML2 = true
+# module ROXML
+#   XML_PARSER = 'nokogiri' # or 'libxml'
+# end
+require 'roxml'
+# /ROXML
+
+
+$:.unshift(File.dirname(__FILE__))
+require 'mws/lib/extensions'
+require 'builder'
+#require_library_or_gem 'mime/types', 'mime-types' unless defined? MIME::Types
+
+module Amazon
+  module MWS
+  end
+end
+
+
+
+require 'mws/lib/memoizable'
+
+require 'mws/feed_builder'
+require 'mws/feed_enumerations'
+require 'mws/feed'
+require 'mws/report_enumerations'
+require 'mws/report'
+
+
+require 'mws/response'
+require 'mws/feed_submission'
+require 'mws/report_request'
+require 'mws/report_info'
+require 'mws/report_schedule'
+Dir.glob(File.join(File.dirname(__FILE__), 'mws/response/*.rb')).each {|f| require f }
+
+require 'mws/base'
+require 'mws/version'
+require 'mws/exceptions'
+require 'mws/connection'
+require 'mws/connection/management'
+require 'mws/connection/request_builder'
+require 'mws/authentication'
+require 'mws/authentication/query_string'
+require 'mws/authentication/signature'
+
+
+Amazon::MWS::Base.class_eval do
+  include Amazon::MWS::Feed
+  include Amazon::MWS::Report
+end
+
+AWS = Amazon
+
+require_library_or_gem 'xmlsimple', 'xml-simple' unless defined? XmlSimple
+=begin
+# If libxml is installed, we use the FasterXmlSimple library, that provides most of the functionality of XmlSimple
+# except it uses the xml/libxml library for xml parsing (rather than REXML). If libxml isn't installed, we just fall back on
+# XmlSimple.
+AWS::S3::Parsing.parser =
+  begin
+    require_library_or_gem 'xml/libxml'
+    # Older version of libxml aren't stable (bus error when requesting attributes that don't exist) so we
+    # have to use a version greater than '0.3.8.2'.
+    raise LoadError unless XML::Parser::VERSION > '0.3.8.2'
+    $:.push(File.join(File.dirname(__FILE__), '..', '..', 'support', 'faster-xml-simple', 'lib'))
+    require_library_or_gem 'faster_xml_simple' 
+    FasterXmlSimple
+  rescue LoadError
+    XmlSimple
+  end
+=end

data/lib/amazon/mws/authentication.rb

@@ -0,0 +1,9 @@
+module Amazon
+  module MWS
+    class Authentication  
+      VERSION = '2009-01-01'
+      # Nothing really to see here, 
+      # please have a look at the files in the authentication folder
+    end
+  end
+end

data/lib/amazon/mws/authentication/query_string.rb

@@ -0,0 +1,28 @@
+class Amazon::MWS::Authentication  
+  
+  class QueryString < String
+    def initialize(params = {})
+      query_params = {
+        'AWSAccessKeyId'   => params[:access_key],
+        'Marketplace'      => params[:marketplace_id],
+        'Merchant'         => params[:merchant_id],
+        'SignatureMethod'  => Signature::METHOD,
+        'SignatureVersion' => Signature::VERSION,
+        'Timestamp'        => Time.now.iso8601,
+        'Version'          => Amazon::MWS::Authentication::VERSION
+      }
+      
+      # Add any params that are passed in via uri before calculating the signature
+      query_params = query_params.merge(params[:query_params] || {})
+      # Calculate the signature
+      query_params['Signature'] = Signature.new(query_params, params)
+      
+      self << formatted_querystring(query_params)
+    end
+    
+    def formatted_querystring(query_params)
+      query_params.collect { |key, value| [CGI.escape(key.to_s), CGI.escape(value.to_s)].join('=') }.join('&') # order doesn't matter for the actual request
+    end
+  end
+  
+end

data/lib/amazon/mws/authentication/signature.rb

@@ -0,0 +1,43 @@
+class Amazon::MWS::Authentication
+  
+  class Signature < String#:nodoc:
+    extend Memoizable
+    
+    VERSION = '2'
+    METHOD  = 'HmacSHA256'
+
+    def initialize(queryparams = {}, params = {})
+      verb   = params[:verb]
+      secret = params[:secret_access_key]
+      # Create the string to sign
+      string = string_to_sign(verb, canonical_querystring(queryparams))
+      self << sign(string, secret)
+    end
+  
+    # Returns a signed string
+    def sign(string, secret_access_key)
+      hmac = HMAC::SHA256.new(secret_access_key)
+      hmac.update(string)
+      # chomp is important!  the base64 encoded version will have a newline at the end
+      Base64.encode64(hmac.digest).chomp
+    end
+    
+    memoize :sign
+    
+    def string_to_sign(verb, querystring)
+      verb   = verb.to_s.upcase
+      string = "#{verb}\n#{Amazon::MWS::DEFAULT_HOST}\n/\n#{querystring}"
+    end
+    
+    memoize :string_to_sign
+
+    def canonical_querystring(params)
+      # Make sure we have string keys, otherwise the sort does not work
+      params = Hash.keys_to_s(params)
+      params.sort.collect { |key, value| [CGI.escape(key.to_s), CGI.escape(value.to_s)].join('=') }.join('&')
+    end
+    
+    memoize :canonical_querystring
+  end
+  
+end

data/lib/amazon/mws/base.rb

@@ -0,0 +1,61 @@
+module Amazon
+  module MWS
+    DEFAULT_HOST = "mws.amazonaws.com"
+    
+    class Base
+      attr_accessor :connection
+      
+      def self.debug; @@debug ||= false end
+      def self.debug=(bool); @@debug = bool end
+      
+      def initialize(options ={})
+        @connection = Amazon::MWS::Connection.connect(options)
+      end
+      
+      def connection
+        raise Amazon::MWS::NoConnectionEstablished.new if !connected?
+        @connection
+      end
+
+      def connected?
+        !@connection.nil?
+      end
+
+      def disconnect
+        @connection.http.finish if @connection.persistent?
+        @connection = nil
+      end
+      
+      # Wraps the current connection's request method and picks the appropriate response class to wrap the response in.
+      # If the response is an error, it will raise that error as an exception. All such exceptions can be caught by rescuing
+      # their superclass, the ResponseError exception class.
+      #
+      # It is unlikely that you would call this method directly. Subclasses of Base have convenience methods for each http request verb
+      # that wrap calls to request.
+      def request(verb, path, query_params = {}, body = nil, attempts = 0, &block)
+        # Find the connection method in connection/management.rb which is evaled into Amazon::MWS::Base
+        response = @connection.request(verb, path, query_params, body, attempts, &block)
+        
+        # Each calling class is responsible for formatting the result
+        return response
+      rescue InternalError, RequestTimeout
+        if attempts == 3
+          raise
+        else
+          attempts += 1
+          retry
+        end
+      end
+      
+      # Make some convenience methods
+      [:get, :post, :put, :delete, :head].each do |verb|
+        class_eval(<<-EVAL, __FILE__, __LINE__)
+          def #{verb}(path, query_params = {}, body = nil, &block)
+            request(:#{verb}, path, query_params, body, &block)
+          end
+        EVAL
+      end
+    end
+    
+  end
+end

data/lib/amazon/mws/connection.rb

@@ -0,0 +1,99 @@
+module Amazon
+  module MWS    
+    
+    class Connection
+      # Static/Class methods
+      class << self
+        def connect(options = {})
+          new(options)
+        end
+      end
+      
+      def initialize(params = {})
+        # These values are essential to establishing a connection
+        @server            = params['server'] || Amazon::MWS::DEFAULT_HOST
+        @persistent        = params['persistent'] || false
+        # These values are essential to signing requests
+        @access_key        = params['access_key']
+        @secret_access_key = params['secret_access_key']
+        @merchant_id       = params['merchant_id']
+        @marketplace_id    = params['marketplace_id']
+        
+        raise MissingConnectionOptions if [@access_key, @secret_access_key, @merchant_id, @marketplace_id].any? {|option| option.nil?}
+        
+        @http = connect
+      end
+      
+      # Create the Net::HTTP object to use for this connection
+      def connect
+        http             = Net::HTTP.new(@server, 443)
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        return http
+      end
+      
+      # Make the request, based on the apropriate request object
+      # Called from Amazon::MWS::Base
+      def request(verb, path, query_params, body = nil, attempts = 0, &block)
+        # presumably this is for files
+        body.rewind if body.respond_to?(:rewind) unless attempts.zero?
+        # Prepare the Proc to be called by Net::HTTP
+        proc = requester(verb, path, query_params, body)
+        
+        if @persistent
+          @http.start unless @http.started?
+          proc.call
+        else
+          @http.start(&proc)
+        end
+      rescue Errno::EPIPE, Timeout::Error, Errno::EINVAL, EOFError
+        @http = connect
+        attempts == 3 ? raise : (attempts += 1; retry)
+      end
+      
+      # A Proc used by the request method
+      def requester(verb, path, query_params, body)
+        Proc.new do |http|
+          path    = prepare_path(verb, path, query_params)
+          puts "#{path}\n\n" if AWS::MWS::Base.debug
+          request = build_request(verb, path, body)
+          
+          @http.request(request)
+        end
+      end
+      
+      # Create the signed authentication query string.
+      # Add this query string to the path WITHOUT prepending the server address.
+      def prepare_path(verb, path, query_params)
+        query_string = authenticate_query_string(verb, query_params)
+        return "#{path}?#{query_string}"
+      end
+      
+      # Generates the authentication query string used by Amazon.
+      # Takes the http method and the query string of the request and returns the authenticated query string
+      def authenticate_query_string(verb, query_params = {})        
+        Authentication::QueryString.new(
+          :verb              => verb,
+          :query_params      => query_params,
+          :access_key        => @access_key,
+          :secret_access_key => @secret_access_key,
+          :merchant_id       => @merchant_id,
+          :marketplace_id    => @marketplace_id
+        )
+      end
+      
+      # Builds up a Net::HTTP request object
+      def build_request(verb, path, body = nil)
+        builder = RequestBuilder.new(verb, path, body)
+        builder.add_user_agent
+        builder.add_content_type
+        builder.add_content_md5(body) unless body.nil?
+        
+        return builder.request
+      end
+    end
+    # Connection
+    
+  end
+end
+