awis4ruby 0.9.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.9.0 / 2007-08-29
+
+* Initial Gem release
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/awis4ruby
+lib/awis4ruby.rb
+lib/url_info.rb
+test/test_awis4ruby.rb

data/README.txt

@@ -0,0 +1,60 @@
+awis4ruby
+    by VotanWeb
+    http://labs.votanweb.com/awis4ruby/
+
+== DESCRIPTION:
+  
+AWIS4Ruby simplifies accessing the Alexa Web Information Service by
+encapsulating all of the network connections and XML parsing into an
+incredibly easy to use interface.
+
+== FEATURES/PROBLEMS:
+  
+* Up-to-date Ruby client
+* Allows simple access to most popular AWIS data
+
+== SYNOPSIS:
+
+ACCESS_KEY_ID = "05RTY5ESSE0EDGR68G2"
+SECRET_ACCESS_KEY = "1tmO+Tgvp0YU/ZOTwUTRYui7JppEc/lSMSD"
+host = 'votanweb.com'
+info = AWIS4Ruby::get_url_info(ACCESS_KEY_ID, SECRET_ACCESS_KEY, host)
+p info.online_since.strftime('%m-%d-%Y')
+p info.rank   # traffic rank
+
+== REQUIREMENTS:
+
+* OpenSSL must be installed
+* Sign up for an Amazon Web Services account at http://aws.amazon.com
+* Get your Access Key ID and Secret Access Key
+* Sign up for the Alexa Web Information Service at http://aws.amazon.com/awis
+* Tell others about this project
+
+== INSTALL:
+
+* sudo gem install awis4ruby --include-dependencies
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007  labs.VotanWeb.com
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/awis4ruby.rb'
+
+Hoe.new('awis4ruby', AWIS4Ruby::VERSION) do |p|
+  p.rubyforge_name = 'awis4ruby'
+  p.author = 'Jay Owack'
+  p.email = 'owack.j@gmail.com'
+  p.summary = 'Simple Ruby client for the Alexa Web Information Service.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = 'http://labs.votanweb.com/awis4ruby/'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/awis4ruby.rb

@@ -0,0 +1,126 @@
+require "cgi"
+require "base64"
+require "openssl"
+require "digest/sha1"
+require "uri"
+require "net/https"
+require "rexml/document"
+require "time"
+require File.dirname(__FILE__) + "/url_info"
+
+module AWIS4Ruby
+
+  VERSION = '0.9.0'
+  
+  def self.get_url_info(access_key_id, secret_access_key, url)    
+    action = "UrlInfo"
+    responseGroup = "Rank,ContactInfo,AdultContent,Speed,Language,Keywords,OwnedDomains,LinksInCount,SiteData,RelatedLinks"      
+    timestamp = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.000Z")      
+    signature = Base64.encode64( OpenSSL::HMAC.digest( OpenSSL::Digest::Digest.new( "sha1" ), secret_access_key, action + timestamp)).strip      
+    awis_url = URI.parse(                      
+          "http://awis.amazonaws.com/?" +
+    {
+            "Action"       => action,
+            "AWSAccessKeyId"  => access_key_id,
+            "Signature"       => signature,
+            "Timestamp"       => timestamp,
+            "ResponseGroup"   => responseGroup,
+            "Url"           => url
+    }.to_a.collect{|item| item.first + "=" + CGI::escape(item.last) }.join("&")     # Put key value pairs into http GET format
+    )
+    resp = Net::HTTP.get(awis_url)
+    
+    xml  = REXML::Document.new(resp)            
+    url_info = AWIS4Ruby::UrlInfo.new  
+    url_info.awis_url = awis_url    
+    url_info.full_xml = resp
+    url_info.domain_name = domain_from_url(url)
+    ## traffic rank
+    url_info.rank = element_int xml.elements["//aws:TrafficData/aws:Rank"]
+    ## adult content
+    ac = element_text xml.elements["//aws:ContentData/aws:AdultContent"]
+    if ac.eql?("yes")
+      url_info.adult_content = true
+    else
+      url_info.adult_content = false
+    end      
+    ## contact info
+    url_info.contact_email = element_text xml.elements["//aws:ContactInfo/aws:Email"]
+    url_info.contact_address = element_text xml.elements["//aws:ContactInfo/aws:PhysicalAddress"]
+    url_info.owner_name = element_text xml.elements["//aws:ContactInfo/aws:OwnerName"]
+    url_info.stock_ticker = element_text xml.elements["//aws:CompanyStockTicker"]
+    xml.elements.each("*//aws:PhoneNumber") do |el|
+      url_info.phone_numbers << el.text if el
+    end
+    ## site data
+    url_info.site_title = element_text xml.elements["//aws:SiteData/aws:Title"]
+    url_info.site_description = element_text xml.elements["//aws:SiteData/aws:Description"]
+    ol_since = xml.elements["//aws:SiteData/aws:OnlineSince"]
+    #url_info.online_since = element_text xml.elements["//aws:SiteData/aws:OnlineSince"]
+    if ol_since
+      url_info.online_since = Time.local(*(ParseDate.parsedate(ol_since.text)))
+    end    
+    ## speed
+    url_info.speed_percentile = element_int xml.elements["//aws:Speed/aws:Percentile"]
+    url_info.load_time = element_int xml.elements["//aws:Speed/aws:MedianLoadTime"]
+    # language
+    url_info.language_locale = element_text xml.elements["//aws:Language/aws:Locale"]
+    url_info.language_encoding = element_text xml.elements["//aws:Language/aws:Encoding"]
+    # links in
+    url_info.links_in_count = element_int xml.elements["//aws:LinksInCount"]
+    # keywords
+    xml.elements.to_a("//aws:Keywords/aws:Keyword").collect do |i|
+      url_info.keywords << i.text if i
+    end
+    # related links    
+    xml.elements.to_a("//aws:RelatedLink").collect do |i|
+      my_map = Hash.new
+      if i
+        my_map[:url] = element_text i.elements["aws:NavigableUrl"]
+        my_map[:title] = element_text i.elements["aws:Title"]
+        my_map[:relevance] = element_int i.elements["aws:Relevance"]
+        url_info.related_links << my_map
+      end
+    end
+    
+    return url_info   
+  end
+  
+  
+  def self.domain_from_url(url)
+    return url.host if url.class == URI::HTTP
+    if url !~ /^\w+:\/\//
+      url = "http://" + url
+    end
+    uri = URI.parse(url)
+    host = uri.host.downcase
+    if(host =~ /^[\w\.-]+\.(\w+\.\w\w\.\w\w)$/)  # www.bulldogbreeds.co.uk
+      domain = $1
+    elsif(host =~ /^[\w\.-]+\.(\w+\w\w\.\w\w+)$/) # www.bulldogbreeds.com
+      domain = $1
+    else
+      domain = host
+    end
+    return domain
+  end
+  
+  
+  def self.element_text(el)
+    if el then el.text
+    else ''
+    end
+  end
+  
+  
+  def self.element_int(el)   
+    begin 
+      return el.text.to_i if el && el.text
+    rescue
+      return -1
+    end
+    el
+  end  
+  
+end
+
+

