mws-connect 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+coverage
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime-workspace

data/.sublime-project

@@ -0,0 +1,19 @@
+{
+  "folders": [
+    {
+      "path": ".",
+      "folder_exclude_patterns": [
+        "pkg",
+        "coverage"
+      ],
+      "file_exclude_patterns": [
+        "*.sublime-project*",
+        ".gitignore"
+      ]
+    }
+  ],
+  "settings": {
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true
+  }
+}

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mws.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sean M. Duncan
+
+MIT License
+
+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.md

@@ -0,0 +1,111 @@
+# Mws
+
+The goal of this gem is to facilities interactions with the Amazon Marketplace Web Services from Ruby clients.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mws'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mws
+
+## Usage
+
+Create Mws connection:
+
+    require 'mws'
+
+    mws = Mws.connect(
+      merchant: 'XXXXXXXXXXXXXX', 
+      access: 'XXXXXXXXXXXXXXXXXXXXX', 
+      secret: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    )
+
+Access the Feeds Api:
+
+    feeds_api = mws.feeds
+
+Access the Feeds Api wrappers:
+
+    products_api = mws.feeds.products
+    prices_api = mws.feeds.prices
+    images_api = mws.feeds.images
+    inventory_api = mws.feeds.inventory
+
+Example: Add product details:
+
+    sku = '12345678'
+    product = Mws::Product sku {
+      upc '123435566654'
+      tax_code 'GEN_TAX_CODE'
+      name 'Some Product'
+      brand 'Some Brand'
+      msrp 19.99, 'USD'
+      manufacturer 'Some Manufacturer'
+      category :ce
+      details {
+        cable_or_adapter {
+          cable_length as_distance 5, :feet
+        }
+      }
+    }
+
+    submission_id = mws.feeds.products.add(product)
+
+Example: Adding product images:
+
+    image_submission_id = mws.feeds.images.add(
+      Mws::ImageListing(sku, 'http://url.to.product.iamges/main.jpg', 'Main'),
+      Mws::ImageListing(sku, 'http://url.to.product.iamges/pt1.jpg', 'PT1')
+    )
+
+Example: Setting product pricing: 
+
+    price_submission_id = mws.feeds.prices.add(
+      Mws::PriceListing(sku, 14.99).on_sale(12.99, Time.now, 3.months.from_now)
+    )
+
+Example: Overriding product shipping:
+
+    sku = '12345678'
+    shipping_submission_id = mws.feeds.shipping.add(
+      Mws::Shipping sku {
+        replace 'UPS Ground', 4.99
+        adjust '2nd-Day Air', 7.00
+      }
+    )
+
+Example: Setting product inventory:
+
+    inventory_submission_id = mws.feeds.inventory.add(
+        Mws::Inventory(sku, quantity: 10, fulfillment_type: :mfn)
+    )
+
+Example: Check the processing status of a feed:
+
+    mws.feeds.list(id: submission_id).each do | info |
+      puts "SubmissionId: #{info.id} Status: #{info.status}"
+      puts "Complete!" if [:cancelled, :done].include? info.status
+    end
+
+Example: Get the results for a submission:
+
+    result = mws.feeds.get(submission_id)
+    puts "Submission: #{result.transaction_id} - #{result.status}"
+
+_For an example of putting it all together check out the 'scripts/catalog-workflow'_
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/mws.rb

@@ -0,0 +1,34 @@
+require 'base64'
+require 'openssl'
+
+module Mws
+
+  autoload :Apis, 'mws/apis'
+  autoload :Connection, 'mws/connection'
+  autoload :Enum, 'mws/enum'
+  autoload :EnumEntry, 'mws/enum'
+  autoload :Errors, 'mws/errors'
+  autoload :Query, 'mws/query'
+  autoload :Serializer, 'mws/serializer'
+  autoload :Signer, 'mws/signer'
+  autoload :Utils, 'mws/utils'
+
+  # The current version of this ruby gem
+  VERSION = '0.0.1'
+
+  Utils.alias self, Apis::Feeds, 
+    :Distance,
+    :Feed,
+    :ImageListing,
+    :Inventory,
+    :Money,
+    :PriceListing,
+    :Product,
+    :Shipping,
+    :Weight
+
+  def self.connect(options)
+    Connection.new options
+  end
+
+end

data/lib/mws/apis.rb

@@ -0,0 +1,6 @@
+module Mws::Apis
+
+  autoload :Feeds, 'mws/apis/feeds'
+  autoload :Orders, 'mws/apis/orders'
+
+end

data/lib/mws/apis/feeds.rb

@@ -0,0 +1,20 @@
+module Mws::Apis::Feeds
+
+  autoload :Api, 'mws/apis/feeds/api'
+  autoload :Distance, 'mws/apis/feeds/distance'
+  autoload :Feed, 'mws/apis/feeds/feed'
+  autoload :ImageListing, 'mws/apis/feeds/image_listing'
+  autoload :Inventory, 'mws/apis/feeds/inventory'
+  autoload :Measurement, 'mws/apis/feeds/measurement'
+  autoload :Money, 'mws/apis/feeds/money'
+  autoload :PriceListing, 'mws/apis/feeds/price_listing'
+  autoload :Product, 'mws/apis/feeds/product'
+  autoload :SalePrice, 'mws/apis/feeds/sale_price'
+  autoload :Shipping, 'mws/apis/feeds/shipping'
+  autoload :SubmissionInfo, 'mws/apis/feeds/submission_info'
+  autoload :SubmissionResult, 'mws/apis/feeds/submission_result'
+  autoload :TargetedApi, 'mws/apis/feeds/api'
+  autoload :Transaction, 'mws/apis/feeds/transaction'
+  autoload :Weight, 'mws/apis/feeds/weight'
+
+end

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

@@ -0,0 +1,103 @@
+module Mws::Apis::Feeds
+
+  class Api
+
+    attr_reader :products, :images, :prices, :shipping, :inventory
+
+    def initialize(connection, defaults={})
+      raise Mws::Errors::ValidationError, 'A connection is required.' if connection.nil?
+      @connection = connection
+      defaults[:version] ||= '2009-01-01'
+      @defaults = defaults
+      
+      @products = self.for :product
+      @images = self.for :image
+      @prices = self.for :price
+      @shipping = self.for :override
+      @inventory = self.for :inventory
+    end
+
+    def get(id)
+      node = @connection.get '/', { feed_submission_id: id }, @defaults.merge(
+        action: 'GetFeedSubmissionResult',
+        xpath: 'AmazonEnvelope/Message'
+      )
+      SubmissionResult.from_xml node
+    end
+
+    def submit(body, params)
+      params[:feed_type] = Feed::Type.for(params[:feed_type]).val
+      doc = @connection.post '/', params, body, @defaults.merge(action: 'SubmitFeed')
+      SubmissionInfo.from_xml doc.xpath('FeedSubmissionInfo').first
+    end
+
+    def cancel(options={})
+
+    end
+
+    def list(params={})
+      params[:feed_submission_id] ||= params.delete(:ids) || [ params.delete(:id) ].flatten.compact
+      doc = @connection.get('/', params, @defaults.merge(action: 'GetFeedSubmissionList'))
+      doc.xpath('FeedSubmissionInfo').map do | node |
+        SubmissionInfo.from_xml node
+      end
+    end
+
+    def count()
+      @connection.get('/', {}, @defaults.merge(action: 'GetFeedSubmissionCount')).xpath('Count').first.text.to_i
+    end
+
+    def for(type)
+      TargetedApi.new self, @connection.merchant, type
+    end
+    
+  end
+
+  class TargetedApi
+
+    def initialize(feeds, merchant, type)
+      @feeds = feeds
+      @merchant = merchant
+      @message_type = Feed::Message::Type.for(type)
+      @feed_type = Feed::Type.for(type)
+    end
+
+    def add(*resources)
+      submit resources, :update, true 
+    end
+
+    def update(*resources)
+      submit resources, :update
+    end
+
+    def patch(*resources)
+      raise 'Operation Type not supported.' unless @feed_type == Feed::Type.PRODUCT
+      submit resources, :partial_update
+    end
+
+    def delete(*resources)
+      submit resources, :delete
+    end
+
+    def submit(resources, def_operation_type=nil, purge_and_replace=false)
+      messages = []
+      feed = Feed.new @merchant, @message_type do
+        resources.each do | resource |
+          operation_type = def_operation_type
+          if resource.respond_to?(:operation_type) and resource.operation_type
+            operation_type = resource.operation_type
+          end 
+          messages << message(resource, operation_type)
+        end
+      end
+      Transaction.new @feeds.submit(feed.to_xml, feed_type: @feed_type, purge_and_replace: purge_and_replace) do 
+        messages.each do | message |
+          item message.id, message.resource.sku, message.operation_type, 
+            message.resource.respond_to?(:type) ? message.resource.type : nil
+        end
+      end
+    end
+
+  end
+
+end

data/lib/mws/apis/feeds/distance.rb

