awis-sdk-ruby 1.0.0 → 1.1.0

data/lib/awis/api/url_info.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module Awis
   module API
     class UrlInfo < Base
-      DEFAULT_RESPONSE_GROUP = %w(related_links categories rank rank_by_country usage_stats adult_content speed language owned_domains links_in_count site_data).freeze
+      DEFAULT_RESPONSE_GROUP = %w[
+        related_links categories rank rank_by_country usage_stats
+        adult_content speed language owned_domains links_in_count site_data
+      ].freeze
 
       def load_request_uri(arguments = {})
         validation_arguments!(arguments)
@@ -10,6 +15,7 @@ module Awis
       end
 
       private
+
       def validation_arguments!(arguments)
         before_validation_arguments(arguments)
 
@@ -19,14 +25,14 @@ module Awis
 
       def params
         {
-          "Action"        => action_name,
-          "Url"           => arguments[:url],
-          "ResponseGroup" => response_groups,
+          'Action'        => action_name,
+          'Url'           => arguments[:url],
+          'ResponseGroup' => response_groups
         }
       end
 
       def response_groups
-        arguments[:response_group].sort.map { |group| camelize(group) }.join(",")
+        arguments[:response_group].sort.map { |group| camelize(group) }.join(',')
       end
     end
   end

data/lib/awis/client.rb

@@ -1,30 +1,33 @@
+# frozen_string_literal: true
+
 module Awis
   class Client
     def initialize
-      raise CertificateError.new("Amazon access certificate is missing!") if Awis.config.access_key_id.nil? || Awis.config.secret_access_key.nil?
+      raise CertificateError, 'Amazon access certificate is missing!' if Awis.config.access_key_id.nil? || Awis.config.secret_access_key.nil?
     end
 
     def url_info(args)
-      parse_response_with_request("UrlInfo", args)
+      parse_response_with_request('UrlInfo', args)
     end
 
     def traffic_history(args)
-      parse_response_with_request("TrafficHistory", args)
+      parse_response_with_request('TrafficHistory', args)
     end
 
     def sites_linking_in(args)
-      parse_response_with_request("SitesLinkingIn", args)
+      parse_response_with_request('SitesLinkingIn', args)
     end
 
     def category_browse(args)
-      parse_response_with_request("CategoryBrowse", args)
+      parse_response_with_request('CategoryBrowse', args)
     end
 
     def category_listings(args)
-      parse_response_with_request("CategoryListings", args)
+      parse_response_with_request('CategoryListings', args)
     end
 
     private
+
     def parse_response_with_request(kclass, args)
       case kclass
       when 'UrlInfo'

data/lib/awis/config.rb

@@ -1,4 +1,6 @@
-require "singleton"
+# frozen_string_literal: true
+
+require 'singleton'
 
 module Awis
   class Config

data/lib/awis/connection.rb

@@ -1,12 +1,24 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'aws-sigv4'
+require 'net/https'
+
 module Awis
   class Connection
-    include Awis::Utils::Request
-
     attr_accessor :debug, :protocol
-    attr_writer :params
+    attr_reader :params, :secret_access_key, :access_key_id
 
-    def initialize
-      raise CertificateError.new("Amazon access certificate is missing!") if Awis.config.access_key_id.nil? || Awis.config.secret_access_key.nil?
+    HEADERS = {
+      'Content-Type' => 'application/xml',
+      'Accept' => 'application/xml',
+      'User-Agent' => "awis-sdk-ruby v#{Awis::VERSION}"
+    }.freeze
+
+    def initialize(options = {})
+      @secret_access_key = options.fetch(:secret_access_key, Awis.config.access_key_id)
+      @access_key_id     = options.fetch(:access_key_id, Awis.config.secret_access_key)
+      raise CertificateError, 'Amazon access certificate is missing!' if @secret_access_key.nil? || @access_key_id.nil?
 
       setup_options!
     end
@@ -18,19 +30,81 @@ module Awis
       @open_timeout = Awis.config.open_timeout || 10
     end
 
-    def params
-      @params ||= {}
+    def get(params = {})
+      @params = params
+      handle_response(request).body.force_encoding(Encoding::UTF_8)
     end
 
-    def setup_params(params)
-      self.params = params
+    private
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        response
+      else
+        handle_error_response(response)
+      end
     end
 