data/lib/url_info.rb

@@ -0,0 +1,55 @@
+
+
+module AWIS4Ruby
+  
+  class UrlInfo
+    # ContactInfo
+    attr_accessor :phone_numbers, :owner_name, :contact_email, :contact_address, :stock_ticker, 
+    # ContentData
+    :site_title, :site_description, :online_since, :speed_percentile, :load_time,
+    :adult_content, :links_in_count, :language_locale, :language_encoding, :keywords ,  
+    # Related 
+    :related_links, 
+    # TrafficData
+    :rank,
+    # Other
+    :domain_name, :full_xml, :awis_url    
+    
+    
+    def initialize
+      @phone_numbers = []
+      @keywords = []
+      @related_links = []
+    end
+    
+    def to_s
+      str = ''
+      self.instance_variables.each do |var_name|
+        cur_var = self.send(var_name.gsub('@', ''))        
+        if cur_var.kind_of?(Array)
+          str += "#{var_name}:\n"
+          cur_var.each do |i|
+            if i.class == Hash
+              i.each do |k,v|
+                str += "  #{k}: #{v}\n"
+              end   
+            else
+              str += "  #{i}\n"       
+            end
+          end          
+        else
+          if var_name =~ /full_xml/
+            str += "#{var_name}: #{cur_var[0..20]}...(abbreviated)\n"
+          else
+            str += "#{var_name}: #{cur_var}\n" 
+          end            
+        end        
+      end   
+      str       
+    end
+    
+    
+  end
+  
+end
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: awis4ruby
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+date: 2007-08-29 00:00:00 -04:00
+summary: Simple Ruby client for the Alexa Web Information Service.
+require_paths: 
+- lib
+email: owack.j@gmail.com
+homepage: http://labs.votanweb.com/awis4ruby/
+rubyforge_project: awis4ruby
+description: "== FEATURES/PROBLEMS:  * Up-to-date Ruby client * Allows simple access to most popular AWIS data  == SYNOPSIS:  ACCESS_KEY_ID = \"05RTY5ESSE0EDGR68G2\" SECRET_ACCESS_KEY = \"1tmO+Tgvp0YU/ZOTwUTRYui7JppEc/lSMSD\" host = 'votanweb.com' info = AWIS4Ruby::get_url_info(ACCESS_KEY_ID, SECRET_ACCESS_KEY, host) p info.online_since.strftime('%m-%d-%Y') p info.rank   # traffic rank  == REQUIREMENTS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jay Owack
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/awis4ruby
+- lib/awis4ruby.rb
+- lib/url_info.rb
+- test/test_awis4ruby.rb
+test_files: 
+- test/test_awis4ruby.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- awis4ruby
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: