mss-sdk 1.0.0

data/lib/mss/core/rest_error_parser.rb

@@ -0,0 +1,23 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+
+    # @api private
+    module RESTErrorParser
+
+
+    end
+
+  end
+end

data/lib/mss/core/rest_json_client.rb

@@ -0,0 +1,39 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+    class RESTJSONClient < Core::Client
+
+      protected
+
+      def self.request_builder_for api_config, operation
+        Core::RESTRequestBuilder.new(operation, :format => :json)
+      end
+
+      def self.response_parser_for api_config, operation
+        Core::RESTResponseParser.new(operation, :format => :json)
+      end
+
+      def extract_error_details response
+        if
+          response.http_response.status >= 300 and
+          body = response.http_response.body and
+          json = (::JSON.load(body) rescue nil)
+        then
+          [json['code'], json['message']]
+        end
+      end
+
+    end
+  end
+end

data/lib/mss/core/rest_request_builder.rb

@@ -0,0 +1,153 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+
+    # Given a hash of request options, a REST::RequestHandler can
+    # populate a Core::Http::Request object.
+    class RESTRequestBuilder
+
+      # @api private
+      def initialize operation, options = {}
+
+        @http = operation[:http]
+        @rules = operation[:inputs]
+
+        @validator = Options::Validator.new(@rules)
+
+        @serializer =
+          case options[:format]
+          when :xml
+            namespace = options[:xmlnamespace]
+            name = operation[:name]
+            Options::XMLSerializer.new(namespace, name, operation)
+          when :json
+            Options::JSONSerializer.new(@rules, @http[:request_payload])
+          else
+            raise ArgumentError, "unhandled format: #{options[:format]}"
+          end
+
+      end
+
+      # Populates a Http::Request with the following:
+      #
+      #   * HTTP method
+      #   * URI
+      #   * headers
+      #   * body
+      #
+      # @param [Http::Request] request
+      #
+      # @param [Hash] params The hash of request options provided
+      #   to the client request method.  This will be used to populate
+      #   the headers, uri and body.
+      #
+      # @raise [ArgumentError] Raises ArgumentError when any of the
+      #   request options are invalid (wrong type, missing, unknown, etc).
+      #
+      def populate_request request, params
+        params = @validator.validate!(params)
+        populate_method(request)
+        populate_uri(request, params)
+        populate_headers(request, params)
+        populate_body(request, params)
+      end
+
+      private
+
+      def populate_method request
+        request.http_method = @http[:verb]
+      end
+
+      def populate_uri request, params
+        request.uri = extract_uri(params)
+      end
+
+      def populate_headers request, params
+        extract_headers(params).each_pair do |header_name, header_value|
+          request.headers[header_name] = header_value
+        end
+      end
+
+      # @param [Hash] params
+      # @return [String]
+      def extract_uri params
+
+        path, querystring = @http[:uri].split(/\?/)
+
+        uri = path.gsub(/:\w+/) do |param_name|
+          if param = params.delete(param_name.sub(/^:/, '').to_sym)
+            UriEscape.escape(param)
+          else
+            raise ArgumentError, "missing required option #{param_name}"
+          end
+        end
+
+        querystring_parts = []
+        querystring.to_s.split(/&|;/).each do |part|
+          param_name = part.match(/:(\w+)/)[1]
+          if param = params.delete(param_name.to_sym)
+            param = UriEscape.escape(param)
+            querystring_parts << part.sub(/:#{param_name}/, param)
+          end
+        end
+
+        unless querystring_parts.empty?
+          uri << "?#{querystring_parts.join('&')}"
+        end
+
+        uri
+
+      end
+
+      # @param [Hash] params
+      # @return [Hash]
+      def extract_headers params
+        headers = {}
+        (@http[:request_headers] || {}).each_pair do |param,header|
+          headers[header] = params[param] if params.key?(param)
+        end
+        headers
+      end
+
+      # @param [Hash] params
+      # @return [String,nil]
+      def populate_body request, params
+        if params.empty?
+          request.body = nil
+        elsif payload = streaming_param # streaming request
+          request.body_stream = params[payload]
+          request.headers['Content-Length'] = size(params[payload])
+        else
+          request.body = @serializer.serialize(params)
+        end
+      end
+
+      def size(payload)
+        if payload.respond_to?(:path) && payload.path
+          File.size(payload.path)
+        else
+          payload.size
+        end
+      end
+
+      def streaming_param
+        if payload = @http[:request_payload]
+          @rules[payload][:type] == :blob ? payload : nil
+        end
+      end
+
+    end
+
+  end
+end

data/lib/mss/core/rest_response_parser.rb

@@ -0,0 +1,65 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+
+    # Given a hash of request options, a REST::RequestHandler can
+    # populate a Core::Http::Request object.
+    class RESTResponseParser
+
+      # @api private
+      def initialize operation, options
+        @http = operation[:http]
+        @parser =
+          case options[:format]
+          when :xml then XML::Parser.new(operation[:outputs])
+          when :json then Core::JSONParser.new(operation[:outputs])
+          else raise "unhandled format: #{options[:format].inspect}"
+          end
+      end
+
+      # Given a response object, this method extract and returns a
+      # hash of response data.
+      # @param [Response] response
+      # @return [Hash]
+      def extract_data response
+
+        if payload = @http[:response_payload]
+          data = { payload => response.http_response.body }
+        else
+          data = @parser.parse(response.http_response.body)
+        end
+
+        if header = response.http_response.headers['x-amzn-requestid']
+          data[:request_id] = [header].flatten.first
+        end
+
+        # extract headers and insert into response
+        (@http[:response_headers] || {}).each_pair do |name,header_name|
+          if header = response.http_response.headers[header_name.downcase]
+            data[name] = [header].flatten.first
+          end
+        end
+
+        data
+
+      end
+
+      def simulate
+        {}
+      end
+
+    end
+
+  end
+end

data/lib/mss/core/rest_xml_client.rb

@@ -0,0 +1,46 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+    # @since 1.8.0
+    class RESTXMLClient < Core::Client
+
+      protected
+
+      def self.request_builder_for api_config, operation
+        RESTRequestBuilder.new(operation,
+          :format => :xml,
+          :xmlnamespace => api_config[:namespace])
+      end
+
+      def self.response_parser_for api_config, operation
+        RESTResponseParser.new(operation, :format => :xml)
+      end
+
+      def extract_error_details response
+        if
+          response.http_response.status >= 300 and
+          body = response.http_response.body and
+          error = errors_module::GRAMMAR.parse(body) and
+          error[:code]
+        then
+          [error[:code], error[:message]]
+        end
+      end
+
+    end
+
+    # @deprecated Use RESTXMLClient instead.
+    RESTClient = RESTXMLClient
+  end
+end

data/lib/mss/core/service_interface.rb

@@ -0,0 +1,82 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+
+    module ServiceInterface
+
+      def self.included base
+
+        base.send(:attr_reader, :config)
+        base.send(:attr_reader, :client)
+
+        base.module_eval('module Errors; end')
+
+        unless base::Errors.include?(Errors)
+          base::Errors.module_eval { include Errors }
+        end
+
+        MSS::Core::MetaUtils.extend(base) do
+
+          # @api private
+          def endpoint_prefix prefix = nil, options = {}
+            if prefix
+              @endpoint_prefix = prefix
+              @global_endpoint = !!options[:global]
+            end
+            @endpoint_prefix
+          end
+
+          # @api private
+          def global_endpoint?
+            @global_endpoint
+          end
+
+          def regions
+            RegionCollection.new(:service => self)
+          end
+
+        end
+
+      end
+
+      # Returns a new interface object for this service.  You can override
+      # any of the global configuration parameters by passing them in as
+      # hash options.  They are merged with MSS.config or merged
+      # with the provided `:config` object.
+      #
+      #     @ec2 = MSS::EC2.new(:max_retries => 2)
+      #
+      # @see MSS::Cofiguration
+      #
+      # @param [Hash] options
+      #
+      # @option options [Configuration] :config An MSS::Configuration
+      #   object to initialize this service interface object with.  Defaults
+      #   to MSS.config when not provided.
+      #
+      def initialize options = {}
+        options = options.dup
+        @config = (options.delete(:config) || MSS.config)
+        @config = @config.with(options)
+        @client = @config.send(Inflection.ruby_name(self.class.name.split('::').last) + '_client')
+      end
+
+      # @return [String]
+      def inspect
+        "<#{self.class}>"
+      end
+
+    end
+  end
+end

data/lib/mss/core/signers/base.rb

@@ -0,0 +1,45 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'base64'
+
+module MSS
+  module Core
+    module Signers
+      # @api private
+      module Base
+
+        # Signs a string using the credentials stored in memory.
+        # @param [String] secret Usually an MSS secret access key.
+        # @param [String] string_to_sign The string to sign.
+        # @param [String] digest_method The digest method to use when
+        #   computing the HMAC digest.
+        # @return [String] Returns the computed signature.
+        def sign secret, string_to_sign, digest_method = 'sha256'
+          Base64.encode64(hmac(secret, string_to_sign, digest_method)).strip
+        end
+        module_function :sign
+
+        # Computes an HMAC digest of the passed string.
+        # @param [String] key
+        # @param [String] value
+        # @param [String] digest ('sha256')
+        # @return [String]
+        def hmac key, value, digest = 'sha256'
+          OpenSSL::HMAC.digest(OpenSSL::Digest.new(digest), key, value)
+        end
+        module_function :hmac
+
+      end
+    end
+  end
+end

data/lib/mss/core/signers/cloud_front.rb

@@ -0,0 +1,55 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'time'
+
+module MSS
+  module Core
+    module Signers
+      class CloudFront
+
+        include Base
+
+        # @param [CredentialProviders::Provider] credentials
+        def initialize credentials
+          @credentials = credentials
+        end
+
+        # @return [CredentialProviders::Provider]
+        attr_reader :credentials
+
+        # @param [Http::Request] req
+        # @return [Http::Request]
+        def sign_request req
+          req.headers['x-amz-security-token'] = credentials.session_token if
+            credentials.session_token
+          req.headers['authorization'] =
+            "AWS #{credentials.access_key_id}:#{signature(req)}"
+          req
+        end
+
+        private
+
+        # @param [Http::Request] req
+        def signature req
+          sign(credentials.secret_access_key, string_to_sign(req), 'sha1')
+        end
+
+        # @param [Http::Request] req
+        def string_to_sign req
+          req.headers['date'] ||= Time.now.httpdate
+        end
+
+      end
+    end
+  end
+end

data/lib/mss/core/signers/s3.rb

@@ -0,0 +1,158 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  module Core
+    module Signers
+      # @api private
+      class S3
+
+        SUB_RESOURCES = %w(
+          acl location logging notification partNumber policy
+          requestPayment torrent uploadId uploads versionId
+          versioning versions restore delete lifecycle tagging cors
+          website
+        )
+
+        QUERY_PARAMS = %w(
+          response-content-type response-content-language
+          response-expires response-cache-control
+          response-content-disposition response-content-encoding
+        )
+
+        # @param [CredentialProviders::Provider] credentials
+        def initialize credentials
+          @credentials = credentials
+        end
+
+        # @return [CredentialProviders::Provider]
+        attr_reader :credentials
+
+        # @param [Http::Request] req
+        # @return [Http::Request]
+        def sign_request req
+          if token = credentials.session_token
+            req.headers["x-amz-security-token"] = token
+          end
+          req.headers["authorization"] = authorization(req)
+        end
+
+        private
+
+        def authorization req
+          "AWS #{credentials.access_key_id}:#{signature(req)}"
+        end
+
+        def signature req
+          secret = credentials.secret_access_key
+          signature = self.class.string_to_sign(req)
+          signature = Base.sign(credentials.secret_access_key, signature, 'sha1')
+          URI.escape(signature)
+        end
+
+        class << self
+
+          # From the S3 developer guide:
+          #
+          #     StringToSign =
+          #       HTTP-Verb ` "\n" `
+          #       content-md5 ` "\n" `
+          #       content-type ` "\n" `
+          #       date ` "\n" `
+          #       CanonicalizedAmzHeaders + CanonicalizedResource;
+          #
+          def string_to_sign req
+            [
+              req.http_method,
+              req.headers.values_at('content-md5', 'content-type').join("\n"),
+              signing_string_date(req),
+              canonicalized_headers(req),
+              canonicalized_resource(req),
+            ].flatten.compact.join("\n")
+          end
+
+          def signing_string_date req
+            # if a date is provided via x-amz-date then we should omit the
+            # Date header from the signing string (should appear as a blank line)
+            if req.headers.detect{|k,v| k.to_s =~ /^x-amz-date$/i }
+              ''
+            else
+              req.headers['date'] ||= Time.now.httpdate
+            end
+          end
+
+          # CanonicalizedAmzHeaders
+          #
+          # See the developer guide for more information on how this element
+          # is generated.
+          #
+          def canonicalized_headers req
+            x_amz = req.headers.select{|k, v| k.to_s =~ /^x-amz-/i }
+            x_amz = x_amz.collect{|k, v| [k.downcase, v] }
+            x_amz = x_amz.sort_by{|k, v| k }
+            x_amz = x_amz.collect{|k, v| "#{k}:#{v.to_s.strip}" }.join("\n")
+            x_amz == '' ? nil : x_amz
+          end
+
+          # From the S3 developer guide
+          #
+          #     CanonicalizedResource =
+          #       [ "/" ` Bucket ] `
+          #       <HTTP-Request-URI, protocol name up to the querystring> +
+          #       [ sub-resource, if present. e.g. "?acl", "?location",
+          #       "?logging", or "?torrent"];
+          #
+          # @api private
+          def canonicalized_resource req
+
+            parts = []
+
+            # virtual hosted-style requests require the hostname to appear
+            # in the canonicalized resource prefixed by a forward slash.
+            if
+              MSS::S3::Client.dns_compatible_bucket_name?(req.bucket) and
+              !req.path_style?
+            then
+              parts << "/#{req.bucket}"
+            end
+
+            # all requests require the portion of the un-decoded uri up to
+            # but not including the query string
+            parts << req.path
+
+            # lastly any sub resource querystring params need to be appened
+            # in lexigraphical ordered joined by '&' and prefixed by '?'
+            params =
+              sub_resource_params(req) +
+              query_parameters_for_signature(req)
+
+            unless params.empty?
+              parts << '?'
+              parts << params.sort.collect{|p| p.to_s }.join('&')
+            end
+
+            parts.join
+          end
+
+          def sub_resource_params req
+            req.params.select{|p| SUB_RESOURCES.include?(p.name) }
+          end
+
+          def query_parameters_for_signature req
+            req.params.select { |p| QUERY_PARAMS.include?(p.name) }
+          end
+
+        end
+      end
+    end
+  end
+end