awis-sdk-ruby 0.1.1 → 1.0.0

data/README.md

@@ -20,8 +20,8 @@ Awis.config do |c|
   c.secret_access_key = AWIS_CONFIG['secret_access_key']
   c.debug = AWIS_CONFIG['debug']
   c.protocol = 'https'    # Default 'https'
-  c.timeout = 5           # Default 5
-  c.open_timeout = 5      # Default 2
+  c.timeout = 10          # Default 10
+  c.open_timeout = 10     # Default 10
   c.logger = false        # Default nil
 end
 ```
@@ -116,7 +116,7 @@ You can specify options:
 
 ``` ruby
 client = Awis::Client.new
-category_listings = client.category_listings(path: "Top/Games/Card_Games")
+category_listings = client.category_listings(path: "Top/Arts")
 ```
 
 If you looking for the API request URI:
@@ -136,7 +136,7 @@ Returns object that contains relationships:
 
 ``` ruby
 client = Awis::Client.new
-category_browses = client.category_browse(path: "Top/Games/Card_Games")
+category_browses = client.category_browse(path: "Top/Arts")
 ```
 
 If you looking for the API request URI:
@@ -154,6 +154,10 @@ Returns object that contains relationships:
 
 * listings [:data_url, :title, :popularity_rank, :description]
 
+##### How to run test
+
+* rake test
+
 ##### Request ID and Status Code
 
 You can retrieve status code and requestID

data/awis.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 1.9.3"
 
   spec.add_dependency "multi_xml", ">= 0.5.0"
-  spec.add_dependency "faraday", "~> 0.9.0"
   spec.add_dependency "nokogiri", '~> 1.6.8'
 
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
 end

data/lib/awis.rb

@@ -3,9 +3,7 @@ require "nokogiri"
 
 require "awis/version"
 require "awis/hash"
-require "awis/utils/xml"
-require "awis/utils/extra"
-require "awis/utils/variable"
+require "awis/utils"
 require "awis/exceptions"
 require "awis/connection"
 require "awis/config"
@@ -14,9 +12,12 @@ require "awis/api"
 require "awis/models"
 
 module Awis
-  API_VERSION           = "2005-07-11".freeze
-  API_HOST              = "awis.amazonaws.com".freeze
-  API_SIGNATURE_VERSION = "2".freeze
+  SERVICE_HOST          = "awis.amazonaws.com".freeze
+  SERVICE_ENDPOINT      = "awis.us-west-1.amazonaws.com".freeze
+  SERVICE_PORT          = 443
+  SERVICE_URI           = "/api".freeze
+  SERVICE_REGION        = "us-west-1".freeze
+  SERVICE_NAME          = "awis".freeze
 
   class << self
   end

data/lib/awis/api/base.rb

@@ -34,7 +34,7 @@ module Awis
       def load_request_uri(params)
         collection = Awis::Connection.new
         collection.setup_params(params)
-        collection.request_url
+        collection.uri
       end
 
       def before_validation_arguments(arguments)

data/lib/awis/client.rb

@@ -28,15 +28,15 @@ module Awis
     def parse_response_with_request(kclass, args)
       case kclass
       when 'UrlInfo'
-        Awis::Models::UrlInfo.new Awis::API::UrlInfo.new.fetch(args)
+        Models::UrlInfo.new API::UrlInfo.new.fetch(args)
       when 'SitesLinkingIn'
-        Awis::Models::SitesLinkingIn.new Awis::API::SitesLinkingIn.new.fetch(args)
+        Models::SitesLinkingIn.new API::SitesLinkingIn.new.fetch(args)
       when 'TrafficHistory'
-        Awis::Models::TrafficHistory.new Awis::API::TrafficHistory.new.fetch(args)
+        Models::TrafficHistory.new API::TrafficHistory.new.fetch(args)
       when 'CategoryBrowse'
-        Awis::Models::CategoryBrowse.new Awis::API::CategoryBrowse.new.fetch(args)
+        Models::CategoryBrowse.new API::CategoryBrowse.new.fetch(args)
       when 'CategoryListings'
-        Awis::Models::CategoryListings.new Awis::API::CategoryListings.new.fetch(args)
+        Models::CategoryListings.new API::CategoryListings.new.fetch(args)
       end
     end
   end

data/lib/awis/connection.rb

@@ -1,12 +1,7 @@
-require "cgi"
-require "base64"
-require "openssl"
-require "digest/sha1"
-require "faraday"
-require "time"
-
 module Awis
   class Connection
+    include Awis::Utils::Request
+
     attr_accessor :debug, :protocol
     attr_writer :params
 
@@ -19,8 +14,8 @@ module Awis
     def setup_options!
       @debug        = Awis.config.debug || false
       @protocol     = Awis.config.protocol || 'https'
-      @timeout      = Awis.config.timeout || 5
-      @open_timeout = Awis.config.open_timeout || 2
+      @timeout      = Awis.config.timeout || 10
+      @open_timeout = Awis.config.open_timeout || 10
     end
 
     def params
@@ -34,82 +29,8 @@ module Awis
     def get(params = {})
       setup_params(params)
 
-      handle_response(request).body.force_encoding(Encoding::UTF_8)
-    end
-
-    def handle_response(response)
-      case response.status.to_i
-      when 200...300
-        response
-      when 300...600
-        if response.body.nil?
-          raise ResponseError.new(nil, response)
-        else
-          xml = MultiXml.parse(response.body)
-          message = xml["Response"]["Errors"]["Error"]["Message"]
-          raise ResponseError.new(message, response)
-        end
-      else
-        raise ResponseError.new("Unknown code: #{respnse.code}", response)
-      end
-    end
-
-    def request
-      connection = Faraday.new(url: host_with_port) do |faraday|
-        faraday.request  :url_encoded             # form-encode POST params
-        faraday.response :logger do |logger|
-          logger.filter(/(AWSAccessKeyId=)(\w+)/, '\1[REMOVED]')
-        end if Awis.config.logger
-        faraday.adapter  :net_http
-      end
-
-      connection.get do |req|
-        req.url url_params
-        req.options.open_timeout = @timeout
-        req.options.timeout = @open_timeout
-      end
-    end
-
-    def host_with_port
-      protocol + '://' + Awis::API_HOST
-    end
-
-    def timestamp
-      @timestamp ||= Time::now.utc.strftime("%Y-%m-%dT%H:%M:%S.000Z")
-    end
-
-    def signature
-      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new("sha256"), Awis.config.secret_access_key, sign)).strip
-    end
-
-    def url_params
-      '?' + original_params
-    end
-
-    def request_url
-      URI.parse(host_with_port + url_params)
-    end
-
-    def default_params
-      {
-        "AWSAccessKeyId"   => Awis.config.access_key_id,
-        "SignatureMethod"  => "HmacSHA256",
-        "SignatureVersion" => Awis::API_SIGNATURE_VERSION,
-        "Timestamp"        => timestamp,
-        "Version"          => Awis::API_VERSION
-      }
-    end
-
-    def sign
-      "GET\n" + Awis::API_HOST + "\n/\n" + query_params
-    end
-
-    def query_params
-      default_params.merge(params).map { |key, value| "#{key}=#{CGI::escape(value.to_s)}" }.sort.join("&")
-    end
-
-    def original_params
-      query_params + "&Signature=" + CGI::escape(signature)
+      response = handle_response(request)
+      response.body.force_encoding(Encoding::UTF_8)
     end
   end
 end

data/lib/awis/hash.rb

@@ -2,4 +2,12 @@ class Hash
   def array_slice_merge!(key, array, count)
     self[key] = array.each_slice(count).collect { |e| e.reduce({}, :merge) }
   end
+
+  def deep_find(key, object = self, found = nil)
+    return object[key] if object.respond_to?(:key?) && object.key?(key)
+    return found unless object.is_a?(Enumerable)
+
+    object.find { |*a| found = deep_find(key, a.last) }
+    found
+  end
 end

data/lib/awis/utils.rb

@@ -0,0 +1,9 @@
+require "awis/utils/extra"
+require "awis/utils/variable"
+require "awis/utils/request"
+
+module Awis
+  module Utils
+    autoload :XML, "awis/utils/xml"
+  end
+end

data/lib/awis/utils/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def deep_find(key, object = self, found = nil)
+    return object[key] if object.respond_to?(:key?) && object.key?(key)
+    return found unless object.is_a?(Enumerable)
+
+    object.find { |*a| found = deep_find(key, a.last) }
+    found
+  end
+end

data/lib/awis/utils/request.rb

@@ -0,0 +1,153 @@
+require "cgi"
+require "base64"
+require "openssl"
+require "uri"
+require "net/https"
+require "time"
+require 'pry'
+
+module Awis
+  module Utils
+    module Request
+      def signature_key(key, date_stamp, region_name, service_name)
+        kDate    = openssl_hmac_digest(encryption_method, aws4 + key, date_stamp)
+        kRegion  = openssl_hmac_digest(encryption_method, kDate, region_name)
+        kService = openssl_hmac_digest(encryption_method, kRegion, service_name)
+        kSigning = openssl_hmac_digest(encryption_method, kService, aws4_request)
+        kSigning
+      end
+
+      # escape str to RFC 3986
+      def escapeRFC3986(str)
+        URI.escape(str, /[^A-Za-z0-9\-_.~]/)
+      end
+
+      def timestamp
+        Time::now.utc.strftime("%Y%m%dT%H%M%SZ")
+      end
+
+      def datestamp
+        Time::now.utc.strftime("%Y%m%d")
+      end
+
+      def headers
+        {
+          "host"        => Awis::SERVICE_ENDPOINT,
+          "x-amz-date"  => timestamp
+        }
+      end
+
+      def query_str
+        params.sort.map{|k,v| k + "=" + escapeRFC3986(v.to_s())}.join('&')
+      end
+
+      def headers_str
+        headers.sort.map{|k,v| k + ":" + v}.join("\n") + "\n"
+      end
+
+      def headers_lst
+        headers.sort.map{|k,v| k}.join(";")
+      end
+
+      def payload_hash
+        digest_sha256_hexdigest ""
+      end
+
+      def canonical_request
+        "GET" + "\n" + Awis::SERVICE_URI + "\n" + query_str + "\n" + headers_str + "\n" + headers_lst + "\n" + payload_hash
+      end
+
+      def algorithm
+        "AWS4-HMAC-SHA256"
+      end
+
+      def credential_scope
+        datestamp + "/" + Awis::SERVICE_REGION + "/" + Awis::SERVICE_NAME + "/" + aws4_request
+      end
+
+      def string_to_sign
+        algorithm + "\n" +  timestamp + "\n" +  credential_scope + "\n" + digest_sha256_hexdigest(canonical_request)
+      end
+
+      def signing_key
+        signature_key(Awis.config.secret_access_key, datestamp, Awis::SERVICE_REGION, Awis::SERVICE_NAME)
+      end
+
+      def signature
+        OpenSSL::HMAC.hexdigest(encryption_method, signing_key, string_to_sign)
+      end
+
+      def authorization_header
+        algorithm + " " +
+          "Credential=" + Awis.config.access_key_id + "/" + credential_scope + ", " +
+          "SignedHeaders=" + headers_lst + ", " +
+          "Signature=" + signature;
+      end
+
+      def uri
+        URI(url + url_params)
+      end
+
+      def request
+        req = Net::HTTP::Get.new(uri.to_s)
+        req["Accept"]         = "application/xml"
+        req["Content-Type"]   = "application/xml"
+        req["x-amz-date"]     = timestamp
+        req["Authorization"]  = authorization_header
+
+        response = Net::HTTP.start(uri.host, uri.port,
+          use_ssl: uri.scheme == 'https',
+          ssl_timeout: @timeout,
+          open_timeout: @open_timeout) { |http|
+          http.request(req)
+        }
+
+        response
+      end
+
+      def handle_response(response)
+        case response.code.to_i
+        when 200...300
+          response
+        when 300...600
+          if response.body.nil?
+            raise ResponseError.new(nil, response)
+          else
+            error_message = MultiXml.parse(response.body).deep_find('ErrorCode')
+            raise ResponseError.new(error_message, response)
+          end
+        else
+          raise ResponseError.new("Unknown code: #{respnse.code}", response)
+        end
+      end
+
+      def aws4
+        "AWS4"
+      end
+
+      def aws4_request
+        "aws4_request"
+      end
+
+      def encryption_method
+        'sha256'
+      end
+
+      def url
+        protocol + '://' + Awis::SERVICE_HOST + Awis::SERVICE_URI
+      end
+
+      def url_params
+        '?' + query_str
+      end
+
+      def openssl_hmac_digest(method, key, secret)
+        OpenSSL::HMAC.digest(method, key, secret)
+      end
+
+      def digest_sha256_hexdigest(key)
+        Digest::SHA256.hexdigest key
+      end
+    end
+  end
+end

data/lib/awis/utils/xml.rb

@@ -8,7 +8,7 @@ module Awis
       def each_node(attributes_in_path = false)
         reader = Nokogiri::XML::Reader(@data)
         nodes = ['']
-        
+
         reader.each do |node|
           if node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
             if attributes_in_path && node.attributes.size > 0

data/lib/awis/version.rb

@@ -1,3 +1,3 @@
 module Awis
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awis-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_xml
@@ -28,13 +28,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,25 +42,25 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.8
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -143,7 +143,10 @@ files:
 - lib/awis/models/sites_linking_in.rb
 - lib/awis/models/traffic_history.rb
 - lib/awis/models/url_info.rb
+- lib/awis/utils.rb
 - lib/awis/utils/extra.rb
+- lib/awis/utils/hash.rb
+- lib/awis/utils/request.rb
 - lib/awis/utils/variable.rb
 - lib/awis/utils/xml.rb
 - lib/awis/version.rb
@@ -167,10 +170,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 862568070736027421
+      hash: -1995395337547775
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: Ruby - Amazon Alexa Web Information Service Library (AWIS)