ralexa 0.0.2 → 0.0.3

data/spec/fixtures/global-top10.xml

@@ -0,0 +1,173 @@
+<?xml version="1.0"?>
+<aws:TopSitesResponse xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:Response xmlns:aws="http://ats.amazonaws.com/doc/2005-11-21"><aws:OperationRequest><aws:RequestId>59620de1-abbc-4966-7f20-b17a55767c15</aws:RequestId></aws:OperationRequest><aws:TopSitesResult><aws:Alexa>
+  
+  <aws:TopSites>
+    <aws:Country>
+      <aws:CountryName>GLOBAL</aws:CountryName>
+      <aws:CountryCode>*</aws:CountryCode>
+      <aws:TotalSites>365603</aws:TotalSites>
+      <aws:Sites>
+        <aws:Site>
+          <aws:DataUrl>google.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>1</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>501800</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>54926</aws:PerMillion>
+              <aws:PerUser>11.63</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>1</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>facebook.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>2</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>440400</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>51798</aws:PerMillion>
+              <aws:PerUser>12.5</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>2</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>youtube.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>3</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>323700</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>38756</aws:PerMillion>
+              <aws:PerUser>12.73</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>3</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>yahoo.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>4</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>222300</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>13620</aws:PerMillion>
+              <aws:PerUser>6.51</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>4</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>baidu.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>5</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>110500</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>19142</aws:PerMillion>
+              <aws:PerUser>18.41</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>5</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>wikipedia.org</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>6</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>141700</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>5191</aws:PerMillion>
+              <aws:PerUser>3.89</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>6</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>live.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>7</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>106270</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>6526</aws:PerMillion>
+              <aws:PerUser>6.53</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>7</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>blogspot.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>8</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>102250</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>3324</aws:PerMillion>
+              <aws:PerUser>3.45</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>8</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>qq.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>9</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>73830</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>6274</aws:PerMillion>
+              <aws:PerUser>9.03</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>9</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+        <aws:Site>
+          <aws:DataUrl>twitter.com</aws:DataUrl>
+          <aws:Country>
+            <aws:Rank>10</aws:Rank>
+            <aws:Reach>
+              <aws:PerMillion>82710</aws:PerMillion>
+            </aws:Reach>
+            <aws:PageViews>
+              <aws:PerMillion>3687</aws:PerMillion>
+              <aws:PerUser>4.74</aws:PerUser>
+            </aws:PageViews>
+          </aws:Country>
+          <aws:Global>
+            <aws:Rank>10</aws:Rank>
+          </aws:Global>
+        </aws:Site>
+      </aws:Sites>
+    </aws:Country>
+  </aws:TopSites>
+</aws:Alexa></aws:TopSitesResult><aws:ResponseStatus xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:StatusCode>Success</aws:StatusCode></aws:ResponseStatus></aws:Response></aws:TopSitesResponse>

data/spec/paginator_spec.rb

@@ -0,0 +1,55 @@
+require_relative "spec_helper"
+
+module Ralexa
+  describe Paginator do
+
+    describe "at 10 per page" do
+
+      def paginate(items)
+        Paginator.new(10, items).pages
+      end
+
+      it "paginates 0 items to 0 pages" do
+        paginate(0).size.must_equal 0
+      end
+
+      it "paginates 1 item to 1 page" do
+        pages = paginate(1)
+        pages.size.must_equal 1
+        pages.first.tap do |p|
+          p.number.must_equal 1
+          p.start.must_equal 1
+          p.finish.must_equal 1
+          p.count.must_equal 1
+        end
+      end
+
+      it "paginates 10 items to 1 page" do
+        pages = paginate(10)
+        pages.size.must_equal 1
+        pages.first.count.must_equal 10
+      end
+
+      it "paginages 25 items to 3 pages" do
+        pages = paginate(25)
+        pages.size.must_equal 3
+
+        pages.first.tap do |p|
+          p.number.must_equal 1
+          p.start.must_equal 1
+          p.finish.must_equal 10
+          p.count.must_equal 10
+        end
+
+        pages.last.tap do |p|
+          p.number.must_equal 3
+          p.start.must_equal 21
+          p.finish.must_equal 25
+          p.count.must_equal 5
+        end
+      end
+
+    end
+
+  end
+end

data/spec/ralexa_spec.rb

@@ -1,7 +1,5 @@
 require_relative "spec_helper"
 
-require "ralexa"
-
 describe Ralexa do
 
   describe ".session" do

data/spec/session_spec.rb

@@ -1,7 +1,5 @@
 require_relative "spec_helper"
 
-require "ralexa/session"
-
 module Ralexa
   describe Session do
 

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 gem "minitest"
 require "minitest/autorun"
