awis-sdk-ruby 0.0.1

data/lib/awis/api/url_info.rb

@@ -0,0 +1,33 @@
+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
+
+      def fetch(arguments = {})
+        raise ArgumentError, "Any valid URL." unless arguments.has_key?(:url)
+        @arguments = arguments
+        @arguments[:response_group] = Array(arguments.fetch(:response_group, DEFAULT_RESPONSE_GROUP))
+
+        loading_response_data
+        self
+      end
+
+      def loading_response_data
+        @response_body = Awis::Connection.new.get(params)
+      end
+
+      private
+      def params
+        {
+          "Action"        => action_name,
+          "Url"           => arguments[:url],
+          "ResponseGroup" => response_groups,
+        }
+      end
+
+      def response_groups
+        arguments[:response_group].sort.map { |group| camelize(group) }.join(",")
+      end
+    end
+  end
+end

data/lib/awis/client.rb

@@ -0,0 +1,44 @@
+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?
+    end
+
+    def url_info(args)
+      parse_response_with_request("UrlInfo", args)
+    end
+
+    def traffic_history(args)
+      parse_response_with_request("TrafficHistory", args)
+    end
+
+    def sites_linking_in(args)
+      parse_response_with_request("SitesLinkingIn", args)
+    end
+
+    def category_browse(args)
+      parse_response_with_request("CategoryBrowse", args)
+    end
+
+    def category_listings(args)
+      parse_response_with_request("CategoryListings", args)
+    end
+
+    private
+    def parse_response_with_request(kclass, args)
+      case kclass
+      when 'UrlInfo'
+        Awis::Models::UrlInfo.new Awis::API::UrlInfo.new.fetch(args)
+      when 'SitesLinkingIn'
+        Awis::Models::SitesLinkingIn.new Awis::API::SitesLinkingIn.new.fetch(args)
+      when 'TrafficHistory'
+        Awis::Models::TrafficHistory.new Awis::API::TrafficHistory.new.fetch(args)
+      when 'CategoryBrowse'
+        Awis::Models::CategoryBrowse.new Awis::API::CategoryBrowse.new.fetch(args)
+      when 'CategoryListings'
+        Awis::Models::CategoryListings.new Awis::API::CategoryListings.new.fetch(args)
+      end
+    end
+  end
+end

data/lib/awis/config.rb

@@ -0,0 +1,15 @@
+require "singleton"
+
+module Awis
+  class Config
+    include Singleton
+    attr_accessor :access_key_id, :secret_access_key, :proxy, :debug
+  end
+
+  def self.config
+    if block_given?
+      yield Config.instance
+    end
+    Config.instance
+  end
+end

data/lib/awis/connection.rb

@@ -0,0 +1,90 @@
+require "cgi"
+require "base64"
+require "openssl"
+require "digest/sha1"
+require "faraday"
+require "time"
+
+module Awis
+  class Connection
+    attr_accessor :access_key_id, :secret_access_key, :proxy, :debug
+    attr_writer :params
+
+    RFC_3986_UNRESERVED_CHARS = "-_.~a-zA-Z\\d".freeze
+
+    def initialize
+      raise CertificateError.new("Amazon access certificate is missing!") if Awis.config.access_key_id.nil? || Awis.config.secret_access_key.nil?
+
+      @access_key_id  = Awis.config.access_key_id
+      @secret_access_key  = Awis.config.secret_access_key
+      @debug = Awis.config.debug || nil
+    end
+
+    def params
+      @params ||= {}
+    end
+
+    def get(params = {})
+      self.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
+      puts "[DEBUG] -> #{uri}" if debug
+      
+      Faraday.get(uri)
+    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"), secret_access_key, sign)).strip
+    end
+
+    def uri
+      URI.parse("http://#{Awis::API_HOST}/?" + query + "&Signature=" + CGI::escape(signature))
+    end
+
+    def default_params
+      {
+        "AWSAccessKeyId"   => access_key_id,
+        "SignatureMethod"  => "HmacSHA256",
+        "SignatureVersion" => "2",
+        "Timestamp"        => timestamp,
+        "Version"          => Awis::API_VERSION
+      }
+    end
+
+    def sign
+      "GET\n" + Awis::API_HOST + "\n/\n" + query
+    end
+
+    def query
+      default_params.merge(params).map { |key, value| "#{key}=#{regexp_params(value)}" }.sort.join("&")
+    end
+
+    def regexp_params(value)
+      URI.escape(value.to_s, Regexp.new("[^#{RFC_3986_UNRESERVED_CHARS}]"))
+    end
+  end
+end

