alexa 0.4.0 → 0.4.1

data/lib/alexa/api/traffic_history.rb

@@ -1,45 +1,63 @@
-module Alexa::API
-  class TrafficHistory
-    include Alexa::Utils
-
-    attr_reader :url, :range, :start, :response_body
-
-    def initialize(credentials)
-      @credentials = credentials
-    end
-
-    def fetch(arguments = {})
-      @url           = arguments[:url] || raise(ArgumentError.new("You must specify url"))
-      @range         = arguments.fetch(:range, 31)
-      @start         = arguments.fetch(:start) { Time.now - (3600 * 24 * range.to_i) }
-      @response_body = Alexa::Connection.new(@credentials).get(params)
-      self
-    end
-
-    # Attributes
-
-    def data
-      @data ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "TrafficHistoryResult", "Alexa", "TrafficHistory", "HistoricalData", "Data")
-    end
-
-    private
-
-    def params
-      {
-        "Action"        => "TrafficHistory",
-        "ResponseGroup" => "History",
-        "Range"         => range,
-        "Start"         => start_param,
-        "Url"           => url
-      }
-    end
-
-    def start_param
-      start.respond_to?(:strftime) ? start.strftime("%Y%m%d") : start
-    end
-
-    def parsed_body
-      @parsed_body ||= MultiXml.parse(response_body)
+require "alexa/api/base"
+
+module Alexa
+  module API
+    class TrafficHistory < Base
+      def fetch(arguments = {})
+        raise ArgumentError, "You must specify 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 = Alexa::Connection.new(@credentials).get(params)
+        self
+      end
+
+      # Response attributes
+
+      def site
+        @site ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "TrafficHistoryResult", "Alexa", "TrafficHistory", "Site")
+      end
+
+      def start
+        @start ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "TrafficHistoryResult", "Alexa", "TrafficHistory", "Start")
+      end
+
+      def range
+        return @range if defined?(@range)
+        if range = safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "TrafficHistoryResult", "Alexa", "TrafficHistory", "Range")
+          @range = range.to_i
+        end
+      end
+
+      def data
+        @data ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "TrafficHistoryResult", "Alexa", "TrafficHistory", "HistoricalData", "Data")
+      end
+
+      def status_code
+        @status_code ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "ResponseStatus", "StatusCode")
+      end
+
+      def request_id
+        @request_id ||= safe_retrieve(parsed_body, "TrafficHistoryResponse", "Response", "OperationRequest", "RequestId")
+      end
+
+      private
+
+      def params
+        {
+          "Action"        => "TrafficHistory",
+          "ResponseGroup" => "History",
+          "Range"         => arguments[:range],
+          "Start"         => start_param,
+          "Url"           => arguments[:url]
+        }
+      end
+
+      def start_param
+        arguments[:start].respond_to?(:strftime) ? arguments[:start].strftime("%Y%m%d") : arguments[:start]
+      end
     end
   end
 end

data/lib/alexa/api/url_info.rb

@@ -1,108 +1,111 @@
-module Alexa::API
-  class UrlInfo
-    include Alexa::Utils
+require "alexa/api/base"
 
-    DEFAULT_RESPONSE_GROUP = ["adult_content", "contact_info", "keywords", "language", "links_in_count", "owned_domains", "rank", "rank_by_city", "rank_by_country", "related_links", "site_data", "speed", "usage_stats"]
+module Alexa
+  module API
+    class UrlInfo < Base
+      DEFAULT_RESPONSE_GROUP = ["adult_content", "contact_info", "keywords", "language", "links_in_count", "owned_domains", "rank", "rank_by_city", "rank_by_country", "related_links", "site_data", "speed", "usage_stats"]
 
-    attr_reader :url, :response_group, :response_body
+      def fetch(arguments = {})
+        raise ArgumentError, "You must specify url" unless arguments.has_key?(:url)
+        @arguments = arguments
 
-    def initialize(credentials)
-      @credentials = credentials
-    end
+        @arguments[:response_group] = Array(arguments.fetch(:response_group, DEFAULT_RESPONSE_GROUP))
 
-    def fetch(arguments = {})
-      @url            = arguments[:url] || raise(ArgumentError.new("You must specify url"))
-      @response_group = Array(arguments.fetch(:response_group, DEFAULT_RESPONSE_GROUP))
-      @response_body  = Alexa::Connection.new(@credentials).get(params)
-      self
-    end
+        @response_body = Alexa::Connection.new(@credentials).get(params)
+        self
+      end
 
-    # attributes
+      # Response attributes
 
