right_aws_api 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8bba3831173844f44970e8ec7de2bdf8deaccfd
-  data.tar.gz: 2d690e778c5465ba65af461b3f270a650f7c095b
+  metadata.gz: d6a1dd0e9ac24ff82bc67bd76900622da118f004
+  data.tar.gz: 40c41f86035559e2946f0f2975efc5b3ddbc02dc
 SHA512:
-  metadata.gz: 05dcde93bbe91da2df664699908be7983409703bbf915b886c1767f565e6fccf05219d4d4f8579cb035737d00073050ac6c380e198dc6d6d443becb89113c723
-  data.tar.gz: 274c90d8e49ae082c0e87e5116bb04b24c18bad63910a41f79e15360f88e4247ae5c0f5935f9688905fa7612df6440ba6b8cded63f2646acc56bbd3912bbffcd
+  metadata.gz: d084136e0e7f1f8b33ded2c0c91f828486f0a9ea67eaa77844bbbf08442488b5e1992cf29d3296a1ab5fd28421c551eead3191a792b9326cb18fe374ec170f5c
+  data.tar.gz: e424d46fff517efa40d79b848fc756fb9b1979f49fdf968f9875efa2ba9bbbd7606634fba2b627e2f1ff9f0da7593b89b2695e052869f854da83cd7d162b79e6

data/HISTORY

@@ -1,5 +1,27 @@
-== current
+== current (not released as a gem yet)
+  - Fixed:
+    - Route53
+      - All POST actions were broken because of the missing 'xmlns' attribute.
+  - Added new services:
+    - Product Advertising API
+    - Market Web Service API:
+      - Cart Information
+      - Customer Information
+      - Feeds
+      - Finances
+      - Fulfillment Inbound Shipment
+      - Fulfillment Inventory
+      - Fulfillment Outbound Shipment
+      - Orders
+      - Products
+      - Recommendations
+      - Reports
+      - Sellers
+      - Subscriptions
+      - Webstore
 
+== 2015-06-02, v0.3.1
+  - AWS china support
 == 2015-03-12, v0.3.0
   - Fixed bugs in Route53:
     - new param added to ChangeResourceRecordSets: HostedZoneId -> TargetHostedZoneId

data/README.md

@@ -21,6 +21,8 @@ http://rightscale.github.io/right_aws_api/frames.html#!file.README.html
 
 The gem supports the following AWS services out of the box:
 
+Web Services:
+
 - {RightScale::CloudApi::AWS::AS::Manager      Auto Scaling (AS)}
 - {RightScale::CloudApi::AWS::CF::Manager      Cloud Front (CF)}
 - {RightScale::CloudApi::AWS::CFM::Manager     Cloud Formation (CFM)}
@@ -39,6 +41,27 @@ The gem supports the following AWS services out of the box:
 - {RightScale::CloudApi::AWS::SNS::Manager     Simple Notification Service (SNS)}
 - {RightScale::CloudApi::AWS::SQS::Manager     Simple Queue Service (SQS)}
 