@@ -0,0 +1,23 @@
+module Mws::Apis::Feeds
+
+  class Distance < Measurement
+
+    Unit = Mws::Enum.for(
+      inches: 'inches',
+      feet: 'feet',
+      meters: 'meters',
+      decimeters: 'decimeters',
+      centimeters:'centimeters',
+      millimeters:'millimeters',
+      micrometers: 'micrometers',
+      nanometers: 'nanometers',
+      picometers: 'picometers'
+    )
+
+    def initialize(amount, unit=nil)
+      super amount, unit || :feet
+    end
+
+  end
+
+end

data/lib/mws/apis/feeds/feed.rb

@@ -0,0 +1,114 @@
+require 'nokogiri'
+
+module Mws::Apis::Feeds
+
+  class Feed
+
+    Type = Mws::Enum.for(
+      product: '_POST_PRODUCT_DATA_', 
+      product_relationship: '_POST_PRODUCT_RELATIONSHIP_DATA_', 
+      item: '_POST_ITEM_DATA_', 
+      override: '_POST_PRODUCT_OVERRIDES_DATA_', 
+      image: '_POST_PRODUCT_IMAGE_DATA_', 
+      price: '_POST_PRODUCT_PRICING_DATA_', 
+      inventory: '_POST_INVENTORY_AVAILABILITY_DATA_', 
+      order_acknowledgement: '_POST_ORDER_ACKNOWLEDGEMENT_DATA_', 
+      order_fufillment: '_POST_ORDER_FULFILLMENT_DATA_', 
+      fulfillment_order_request: '_POST_FULFILLMENT_ORDER_REQUEST_DATA_', 
+      fulfillment_order_cancellation: '_POST_FULFILLMENT_ORDER_CANCELLATION_REQUEST_DATA'
+    )
+
+    attr_reader :merchant, :purge_and_replace
+
+    Mws::Enum.sym_reader self, :message_type
+
+    def initialize(merchant, message_type, purge_and_replace=false, &block)
+      @merchant = merchant
+      raise Mws::Errors::ValidationError, 'Merchant identifier is required.' if @merchant.nil?
+      @message_type = Message::Type.for(message_type)
+      raise Mws::Errors::ValidationError, 'A valid message type is required.' if @message_type.nil?
+      @purge_and_replace = purge_and_replace
+      @messages = []
+      Builder.new(self, @messages).instance_eval &block if block_given?
+    end
+
+    def messages
+      @messages.dup
+    end
+
+    def to_xml
+      Nokogiri::XML::Builder.new do | xml |
+        xml.AmazonEnvelope('xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', 'xsi:noNamespaceSchemaLocation' => 'amznenvelope.xsd') {
+          xml.Header {
+            xml.DocumentVersion '1.01'
+            xml.MerchantIdentifier @merchant
+          }
+          xml.MessageType @message_type.val
+          xml.PurgeAndReplace @purge_and_replace
+          @messages.each do | message |
+            message.to_xml xml
+          end
+        }
+      end.to_xml
+    end
+
+    class Builder
+
+      def initialize(feed, messages)
+        @feed = feed
+        @messages = messages
+      end
+
+      def message(resource, operation_type=nil)
+        (@messages << Message.new(@messages.length + 1, @feed.message_type, resource, operation_type)).last
+      end
+
+    end
+
+    class Message
+
+      Type = Mws::Enum.for(
+        fufillment_center: 'FulfillmentCenter',
+        inventory: 'Inventory', 
+        listings: 'Listings', 
+        order_acknowledgement: 'OrderAcknowledgement', 
+        order_adjustment: 'OrderAdjustment', 
+        order_fulfillment: 'OrderFulfillment', 
+        override: 'Override', 
+        price: 'Price',
+        processing_report: 'ProcessingReport',
+        product: 'Product',
+        image: 'ProductImage',
+        relationship: 'Relationship',
+        settlement_report: 'SettlementReport'
+      )
+
+      OperationType = Mws::Enum.for(
+        update: 'Update', 
+        delete: 'Delete', 
+        partial_update: 'PartialUpdate'
+      )
+
+      attr_reader :id, :resource
+
+      Mws::Enum.sym_reader self, :type, :operation_type
+
+      def initialize(id, type, resource, operation_type)
+        @id = id
+        @type = Type.for(type)
+        @resource = resource
+        @operation_type = OperationType.for(operation_type) || OperationType.UPDATE
+      end
+
+      def to_xml(parent)
+        Mws::Serializer.tree 'Message', parent do | xml |
+          xml.MessageID @id
+          xml.OperationType @operation_type.val
+          @resource.to_xml @type.val, xml
+        end
+      end
+    end
+
+  end
+
+end