-    def rank
-      return @rank if defined?(@rank)
-      if rank = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "Rank")
-        @rank = rank.to_i
+      def rank
+        return @rank if defined?(@rank)
+        if rank = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "Rank")
+          @rank = rank.to_i
+        end
       end
-    end
 
-    def rank_by_country
-      @rank_by_country ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "RankByCountry", "Country")
-    end
+      def rank_by_country
+        @rank_by_country ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "RankByCountry", "Country")
+      end
 
-    def rank_by_city
-      @rank_by_city ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "RankByCity", "City")
-    end
+      def rank_by_city
+        @rank_by_city ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "RankByCity", "City")
+      end
 
-    def data_url
-      @data_url ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "DataUrl", "__content__")
-    end
+      def data_url
+        @data_url ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "DataUrl", "__content__")
+      end
 
-    def usage_statistics
-      @usage_statistics ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "UsageStatistics", "UsageStatistic")
-    end
+      def usage_statistics
+        @usage_statistics ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "TrafficData", "UsageStatistics", "UsageStatistic")
+      end
 
-    def site_title
-      @site_title ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "SiteData", "Title")
-    end
+      def site_title
+        @site_title ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "SiteData", "Title")
+      end
 
-    def site_description
-      @site_description ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "SiteData", "Description")
-    end
+      def site_description
+        @site_description ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "SiteData", "Description")
+      end
 
-    def language_locale
-      @language_locale ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Language", "Locale")
-    end
+      def language_locale
+        @language_locale ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Language", "Locale")
+      end
 
-    def language_encoding
-      @language_encoding ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Language", "Encoding")
-    end
+      def language_encoding
+        @language_encoding ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Language", "Encoding")
+      end
 
-    def links_in_count
-      return @links_in_count if defined?(@links_in_count)
-      if links_in_count = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "LinksInCount")
-        @links_in_count = links_in_count.to_i
+      def links_in_count
+        return @links_in_count if defined?(@links_in_count)
+        if links_in_count = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "LinksInCount")
+          @links_in_count = links_in_count.to_i
+        end
       end
-    end
 
-    def keywords
-      @keywords ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Keywords", "Keyword")
-    end
+      def keywords
+        @keywords ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Keywords", "Keyword")
+      end
 
-    def speed_median_load_time
-      return @speed_median_load_time if defined?(@speed_median_load_time)
-      if speed_median_load_time = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Speed", "MedianLoadTime")
-        @speed_median_load_time = speed_median_load_time.to_i
+      def speed_median_load_time
+        return @speed_median_load_time if defined?(@speed_median_load_time)
+        if speed_median_load_time = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Speed", "MedianLoadTime")
+          @speed_median_load_time = speed_median_load_time.to_i
+        end
       end
-    end
 
-    def speed_percentile
-      return @speed_percentile if defined?(@speed_percentile)
-      if speed_percentile = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Speed", "Percentile")
-        @speed_percentile = speed_percentile.to_i
+      def speed_percentile
+        return @speed_percentile if defined?(@speed_percentile)
+        if speed_percentile = safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "ContentData", "Speed", "Percentile")
+          @speed_percentile = speed_percentile.to_i
+        end
       end
-    end
 
-    def related_links
-      @related_links ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "Related", "RelatedLinks", "RelatedLink")
-    end
+      def related_links
+        @related_links ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "UrlInfoResult", "Alexa", "Related", "RelatedLinks", "RelatedLink")
+      end
 
-    private
+      def status_code
+        @status_code ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "ResponseStatus", "StatusCode")
+      end
 
-    def params
-      {
-        "Action"        => "UrlInfo",
-        "ResponseGroup" => response_group_param,
-        "Url"           => url
-      }
-    end
+      def request_id
+        @request_id ||= safe_retrieve(parsed_body, "UrlInfoResponse", "Response", "OperationRequest", "RequestId")
+      end
 
-    def response_group_param
-      response_group.sort.map { |group| camelize(group) }.join(",")
-    end
+      private
+
+      def params
+        {
+          "Action"        => "UrlInfo",
+          "ResponseGroup" => response_group_param,
+          "Url"           => arguments[:url]
+        }
+      end
 
-    def parsed_body
-      @parsed_body ||= MultiXml.parse(response_body)
+      def response_group_param
+        arguments[:response_group].sort.map { |group| camelize(group) }.join(",")
+      end
     end
   end
 end

data/lib/alexa/version.rb

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

data/test/api/category_browse_test.rb