-    def get(params = {})
-      setup_params(params)
+    def handle_error_response(response)
+      case response.code.to_i
+      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: #{response.code}", response)
+      end
+    end
+
+    def request
+      req = Net::HTTP::Get.new(uri)
+      headers.each do |key, value|
+        req[key] = value
+      end
+      Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: uri.scheme == 'https',
+        ssl_timeout: @timeout,
+        open_timeout: @open_timeout
+      ) do |http|
+        http.request(req)
+      end
+    end
+
+    def uri
+      @uri ||= URI.parse("#{protocol}://#{Awis::SERVICE_HOST}/#{Awis::SERVICE_PATH}?" << query)
+    end
+
+    def headers
+      HEADERS.merge(auth_headers)
+    end
+
+    def auth_headers
+      signer.sign_request(
+        http_method: 'GET',
+        headers: HEADERS,
+        url: uri.to_s
+      ).headers
+    end
+
+    def signer
+      Aws::Sigv4::Signer.new(
+        service: Awis::SERVICE_NAME,
+        region: Awis::SERVICE_REGION,
+        access_key_id: access_key_id,
+        secret_access_key: secret_access_key
+      )
+    end
 
-      response = handle_response(request)
-      response.body.force_encoding(Encoding::UTF_8)
+    def query
+      params.map do |key, value|
+        "#{key}=#{CGI.escape(value.to_s)}"
+      end.sort!.join('&')
     end
   end
 end

data/lib/awis/exceptions.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Awis
-  # Awis exceptions can be cought by rescuing: Awis::StandardError
+  # Awis exceptions can be caught by rescuing: Awis::StandardError
 
   class StandardError < StandardError; end
   class ArgumentError < StandardError; end

data/lib/awis/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hash
   def array_slice_merge!(key, array, count)
     self[key] = array.each_slice(count).collect { |e| e.reduce({}, :merge) }

data/lib/awis/models.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
-    autoload :Base,             "awis/models/base"
-    autoload :BaseEntity,       "awis/models/base_entity"
-    autoload :UrlInfo,          "awis/models/url_info"
-    autoload :TrafficHistory,   "awis/models/traffic_history"
-    autoload :SitesLinkingIn,   "awis/models/sites_linking_in"
-    autoload :CategoryListings, "awis/models/category_listings"
-    autoload :CategoryBrowse,   "awis/models/category_browse"
+    autoload :Base,             'awis/models/base'
+    autoload :BaseEntity,       'awis/models/base_entity'
+    autoload :UrlInfo,          'awis/models/url_info'
+    autoload :TrafficHistory,   'awis/models/traffic_history'
+    autoload :SitesLinkingIn,   'awis/models/sites_linking_in'
+    autoload :CategoryListings, 'awis/models/category_listings'
+    autoload :CategoryBrowse,   'awis/models/category_browse'
   end
 end

data/lib/awis/models/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class Base
@@ -15,11 +17,11 @@ module Awis
         self.class.name.split(/\:\:/)[-1]
       end
 
-      def relationship_collections(_object, items, items_count, kclass)
+      def relationship_collections(item_object, items, items_count, kclass)
         return if items.empty?
 
         all_items = {}.array_slice_merge!(:item, items, items_count)
-        all_items.map { |item| _object << kclass.new(item) }
+        all_items.map { |item| item_object << kclass.new(item) }
       end
 
       def success?

data/lib/awis/models/base_entity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class BaseEntity

data/lib/awis/models/category_browse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class CategoryBrowse < Base
@@ -12,6 +14,11 @@ module Awis
         setup_data! loading_response(response)
       end
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/BlockLength
       def setup_data!(response)
         categories = []
         language_categories = []
@@ -20,8 +27,8 @@ module Awis
 
         response.each_node do |node, path|
           text = node.inner_xml
-          text = text.to_i if text.to_i.to_s === text
-          text = nil if (text.class == String && text.empty?)
+          text = text.to_i if text.to_i.to_s == text
+          text = nil if text.class == String && text.empty?
 
           if node.name == 'aws:RequestId'
             @request_id ||= text
@@ -67,6 +74,11 @@ module Awis
         relationship_collections(@related_categories, related_categories, 4, RelatedCategory)
         relationship_collections(@letter_bars, letter_bars, 4, LetterBar)
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/BlockLength
 
       def base_node_name
         "#{root_node_name}/aws:CategoryBrowse"

data/lib/awis/models/category_listings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class CategoryListings < Base
@@ -13,8 +15,8 @@ module Awis
 
         response.each_node do |node, path|
           text = node.inner_xml