data/lib/awis/exceptions.rb

@@ -0,0 +1,16 @@
+module Awis
+  # Awis exceptions can be cought by rescuing: Awis::StandardError
+
+  class StandardError < StandardError; end
+  class ArgumentError < StandardError; end
+  class CertificateError < StandardError; end
+
+  class ResponseError < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      @response = response
+      super(message)
+    end
+  end
+end

data/lib/awis/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def deep_find(key)
+    key?(key) ? self[key] : self.values.inject(nil) { |memo, v| memo ||= v.deep_find(key) if v.respond_to?(:deep_find) }
+  end
+
+  def array_slice_merge!(key, array, count)
+    self[key] = array.each_slice(count).collect { |e| e.reduce({}, :merge) }
+  end
+end

data/lib/awis/models.rb

@@ -0,0 +1,10 @@
+module Awis
+  module Models
+    autoload :Base,             "awis/models/base"
+    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

@@ -0,0 +1,26 @@
+module Awis
+  module Models
+    class Base
+      attr_accessor :response, :status_code, :request_id
+
+      def loading_response(response)
+        Awis::Utils::XML.new(response.response_body)
+      end
+
+      def root_node_name
+        "/aws:#{action_name}Response/aws:Response/aws:#{action_name}Result/aws:Alexa"
+      end
+
+      def action_name
+        self.class.name.split(/\:\:/)[-1]
+      end
+      
+      def relationship_collections(_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) }
+      end
+    end
+  end
+end

data/lib/awis/models/category_browse.rb

@@ -0,0 +1,123 @@
+module Awis
+  module Models
+    class CategoryBrowse < Base
+      attr_accessor :categories, :language_categories, :related_categories, :letter_bars
+
+      def initialize(response)
+        @categories = []
+        @language_categories = []
+        @related_categories = []
+        @letter_bars = []
+        
+        setup_data!( loading_response(response) )
+      end
+
+      def setup_data!(response)
+        categories = []
+        language_categories = []
+        related_categories = []
+        letter_bars = []
+
+        response.each_node do |node, path|
+          text = node.inner_xml
+          text = text.to_i if text.to_i.to_s === text
+
+          if node.name == 'aws:RequestId'
+            @request_id ||= text
+          elsif node.name == 'aws:StatusCode'
+            @status_code ||= text
+          elsif node.name == 'aws:Path' && path == "#{category_node_name}/aws:Path"
+            categories << { path: text }
+          elsif node.name == 'aws:Title' && path == "#{category_node_name}/aws:Title"
+            categories << { title: text }
+          elsif node.name == 'aws:SubCategoryCount' && path == "#{category_node_name}/aws:SubCategoryCount"
+            categories << { sub_category_count: text }
+          elsif node.name == 'aws:TotalListingCount' && path == "#{category_node_name}/aws:TotalListingCount"
+            categories << { total_listing_count: text }
+          elsif node.name == 'aws:Path' && path == "#{language_category_node_name}/aws:Path"
+            language_categories << { path: text }
+          elsif node.name == 'aws:Title' && path == "#{language_category_node_name}/aws:Title"
+            language_categories << { title: text }
+          elsif node.name == 'aws:SubCategoryCount' && path == "#{language_category_node_name}/aws:SubCategoryCount"
+            language_categories << { sub_category_count: text }
+          elsif node.name == 'aws:TotalListingCount' && path == "#{language_category_node_name}/aws:TotalListingCount"
+            language_categories << { total_listing_count: text }
+          elsif node.name == 'aws:Path' && path == "#{related_category_node_name}/aws:Path"
+            related_categories << { path: text }
+          elsif node.name == 'aws:Title' && path == "#{related_category_node_name}/aws:Title"
+            related_categories << { title: text }
+          elsif node.name == 'aws:SubCategoryCount' && path == "#{related_category_node_name}/aws:SubCategoryCount"
+            related_categories << { sub_category_count: text }
+          elsif node.name == 'aws:TotalListingCount' && path == "#{related_category_node_name}/aws:TotalListingCount"
+            related_categories << { total_listing_count: text }
+          elsif node.name == 'aws:Path' && path == "#{letter_bars_node_name}/aws:Path"
+            letter_bars << { path: text }
+          elsif node.name == 'aws:Title' && path == "#{letter_bars_node_name}/aws:Title"
+            letter_bars << { title: text }
+          elsif node.name == 'aws:SubCategoryCount' && path == "#{letter_bars_node_name}/aws:SubCategoryCount"
+            letter_bars << { sub_category_count: text }
+          elsif node.name == 'aws:TotalListingCount' && path == "#{letter_bars_node_name}/aws:TotalListingCount"
+            letter_bars << { total_listing_count: text }
+          end
+        end
+
+        relationship_collections(@categories, categories, 4, Category)
+        relationship_collections(@language_categories, language_categories, 4, LanguageCategory)
+        relationship_collections(@related_categories, related_categories, 4, RelatedCategory)
+        relationship_collections(@letter_bars, letter_bars, 4, LetterBar)
+      end
+
+      def base_node_name
+        "#{root_node_name}/aws:CategoryBrowse"
+      end
+
+      def category_node_name
+        "#{base_node_name}/aws:Categories/aws:Category"
+      end
+
+      def language_category_node_name
+        "#{base_node_name}/aws:LanguageCategories/aws:Category"
+      end
+
+      def related_category_node_name
+        "#{base_node_name}/aws:RelatedCategories/aws:Category"
+      end
+
+      def letter_bars_node_name
+        "#{base_node_name}/aws:LetterBars/aws:Category"
+      end
+    end
+
+    class Category
+      attr_accessor :path, :title, :sub_category_count, :total_listing_count
+
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+
+    class LanguageCategory
+      attr_accessor :path, :title, :sub_category_count, :total_listing_count
+
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+
+    class RelatedCategory
+      attr_accessor :path, :title, :sub_category_count, :total_listing_count
+
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+
+    class LetterBar
+      attr_accessor :path, :title, :sub_category_count, :total_listing_count
+
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+  end
+end

