ralexa 0.0.2 → 0.0.3

data/README.md

@@ -41,19 +41,20 @@ session = Ralexa.session("aws_access_key_id", "aws_secret_access_key")
 
 # all countries
 countries = session.top_sites.list_countries
+p countries.map(&:name)
 
-# global top sites
-global = session.top_sites.global
+# global top 250 sites
+global = session.top_sites.global(250)
 
 # per-country top sites
 first_by_country = {}
 countries.each do |c|
-  first_by_country[c.name] = session.top_sites.country(c.code).first.url
+  first_by_country[c.name] = session.top_sites.country(c.code, 1).first.url
 end
 
 # individual country lookup
-puts "Top Australian Sites"
-session.top_sites.country("AU").each do |s|
+puts "Top Ten Australian Sites"
+session.top_sites.country("AU", 10).each do |s|
   puts "#{s.url} (#{s.page_views} pageviews)"
 end
 

data/lib/ralexa/abstract_service.rb

@@ -0,0 +1,41 @@
+module Ralexa
+  class AbstractService
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    # A lazy collection which fetches records on demand.
+    def collection(*params, &parser)
+      LazyCollection.new(
+        @client,
+        host,
+        path,
+        merged_params(*params),
+        &parser
+      )
+    end
+
+    def paginating_collection(limit, per_page, *params, &parser)
+      PaginatingCollection.new(
+        @client,
+        host,
+        path,
+        merged_params(*params),
+        limit,
+        per_page,
+        &parser
+      )
+    end
+
+    # A hash of the provided params hashes merged into the default_params.
+    def merged_params(*params)
+      params.reduce(default_params) do |merged, params|
+        merged.merge(params)
+      end
+    end
+
+  end
+end

data/lib/ralexa/client.rb

@@ -1,8 +1,6 @@
 require "addressable/uri"
 require "net/http"
 
-require "ralexa/uri_signer"
-
 module Ralexa
   class Client
 

data/lib/ralexa/lazy_collection.rb

@@ -0,0 +1,35 @@
+require "nokogiri"
+
+module Ralexa
+  class LazyCollection
+
+    include Enumerable
+
+    def initialize(client, host, path, parameters, &parser)
+      @client = client
+      @host = host
+      @path = path
+      @parameters = parameters
+      @parser = parser
+    end
+
+    def each
+      parse(fetch(@parameters)).each do |item|
+        yield item
+      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/paginating_collection.rb

@@ -0,0 +1,36 @@
+module Ralexa
+  class PaginatingCollection < LazyCollection
+
+    def initialize(client, host, path, parameters, limit, per_page, &parser)
+      validate_parameters(parameters)
+      super(client, host, path, parameters, &parser)
+      @limit = limit
+      @per_page = per_page
+    end
+
+    def each
+      Paginator.new(@per_page, @limit).pages.each do |page|
+        parse(fetch(parameters(page))).each do |item|
+          yield item
+        end
+      end
+    end
+
+    private
+
+    def parameters(page)
+      @parameters.merge("Start" => page.start, "Count" => page.count)
+    end
+
+    def validate_parameters(parameters)
+      parameters.keys.each do |k|
+        if %w{start count}.include?(k.to_s.downcase)
+          raise Error,
+            "Limit & Count must not be specified for PaginatingCollection"
+        end
+      end
+    end
+
+    Error = Class.new(StandardError)
+  end
+end

data/lib/ralexa/paginator.rb

@@ -0,0 +1,57 @@
+module Ralexa
+  class Paginator
+
+    def initialize(per_page, items)
+      @per_page = per_page
+      @items = items
+    end
+
+    def pages
+      page_count.times.map do |i|
+        Page.new(page_count, @per_page, @items, i)
+      end
+    end
+
+    private
+
+    def page_count
+      Rational(@items, @per_page).ceil
+    end
+
+    class Page
+
+      def initialize(page_count, per_page, items, index)
+        @page_count = page_count
+        @per_page = per_page
+        @items = items
+        @index = index
+      end
+
+      def number
+        @index + 1
+      end
+
+      def start
+        (@index * @per_page) + 1
+      end
+
+      def finish
+        start + count - 1
+      end
+
+      def count
+        if full? then @per_page else @items % @per_page end
+      end
+
+      def full?
+        number < @page_count || @items % @per_page == 0
+      end
+
+      def partial?
+        !full?
+      end
+
+    end
+
+  end
+end

