asin 0.0.8 → 0.1.0

data/.document

@@ -0,0 +1,2 @@
+lib/*.rb
+README.rdoc

data/.gitignore

@@ -0,0 +1,5 @@
+html
+pkg
+*.gem
+.DS_Store
+.bundle

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 1.9.2@asin --create
+rvm wrapper 1.9.2@asin textmate

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in asin.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    asin (0.0.9)
+      crack (~> 0.1.8)
+      hashie (~> 0.4.0)
+      httpi (~> 0.7.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    hashie (0.4.0)
+    httpclient (2.1.5.2)
+    httpi (0.7.6)
+      rack
+    mocha (0.9.10)
+      rake
+    rack (1.2.1)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asin!
+  crack (~> 0.1.8)
+  hashie (~> 0.4.0)
+  httpclient (~> 2.1.5.2)
+  httpi (~> 0.7.6)
+  mocha (~> 0.9.10)

data/README.rdoc

@@ -1,20 +1,7 @@
-= Introduction
-
-There is already a sophisticated amazon gem out there called ruby-aaws[http://raa.ruby-lang.org/project/ruby-aws/], but ASIN in comparison is _reaaaaaaaaaly_ easy to use!
-
-It currently just supports the _ItemLookup_ via REST but is easy to extend and understand!
-
-Have a look at the RDOC[http://rdoc.info/projects/phoet/asin] for this project, if you want further information.
-
-For more information on the REST calls, have a look at the whole Amazon E-Commerce-API[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/].
-
-The code currently runs best on Ruby-1.9 due to encoding issues with the Amazon REST output (if *YOU* know how to backport this to 1.8.7, you are welcome!).
-
 == Installation
 
-The gem is tested against 1.9.1 (to be compatible with Heroku Bamboo Stack) and somewhat against 1.8.7.
+The gem is tested against 1.9.2, 1.9.1 and 1.8.7 (compatibility with Heroku-Bamboo-Stack[http://docs.heroku.com/stack]) and runs smoothly with Rails 3.
 
-  rvm use 1.9.1
   gem install asin
 
 == Usage
@@ -32,6 +19,26 @@ The gem is tested against 1.9.1 (to be compatible with Heroku Bamboo Stack) and
   item.title
   => Learn Objective-C on the Mac (Learn Series)
   
+  # search for any kind of stuff on amazon
+  items = search 'Learn Objective-C'
+  items.first.title
+  => "Learn Objective-C on the Mac (Learn Series)"
+  
   # access the internal data representation (Hashie::Mash)
   item.raw.ItemAttributes.ListPrice.FormattedPrice
   => $39.99
+
+== HTTPI
+
+ASIN uses HTTPI[https://github.com/rubiii/httpi] as a HTTP-Client adapter.
+You can configure the Client you like via configure:
+
+  configure :client => :curb
+
+== Infos
+
+Have a look at the RDOC[http://rdoc.info/projects/phoet/asin] for this project, if you want further information.
+
+For more information on the REST calls, have a look at the whole Amazon E-Commerce-API[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/].
+
+The code currently runs best on Ruby-1.9 due to encoding issues with the Amazon REST output (if *YOU* know how to backport this to 1.8.7, you are welcome!).

data/asin.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "asin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "asin"
+  s.version     = Asin::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Peter Schröder']
+  s.email       = ['phoetmail@googlemail.com']
+  s.homepage    = 'http://github.com/phoet/asin'
+  s.summary     = 'Simple interface to Amazon Item lookup.'
+  s.description = 'Amazon Simple INterface or whatever you want to call this.'
+
+  s.rubyforge_project = "asin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('crack', '~> 0.1.8')
+  s.add_dependency('hashie', '~> 0.4.0')
+  s.add_dependency('httpi', '~> 0.7.6')
+  
+  s.add_development_dependency('httpclient', '~> 2.1.5.2')
+  s.add_development_dependency('mocha', '~> 0.9.10')
+end

data/lib/asin.rb

@@ -1,10 +1,12 @@
-require 'hashie'
-require 'httpclient'
+require 'httpi'
 require 'crack/xml'
 require 'cgi'
 require 'base64'
 require 'logger'
 
+require 'asin/item'
+require 'asin/version'
+
 # ASIN (Amazon Simple INterface) is a gem for easy access of the Amazon E-Commerce-API.
 # It is simple to configure and use. Since it's very small and flexible, it is easy to extend it to your needs.
 # 
@@ -25,11 +27,18 @@ require 'logger'
 # 
 #   configure :secret => 'your-secret', :key => 'your-key'
 # 
-# After configuring your environment you can call the +lookup+ method to retrieve an +Item+ via the Amazon Standard Identification Number (ASIN):
+# After configuring your environment you can call the +lookup+ method to retrieve an +Item+ via the 
+# Amazon Standard Identification Number (ASIN):
 # 
 #   item = lookup '1430218150'
 #   item.title
 #   => "Learn Objective-C on the Mac (Learn Series)"
+#
+# OR search with fulltext/ASIN/ISBN
+# 
+#   items = search 'Learn Objective-C'
+#   items.first.title
+#   => "Learn Objective-C on the Mac (Learn Series)"
 # 
 # The +Item+ uses a Hashie::Mash as its internal data representation and you can get fetched data from it:
 # 
@@ -38,7 +47,8 @@ require 'logger'
 # 
 # ==Further Configuration
 # 
-# If you need more controll over the request that is sent to the Amazon API (http://docs.amazonwebservices.com/AWSEcommerceService/4-0/),
+# If you need more controll over the request that is sent to the 
+# Amazon API (http://docs.amazonwebservices.com/AWSEcommerceService/4-0/),
 # you can override some defaults or add additional query-parameters to the REST calls:
 # 
 #   configure :host => 'webservices.amazon.de'
@@ -46,26 +56,6 @@ require 'logger'
 # 
 module ASIN
 
-  # =Item
-  # 
-  # The +Item+ class is a wrapper for the Amazon XML-REST-Response.
-  # 
-  # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
-  # 
-  class Item
-
-    attr_reader :raw
-
-    def initialize(hash)
-      @raw = Hashie::Mash.new(hash).ItemLookupResponse.Items.Item
-    end
-
-    def title
-      @raw.ItemAttributes.Title
-    end
-
-  end
-
   # Configures the basic request parameters for ASIN.
   # 
   # Expects at least +secret+ and +key+ for the API call:
@@ -77,6 +67,7 @@ module ASIN
   # [secret] the API secret key
   # [key] the API access key
   # [host] the host, which defaults to 'webservices.amazon.com'
+  # [client] the client library for http (:httpclient, :curb, :net_http) see HTTPI for more information
   # [logger] a different logger than logging to STDERR
   # 
   def configure(options={})
@@ -84,6 +75,7 @@ module ASIN
       :host => 'webservices.amazon.com', 
       :path => '/onca/xml', 
       :digest => OpenSSL::Digest::Digest.new('sha256'),
+      :client => :httpclient,
       :logger => Logger.new(STDERR),
       :key => '', 
       :secret => '',
@@ -106,22 +98,57 @@ module ASIN
   #   lookup(asin, :ResponseGroup => :Medium)
   # 
   def lookup(asin, params={})
-    Item.new(call(params.merge(:Operation => :ItemLookup, :ItemId => asin)))
+    response = call(params.merge(:Operation => :ItemLookup, :ItemId => asin))
+    Item.new(response['ItemLookupResponse']['Items']['Item'])
+  end
+  
+  # Performs an +ItemSearch+ REST call against the Amazon API.
+  # 
+  # Expects a search-string which can be an ASIN (Amazon Standard Identification Number) and returns a list of +Items+:
+  # 
+  #   items = search 'Learn Objective-C'
+  #   items.first.title
+  #   => "Learn Objective-C on the Mac (Learn Series)"
+  # 
+  # ==== Options:
+  # 
+  # Additional parameters for the API call like this:
+  # 
+  #   search(asin, :SearchIndex => :Music)
+  #
+  # Have a look at the different search index values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
+  #
+  def search(search_string, params={:SearchIndex => :Books})
+    response = call(params.merge(:Operation => :ItemSearch, :Keywords => search_string))
+    response['ItemSearchResponse']['Items']['Item'].map {|item| Item.new(item)}
   end
 
   private
 
   def call(params)
     raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" if @options.nil?
+    
     log(:debug, "calling with params=#{params}")
     signed = create_signed_query_string(params)
+    
     url = "http://#{@options[:host]}#{@options[:path]}?#{signed}"
-    log(:info, "performing rest call to url='#{url}'")
-    resp = HTTPClient.new.get_content(url)
-    # force utf-8 chars, works only on 1.9 string
-    resp = resp.force_encoding('UTF-8') if resp.respond_to? :force_encoding
-    log(:debug, "got response='#{resp}'")
-    Crack::XML.parse(resp)
+    log(:info, "performing rest call to url='#{url}' with client='#{@options[:client]}'")
+    
+    HTTPI::Adapter.use = @options[:client]
+    HTTPI.logger = @options[:logger] if @options[:logger]
+    request = HTTPI::Request.new(url)
+    response = HTTPI.get(request)
+    
+    if response.code == 200
+      # force utf-8 chars, works only on 1.9 string
+      resp = response.body
+      resp = resp.force_encoding('UTF-8') if resp.respond_to? :force_encoding
+      log(:debug, "got response='#{resp}'")
+      Crack::XML.parse(resp)
+    else
+      log(:error, "got response='#{response.body}'")
+      raise "request failed with response-code='#{response.code}'"
+    end
   end
 
   def create_signed_query_string(params)
@@ -130,12 +157,15 @@ module ASIN
     params[:AWSAccessKeyId] = @options[:key]
     # utc timestamp needed for signing
     params[:Timestamp] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ') 
-    
-    query = params.map{|key, value| "#{key}=#{CGI.escape(value.to_s)}" }.sort.join('&')
-    
+  
+    # signing needs to order the query alphabetically
+    query = params.map{|key, value| "#{key}=#{CGI.escape(value.to_s)}" }.sort.join('&').gsub('+','%20')
+  
+    # yeah, you really need to sign the get-request not the query
     request_to_sign = "GET\n#{@options[:host]}\n#{@options[:path]}\n#{query}"
     hmac = OpenSSL::HMAC.digest(@options[:digest], @options[:secret], request_to_sign)
-    
+  
+    # don't forget to remove the newline from base64
     signature = CGI.escape(Base64.encode64(hmac).chomp)
     "#{query}&Signature=#{signature}"
   end

data/lib/asin/item.rb

@@ -0,0 +1,24 @@
+require 'hashie'
+
+module ASIN
+
+  # =Item
+  # 
+  # The +Item+ class is a wrapper for the Amazon XML-REST-Response.
+  # 
+  # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
+  # 
+  class Item
+
+    attr_reader :raw
+
+    def initialize(hash)
+      @raw = Hashie::Mash.new(hash)
+    end
+
+    def title
+      @raw.ItemAttributes.Title
+    end
+  end
+  
+end

data/lib/asin/version.rb

@@ -0,0 +1,3 @@
+module Asin
+  VERSION = "0.1.0"
+end

data/rakefile.rb

@@ -0,0 +1,29 @@
+require "bundler"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+
+Bundler::GemHelper.install_tasks
+
+spec = eval(File.new("asin.gemspec").readlines.join("\n"))
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+Rake::RDocTask.new(:rdoc_dev) do |rd|
+  rd.rdoc_files.include("lib/**/*.rb", "README.rdoc")
+  rd.options + ['-a', '--inline-source', '--charset=UTF-8']
+end
+
+desc "the test task"
+task :test do
+  require 'rake/testtask'
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.ruby_opts << "-rubygems"
+    t.test_files = FileList['test/test_*.rb']
+    t.verbose = true
+  end
+end
+task :default=>:test

