alexa 0.3.1 → 0.4.0

data/lib/alexa/client.rb

@@ -0,0 +1,30 @@
+module Alexa
+  class Client
+    attr_reader :access_key_id, :secret_access_key
+
+    def initialize(configuration = {})
+      @access_key_id     = configuration[:access_key_id]     || raise(ArgumentError.new("You must specify access_key_id"))
+      @secret_access_key = configuration[:secret_access_key] || raise(ArgumentError.new("You must specify secret_access_key"))
+    end
+
+    def category_browse(arguments = {})
+      API::CategoryBrowse.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key).fetch(arguments)
+    end
+
+    def category_listings(arguments = {})
+      API::CategoryListings.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key).fetch(arguments)
+    end
+
+    def sites_linking_in(arguments = {})
+      API::SitesLinkingIn.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key).fetch(arguments)
+    end
+
+    def traffic_history(arguments = {})
+      API::TrafficHistory.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key).fetch(arguments)
+    end
+
+    def url_info(arguments = {})
+      API::UrlInfo.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key).fetch(arguments)
+    end
+  end
+end

data/lib/alexa/connection.rb

@@ -0,0 +1,86 @@
+require "cgi"
+require "base64"
+require "openssl"
+require "digest/sha1"
+require "net/http"
+require "time"
+
+module Alexa
+  class Connection
+    attr_accessor :secret_access_key, :access_key_id
+    attr_writer :params
+
+    def initialize(credentials = {})
+      self.secret_access_key = credentials.fetch(:secret_access_key)
+      self.access_key_id     = credentials.fetch(:access_key_id)
+    end
+
+    def params
+      @params ||= {}
+    end
+
+    def get(params = {})
+      self.params = params
+      encode handle_response(request).body
+    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
+          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
+      Net::HTTP.get_response(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::Digest.new("sha256"), secret_access_key, sign)).strip
+    end
+
+    def uri
+      URI.parse("http://#{Alexa::API_HOST}/?" + query + "&Signature=" + CGI::escape(signature))
+    end
+
+    def default_params
+      {
+        "AWSAccessKeyId"   => access_key_id,
+        "SignatureMethod"  => "HmacSHA256",
+        "SignatureVersion" => "2",
+        "Timestamp"        => timestamp,
+        "Version"          => Alexa::API_VERSION
+      }
+    end
+
+    def sign
+      "GET\n" + Alexa::API_HOST + "\n/\n" + query
+    end
+
+    def query
+      default_params.merge(params).map { |key, value| "#{key}=#{CGI::escape(value.to_s)}" }.sort.join("&")
+    end
+
+    def encode(string)
+      if "muflon".respond_to?(:force_encoding)
+        string.force_encoding(Encoding::UTF_8)
+      else
+        string
+      end
+    end
+  end
+end

data/lib/alexa/exceptions.rb

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

data/lib/alexa/utils.rb

@@ -0,0 +1,19 @@
+module Alexa
+  module Utils
+    def safe_retrieve(hash, *keys)
+      return if !hash.kind_of?(Hash) || !hash.has_key?(keys.first)
+
+      if keys.size == 1
+        hash[keys.first]
+      elsif keys.size > 1
+        Alexa::Utils.safe_retrieve(hash[keys.first], *keys[1..-1])
+      end
+    end
+
+    def camelize(string)
+      string.split("_").map { |w| w.capitalize }.join
+    end
+
+    module_function :safe_retrieve, :camelize
+  end
+end

data/lib/alexa/version.rb

@@ -1,3 +1,3 @@
 module Alexa
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/test/api/category_browse_test.rb

@@ -0,0 +1,27 @@
+require "helper"
+
+describe Alexa::API::CategoryBrowse do
+  describe "parsing xml" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("category_browse/card_games.txt"))
+      @category_browse = Alexa::API::CategoryBrowse.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @category_browse.fetch(:path => "Top/Games/Card_Games")
+    end
+
+    it "returns categories" do
+      assert_equal 8, @category_browse.categories.size
+    end
+
+    it "returns language categories" do
+      assert_equal 20, @category_browse.language_categories.size
+    end
+
+    it "returns related categories" do
+      assert_equal 8, @category_browse.related_categories.size
+    end
+
+    it "returns letter bars" do
+      assert_equal 36, @category_browse.letter_bars.size
+    end
+  end
+end

data/test/api/category_listings_test.rb

@@ -0,0 +1,19 @@
+require "helper"
+
+describe Alexa::API::CategoryListings do
+  describe "parsing xml" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("category_listings/card_games.txt"))
+      @category_listings = Alexa::API::CategoryListings.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @category_listings.fetch(:path => "Top/Games/Card_Games")
+    end
+
+    it "returns recursive count" do
+      assert_equal 1051, @category_listings.recursive_count
+    end
+
+    it "returns listings" do
+      assert_equal 20, @category_listings.listings.size
+    end
+  end
+end

