gaiottino-amazon-awis 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*.gem

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.1.0 2009-10-16
+----------------
+Initial Release

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Hasham Malik
+
+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,54 @@
+== amazon-awis
+
+Ruby Amazon Alexa web service REST API using Hpricot with configurable 
+default options and method call options. Uses Response and 
+Element wrapper classes for easy access to REST XML output.
+
+This version is based on http://github.com/hasham2/amazon-awis but I didn't 
+like how it was possible to globally alter options. The AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
+are still global since one will likely only want to initialize these once.
+
+== INSTALLATION
+
+  $ gem install amazon-awis
+
+== EXAMPLE
+
+    require 'rubygems'
+    require 'amazon/awis'
+	
+    # set the default config; config will be camelized and converted to REST request parameters.
+    Amazon::Awis.configure do |config|
+      config[:aws_access_key_id] = AWS_ACCESS_KEY_ID
+      config[:aws_secret_key] = AWS_SECRET_KEY
+    end
+
+    # create an instance of Awis for a specific action and domain
+    awis = Amazon::Awis.new({ :action => :url_info, :domain => 'google.com' })
+
+    # call query with the Response Group you want
+    resp = awis.query(:rank)
+    
+    # some common response object methods        
+    res.is_success?   # return true if request was successful
+   
+    #dynamic methods
+    res.rank          # return the rank of domain name that was passed
+    res.dataurl	      # returns the url which was queried
+    
+    # Query another action/domain after updating the options
+    awis.options[:domain] = 'yahoo.com/'
+    
+
+Refer to Amazon AWIS documentation for more information on Amazon REST request parameters and XML output:
+http://docs.amazonwebservices.com/AlexaWebInfoService/2005-07-11/
+
+== SOURCE CODES
+
+* http://github.com/gaiottino/amazon-awis
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 Daniel Gaiottino (Based on the initial work by Hasham Malik)

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/packagetask'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gemspec| 
+		gemspec.name = "gaiottino-amazon-awis"
+		gemspec.summary = "Ruby Amazon Alexa web information service REST API"
+		gemspec.description = "Ruby Amazon Alexa web information service REST API"
+		gemspec.email = "daniel.gaiottino@gmail.com"
+		gemspec.homepage = "http://github.com/gaiottino/amazon-awis"
+		gemspec.authors = ["Daniel Gaiottino"]
+		gemspec.add_dependency('hpricot', '>= 0.4')
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+desc "Run the unit tests in test" 
+Rake::TestTask.new(:test) do |t|
+	t.libs << "test" 
+	t.pattern = 'test/**/*_test.rb'
+	t.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/gaiottino-amazon-awis.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gaiottino-amazon-awis}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Gaiottino"]
+  s.date = %q{2010-04-29}
+  s.description = %q{Ruby Amazon Alexa web information service REST API}
+  s.email = %q{daniel.gaiottino@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gaiottino-amazon-awis.gemspec",
+     "lib/amazon/awis.rb",
+     "test/amazon/awis_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gaiottino/amazon-awis}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby Amazon Alexa web information service REST API}
+  s.test_files = [
+    "test/amazon/awis_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<hpricot>, [">= 0.4"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0.4"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0.4"])
+  end
+end
+

data/lib/amazon/awis.rb

@@ -0,0 +1,274 @@
+#--
+# Copyright (c) 2010 Daniel Gaiottino (Based on the initial work by Hasham Malik)
+#
+# 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.
+#++
+
+require "cgi"
+require "base64"
+require "openssl"
+require "digest/sha1"
+require "uri"
+require "net/https"
+require "time"
+require "hpricot"
+
+module Amazon
+  
+  class RequestError < StandardError; end
+  
+  class Awis
+    @@config = {}
+    
+    @@debug = false
+
+    def initialize(opts={})
+      @options = {
+        :action => "UrlInfo",
+      }
+      @options.merge!(opts)
+      
+      raise 'Use Awis.configure before creating a new object to set :aws_access_key_id and :aws_secret_key' unless @@config[:aws_access_key_id] && @@config[:aws_secret_key]
+      raise 'Missing required option :domain' unless options[:domain]
+    end
+    
+    def self.configure(&proc)
+      raise ArgumentError, "Block is required." unless block_given?
+      yield @@config
+    end
+    
+    # Default service options
+    def options
+      @options
+    end
+    
+    # Set default service options
+    def options=(opts)
+      @options = opts
+    end
+    
+    # Get debug flag.
+    def self.debug
+      @@debug
+    end
+    
+    # Set debug flag to true or false.
+    def self.debug=(dbg)
+      @@debug = dbg
+    end
+    
+    def query(response_group)
+      raise 'Must specify Response Group e.g. :rank, rank, or Rank for Rank' unless response_group
+      
+      url = prepare_url(options[:domain], response_group)
+      
+      log "Request URL: #{url}"
+      res = Net::HTTP.get_response(url)
+      unless res.kind_of? Net::HTTPSuccess
+        raise Amazon::RequestError, "HTTP Response: #{res.code} #{res.message}"
+      end
+      log "Response text: #{res.body}"
+      Response.new(res.body)
+    end	
+    
+    # Response object returned after a REST call to Amazon service.
+    class Response
+      # XML input is in string format
+      def initialize(xml)
+        @doc = Hpricot(xml)
+      end
+
+      # Return Hpricot object.
+      def doc
+        @doc
+      end      
+      
+      # Return true if response has an error.
+      def has_error?
+        !(error.nil? || error.empty?)
+      end
+
+      # Return error message.
+      def error
+        Element.get(@doc, "error/message")
+      end
+      
+      # Return error code
+      def error_code
+        Element.get(@doc, "error/code")
+      end
+      
+      # Return error message.
+      def is_success?
+        (@doc/"aws:statuscode").innerHTML == "Success"
+      end
+      
+      #returns inner html of any tag in awis response i.e resp.rank => 3
+      def method_missing(methodId)
+        txt = (@doc/"aws:#{methodId.id2name}").innerHTML
+        if txt.empty?
+          raise NoMethodError
+        else
+          txt
+        end
+      end
+
+    end
+    
+  protected
+    
+    def log(s)
+      return unless Awis.debug
+      if defined? RAILS_DEFAULT_LOGGER
+        RAILS_DEFAULT_LOGGER.error(s)
+      elsif defined? LOGGER
+        LOGGER.error(s)
+      else
+        puts s
+      end
+    end
+      
+  private 
+    
+    def prepare_url(domain, response_group)
+      timestamp = ( Time::now ).utc.strftime("%Y-%m-%dT%H:%M:%S.000Z")
+      secret_key = @@config[:aws_secret_key]
+      action = options[:action]
+      signature = Base64.encode64( OpenSSL::HMAC.digest( OpenSSL::Digest::Digest.new( "sha1" ), secret_key, action + timestamp)).strip
+      url = URI.parse("http://awis.amazonaws.com/?" +
+        {
+          "Action"          => action,
+          "AWSAccessKeyId"  => @@config[:aws_access_key_id],
+          "Signature"       => signature,
+          "Timestamp"       => timestamp,
+          "ResponseGroup"   => camelize(response_group.to_s),
+          "Url"             => domain
+        }.to_a.collect{|item| item.first + "=" + CGI::escape(item.last) }.join("&")
+      )
+      return url
+    end
+    
+    def camelize(lower_case_and_underscored_word)
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+    end
+    
+  end
+
+  # Internal wrapper class to provide convenient method to access Hpricot element value.
+  class Element
+    # Pass Hpricot::Elements object
+    def initialize(element)
+      @element = element
+    end
+
+    # Returns Hpricot::Elments object    
+    def elem
+      @element
+    end
+    
+    # Find Hpricot::Elements matching the given path. Example: element/"author".
+    def /(path)
+      elements = @element/path
+      return nil if elements.size == 0
+      elements
+    end
+    
+    # Find Hpricot::Elements matching the given path, and convert to Amazon::Element.
+    # Returns an array Amazon::Elements if more than Hpricot::Elements size is greater than 1.
+    def search_and_convert(path)
+      elements = self./(path)
+      return unless elements
+      
+      elements = elements.map{|element| Element.new(element)}
+      return elements.first if elements.size == 1
+      
+      elements
+    end
+
+    # Get the text value of the given path, leave empty to retrieve current element value.
+    def get(path='')
+      Element.get(@element, path)
+    end
+    
+    # Get the unescaped HTML text of the given path.
+    def get_unescaped(path='')
+      Element.get_unescaped(@element, path)
+    end
+    
+    # Get the array values of the given path.
+    def get_array(path='')
+      Element.get_array(@element, path)
+    end
+
+    # Get the children element text values in hash format with the element names as the hash keys.
+    def get_hash(path='')
+      Element.get_hash(@element, path)
+    end
+
+    # Similar to #get, except an element object must be passed-in.
+    def self.get(element, path='')
+      return unless element
+      result = element.at(path)
+      result = result.inner_html if result
+      result
+    end
+    
+    # Similar to #get_unescaped, except an element object must be passed-in.    
+    def self.get_unescaped(element, path='')
+      result = get(element, path)
+      CGI::unescapeHTML(result) if result
+    end
+
+    # Similar to #get_array, except an element object must be passed-in.
+    def self.get_array(element, path='')
+      return unless element
+      
+      result = element/path
+      if (result.is_a? Hpricot::Elements) || (result.is_a? Array)
+        parsed_result = []
+        result.each {|item|
+          parsed_result << Element.get(item)
+        }
+        parsed_result
+      else
+        [Element.get(result)]
+      end
+    end
+
+    # Similar to #get_hash, except an element object must be passed-in.
+    def self.get_hash(element, path='')
+      return unless element
+
+      result = element.at(path)
+      if result
+        hash = {}
+        result = result.children
+        result.each do |item|
+          hash[item.name.to_sym] = item.inner_html
+        end 
+        hash
+      end
+    end
+
+    def to_s
+      elem.to_s if elem
+    end
+  end
+end

data/test/amazon/awis_test.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class Amazon::AwisTest < Test::Unit::TestCase
+
+  AWS_ACCESS_KEY_ID = ''
+  AWS_SECRET_KEY = ''
+  
+  DOMAIN_STRING = 'yahoo.com'
+  
+  raise "Please specify set your AWS_ACCESS_KEY_ID" if AWS_ACCESS_KEY_ID.empty?
+  raise "Please specify set your AWS_SECRET_KEY" if AWS_SECRET_KEY.empty?
+  
+  Amazon::Awis.configure do |config|
+    config[:aws_access_key_id] = AWS_ACCESS_KEY_ID
+    config[:aws_secret_key] = AWS_SECRET_KEY
+  end
+  
+  Amazon::Awis.debug = true
+    
+  def setup
+    @awis = Amazon::Awis.new({
+      :domain => DOMAIN_STRING
+    })
+  end
+  
+  ## Test get_info
+  def test_query
+    resp = @awis.query(:rank)
+
+    assert(resp.is_success?)  	  
+    assert(resp.dataurl == 'yahoo.com/')
+    assert(resp.rank == 4.to_s)    
+  end
+   
+  # Test get_info with SiteData response group
+  def test_site_data_response
+    resp = @awis.query(:site_data)
+
+    assert(resp.is_success?)
+    assert(resp.title == 'Yahoo!')
+    assert(resp.onlinesince == '18-Jan-1995')
+  end
+  
+  ## Test get_info with ContactInfo response group
+  def test_contact_info_response
+    resp = @awis.query(:contact_info)
+    
+    assert(resp.is_success?)
+    assert(resp.symbol == 'YHOO')
+  end
+  
+  def test_with_another_domain
+    @awis.options[:domain] = 'google.com/'
+    
+    resp = @awis.query(:rank)
+    
+    assert(resp.is_success?)
+    assert(resp.dataurl == 'google.com/')
+    assert(resp.rank == 1.to_s)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/amazon/awis'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: gaiottino-amazon-awis
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Daniel Gaiottino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :runtime
+  version_requirements: *id001
+description: Ruby Amazon Alexa web information service REST API
+email: daniel.gaiottino@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- gaiottino-amazon-awis.gemspec
+- lib/amazon/awis.rb
+- test/amazon/awis_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gaiottino/amazon-awis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby Amazon Alexa web information service REST API
+test_files: 
+- test/amazon/awis_test.rb
+- test/test_helper.rb