data/test/test_asin.rb

@@ -1,9 +1,11 @@
 require 'test_helper'
 
-ANY_ASIN = '1430218150'
-
 class TestAsin < Test::Unit::TestCase
 
+
+  ANY_ASIN = '1430218150'
+  ANY_SEARCH = 'Learn Objective-C'
+
   def setup
     @helper = Object.new
     @helper.extend ASIN
@@ -13,12 +15,24 @@ class TestAsin < Test::Unit::TestCase
     secret = ENV['ASIN_SECRET']
     key = ENV['ASIN_KEY']
     puts "configure #{secret} and #{key} for this test"
-    
+
+    @helper.configure :secret => secret, :key => key
+    item = @helper.lookup(ANY_ASIN)
+    assert_match(/Learn Objective/, item.title)
+  end
+
+  def test_search_with_configured_string
+    secret = ENV['ASIN_SECRET']
+    key = ENV['ASIN_KEY']
+    puts "configure #{secret} and #{key} for this test"
+
     @helper.configure :secret => secret, :key => key
-    p item = @helper.lookup(ANY_ASIN)
+    items = @helper.search(ANY_SEARCH)
+    assert_equal(10, items.size)
+    item = items.first
     assert_match(/Learn Objective/, item.title)
   end
-  
+
   def test_configure_second_time_wont_get_overridden
     config = @helper.configure :something => 'wont get overridden'
     assert_not_nil(config[:something])
@@ -27,9 +41,9 @@ class TestAsin < Test::Unit::TestCase
     assert_not_nil(config[:something])
     assert_not_nil(config[:different])
   end
-  
+
   def test_error_with_not_called_configure
     assert_raise(RuntimeError) { @helper.lookup ANY_ASIN }
   end
 
-end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: asin
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Peter Schr\xC3\xB6der"
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2011-01-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +23,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
         segments: 
         - 0
         - 1
-        - 0
-        version: 0.1.0
+        - 8
+        version: 0.1.8
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,34 +38,64 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
-        - 2
+        - 4
         - 0
-        version: 0.2.0
+        version: 0.4.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: httpclient
+  name: httpi
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
-        - 2
-        - 1
         - 0
-        version: 2.1.0
+        - 7
+        - 6
+        version: 0.7.6
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 5
+        - 2
+        version: 2.1.5.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  type: :development
+  version_requirements: *id005
 description: Amazon Simple INterface or whatever you want to call this.
-email: phoetmail@googlemail.com
+email: 
+- phoetmail@googlemail.com
 executables: []
 
 extensions: []
@@ -75,8 +103,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/asin.rb
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
 - README.rdoc
+- asin.gemspec
+- lib/asin.rb
+- lib/asin/item.rb
+- lib/asin/version.rb
+- rakefile.rb
 - test/test_asin.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -84,10 +121,8 @@ homepage: http://github.com/phoet/asin
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- -a
-- --inline-source
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -95,7 +130,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -104,13 +138,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: asin
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3