@@ -1,6 +1,12 @@
 require "helper"
 
 describe Alexa::API::CategoryBrowse do
+  it "raises argument error when path not present" do
+    assert_raises Alexa::ArgumentError, /path/ do
+      Alexa::API::CategoryBrowse.new(:access_key_id => "fake", :secret_access_key => "fake").fetch
+    end
+  end
+
   describe "parsing xml" do
     before do
       stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("category_browse/card_games.txt"))
@@ -23,5 +29,13 @@ describe Alexa::API::CategoryBrowse do
     it "returns letter bars" do
       assert_equal 36, @category_browse.letter_bars.size
     end
+
+    it "has success status code" do
+      assert_equal "Success", @category_browse.status_code
+    end
+
+    it "has request id" do
+      assert_equal "c8bec6fe-84f3-9a8e-7444-47f86c64d74b", @category_browse.request_id
+    end
   end
 end

data/test/api/category_listings_test.rb

@@ -1,6 +1,12 @@
 require "helper"
 
 describe Alexa::API::CategoryListings do
+  it "raises argument error when path not present" do
+    assert_raises Alexa::ArgumentError, /path/ do
+      Alexa::API::CategoryListings.new(:access_key_id => "fake", :secret_access_key => "fake").fetch
+    end
+  end
+
   describe "parsing xml" do
     before do
       stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("category_listings/card_games.txt"))
@@ -12,8 +18,20 @@ describe Alexa::API::CategoryListings do
       assert_equal 1051, @category_listings.recursive_count
     end
 
+    it "returns count" do
+      assert_equal 1, @category_listings.count
+    end
+
     it "returns listings" do
       assert_equal 20, @category_listings.listings.size
     end
+
+    it "has success status code" do
+      assert_equal "Success", @category_listings.status_code
+    end
+
+    it "has request id" do
+      assert_equal "a069b6cd-309f-df52-88be-1bd88ab45b7e", @category_listings.request_id
+    end
   end
 end

data/test/api/sites_linking_in_test.rb

@@ -1,6 +1,12 @@
 require "helper"
 
 describe Alexa::API::SitesLinkingIn do
+  it "raises argument error when url not present" do
+    assert_raises Alexa::ArgumentError, /url/ do
+      Alexa::API::SitesLinkingIn.new(:access_key_id => "fake", :secret_access_key => "fake").fetch
+    end
+  end
+
   describe "parsing xml" do
     before do
       stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("sites_linking_in/github_count_3.txt"))
@@ -19,5 +25,13 @@ describe Alexa::API::SitesLinkingIn do
     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
+
+    it "has success status code" do
+      assert_equal "Success", @sites_linking_in.status_code
+    end
+
+    it "has request id" do
+      assert_equal "abb553a3-035f-8d12-f353-40532a087b52", @sites_linking_in.request_id
+    end
   end
 end

data/test/api/traffic_history_test.rb

@@ -1,24 +1,58 @@
 require "helper"
 
 describe Alexa::API::TrafficHistory do
+  it "raises argument error when url not present" do
+    assert_raises Alexa::ArgumentError, /url/ do
+      Alexa::API::TrafficHistory.new(:access_key_id => "fake", :secret_access_key => "fake").fetch
+    end
+  end
+
   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
+    assert_in_delta (Time.now - 3600 * 24 * 14).to_i, @traffic_history.arguments[: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"))
+      stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("traffic_history/github.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)
+      @traffic_history.fetch(:url => "github.com")
+    end
+
+    it "returns site" do
+      assert_equal "github.com", @traffic_history.site
+    end
+
+    it "returns range" do
+      assert_equal 28, @traffic_history.range
+    end
+
+    it "returns start" do
+      assert_equal "2012-07-11", @traffic_history.start
     end
 
     it "returns data" do
-      # assert_equal 1, @traffic_history.data.size
+      assert_equal 28, @traffic_history.data.size
+    end
+
+    it "has success status code" do
+      assert_equal "Success", @traffic_history.status_code
+    end
+
+    it "has request id" do
+      assert_equal "617614fc-46a3-a105-a7ab-80a17f117bcf", @traffic_history.request_id
     end
   end
+
+  it "has error status code" do
+    stub_request(:get, %r{http://awis.amazonaws.com}).to_return(fixture("traffic_history/alexa_error.txt"))
+    traffic_history = Alexa::API::TrafficHistory.new(:access_key_id => "fake", :secret_access_key => "fake")
+    traffic_history.fetch(:url => "amazon.com")
+
+    assert_equal "AlexaError", traffic_history.status_code
+  end
 end