data/lib/awis/models/category_listings.rb

@@ -0,0 +1,53 @@
+module Awis
+  module Models
+    class CategoryListings < Base
+      attr_accessor :count, :recursive_count, :listings
+
+      def initialize(response)
+        @listings = []
+        setup_data!( loading_response(response) )
+      end
+
+      def setup_data!(response)
+        category_listings = []
+
+        response.each_node do |node, path|
+          text = node.inner_xml
+          text = text.to_i if text.to_i.to_s === text
+
+          if node.name == 'aws:RequestId'
+            @request_id ||= text
+          elsif node.name == 'aws:StatusCode'
+            @status_code ||= text
+          elsif node.name == 'aws:Count'
+            @count ||= text
+          elsif node.name == 'aws:RecursiveCount'
+            @recursive_count ||= text
+          elsif node.name == 'aws:DataUrl' && path == "#{base_node_name}/aws:DataUrl"
+            category_listings << { data_url: text }
+          elsif node.name == 'aws:Title' && path == "#{base_node_name}/aws:Title"
+            category_listings << { title: text }
+          elsif node.name == 'aws:PopularityRank' && path == "#{base_node_name}/aws:PopularityRank"
+            category_listings << { popularity_rank: text }
+          elsif node.name == 'aws:Description' && path == "#{base_node_name}/aws:Description"
+            category_listings << { description: text }
+          end
+        end
+
+        relationship_collections(@listings, category_listings, 4, Listing)
+      end
+
+      def base_node_name
+        "#{root_node_name}/aws:CategoryListings/aws:Listings/aws:Listing"
+      end
+    end
+
+    class Listing
+      attr_accessor :data_url, :title, :popularity_rank, :description
+
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+  end
+end

data/lib/awis/models/sites_linking_in.rb

@@ -0,0 +1,40 @@
+module Awis
+  module Models
+    class SitesLinkingIn < Base
+      attr_accessor :sites
+
+      def initialize(response)
+        @sites = []
+        setup_data!( loading_response(response) )
+      end
+
+      def setup_data!(response)
+        sites = []
+
+        response.each_node do |node, path|
+          text = node.inner_xml
+
+          if node.name == 'aws:RequestId'
+            @request_id ||= text
+          elsif node.name == 'aws:StatusCode'
+            @status_code ||= text
+          elsif node.name == 'aws:Title'
+            sites << { title: text }
+          elsif node.name == 'aws:Url'
+            sites << { url: text }
+          end
+        end
+
+        relationship_collections(@sites, sites, 2, Site)
+      end
+    end
+
+    class Site
+      attr_accessor :title, :url
+      
+      def initialize(hash)
+        hash.map { |k, v| instance_variable_set("@#{k}", v) }
+      end
+    end
+  end
+end