rmoriz-alexa 0.0.4.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wojciech Wnętrzak
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,16 @@
+= Alexa Web Information Service
+
+== Usage
+  Alexa.url_info(:access_key_id => 'key', :secret_access_key => 'secret', :host => 'site.com')
+  # also you can specify option :response_group => 'Rank,ContactInfo' or any other valid group,
+  # see: http://docs.amazonwebservices.com/AlexaWebInfoService/2005-07-11/
+  # default response group takes all the available options
+
+  returns object with methods:
+  :xml_response, :rank, :data_url, :site_title, :site_description, :language_locale, :language_encoding,
+  :links_in_count, :keywords, :related_links, :speed_median_load_time, :speed_percentile,
+  :rank_by_country, :rank_by_city, :usage_statistics
+
+== Copyright
+
+Copyright (c) 2009 Wojciech Wnętrzak. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "alexa"
+    gem.summary = %Q{Alexa Web Information Service library}
+    gem.email = "w.wnetrzak@gmail.com"
+    gem.homepage = "http://github.com/morgoth/alexa"
+    gem.authors = ["Wojciech Wnętrzak"]
+    gem.add_dependency('xml-simple')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "alexa #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/alexa.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{alexa}
+  s.version = "0.0.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wojciech Wnętrzak"]
+  s.date = %q{2009-07-07}
+  s.email = %q{w.wnetrzak@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "alexa.gemspec",
+     "lib/alexa.rb",
+     "lib/alexa/url_info.rb",
+     "test/alexa_test.rb",
+     "test/fixtures/empty.xml",
+     "test/fixtures/polsl.xml",
+     "test/fixtures/polsl_small.xml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/morgoth/alexa}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Alexa Web Information Service library}
+  s.test_files = [
+    "test/alexa_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+    else
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+  end
+end

data/lib/alexa/url_info.rb

@@ -0,0 +1,95 @@
+module Alexa
+  class UrlInfo
+    RESPONSE_GROUP = "Rank,ContactInfo,AdultContent,Speed,Language,Keywords,OwnedDomains,LinksInCount,SiteData,RelatedLinks,RankByCountry,RankByCity,UsageStats"
+    attr_accessor :access_key_id, :secret_access_key, :host, :response_group, :xml_response,
+      :rank, :data_url, :site_title, :site_description, :language_locale, :language_encoding,
+      :links_in_count, :keywords, :related_links, :speed_median_load_time, :speed_percentile,
+      :rank_by_country, :rank_by_city, :usage_statistics
+
+    def initialize(options = {} )
+      @access_key_id = options[:access_key_id] or raise ArgumentError.new("you must specify access_key_id")
+      @secret_access_key = options[:secret_access_key] or raise ArgumentError.new("you must specify secret_access_key")
+      @host = options[:host] or raise ArgumentError.new("you must specify host")
+      @response_group = options[:response_group] || RESPONSE_GROUP
+    end
+
+    def connect
+      action = "UrlInfo"
+      timestamp = ( Time::now ).utc.strftime("%Y-%m-%dT%H:%M:%S.000Z")
+      signature = generate_signature(secret_access_key, action, timestamp)
+      url = generate_url(action, access_key_id, signature, timestamp, response_group, host)
+      response = Net::HTTP.start(url.host) do |http|
+        http.get url.request_uri
+      end
+      @xml_response = handle_response(response).body
+    end
+
+    def parse_xml(xml)
+      xml = XmlSimple.xml_in(force_encoding(xml), 'ForceArray' => false)
+      group = response_group.split(',')
+      alexa = xml['Response']['UrlInfoResult']['Alexa']
+      @rank = alexa['TrafficData']['Rank'].to_i if group.include?('Rank') and !alexa['TrafficData']['Rank'].empty?
+      @data_url = alexa['TrafficData']['DataUrl']['content'] if group.include?('Rank')
+      @rank_by_country = alexa['TrafficData']['RankByCountry']['Country'] if group.include?('RankByCountry')
+      @rank_by_city = alexa['TrafficData']['RankByCity']['City'] if group.include?('RankByCity')
+      @usage_statistics = alexa['TrafficData']['UsageStatistics']["UsageStatistic"] if group.include?('UsageStats') and !alexa['TrafficData']['UsageStatistics'].nil?
+
+      @site_title = alexa['ContentData']['SiteData']['Title'] if group.include?('SiteData')
+      @site_description = alexa['ContentData']['SiteData']['Description'] if group.include?('SiteData')
+      @language_locale = alexa['ContentData']['Language']['Locale'] if group.include?('Language')
+      @language_encoding = alexa['ContentData']['Language']['Encoding'] if group.include?('Language')
+      @links_in_count = alexa['ContentData']['LinksInCount'].to_i if group.include?('LinksInCount') and !alexa['ContentData']['LinksInCount'].empty?
+      @keywords = alexa['ContentData']['Keywords']['Keyword'] if group.include?('Keywords')
+      @speed_median_load_time = alexa['ContentData']['Speed']['MedianLoadTime'].to_i if group.include?('Speed') and !alexa['ContentData']['Speed']['MedianLoadTime'].empty?
+      @speed_percentile = alexa['ContentData']['Speed']['Percentile'].to_i if group.include?('Speed') and !alexa['ContentData']['Speed']['Percentile'].empty?
+
+      @related_links = alexa['Related']['RelatedLinks']['RelatedLink'] if group.include?('RelatedLinks')
+    end
+
+    private
+
+    def force_encoding(xml)
+      if RUBY_VERSION >= '1.9'
+        xml.force_encoding(Encoding::UTF_8)
+      else
+        xml
+      end
+    end
+
+    def handle_response(response)
+      case response.code.to_i
+      when 200...300
+        response
+      when 300...600
+        if response.body.nil?
+          raise StandardError.new(response)
+        else
+          @xml_response = response.body
+          xml = XmlSimple.xml_in(response.body, 'ForceArray' => false)
+          message = xml['Errors']['Error']['Message']
+          raise StandardError.new(message)
+        end
+      else
+        raise StandardError.new("Unknown code: #{respnse.code}")
+      end
+    end
+
+    def generate_signature(secret_acces_key, action, timestamp)
+      Base64.encode64( OpenSSL::HMAC.digest( OpenSSL::Digest::Digest.new( "sha1" ), secret_access_key, action + timestamp)).strip
+    end
+
+    def generate_url(action, access_key_id, signature, timestamp, response_group, host)
+      url = URI.parse(
+          "http://awis.amazonaws.com/?" +
+          {
+            "Action"       => action,
+            "AWSAccessKeyId"  => access_key_id,
+            "Signature"       => signature,
+            "Timestamp"       => timestamp,
+            "ResponseGroup"   => response_group,
+            "Url"           => host
+          }.to_a.collect{|item| item.first + "=" + CGI::escape(item.last) }.join("&")     # Put key value pairs into http GET format
+       )
+    end
+  end
+end

data/lib/alexa.rb

@@ -0,0 +1,21 @@
+#/usr/bin/ruby
+require "cgi"
+require "base64"
+require "openssl"
+require "digest/sha1"
+require "uri"
+require "net/https"
+require "xmlsimple"
+require "time"
+
+require 'alexa/url_info'
+
+module Alexa
+  def self.url_info(options = {})
+    url_info = Alexa::UrlInfo.new(options)
+    xml = url_info.connect
+    url_info.parse_xml(xml)
+    url_info
+  end
+end
+

data/test/alexa_test.rb

@@ -0,0 +1,224 @@
+require 'test_helper'
+
+class AlexaTest < Test::Unit::TestCase
+  context "Alexa::UrlInfo" do
+    setup do
+      @alexa = Alexa::UrlInfo.new(
+      :access_key_id =>  "12345678901234567890",
+      :secret_access_key =>  "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDF",
+      :host => "some.host"
+      )
+    end
+
+    should "Generate signature" do
+      signature = @alexa.send :generate_signature, @alexa.secret_access_key, "UrlInfo", '2009-07-03T07:22:24.000Z'
+      assert_equal "I1mPdBy+flhhzqqUaamNq9gq190=", signature
+    end
+
+    should "Generate url" do
+      url = @alexa.send( :generate_url,
+      "UrlInfo",
+      @alexa.access_key_id,
+      "I1mPdBy+flhhzqqUaamNq9gq190=",
+      '2009-07-03T07:22:24.000Z',
+      "Rank,ContactInfo,AdultContent,Speed,Language,Keywords,OwnedDomains,LinksInCount,SiteData,RelatedLinks",
+      "heroku.com"
+      )
+      if RUBY_VERSION >= '1.9'
+        expected_uri = "/?Action=UrlInfo&AWSAccessKeyId=12345678901234567890&Signature=I1mPdBy%2BflhhzqqUaamNq9gq190%3D&Timestamp=2009-07-03T07%3A22%3A24.000Z&ResponseGroup=Rank%2CContactInfo%2CAdultContent%2CSpeed%2CLanguage%2CKeywords%2COwnedDomains%2CLinksInCount%2CSiteData%2CRelatedLinks&Url=heroku.com"
+      else
+        expected_uri = "/?Action=UrlInfo&Signature=I1mPdBy%2BflhhzqqUaamNq9gq190%3D&AWSAccessKeyId=12345678901234567890&Url=heroku.com&Timestamp=2009-07-03T07%3A22%3A24.000Z&ResponseGroup=Rank%2CContactInfo%2CAdultContent%2CSpeed%2CLanguage%2CKeywords%2COwnedDomains%2CLinksInCount%2CSiteData%2CRelatedLinks"
+        assert_equal expected_uri, url.request_uri
+      end
+      assert_equal "awis.amazonaws.com", url.host
+    end
+
+    context "should parse xml return by options LinksInCount,SiteData and" do
+      setup do
+        @alexa.response_group = "Rank,LinksInCount,SiteData"
+        xml = fixture_file('polsl_small.xml')
+        @alexa.parse_xml(xml)
+      end
+
+      should "return rank" do
+        assert_equal 86020, @alexa.rank
+      end
+
+      should "return data url" do
+        assert_equal "polsl.pl/", @alexa.data_url
+      end
+
+      should "return site title" do
+        assert_equal "Silesian University of Technology", @alexa.site_title
+      end
+
+      should "return site description" do
+        assert_equal "About the university, studies, faculties and departments, photo gallery.", @alexa.site_description
+      end
+
+      should "not crash" do
+        assert_nothing_raised do
+          @alexa.language_locale
+        end
+        assert_nil @alexa.language_locale
+      end
+    end
+
+    context "should parse xml with all options and" do
+      setup do
+        xml = fixture_file('polsl.xml')
+        @alexa.parse_xml(xml)
+      end
+
+      should "return rank" do
+        assert_equal 86020, @alexa.rank
+      end
+
+      should "return data url" do
+        assert_equal "polsl.pl", @alexa.data_url
+      end
+
+      should "return site title" do
+        assert_equal "Silesian University of Technology", @alexa.site_title
+      end
+
+      should "return site description" do
+        assert_equal "About the university, studies, faculties and departments, photo gallery.", @alexa.site_description
+      end
+
+      should "return language locale" do
+        assert_equal "pl-PL", @alexa.language_locale
+      end
+
+      should "return language encoding" do
+        assert_equal "iso-8859-2", @alexa.language_encoding
+      end
+
+      should "return links in count" do
+        assert_equal 281, @alexa.links_in_count
+      end
+
+      should "return keywords" do
+        assert_equal ["Polska", "Regionalne", "Gliwice"], @alexa.keywords
+      end
+
+      should "return related links" do
+        assert_equal 10, @alexa.related_links.count
+      end
+
+      should "return speed_median load time" do
+        assert_equal 266, @alexa.speed_median_load_time
+      end
+
+      should "return speed percentile" do
+        assert_equal 98, @alexa.speed_percentile
+      end
+
+      should "return rank by country" do
+        assert_equal 3, @alexa.rank_by_country.count
+      end
+
+      should "return rank by city" do
+        assert_equal 68, @alexa.rank_by_city.count
+      end
+
+      should "return usage statistics" do
+        assert_equal 4, @alexa.usage_statistics.count
+      end
+
+    end
+
+    context "should not crash when parsing empty xml response and" do
+      setup do
+        xml = fixture_file('empty.xml')
+        @alexa.parse_xml(xml)
+      end
+
+      should "return nil" do
+        assert_nil @alexa.rank
+      end
+
+      should "return nil" do
+        assert_nil @alexa.data_url
+      end
+
+      should "return nil" do
+        assert_nil @alexa.site_title
+      end
+
+      should "return nil" do
+        assert_nil @alexa.site_description
+      end
+
+      should "return nil" do
+        assert_nil @alexa.language_locale
+      end
+
+      should "return nil" do
+        assert_nil @alexa.language_encoding
+      end
+
+      should "return nil" do
+        assert_nil @alexa.links_in_count
+      end
+
+      should "return nil" do
+        assert_nil @alexa.keywords
+      end
+
+      should "return nil" do
+        assert_nil @alexa.related_links
+      end
+
+      should "return nil" do
+        assert_nil @alexa.speed_median_load_time
+      end
+
+      should "return nil" do
+        assert_nil @alexa.speed_percentile
+      end
+
+      should "return nil" do
+        assert_nil @alexa.rank_by_country
+      end
+
+      should "return nil" do
+        assert_nil @alexa.rank_by_city
+      end
+
+      should "return nil" do
+        assert_nil @alexa.usage_statistics
+      end
+
+    end
+
+    should "not raise error when response is OK" do
+      assert_nothing_raised do
+        @alexa.send :handle_response, Net::HTTPOK.new("1.1", "200", "OK")
+      end
+    end
+  end
+
+  should "Raise argumment error if keys or host are not present" do
+    assert_raise ArgumentError do
+      Alexa::UrlInfo.new(
+      :secret_access_key =>  "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDF",
+      :host => "some.host"
+      )
+    end
+
+    assert_raise ArgumentError do
+      Alexa::UrlInfo.new(
+      :access_key_id =>  "12345678901234567890",
+      :host => "some.host"
+      )
+    end
+
+    assert_raise ArgumentError do
+      Alexa::UrlInfo.new(
+      :access_key_id =>  "12345678901234567890",
+      :secret_access_key =>  "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDF"
+      )
+    end
+  end
+end  

data/test/fixtures/empty.xml

@@ -0,0 +1,39 @@
+<?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>6a12c8f4-056f-4fce-95cd-2f9d2a353236</aws:RequestId></aws:OperationRequest><aws:UrlInfoResult><aws:Alexa>
+  
+  <aws:ContactInfo>
+    <aws:DataUrl type="canonical">404</aws:DataUrl>
+    <aws:PhoneNumbers>
+      <aws:PhoneNumber/>
+    </aws:PhoneNumbers>
+    <aws:OwnerName/>
+    <aws:Email/>
+    <aws:PhysicalAddress/>
+    <aws:CompanyStockTicker/>
+  </aws:ContactInfo>
+  <aws:ContentData>
+    <aws:DataUrl type="canonical">404</aws:DataUrl>
+    <aws:SiteData>
+      <aws:Title>404</aws:Title>
+    </aws:SiteData>
+    <aws:Speed>
+      <aws:MedianLoadTime/>
+      <aws:Percentile/>
+    </aws:Speed>
+    <aws:AdultContent/>
+    <aws:Language/>
+    <aws:LinksInCount/>
+    <aws:Keywords/>
+    <aws:OwnedDomains/>
+  </aws:ContentData>
+  <aws:Related>
+    <aws:DataUrl type="canonical">404</aws:DataUrl>
+    <aws:RelatedLinks/>
+  </aws:Related>
+  <aws:TrafficData>
+    <aws:DataUrl type="canonical">404</aws:DataUrl>
+    <aws:Rank/>
+    <aws:RankByCountry/>
+    <aws:RankByCity/>
+  </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>