+
 $LOAD_PATH.unshift "./lib"
+require "ralexa"
 
 def fixture(filename)
   File.read("#{File.dirname(__FILE__)}/fixtures/#{filename}")

data/spec/top_sites_spec.rb

@@ -1,7 +1,5 @@
 require_relative "spec_helper"
 
-require "ralexa/top_sites"
-
 module Ralexa
   describe TopSites do
 
@@ -9,31 +7,75 @@ module Ralexa
     let(:client) { MiniTest::Mock.new }
 
     describe "#global" do
-      before do
-        expect_parameters = {
+      def expected_params(start, count)
+        {
           "Action" => "TopSites",
           "ResponseGroup" => "Country",
+          "Start" => start,
+          "Count" => count,
         }
-        client.expect :get, fixture("global.xml"),
-          ["ats.amazonaws.com", "/", expect_parameters]
       end
-      it "fetches, parses and returns top sites" do
-        top_sites_match_fixture(top_sites.global)
+      describe "requesting ten sites" do
+        before do
+          client.expect :get, fixture("global-top10.xml"),
+            ["ats.amazonaws.com", "/", expected_params(1, 10)]
+        end
+        it "fetches, parses and returns top ten sites" do
+          sites = top_sites.global(10).to_a
+          sites.size.must_equal 10
+          [ sites.first.rank, sites.last.rank ].must_equal [ 1, 10 ]
+
+          g = sites.first
+          g.url.must_equal "google.com"
+          g.rank.must_equal 1
+          g.reach.must_equal 501_800_000_000
+          g.page_views.must_equal 54_926_000_000
+          g.page_views_per_user.must_equal 11.63
+        end
+      end
+      describe "requesting 150 sites" do
+        before do
+          client.expect :get, fixture("global-page1.xml"),
+            ["ats.amazonaws.com", "/", expected_params(1, 100)]
+          client.expect :get, fixture("global-page2.xml"),
+            ["ats.amazonaws.com", "/", expected_params(101, 50)]
+        end
+        it "fetches, parses and returns top ten sites" do
+          sites = top_sites.global(150).to_a
+          sites.size.must_equal 150
+          [ sites.first.rank, sites.last.rank ].must_equal [ 1, 150 ]
+        end
+      end
+      it "raises error if Count (or Start) are specified" do
+        ->{
+          top_sites.global(10, "Count" => 2)
+        }.must_raise PaginatingCollection::Error
       end
     end
 
     describe "#country" do
-      before do
-        expect_parameters = {
+      def expected_params(start, count)
+        {
           "Action" => "TopSites",
           "ResponseGroup" => "Country",
           "CountryCode" => "AU",
+          "Start" => start,
+          "Count" => count,
         }
-        client.expect :get, fixture("global.xml"),
-          ["ats.amazonaws.com", "/", expect_parameters]
+      end
+      before do
+        client.expect :get, fixture("global-top10.xml"),
+          ["ats.amazonaws.com", "/", expected_params(1, 10)]
       end
       it "fetches, parses and returns top sites for specified country" do
-        top_sites_match_fixture(top_sites.country("AU"))
+        sites = top_sites.country("AU", 10).to_a
+        sites.size.must_equal 10
+        sites.last.url.must_equal "twitter.com"
+      end
+      it "raises error if Start (or Count) are specified" do
+        ->{
+          top_sites.country("AU", 10, start: 2)
+        }.must_raise PaginatingCollection::Error
       end
     end
 
@@ -49,8 +91,8 @@ module Ralexa
 
       it "fetches, parses and returns countries" do
         countries = top_sites.list_countries
-        countries.size.must_equal 2
-        a, u = countries
+        countries.to_a.size.must_equal 2
+        a, u = countries.to_a
 
         u.name.must_equal "United States"
         u.code.must_equal "US"
@@ -66,22 +108,5 @@ module Ralexa
       end
     end
 
-    def top_sites_match_fixture(sites)
-        sites.size.must_equal 2
-        w, b = sites
-
-        w.url.must_equal "wikipedia.org"
-        w.rank.must_equal 6
-        w.reach.must_equal 143_000_000_000
-        w.page_views.must_equal 5_219_000_000
-        w.page_views_per_user.must_equal 3.88
-
-        b.url.must_equal "bbc.co.uk"
-        b.rank.must_equal 52
-        b.reach.must_equal 20_540_000_000
-        b.page_views.must_equal 898_500_000
-        b.page_views_per_user.must_equal 4.65
-    end
-
   end
 end

data/spec/uri_signer_spec.rb

@@ -1,7 +1,6 @@
 require_relative "spec_helper"
 
 require "addressable/uri"
-require "ralexa/uri_signer"
 
 module Ralexa
   describe UriSigner do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ralexa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70311985014320 !ruby/object:Gem::Requirement
+  requirement: &70339587667200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311985014320
+  version_requirements: *70339587667200
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70311985013900 !ruby/object:Gem::Requirement
+  requirement: &70339587666780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311985013900
+  version_requirements: *70339587666780
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70311985013480 !ruby/object:Gem::Requirement
+  requirement: &70339587666360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311985013480
+  version_requirements: *70339587666360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70311985013060 !ruby/object:Gem::Requirement
+  requirement: &70339587665940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311985013060
+  version_requirements: *70339587665940
 description: Ruby client for Amazon Alexa APIs.
 email:
 - paul@annesley.cc
@@ -68,9 +68,12 @@ files:
 - README.md
 - Rakefile
 - lib/ralexa.rb
-- lib/ralexa/abstract_xml_service.rb
+- lib/ralexa/abstract_service.rb
 - lib/ralexa/canonicalized_query_string.rb
 - lib/ralexa/client.rb
+- lib/ralexa/lazy_collection.rb
+- lib/ralexa/paginating_collection.rb
+- lib/ralexa/paginator.rb
 - lib/ralexa/session.rb
 - lib/ralexa/top_sites.rb
 - lib/ralexa/uri_signer.rb
@@ -78,8 +81,11 @@ files:
 - ralexa.gemspec
 - spec/canonicalized_query_string_spec.rb
 - spec/client_spec.rb
-- spec/fixtures/global.xml
+- 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
@@ -112,8 +118,11 @@ 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.xml
+- 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

data/lib/ralexa/abstract_xml_service.rb

@@ -1,27 +0,0 @@
-require "nokogiri"
-
-module Ralexa
-  class AbstractXmlService
-
-    def initialize(client)
-      @client = client
-    end
-
-    private
-
-    # Returns the response as an XML document stripped of namespaces.
-    def dispatch(*params)
-      Nokogiri::XML.parse(
-        @client.get(host, path, merged_params(*params))
-      ).remove_namespaces!
-    end
-
-    # A hash of the provided params hashes merged into the default_params.
-    def merged_params(*params)
-      params.reduce(default_params) do |merged_params, params|
-        merged_params.merge(params)
-      end
-    end
-
-  end
-end

data/spec/fixtures/global.xml

@@ -1,45 +0,0 @@
-<?xml version="1.0"?>
-<aws:TopSitesResponse xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:Response xmlns:aws="http://ats.amazonaws.com/doc/2005-11-21"><aws:OperationRequest><aws:RequestId>8a6c3a3f-a3c8-48d8-4775-3914d8f36e88</aws:RequestId></aws:OperationRequest><aws:TopSitesResult><aws:Alexa>
-  
-  <aws:TopSites>
-    <aws:Country>
-      <aws:CountryName>GLOBAL</aws:CountryName>
-      <aws:CountryCode>*</aws:CountryCode>
-      <aws:TotalSites>366720</aws:TotalSites>
-      <aws:Sites>
-        <aws:Site>
-          <aws:DataUrl>wikipedia.org</aws:DataUrl>
-          <aws:Country>
-            <aws:Rank>6</aws:Rank>
-            <aws:Reach>
-              <aws:PerMillion>143000</aws:PerMillion>
-            </aws:Reach>
-            <aws:PageViews>
-              <aws:PerMillion>5219</aws:PerMillion>
-              <aws:PerUser>3.88</aws:PerUser>
-            </aws:PageViews>
-          </aws:Country>
-          <aws:Global>
-            <aws:Rank>6</aws:Rank>
-          </aws:Global>
-        </aws:Site>
-        <aws:Site>
-          <aws:DataUrl>bbc.co.uk</aws:DataUrl>
-          <aws:Country>
-            <aws:Rank>52</aws:Rank>
-            <aws:Reach>
-              <aws:PerMillion>20540</aws:PerMillion>
-            </aws:Reach>
-            <aws:PageViews>
-              <aws:PerMillion>898.5</aws:PerMillion>
-              <aws:PerUser>4.65</aws:PerUser>
-            </aws:PageViews>
-          </aws:Country>
-          <aws:Global>
-            <aws:Rank>52</aws:Rank>
-          </aws:Global>
-        </aws:Site>
-      </aws:Sites>
-    </aws:Country>
-  </aws:TopSites>
-</aws:Alexa></aws:TopSitesResult><aws:ResponseStatus xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/"><aws:StatusCode>Success</aws:StatusCode></aws:ResponseStatus></aws:Response></aws:TopSitesResponse>