ralexa 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cf3a967f413ff08f51c5becbe7df4e6bc20fda3
+  data.tar.gz: 92d1e853bcd2bbadb4862ef25d3461e7c1631412
+SHA512:
+  metadata.gz: 848a42c1b198bb0b482f455c14376e657d463069d8320d18faca74e6d1238bc54cfbc3bbefa6cd2cd0c63d5c46ab0e86c6833d3dab996db071ca70523c145783
+  data.tar.gz: ac3c77176cdc9df7299baed7d3fa94d2059e8302af6853cfb46124be4c050c05d528636f95a766c38aca02c2dfd38b2a7806a80ce5beaf4dfafb42ac03689e13

data/README.md

@@ -58,6 +58,10 @@ session.top_sites.country("AU", 10).each do |s|
   puts "#{s.url} (#{s.page_views} pageviews)"
 end
 
+# rank of an individual site
+puts "Rank of Flippa.com"
+puts session.url_info.rank("http://flippa.com")
+
 puts "bam!"
 ```
 
@@ -73,46 +77,51 @@ Status
     <th>Supported</th>
   </tr>
   <tr>
-    <td rowspan="3">Alexa Top Sites</th>
-    <td>TopSites</th>
-    <td>Global</th>
-    <td>Yes</th>
+    <td rowspan="3">Alexa Top Sites</td>
+    <td>TopSites</td>
+    <td>Global</td>
+    <td>Yes</td>
+  </tr>
+  <tr>
+    <td></td>
+    <td>Country</td>
+    <td>Yes</td>
   </tr>
   <tr>
-    <td></th>
-    <td>Country</th>
-    <td>Yes</th>
+    <td></td>
+    <td>ListCountries</td>
+    <td>Yes</td>
   </tr>
   <tr>
-    <td></th>
-    <td>ListCountries</th>
-    <td>Yes</th>
+    <td rowspan="7">Alexa Web Information Services</td>
+    <td>UrlInfo</td>
+    <td>Rank</td>
+    <td>Yes</td>
   </tr>
   <tr>
-    <td rowspan="5">Alexa Web Information Services</th>
-    <td>UrlInfo</th>
-    <td>*</th>
-    <td>Send a pull request!</th>
+    <td></td>
+    <td>*</td>
+    <td>Send a pull request!</td>
   </tr>
   <tr>
-    <td>TrafficHistory</th>
-    <td>*</th>
-    <td>Send a pull request!</th>
+    <td>TrafficHistory</td>
+    <td>*</td>
+    <td>Send a pull request!</td>
   </tr>
   <tr>
-    <td>CategoryBrowse</th>
-    <td>*</th>
-    <td>Send a pull request!</th>
+    <td>CategoryBrowse</td>
+    <td>*</td>
+    <td>Send a pull request!</td>
   </tr>
   <tr>
-    <td>CategoryListings</th>
-    <td>*</th>
-    <td>Send a pull request!</th>
+    <td>CategoryListings</td>
+    <td>*</td>
+    <td>Send a pull request!</td>
   </tr>
   <tr>
-    <td>SitesLinkingIn</th>
-    <td>*</th>
-    <td>Send a pull request!</th>
+    <td>SitesLinkingIn</td>
+    <td>*</td>
+    <td>Send a pull request!</td>
   </tr>
 </table>
 

data/lib/ralexa/abstract_service.rb

@@ -7,6 +7,17 @@ module Ralexa
 
     private
 
+    # a single result value
+    def result(*params, &parser)
+      Result.new(
+        @client,
+        host,
+        path,
+        merged_params(*params),
+        &parser
+      ).result
+    end
+
     # A lazy collection which fetches records on demand.
     def collection(*params, &parser)
       LazyCollection.new(

data/lib/ralexa/lazy_collection.rb

@@ -1,16 +1,12 @@
 require "nokogiri"
 
 module Ralexa
-  class LazyCollection
+  class LazyCollection < Result
 
     include Enumerable
 
     def initialize(client, host, path, parameters, &parser)
-      @client = client
-      @host = host
-      @path = path
-      @parameters = parameters
-      @parser = parser
+      super(client, host, path, parameters, &parser)
     end
 
     def each
@@ -19,17 +15,5 @@ module Ralexa
       end
     end
 
-    private
-
-    def fetch(parameters)
-      @client.get(@host, @path, parameters)
-    end
-
-    def parse(response_body)
-      @parser.call(
-        Nokogiri::XML.parse(response_body).remove_namespaces!
-      )
-    end
-
   end
 end

data/lib/ralexa/result.rb

@@ -0,0 +1,30 @@
+require "nokogiri"
+
+module Ralexa
+  class Result
+
+    def initialize(client, host, path, parameters, &parser)
+      @client = client
+      @host = host
+      @path = path
+      @parameters = parameters
+      @parser = parser
+    end
+
+    def result
+      parse(fetch(@parameters))
+    end
+
+    private
+
+    def fetch(parameters)
+      @client.get(@host, @path, parameters)
+    end
+
+    def parse(response_body)
+      @parser.call(
+        Nokogiri::XML.parse(response_body).remove_namespaces!
+      )
+    end
+  end
+end

data/lib/ralexa/session.rb

@@ -11,5 +11,11 @@ module Ralexa
       TopSites.new(@client)
     end
 
+    # Provides a UrlInfo instance with an authenticated client.
+    # See: http://docs.amazonwebservices.com/AlexaWebInfoService/latest
+    def url_info
+      UrlInfo.new(@client)
+    end
+
   end
 end

data/lib/ralexa/url_info.rb

@@ -0,0 +1,19 @@
+module Ralexa
+  class UrlInfo < AbstractService
+
+    # The site's Alexa rank
+    def rank(url, params = {})
+      result({"ResponseGroup" => "Rank", "Url" => url}, params) do |document|
+        document.at("//UrlInfoResult/Alexa/TrafficData/Rank").text.to_i
+      end 
+    end
+
+
+    private
+
+    def host; "awis.amazonaws.com" end
+    def path; "/" end
+    def default_params; {"Action" => "UrlInfo"}; end
+
+  end
+end

data/lib/ralexa/version.rb

@@ -1,3 +1,3 @@
 module Ralexa
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/ralexa.rb

@@ -2,11 +2,13 @@
   abstract_service
   canonicalized_query_string
   client
+  result
   lazy_collection
   paginating_collection
   paginator
   session
   top_sites
+  url_info
   uri_signer
   version
 }.each do |file|

data/spec/fixtures/rank.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<aws:UrlInfoResponse xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:Response xmlns:aws="http://awis.amazonaws.com/doc/2005-07-11"><aws:OperationRequest><aws:RequestId>bb3746dc-fe13-aae7-8058-a98caf283873</aws:RequestId></aws:OperationRequest><aws:UrlInfoResult><aws:Alexa>
+
+        <aws:TrafficData>
+          <aws:DataUrl type="canonical">google.com/</aws:DataUrl>
+          <aws:Rank>1</aws:Rank>
+        </aws:TrafficData>
+</aws:Alexa></aws:UrlInfoResult><aws:ResponseStatus xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:StatusCode>Success</aws:StatusCode></aws:ResponseStatus></aws:Response></aws:UrlInfoResponse>

data/spec/session_spec.rb

@@ -9,5 +9,11 @@ module Ralexa
       end
     end
 
+    describe ".url_info" do
+      it "returns a Ralexa::UrlInfo instance" do
+        Session.new("id", "secret").url_info.must_be_kind_of ::Ralexa::UrlInfo
+      end
+    end
+
   end
 end

data/spec/top_sites_spec.rb

@@ -90,9 +90,9 @@ module Ralexa
       end
 
       it "fetches, parses and returns countries" do
-        countries = top_sites.list_countries
-        countries.to_a.size.must_equal 2
-        a, u = countries.to_a
+        countries = top_sites.list_countries.to_a
+        countries.size.must_equal 2
+        a, u = countries
 
         u.name.must_equal "United States"
         u.code.must_equal "US"

data/spec/url_info_spec.rb

@@ -0,0 +1,28 @@
+require_relative "spec_helper"
+
+module Ralexa
+  describe UrlInfo do
+
+    let(:url_info) { UrlInfo.new(client) }
+    let(:client) { MiniTest::Mock.new }
+
+    describe "#rank" do
+      def expected_params
+        {
+          "Action" => "UrlInfo",
+          "ResponseGroup" => "Rank",
+          "Url" => "google.com"
+        }
+      end
+      before do
+        client.expect :get, fixture("rank.xml"),
+          ["awis.amazonaws.com", "/", expected_params]
+      end
+      it "fetches, parses, and returns the site's rank" do
+        rank = url_info.rank("google.com")
+        rank.must_equal 1
+      end 
+    end
+
+  end
+end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: ralexa
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Paul Annesley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70187430114040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *70187430114040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.7
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70187430113620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70187430113620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70187430113160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70187430113160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70187430112740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70187430112740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for Amazon Alexa APIs.
 email:
 - paul@annesley.cc
@@ -74,9 +85,11 @@ files:
 - lib/ralexa/lazy_collection.rb
 - lib/ralexa/paginating_collection.rb
 - lib/ralexa/paginator.rb
+- lib/ralexa/result.rb
 - lib/ralexa/session.rb
 - lib/ralexa/top_sites.rb
 - lib/ralexa/uri_signer.rb
+- lib/ralexa/url_info.rb
 - lib/ralexa/version.rb
 - ralexa.gemspec
 - spec/canonicalized_query_string_spec.rb
@@ -85,47 +98,35 @@ files:
 - spec/fixtures/global-page2.xml
 - spec/fixtures/global-top10.xml
 - spec/fixtures/list_countries.xml
+- spec/fixtures/rank.xml
 - spec/paginator_spec.rb
 - spec/ralexa_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
 - spec/top_sites_spec.rb
 - spec/uri_signer_spec.rb
+- spec/url_info_spec.rb
 homepage: https://github.com/flippa/ralexa
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby client for Amazon Alexa APIs such as TopSites.
-test_files:
-- spec/canonicalized_query_string_spec.rb
-- spec/client_spec.rb
-- spec/fixtures/global-page1.xml
-- spec/fixtures/global-page2.xml
-- spec/fixtures/global-top10.xml
-- spec/fixtures/list_countries.xml
-- spec/paginator_spec.rb
-- spec/ralexa_spec.rb
-- spec/session_spec.rb
-- spec/spec_helper.rb
-- spec/top_sites_spec.rb
-- spec/uri_signer_spec.rb
-has_rdoc: 
+test_files: []