awis-sdk-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+.ruby-version
+awis.yml

data/.travis.yml

@@ -0,0 +1,9 @@
+notifications:
+  disabled: true
+bundler_args: --without extra
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+env:
+  - XML_PARSER=nokogiri

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+group :extra do
+  gem "debugger"
+end
+
+gem "bundler"
+gem "rake"
+
+# XML parsers
+gem "nokogiri", '~> 1.6.8'
+
+gemspec

data/README.md

@@ -0,0 +1,149 @@
+## Amazon - Alexa Web Information Service (AWIS)
+Ruby Library for AWSI API - [Amazon AWIS](http://docs.amazonwebservices.com/AlexaWebInfoService/latest/)
+
+### How to installation
+
+```
+gem install awis-sdk-ruby
+```
+
+### How to usage
+
+##### Configure your amazon certificate
+
+```
+AWIS_CONFIG = YAML.load(File.read('awis.yml'))
+
+Awis.config do |c|
+  c.access_key_id = AWIS_CONFIG['access_key_id']
+  c.secret_access_key = AWIS_CONFIG['secret_access_key']
+  c.debug = AWIS_CONFIG['debug']
+end
+```
+
+##### Get UrlInfo Information
+
+``` ruby
+client = Awis::Client.new
+url_info = client.url_info(url: "github.com")
+```
+
+Returns object that contains attributes:
+
+* data_url
+* rank
+* asin
+
+Returns object that contains relationships:
+
+* contact_info [:data_url, :owner_name, :email, :physical_address, :company_stock_ticker, :phone_numbers]
+* content_data [:data_url, :site_title, :site_description, :speed_median_load_time, :speed_percentile, :adult_content, :language_locale, :links_in_count, :owned_domains]
+* usage_statistics [:time_range_months, :time_range_days, :rank_value, :rank_delta, :reach_rank_value, :reach_rank_delta, 
+                    :reach_per_million_value, :reach_per_million_delta, :reach_page_views_per_million_value, :reach_page_views_per_million_delta,
+                    :reach_page_views_rank_value, :reach_page_views_rank_delta, :reach_page_views_per_user_value, :reach_page_views_per_user_delta]
+* related_links [:data_url, :navigable_url, :title]
+* categories [:title, :absolute_path]
+
+You can specify options:
+
+* url 
+* response_group - which data to include in response (i.e. ["rank", "contact_info", "content_data"]) - defaults to all available
+
+See: [Docs](http://docs.amazonwebservices.com/AlexaWebInfoService/latest/) for valid groups.
+
+##### Get Sites Linking In
+
+``` ruby
+client = Awis::Client.new
+sites_linking_in = client.sites_linking_in(url: "site.com")
+```
+
+Returns object that contains relationships:
+
+* sites [:title, :url]
+
+You can specify options:
+
+* url
+* count - how many results to retrieve - defaults to max value that is 20
+* start - offset of results - defaults to 0
+
+##### Get Traffic History
+
+``` ruby
+client = Awis::Client.new
+traffic_history = client.traffic_history(url: "site.com")
+```
+
+Returns object that contains methods:
+
+* range
+* site
+* start
+
+Returns object that contains relationships:
+
+* historical_data [:date, :page_views_per_million, :page_views_per_user, :rank, :reach_per_million]
+
+You can specify options:
+
+* url
+* range - how many days to retrieve - defaults to max value 31
+* start - start date (i.e. "20120120", 4.days.ago) - defaults to range number days ago
+
+##### Get Category Listings
+
+``` ruby
+client = Awis::Client.new
+category_listings = client.category_listings(path: "Top/Games/Card_Games")
+```
+
+Returns object that contains methods:
+
+* count
+* recursive_count
+
+Returns object that contains relationships:
+
+* listings [:data_url, :title, :popularity_rank, :description]
+
+##### Get Category Browse
+
+``` ruby
+client = Awis::Client.new
+category_browses = client.category_browse(path: "Top/Games/Card_Games")
+```
+
+Returns object that contains methods:
+
+* categories [:path, :title, :sub_category_count, :total_listing_count]
+* language_categories [:path, :title, :sub_category_count, :total_listing_count]
+* related_categories [:path, :title, :sub_category_count, :total_listing_count]
+* letter_bars [:path, :title, :sub_category_count, :total_listing_count]
+
+Returns object that contains relationships:
+
+* listings [:data_url, :title, :popularity_rank, :description]
+
+##### Request ID and Status Code
+
+You can retrieve status code and request id
+
+* request_id
+* status_code
+
+### Parsers
+
+Awis is using `nokogiri` to parse XML documents.
+
+### Contributors
+
+* [Encore Shao](https://github.com/encoreshao)
+
+### Continuous Integration
+
+[![Build Status](https://travis-ci.org/encoreshao/awis.svg?branch=master)](https://travis-ci.org/encoreshao/awis)
+
+### Copyright
+
+Copyright (c) Encore Shao. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/awis.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "awis-sdk-ruby"
+  spec.version       = Awis::VERSION
+  spec.authors       = ["Encore Shao"]
+  spec.email         = ["encore.shao@gmail.com"]
+
+  spec.summary       = %q{Ruby - Amazon Alexa Web Information Service Library (AWIS)}
+  spec.description   = %q{Ruby - Amazon Alexa Web Information Service Library (AWIS)}
+  spec.homepage      = "https://github.com/encoreshao/awis"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "multi_xml", ">= 0.5.0"
+  spec.add_dependency "faraday", "~> 0.9.0"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "webmock"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "awis"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/awis.rb

@@ -0,0 +1,19 @@
+require "multi_xml"
+
+require "awis/version"
+require "awis/hash"
+require "awis/utils/xml"
+require "awis/utils/extra"
+require "awis/exceptions"
+require "awis/connection"
+require "awis/config"
+require "awis/client"
+require "awis/api"
+require "awis/models"
+
+module Awis
+  API_VERSION = "2005-07-11".freeze
+  API_HOST    = "awis.amazonaws.com".freeze
+  class << self
+  end
+end

data/lib/awis/api.rb

@@ -0,0 +1,10 @@
+module Awis
+  module API
+    autoload :Base,             "awis/api/base"
+    autoload :UrlInfo,          "awis/api/url_info"
+    autoload :TrafficHistory,   "awis/api/traffic_history"
+    autoload :SitesLinkingIn,   "awis/api/sites_linking_in"
+    autoload :CategoryListings, "awis/api/category_listings"
+    autoload :CategoryBrowse,   "awis/api/category_browse"
+  end
+end

data/lib/awis/api/base.rb

@@ -0,0 +1,26 @@
+module Awis
+  module API
+    class Base
+      include Utils::Extra
+      attr_reader :arguments, :response_body
+
+      def parsed_body
+        @parsed_body ||= MultiXml.parse(response_body)
+      end
+
+      def root_node_name
+        "#{action_name}Response"
+      end
+
+      def action_name
+        self.class.name.split(/\:\:/)[-1]
+      end
+
+      class << self
+        def loading_data_from_xml(xml_file_path)
+          MultiXml.parse(File.new(xml_file_path))
+        end
+      end
+    end
+  end
+end

data/lib/awis/api/category_browse.rb

@@ -0,0 +1,36 @@
+module Awis
+  module API
+    class CategoryBrowse < Base
+      DEFAULT_RESPONSE_GROUP = %w(categories related_categories language_categories letter_bars).freeze
+
+      def fetch(arguments = {})
+        raise ArgumentError.new("Valid category path (Top/Arts, Top/Business/Automotive)") unless arguments.has_key?(:path)
+        @arguments = arguments
+
+        @arguments[:response_group] = Array(arguments.fetch(:response_group, DEFAULT_RESPONSE_GROUP))
+        @arguments[:descriptions]   = arguments.fetch(:descriptions, true)
+
+        @response_body = Awis::Connection.new.get(params)
+        self
+      end
+
+      private
+      def params
+        {
+          "Action"        => action_name,
+          "ResponseGroup" => response_groups,
+          "Path"          => arguments[:path],
+          "Descriptions"  => descriptions_params
+        }
+      end
+
+      def response_groups
+        arguments[:response_group].sort.map { |group| camelize(group) }.join(",")
+      end
+
+      def descriptions_params
+        arguments[:descriptions].to_s.capitalize
+      end
+    end
+  end
+end

data/lib/awis/api/category_listings.rb

@@ -0,0 +1,45 @@
+module Awis
+  module API
+    class CategoryListings < Base
+      def fetch(arguments = {})
+        raise ArgumentError, "You must provide a URL" unless arguments.has_key?(:path)
+        @arguments = arguments
+
+        @arguments[:sort_by]      = arguments.fetch(:sort_by, "popularity")
+        @arguments[:recursive]    = arguments.fetch(:recursive, true)
+        @arguments[:descriptions] = arguments.fetch(:descriptions, true)
+        @arguments[:start]        = arguments.fetch(:start, 0)
+        @arguments[:count]        = arguments.fetch(:count, 20)
+
+        @response_body = Awis::Connection.new.get(params)
+        self
+      end
+
+      private
+      def params
+        {
+          "Action"        => "CategoryListings",
+          "ResponseGroup" => "Listings",
+          "Path"          => arguments[:path],
+          "Recursive"     => recursive_param,
+          "Descriptions"  => descriptions_params,
+          "SortBy"        => sort_by_param,
+          "Count"         => arguments[:count],
+          "Start"         => arguments[:start],
+        }
+      end
+
+      def recursive_param
+        arguments[:recursive].to_s.capitalize
+      end
+
+      def descriptions_params
+        arguments[:descriptions].to_s.capitalize
+      end
+
+      def sort_by_param
+        camelize(arguments[:sort_by])
+      end
+    end
+  end
+end

data/lib/awis/api/sites_linking_in.rb

@@ -0,0 +1,29 @@
+module Awis
+  module API
+    class SitesLinkingIn < Base
+      attr_accessor :sites
+
+      def fetch(arguments = {})
+        raise ArgumentError, "You must provide a URL" unless arguments.has_key?(:url)
+
+        @arguments = arguments
+        @arguments[:count] = arguments.fetch(:count, 20)
+        @arguments[:start] = arguments.fetch(:start, 0)
+
+        @response_body = Awis::Connection.new.get(params)
+        self
+      end
+
+      private
+      def params
+        {
+          "Action"        => "SitesLinkingIn",
+          "Url"           => arguments[:url],
+          "ResponseGroup" => "SitesLinkingIn",
+          "Count"         => arguments[:count],
+          "Start"         => arguments[:start]
+        }
+      end
+    end
+  end
+end

data/lib/awis/api/traffic_history.rb

@@ -0,0 +1,30 @@
+module Awis
+  module API
+    class TrafficHistory < Base
+      def fetch(arguments = {})
+        raise ArgumentError, "Any valid URL." unless arguments.has_key?(:url)
+        @arguments = arguments
+
+        @arguments[:range] = arguments.fetch(:range, 31)
+        @arguments[:start] = arguments.fetch(:start) { Time.now - (3600 * 24 * @arguments[:range].to_i) }
+
+        @response_body = Awis::Connection.new.get(params)
+        self
+      end
+
+      def params
+        {
+          "Action"        => "TrafficHistory",
+          "Url"           => arguments[:url],
+          "ResponseGroup" => "History",
+          "Range"         => arguments[:range],
+          "Start"         => start_param,
+        }
+      end
+
+      def start_param
+        arguments[:start].respond_to?(:strftime) ? arguments[:start].strftime("%Y%m%d") : arguments[:start]
+      end
+    end
+  end
+end