-          text = text.to_i if text.to_i.to_s === text
-          text = nil if (text.class == String && text.empty?)
+          text = text.to_i if text.to_i.to_s == text
+          text = nil if text.class == String && text.empty?
 
           if node.name == 'aws:RequestId'
             @request_id ||= text

data/lib/awis/models/sites_linking_in.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class SitesLinkingIn < Base
@@ -11,9 +13,9 @@ module Awis
       def setup_data!(response)
         sites = []
 
-        response.each_node do |node, path|
+        response.each_node do |node, _path|
           text = node.inner_xml
-          text = nil if (text.class == String && text.empty?)
+          text = nil if text.class == String && text.empty?
 
           if node.name == 'aws:RequestId'
             @request_id ||= text

data/lib/awis/models/traffic_history.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class TrafficHistory < Base
@@ -8,13 +10,16 @@ module Awis
         setup_data! loading_response(response)
       end
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def setup_data!(response)
         datas = []
 
         response.each_node do |node, path|
           text = node.inner_xml
-          text = text.to_i if text.to_i.to_s === text
-          text = nil if (text.class == String && text.empty?)
+          text = text.to_i if text.to_i.to_s == text
+          text = nil if text.class == String && text.empty?
 
           if node.name == 'aws:RequestId'
             @request_id ||= text
@@ -41,6 +46,9 @@ module Awis
 
         relationship_collections(@historical_data, datas, 5, HistoricalData)
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       def base_node_name
         "#{root_node_name}/aws:TrafficHistory/aws:HistoricalData/aws:Data"

data/lib/awis/models/url_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awis
   module Models
     class UrlInfo < Base
@@ -24,8 +26,8 @@ module Awis
 
         response.each_node do |node, path|
           text = node.inner_xml
-          text = text.to_i if text.to_i.to_s === text && node.name != 'aws:Delta'
-          text = nil if (text.class == String && text.empty?)
+          text = text.to_i if text.to_i.to_s == text && node.name != 'aws:Delta'
+          text = nil if text.class == String && text.empty?
 
           if node.name == 'aws:RequestId'
             @request_id ||= text
@@ -75,7 +77,7 @@ module Awis
             related_related_links << { data_url: text }
           elsif node.name == 'aws:NavigableUrl' && path == "#{related_links_node_name}/aws:NavigableUrl"
             related_related_links << { navigable_url: text }
-          elsif node.name == 'aws:Title' &&  path == "#{related_links_node_name}/aws:Title"
+          elsif node.name == 'aws:Title' && path == "#{related_links_node_name}/aws:Title"
             related_related_links << { title: text }
           elsif node.name == 'aws:Title' && path == "#{categories_node_name}/aws:Title"
             category_data << { title: text }
@@ -166,11 +168,11 @@ module Awis
         owned_domains_relationship_collections(@owned_domains, owned_domain_objects, 2, OwnedDomain)
       end
 
-      def owned_domains_relationship_collections(_object, items, items_count, kclass)
+      def owned_domains_relationship_collections(item_object, items, items_count, kclass)
         return if items.empty?
 
         all_items = {}.array_slice_merge!(:item, items, items_count)
-        all_items.map { |item| _object << kclass.new(item) }
+        all_items.map { |item| item_object << kclass.new(item) }
       end
     end
 
@@ -188,7 +190,7 @@ module Awis
       end
 
       def phone_number_collections(phone_numbers)
-        return @phone_numbers = [] if phone_numbers.nil? || phone_numbers.empty?
+        return @phone_numbers = [] if phone_numbers.blank?
 
         phone_numbers.map { |item| @phone_numbers << PhoneNumber.new(item) }
       end
@@ -215,7 +217,7 @@ module Awis
                     :reach_page_views_per_user_value, :reach_page_views_per_user_delta
 
       def range_type
-        return 'month' unless time_range_months.blank?
+        return 'month' if time_range_months.present?
 
         'day'
       end

data/lib/awis/utils.rb

@@ -1,9 +1,10 @@
-require "awis/utils/extra"
-require "awis/utils/variable"
-require "awis/utils/request"
+# frozen_string_literal: true
+
+require 'awis/utils/extra'
+require 'awis/utils/variable'
 
 module Awis
   module Utils
-    autoload :XML, "awis/utils/xml"
+    autoload :XML, 'awis/utils/xml'
   end
 end