data/lib/ralexa/session.rb

@@ -1,6 +1,3 @@
-require "ralexa/client"
-require "ralexa/top_sites"
-
 module Ralexa
   class Session
 

data/lib/ralexa/top_sites.rb

@@ -1,37 +1,43 @@
-require "ralexa/abstract_xml_service"
-
 module Ralexa
-  class TopSites < AbstractXmlService
+  class TopSites < AbstractService
+
+    PER_PAGE = 100
 
     # A global list of top sites.
-    def global(params = {})
-      top_sites_from_document(dispatch(
+    def global(limit, params = {})
+      paginating_collection(
+        limit,
+        PER_PAGE,
         {"ResponseGroup" => "Country"},
-        params
-      ))
+        params,
+        &top_sites_parser
+      )
     end
 
     # Top sites for the specified two letter country code.
-    def country(code, params = {})
-      top_sites_from_document(dispatch(
+    def country(code, limit, params = {})
+      paginating_collection(
+        limit,
+        PER_PAGE,
         {"ResponseGroup" => "Country", "CountryCode" => code.to_s.upcase},
-        params
-      ))
+        params,
+        &top_sites_parser
+      )
     end
 
     # All countries that have Alexa top sites.
     def list_countries(params = {})
-      dispatch(
-        {"ResponseGroup" => "ListCountries"},
-        params
-      ).at("//TopSitesResult/Alexa/TopSites/Countries").elements.map do |node|
-        Country.new(
-          node.at("Name").text,
-          node.at("Code").text,
-          node.at("TotalSites").text.to_i,
-          node.at("PageViews").text.to_f * 1_000_000,
-          node.at("Users").text.to_f * 1_000_000,
-        )
+      collection({"ResponseGroup" => "ListCountries"}, params) do |document|
+        path = "//TopSitesResult/Alexa/TopSites/Countries"
+        document.at(path).elements.map do |node|
+          Country.new(
+            node.at("Name").text,
+            node.at("Code").text,
+            node.at("TotalSites").text.to_i,
+            node.at("PageViews").text.to_f * 1_000_000,
+            node.at("Users").text.to_f * 1_000_000,
+          )
+        end
       end
     end
 
@@ -41,16 +47,18 @@ module Ralexa
     def path; "/" end
     def default_params; {"Action" => "TopSites"} end
 
-    def top_sites_from_document(document)
-      document.at("//TopSites/Country/Sites").elements.map do |node|
-        Site.new(
-          node.at("DataUrl").text,
-          node.at("Country/Rank").text.to_i,
-          node.at("Country/Reach/PerMillion").text.to_i * 1_000_000,
-          (node.at("Country/PageViews/PerMillion").text.to_f * 1_000_000).to_i,
-          node.at("Country/PageViews/PerUser").text.to_f
-        )
-      end
+    def top_sites_parser
+      ->(document){
+        document.at("//TopSites/Country/Sites").elements.map do |node|
+          Site.new(
+            node.at("DataUrl").text,
+            node.at("Country/Rank").text.to_i,
+            node.at("Country/Reach/PerMillion").text.to_i * 1_000_000,
+            (node.at("Country/PageViews/PerMillion").text.to_f * 1_000_000).to_i,
+            node.at("Country/PageViews/PerUser").text.to_f
+          )
+        end
+      }
     end
 
     Country = Struct.new(:name, :code, :total_sites, :page_views, :users)

data/lib/ralexa/uri_signer.rb

@@ -2,8 +2,6 @@ require "base64"
 require "digest/sha2"
 require "openssl"
 
-require "ralexa/canonicalized_query_string"
-
 module Ralexa
   class UriSigner
 

data/lib/ralexa/version.rb

@@ -1,3 +1,3 @@
 module Ralexa
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/ralexa.rb

@@ -1,7 +1,10 @@
 %w{
-  abstract_xml_service
+  abstract_service
   canonicalized_query_string
   client
+  lazy_collection
+  paginating_collection
+  paginator
   session
   top_sites
   uri_signer

data/spec/canonicalized_query_string_spec.rb

@@ -2,8 +2,6 @@
 
 require_relative "spec_helper"
 
-require "ralexa/canonicalized_query_string"
-
 module Ralexa
   describe CanonicalizedQueryString do
 

data/spec/client_spec.rb

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