data/test/api/sites_linking_in_test.rb

@@ -0,0 +1,23 @@
+require "helper"
+
+describe Alexa::API::SitesLinkingIn do
+  describe "parsing xml" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("sites_linking_in/github_count_3.txt"))
+      @sites_linking_in = Alexa::API::SitesLinkingIn.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @sites_linking_in.fetch(:url => "github.com", :count => 3)
+    end
+
+    it "returns sites" do
+      assert_equal 3, @sites_linking_in.sites.size
+    end
+
+    it "has Title attribute on single site" do
+      assert_equal "google.com", @sites_linking_in.sites.first["Title"]
+    end
+
+    it "has Url attribute on single site" do
+      assert_equal "code.google.com:80/a/eclipselabs.org/p/m2eclipse-android-integration", @sites_linking_in.sites.first["Url"]
+    end
+  end
+end

data/test/api/traffic_history_test.rb

@@ -0,0 +1,24 @@
+require "helper"
+
+describe Alexa::API::TrafficHistory do
+  it "defaults start to be in range to current time" do
+    stub_request(:get, %r{http://awis.amazonaws.com}).to_return(:body => "ok")
+    @traffic_history = Alexa::API::TrafficHistory.new(:access_key_id => "fake", :secret_access_key => "fake")
+    @traffic_history.fetch(:url => "github.com", :range => 14)
+
+    # 14 days from now
+    assert_in_delta (Time.now - 3600 * 24 * 14).to_i, @traffic_history.start.to_i, 0.001
+  end
+
+  describe "parsing xml" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("traffic_history/alexa_example.txt"))
+      @traffic_history = Alexa::API::TrafficHistory.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @traffic_history.fetch(:url => "amazon.com", :start => "20050101", :range => 31)
+    end
+
+    it "returns data" do
+      # assert_equal 1, @traffic_history.data.size
+    end
+  end
+end

data/test/api/url_info_test.rb

@@ -0,0 +1,112 @@
+require "helper"
+
+describe Alexa::API::UrlInfo do
+  it "allows to pass single attribute as response_group" do
+    stub_request(:get, %r{http://awis.amazonaws.com}).to_return(:body => "ok")
+    @url_info = Alexa::API::UrlInfo.new(:access_key_id => "fake", :secret_access_key => "fake")
+    @url_info.fetch(:url => "github.com", :response_group => "rank")
+
+    assert_equal ["rank"], @url_info.response_group
+  end
+
+  describe "parsing xml returned by options rank, links_in_count, site_data" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("url_info/custom-response-group.txt"))
+      @url_info = Alexa::API::UrlInfo.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @url_info.fetch(:url => "github.com", :response_group => ["rank", "links_in_count", "site_data"])
+    end
+
+    it "returns rank" do
+      assert_equal 493, @url_info.rank
+    end
+
+    it "returns data url" do
+      assert_equal "github.com/", @url_info.data_url
+    end
+
+    it "returns site title" do
+      assert_equal "GitHub", @url_info.site_title
+    end
+
+    it "returns site description" do
+      expected = "Online project hosting using Git. Includes source-code browser, in-line editing, wikis, and ticketing. Free for public open-source code. Commercial closed source hosting is also available."
+
+      assert_equal expected, @url_info.site_description
+    end
+  end
+
+  describe "with github.com full response group" do
+    before do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("url_info/github_full.txt"))
+      @url_info = Alexa::API::UrlInfo.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @url_info.fetch(:url => "github.com")
+    end
+
+    it "returns rank" do
+      assert_equal 551, @url_info.rank
+    end
+
+    it "returns data url" do
+      assert_equal "github.com", @url_info.data_url
+    end
+
+    it "returns site title" do
+      assert_equal "GitHub", @url_info.site_title
+    end
+
+    it "returns site description" do
+      expected = "Online project hosting using Git. Includes source-code browser, in-line editing, wikis, and ticketing. Free for public open-source code. Commercial closed source hosting is also available."
+      assert_equal expected, @url_info.site_description
+    end
+
+    it "returns language locale" do
+      assert_nil @url_info.language_locale
+    end
+
+    it "returns language encoding" do
+      assert_nil @url_info.language_encoding
+    end
+
+    it "returns links in count" do
+      assert_equal 43819, @url_info.links_in_count
+    end
+
+    it "returns keywords" do
+      assert_nil @url_info.keywords
+    end
+
+    it "returns related links" do
+      assert_equal 10, @url_info.related_links.size
+    end
+
+    it "returns speed_median load time" do
+      assert_equal 1031, @url_info.speed_median_load_time
+    end
+
+    it "returns speed percentile" do
+      assert_equal 68, @url_info.speed_percentile
+    end
+
+    it "returns rank by country" do
+      assert_equal 19, @url_info.rank_by_country.size
+    end
+
+    it "returns rank by city" do
+      assert_equal 163, @url_info.rank_by_city.size
+    end
+
+    it "returns usage statistics" do
+      assert_equal 4, @url_info.usage_statistics.size
+    end
+  end
+
+  describe "with github.com rank response group" do
+    it "successfuly connects" do
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("url_info/github_rank.txt"))
+      @url_info = Alexa::API::UrlInfo.new(:access_key_id => "fake", :secret_access_key => "fake")
+      @url_info.fetch(:url => "github.com", :response_group => ["rank"])
+
+      assert_equal 551, @url_info.rank
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,65 @@
+require "helper"
+
+describe Alexa::Client do
+  it "raises Argument Error when access_key_id not present" do
+    assert_raises Alexa::ArgumentError, /access_key_id/ do
+      Alexa::Client.new(:secret_access_key => "secret")
+    end
+  end
+
+  it "raises Argument Error when secret_access_key not present" do
+    assert_raises Alexa::ArgumentError, /secret_access_key/ do
+      Alexa::Client.new(:access_key_id => "key")
+    end
+  end
+
+  it "fetches UrlInfo results" do
+    credentials = {:access_key_id => "key", :secret_access_key => "secret"}
+    client = Alexa::Client.new(credentials)
+    url_info = stub
+    Alexa::API::UrlInfo.expects(:new).with(credentials).returns(url_info)
+    url_info.expects(:fetch).with(:url => "github.com")
+
+    client.url_info(:url => "github.com")
+  end
+
+  it "fetches SitesLinkingIn results" do
+    credentials = {:access_key_id => "key", :secret_access_key => "secret"}
+    client = Alexa::Client.new(credentials)
+    sites_linking_in = stub
+    Alexa::API::SitesLinkingIn.expects(:new).with(credentials).returns(sites_linking_in)
+    sites_linking_in.expects(:fetch).with(:url => "github.com", :count => 15, :start => 2)
+
+    client.sites_linking_in(:url => "github.com", :count => 15, :start => 2)
+  end
+
+  it "fetches TrafficHistory results" do
+    credentials = {:access_key_id => "key", :secret_access_key => "secret"}
+    client = Alexa::Client.new(credentials)
+    traffic_history = stub
+    Alexa::API::TrafficHistory.expects(:new).with(credentials).returns(traffic_history)
+    traffic_history.expects(:fetch).with(:url => "github.com", :range => 15)
+
+    client.traffic_history(:url => "github.com", :range => 15)
+  end
+
+  it "fetches CategoryBrowse results" do
+    credentials = {:access_key_id => "key", :secret_access_key => "secret"}
+    client = Alexa::Client.new(credentials)
+    category_browse = stub
+    Alexa::API::CategoryBrowse.expects(:new).with(credentials).returns(category_browse)
+    category_browse.expects(:fetch).with(:path => "Top/Games/Card_Games")
+
+    client.category_browse(:path => "Top/Games/Card_Games")
+  end
+
+  it "fetches CategoryListings results" do
+    credentials = {:access_key_id => "key", :secret_access_key => "secret"}
+    client = Alexa::Client.new(credentials)
+    category_listings = stub
+    Alexa::API::CategoryListings.expects(:new).with(credentials).returns(category_listings)
+    category_listings.expects(:fetch).with(:path => "Top/Games/Card_Games")
+
+    client.category_listings(:path => "Top/Games/Card_Games")
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,37 @@
+require "helper"
+
+describe Alexa::Connection do
+  it "calculates signature" do
+    connection = Alexa::Connection.new(:access_key_id => "fake", :secret_access_key => "fake")
+    connection.stubs(:timestamp).returns("2012-08-08T20:58:32.000Z")
+
+    assert_equal "3uaSV1s7uJUtIDivvM8mzPkNxq+Za8jAFCDnQOvjRH4=", connection.signature
+  end
+
+  it "normalizes non string params value" do
+    connection = Alexa::Connection.new(:access_key_id => "fake", :secret_access_key => "fake")
+    connection.stubs(:timestamp).returns("2012-08-08T20:58:32.000Z")
+    connection.params = {:custom_value => 3}
+
+    expected = "AWSAccessKeyId=fake&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-08-08T20%3A58%3A32.000Z&Version=2005-07-11&custom_value=3"
+    assert_equal expected, connection.query
+  end
+
+  it "raises error when unathorized" do
+    stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("unathorized.txt"))
+    connection = Alexa::Connection.new(:access_key_id => "wrong", :secret_access_key => "wrong")
+
+    assert_raises Alexa::ResponseError do
+      connection.get
+    end
+  end
+
+  it "raises error when forbidden" do
+    stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("forbidden.txt"))
+    connection = Alexa::Connection.new(:access_key_id => "wrong", :secret_access_key => "wrong")
+
+    assert_raises Alexa::ResponseError do
+      connection.get
+    end
+  end
+end