+Product Advertising API:
+
+- {RightScale::CloudApi::ECS::PA::Manager      Product Advertising API (PA)}
+
+Market Web Services:
+
+- {RightScale::CloudApi::MWS::CartInformation::Manager              Cart Information}
+- {RightScale::CloudApi::MWS::CustomerInformation::Manager          Customer Information}
+- {RightScale::CloudApi::MWS::Feeds::Manager                        Feeds}
+- {RightScale::CloudApi::MWS::Finances::Manager                     Finances}
+- {RightScale::CloudApi::MWS::FulfillmentInboundShipment::Manager   Fulfillment Inbound Shipment}
+- {RightScale::CloudApi::MWS::FulfillmentInventory::Manager         Fulfillment Inventory}
+- {RightScale::CloudApi::MWS::FulfillmentOutboundShipment::Manager  Fulfillment Outbound Shipment}
+- {RightScale::CloudApi::MWS::Orders::Manager                       Orders}
+- {RightScale::CloudApi::MWS::Products::Manager                     Products}
+- {RightScale::CloudApi::MWS::Recommendations::Manager              Recommendations}
+- {RightScale::CloudApi::MWS::Reports::Manager                      Reports}
+- {RightScale::CloudApi::MWS::Sellers::Manager                      Sellers}
+- {RightScale::CloudApi::MWS::Subscriptions::Manager                Subscriptions}
+- {RightScale::CloudApi::MWS::Webstore::Manager                     Webstore}
+
 And it is easy to add support for other. You will need to refer to
 the AWS docs (http://aws.amazon.com/documentation/) for all the API params and usage explanations.
 
@@ -159,6 +182,52 @@ call and you know what params it accepts - just call the method with those param
   sqs.DeleteQueue('myCoolQueue')
 ```
 
+### Amazon Product Advertising API (PA)
+
+```ruby
+
+  require "right_aws_api"
+
+  key      = ENV['AWS_ACCESS_KEY_ID']
+  secret   = ENV['AWS_SECRET_ACCESS_KEY']
+  endpoint = 'https://webservices.amazon.com'
+  paa      = RightScale::CloudApi::ECS::PA::Manager.new(key, secret, endpoint)
+
+  paa.ItemLookup(
+    'AssociateTag'  => 'weird-tag',
+    'IdType'        => 'ASIN',
+    'ItemId'        => 'B00TRAO8HK',
+    'ResponseGroup' => 'OfferSummary'
+  )
+```
+
+### Amazon Market Web Services API (MWS)
+
+```ruby
+
+  key      = ENV['AWS_ACCESS_KEY_ID']
+  secret   = ENV['AWS_SECRET_ACCESS_KEY']
+  endpoint = 'https://mws.amazonservices.com'
+
+  # Webstore
+  ws = RightScale::CloudApi::MWS::Webstore::Manager.new(key, secret, endpoint)
+  ws.GetServiceStatus
+
+  # Reports
+  rd = RightScale::CloudApi::MWS::Reports::Manager.new(key, secret, endpoint)
+  rd.GetReportList(
+    'SellerId'      => 'foo',
+    'MarketplaceId' => 'bar',
+  )
+
+  # Recommendations
+  rd = RightScale::CloudApi::MWS::Recommendations::Manager.new(key, secret, endpoint)
+  rd.ListRecommendations(
+    'SellerId'      => 'foo',
+    'MarketplaceId' => 'bar',
+  )
+```
+
 ### Options
 
 There is a way to provide extra options when you instantiate a new manager:

data/lib/cloud/aws/base/helpers/utils.rb

@@ -204,10 +204,10 @@ module RightScale
             when host[              /^route53\.amazonaws\.com$/i ] then ['route53', 'us-east-1']
             when host[            /^(.*\.)?s3\.amazonaws\.com$/i ] then ['s3',  'us-east-1']
             when host[ /^(.*\.)?s3-external-1\.amazonaws\.com$/i ] then ['s3',  'us-east-1']
-            when host[    /s3-website-([^.]+)\.amazonaws\.com$/i ] then ['s3',           $1]
-            when host[     /^(.*\.)?s3-([^.]+).amazonaws\.com$/i ] then ['s3',           $2]
-            when host[   /^(.*\.)?s3\.([^.]+)\.amazonaws\.com$/i ] then ['s3',           $2]
-            else host[     /^([^.]+)\.([^.]+)\.amazonaws\.com$/i ]   && [$1,             $2]
+            when host[    /s3-website(-|\.)([^.]+)\.amazonaws\.com(\.cn)?$/i ] then ['s3', $2]
+            when host[     /^(.*\.)?s3-([^.]+).amazonaws\.com(\.cn)?$/i ] then ['s3', $2]
+            when host[   /^(.*\.)?s3\.([^.]+)\.amazonaws\.com(\.cn)?$/i ] then ['s3', $2]
+            else host[     /^([^.]+)\.([^.]+)\.amazonaws\.com(\.cn)?$/i ]   && [$1,   $2]
             end
           fail(ArgumentError, "Cannot extract service name from %s host" % host.inspect) if !result || result[0].to_s.empty?
           fail(ArgumentError, "Cannot extract region name from %s host"  % host.inspect) if result[1].to_s.empty?

data/lib/cloud/aws/base/routines/request_signer.rb

@@ -32,9 +32,6 @@ module RightScale
         class Error < CloudApi::Error
         end
 
-        # Use POST verb if GET's path is getting too big.
-        MAX_GET_REQUEST_PATH_LENGTH = 2000
-
         # Authenticates an AWS request
         #
         # @return [void]

data/lib/cloud/aws/route53/wrappers/default.rb

@@ -48,6 +48,7 @@ module RightScale
               base.query_api_pattern 'CreateHostedZone', :post, 'hostedzone',
                 :body => {
                   'CreateHostedZoneRequest' => {
+                    '@xmlns'           => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'Name'             => :Name,
                     'CallerReference'  => :CallerReference,
                     'HostedZoneConfig{!remove-if-blank}' => {
@@ -78,6 +79,7 @@ module RightScale
               base.query_api_pattern 'UpdateHostedZoneComment', :post, 'hostedzone/{:HostedZoneId}',
                 :body => {
                   'UpdateHostedZoneCommentRequest' => {
+                    '@xmlns'  => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'Comment' => :Comment
                   }
                 }
@@ -85,6 +87,7 @@ module RightScale
               base.query_api_pattern 'AssociateVPCWithHostedZone', :post, 'hostedzone/{:HostedZoneId}/associatevpc',
                 :body => {
                   'AssociateVPCWithHostedZoneRequest' => {
+                    '@xmlns'                => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'VPC{!remove-if-blank}' => {
                       'VPCId'     => :VPCId,
                       'VPCRegion' => :VPCRegion
@@ -99,6 +102,7 @@ module RightScale
               base.query_api_pattern 'DisassociateVPCFromHostedZone', :post, 'hostedzone/{:HostedZoneId}/disassociatevpc',
                 :body => {
                   'DisassociateVPCFromHostedZoneRequest' => {
+                    '@xmlns'                => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'VPC{!remove-if-blank}' => {
                       'VPCId'     => :VPCId,
                       'VPCRegion' => :VPCRegion
@@ -127,6 +131,7 @@ module RightScale
               base.query_api_pattern 'ChangeResourceRecordSets', :post, 'hostedzone/{:HostedZoneId}/rrset',
                 :body => {
                   'ChangeResourceRecordSetsRequest' => {
+                    '@xmlns'      => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'ChangeBatch' => {
                       'Comment' => :Comment,
                       'Changes' => {
@@ -184,6 +189,7 @@ module RightScale
               base.query_api_pattern 'CreateReusableDelegationSet', :post, 'delegationset',
                 :body => {
                   'CreateReusableDelegationSetRequest' => {
+                    '@xmlns' => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'CallerReference' => :CallerReference,
                     'HostedZoneId'    => :HostedZoneId
                   }
@@ -202,6 +208,7 @@ module RightScale
               base.query_api_pattern 'CreateHealthCheck', :post, 'healthcheck',
                 :body => {
                   'CreateHealthCheckRequest' => {
+                    '@xmlns'          => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'CallerReference' => :CallerReference,
                     'HealthCheckConfig' => {
                       'IPAddress'                => :IPAddress,
@@ -227,6 +234,7 @@ module RightScale
               base.query_api_pattern 'UpdateHealthCheck', :post, 'healthcheck/{:HealthCheckId}',
                 :body => {
                   'CreateHealthCheckRequest' => {
+                    '@xmlns'                   => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'HealthCheckVersion'       => :HealthCheckVersion,
                     'IPAddress'                => :IPAddress,
                     'Port'                     => :Port,
@@ -267,6 +275,7 @@ module RightScale
               base.query_api_pattern 'ChangeTagsForResource', :post, 'tags/{:ResourceType}/{:ResourceId}',
                 :body => {
                   'ChangeTagsForResourceRequest' => {
+                    '@xmlns'        => 'https://route53.amazonaws.com/doc/2013-04-01/',
                     'RemoveTagKeys' => :RemoveTagKeys,
                     'AddTags{!remove-if-blank}' => {
                       'Tag' => :Tag

data/lib/cloud/ecs/pa/manager.rb

@@ -0,0 +1,138 @@
+#--
+# Copyright (c) 2015 RightScale, Inc.
+#
+# 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.
+#++
+
+require "cloud/ecs/pa/routines/request_signer"
+require "cloud/ecs/pa/parsers/response_error"
+
+module RightScale
+  module CloudApi
+
+    # ECS (ECommerceService) namespace
+    module ECS
+
+      module PA
+
+        # Product Advertising API (PA) compatible manager (thread safe).
+        #
+        # @example
+        #  require "right_aws_api"
+        #
+        #  # Create a manager to access Product Advertising API.
+        #  paa = RightScale::CloudApi::ECS::PA::Manager.new(key, secret, 'https://webservices.amazon.com')
+        #
+        #  paa.ThisCallMustBeSupportedByPA('Param.1' => 'A', 'Param.2' => 'B') #=> Hash
+        #
+        # @example
+        #  paa.ItemSearch(
+        #    'AssociateTag'  => 'weird-tag',
+        #    'BrowseNode'    => 2625374011,
+        #    'MaximumPrice'  => 2000,
+        #    'MinimumPrice'  => 2000,
+        #    'ResponseGroup' => 'SalesRank',
+        #    'SearchIndex'   => 'DVD',
+        #    'Sort'          => 'salesrank',
+        #   )  #=>
+        #      {"ItemSearchResponse"=>
+        #        {"@xmlns"=>"http://webservices.amazon.com/AWSECommerceService/2013-08-01",
+        #         "OperationRequest"=>
+        #          {"HTTPHeaders"=>{"Header"=>{"@Name"=>"UserAgent", "@Value"=>"Ruby"}},
+        #           "RequestId"=>"a21817e1-f828-4a80-8b6a-c27e320b92e2",
+        #           "Arguments"=>
+        #            {"Argument"=> ..... }}}
+        #
+        # @example
+        #  paa.ItemLookup(
+        #    'AssociateTag'  => 'weird-tag',
+        #    'IdType'        => 'ASIN',
+        #    'ItemId'        => 'B00TRAO8HK',
+        #    'ResponseGroup' => 'OfferSummary',
+        #  ) #=>
+        #      {"ItemLookupResponse"=>
+        #        {"@xmlns"=>"http://webservices.amazon.com/AWSECommerceService/2013-08-01",
+        #         "OperationRequest"=>
+        #          {"HTTPHeaders"=>{"Header"=>{"@Name"=>"UserAgent", "@Value"=>"Ruby"}},
+        #           "RequestId"=>"1c199f5d-3794-40b3-9fc4-33316010d130",
+        #           "Arguments"=> { ... },
+        #         "Items"=>
+        #          {"Request"=> { ... },
+        #           "Item"=>
+        #            {"ASIN"=>"B00TRAO8HK",
+        #             "OfferSummary"=>
+        #              {"LowestNewPrice"=>
+        #                {"Amount"=>"2000",
+        #                 "CurrencyCode"=>"USD",
+        #                 "FormattedPrice"=>"$20.00"},
+        #               "LowestUsedPrice"=>
+        #                {"Amount"=>"2654",
+        #                 "CurrencyCode"=>"USD",
+        #                 "FormattedPrice"=>"$26.54"},
+        #               "TotalNew"=>"23",
+        #               "TotalUsed"=>"2",
+        #               "TotalCollectible"=>"0",
+        #               "TotalRefurbished"=>"0"}}}}}
+        #
+        # If there is a new API version available just pass it to the manager!
+        #
+        # @example
+        #  paa = RightScale::CloudApi::ECS::PA::Manager.new(key, secret, 'https://webservices.amazon.com', :api_version => "2021-12-31")
+        #
+        # @see ApiManager
+        # @see http://docs.aws.amazon.com/AWSECommerceService/latest/DG/Welcome.html
+        #
+        class Manager < CloudApi::Manager
+        end
+
+        # Thread un-safe parent class for almost all the AWS services.
+        class ApiManager < AWS::ApiManager
+
+          DEFAULT_API_VERSION = '2013-08-01'
+
+          set_routine RetryManager
+          set_routine RequestInitializer
+          set_routine ECS::PA::RequestSigner
+          set_routine RequestGenerator
+          set_routine RequestAnalyzer
+          set_routine ConnectionProxy
+          set_routine ResponseAnalyzer
+          set_routine CacheValidator
+          set_routine ResponseParser
+          set_routine ResultWrapper
+
+          set :response_error_parser => Parser::ECS::ResponseError
+
+          def api(action, params={}, &block)
+            params['Operation'] ||= action.to_s._snake_case._camelize
+            opts = {}
+            verb           = params.delete(:verb) || :post
+            opts[:body]    = params.delete(:body)
+            opts[:headers] = params.delete(:headers) || {}
+            opts[:options] = params.delete(:options) || {}
+            opts[:params]  = parametrize(params)
+            process_api_request(verb, 'onca/xml', opts, &block)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/cloud/ecs/pa/parsers/response_error.rb

@@ -0,0 +1,85 @@
+#--
+# Copyright (c) 2015 RightScale, Inc.
+#
+# 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.
+#++
+
+module RightScale
+  module CloudApi
+    # Parsers namespace
+    module Parser
+      # AWS parsers namespace
+      module ECS
+
+        # AWS response error parser, case 1
+        #
+        class ResponseError
+
+          # Parse HTTP error message from a response body
+          #
+          # @param [RightScale::CloudApi::HTTPResponse] response
+          # @param [Hash] options
+          # @option options [Class] :xml_parser
+          #
+          # @return [String]
+          #
+          # @example
+          #  # For the call below:
+          #  ec2.DescribeInstances('InstanceId' => 'hohoho')
+          #  # Generates an XML error:
+          #    <?xml version="1.0"?>
+          #    <ItemLookupErrorResponse xmlns="http://ecs.amazonaws.com/doc/2013-08-01/">
+          #      <Error>
+          #        <Code>
+          #          AWS.InvalidAccount
+          #        </Code>
+          #        <Message>
+          #          Your AccessKey Id is not registered for Product Advertising API. Please use the AccessKey Id obtained after registering at https://affiliate-program.amazon.com/gp/flex/advertising/api/sign-in.html
+          #        </Message>
+          #      </Error>
+          #      <RequestId>
+          #        57510d4f-72ad-4c15-985c-1dc330e5f3d4
+          #      </RequestId>
+          #    </ItemLookupErrorResponse>
+          #  # And the method parse all above into:
+          #  400: Your AccessKey Id is not registered for Product Advertising API. Please use the AccessKey Id obtained after registering at https://affiliate-program.amazon.com/gp/flex/advertising/api/sign-in.html (RequestID: 57510d4f-72ad-4c15-985c-1dc330e5f3d4)
+          #
+          def self.parse(response, options={})
+            result = "#{response.code}: "
+            body   = response.body.to_s
+            if response['content-type'].to_s[/xml/] || body[/\A<\?xml /]
+              hash    = Utils::get_xml_parser_class(options[:xml_parser]).parse(body)
+              top_key = hash.keys.first
+              error   = hash[top_key] && hash[top_key]["Error"]
+              if error
+                result << ('%s: %s' % [error['Code'], error['Message']])
+                result << (' (RequestID: %s)' % hash[top_key]['RequestId'])
+              end
+            else
+              result << body unless body._blank?
+            end
+            result
+          end
+        end
+
+      end
+    end
+  end
+end