asin 0.1.0 → 0.2.0

data/Gemfile.lock

@@ -1,23 +1,35 @@
 PATH
   remote: .
   specs:
-    asin (0.0.9)
+    asin (0.2.0)
       crack (~> 0.1.8)
-      hashie (~> 0.4.0)
-      httpi (~> 0.7.6)
+      hashie (~> 1.0.0)
+      httpi (~> 0.7.9)
 
 GEM
   remote: http://rubygems.org/
   specs:
     crack (0.1.8)
-    hashie (0.4.0)
-    httpclient (2.1.5.2)
-    httpi (0.7.6)
+    diff-lcs (1.1.2)
+    fuubar (0.0.3)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
+    hashie (1.0.0)
+    httpclient (2.1.6.1)
+    httpi (0.7.9)
       rack
-    mocha (0.9.10)
-      rake
     rack (1.2.1)
-    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.5)
+    rspec-mocks (2.4.0)
+    ruby-progressbar (0.0.9)
 
 PLATFORMS
   ruby
@@ -25,7 +37,8 @@ PLATFORMS
 DEPENDENCIES
   asin!
   crack (~> 0.1.8)
-  hashie (~> 0.4.0)
-  httpclient (~> 2.1.5.2)
-  httpi (~> 0.7.6)
-  mocha (~> 0.9.10)
+  fuubar (~> 0.0.3)
+  hashie (~> 1.0.0)
+  httpclient (~> 2.1.6.1)
+  httpi (~> 0.7.9)
+  rspec (~> 2.4.0)

data/README.rdoc

@@ -1,19 +1,37 @@
 == Installation
 
+Status: http://stillmaintained.com/phoet/asin.png
+
 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.
 
   gem install asin
 
-== Usage
+== Configuration
+
+Since Version 0.2.0 ASIN provides a Rails-Style configuration.
+
+You can put this in a initializer (config/initializers/asin.rb):
+
+  ASIN::Configuration.configure do |config|
+    config.secret = 'your-secret'
+    config.key = 'your-key'
+  end
+
+The old configuration syntax is still valid:
 
   require 'asin'
   include ASIN
   
   # use the configure method to setup your api credentials
   configure :secret => 'your-secret', :key => 'your-key'
-  
+
+== Usage  
+
+  # create an ASIN client
+  client = ASIN.client
+
   # lookup an item with the amazon standard identification number (asin)
-  item = lookup '1430218150'
+  item = client.lookup '1430218150'
   
   # have a look at the title of the item
   item.title
@@ -31,9 +49,10 @@ The gem is tested against 1.9.2, 1.9.1 and 1.8.7 (compatibility with Heroku-Bamb
 == HTTPI
 
 ASIN uses HTTPI[https://github.com/rubiii/httpi] as a HTTP-Client adapter.
-You can configure the Client you like via configure:
+See the HTTPI documentation for how to configure different clients or the logger.
+As a default HTTPI uses _httpclient_ so you should add that dependency to your project:
 
-  configure :client => :curb
+  gem 'httpclient'
 
 == Infos
 
@@ -42,3 +61,4 @@ Have a look at the RDOC[http://rdoc.info/projects/phoet/asin] for this project,
 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

@@ -4,7 +4,7 @@ require "asin/version"
 
 Gem::Specification.new do |s|
   s.name        = "asin"
-  s.version     = Asin::VERSION
+  s.version     = ASIN::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Peter Schröder']
   s.email       = ['phoetmail@googlemail.com']
@@ -20,9 +20,10 @@ Gem::Specification.new do |s|
   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_dependency('hashie', '~> 1.0.0')
+  s.add_dependency('httpi', '~> 0.7.9')
   
-  s.add_development_dependency('httpclient', '~> 2.1.5.2')
-  s.add_development_dependency('mocha', '~> 0.9.10')
+  s.add_development_dependency('httpclient', '~> 2.1.6.1')
+  s.add_development_dependency('rspec', '~> 2.4.0')
+  s.add_development_dependency('fuubar', '~> 0.0.3')
 end

data/lib/asin.rb

@@ -6,6 +6,7 @@ require 'logger'
 
 require 'asin/item'
 require 'asin/version'
+require 'asin/configuration'
 
 # 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.
@@ -55,6 +56,19 @@ require 'asin/version'
 #   lookup(asin, :ResponseGroup => :Medium)
 # 
 module ASIN
+  
+  DIGEST  = OpenSSL::Digest::Digest.new('sha256')
+  PATH    = '/onca/xml'
+
+  # Convenience method to create an ASIN client.
+  # 
+  # A client is not necessary though, you can simply include the ASIN module otherwise.
+  # 
+  def self.client
+    client = Object.new
+    client.extend ASIN
+    client
+  end
 
   # Configures the basic request parameters for ASIN.
   # 
@@ -62,25 +76,10 @@ module ASIN
   # 
   #   configure :secret => 'your-secret', :key => 'your-key'
   # 
-  # ==== Options:
-  # 
-  # [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
+  # See ASIN::Configuration for more infos.
   # 
   def configure(options={})
-    @options = {
-      :host => 'webservices.amazon.com', 
-      :path => '/onca/xml', 
-      :digest => OpenSSL::Digest::Digest.new('sha256'),
-      :client => :httpclient,
-      :logger => Logger.new(STDERR),
-      :key => '', 
-      :secret => '',
-    } if @options.nil?
-    @options.merge! options
+    Configuration.configure(options)
   end
 
   # Performs an +ItemLookup+ REST call against the Amazon API.
@@ -125,20 +124,20 @@ module ASIN
 
   private
 
+  def credentials_valid?
+    !Configuration.secret.nil? && !Configuration.key.nil?
+  end
+
   def call(params)
-    raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" if @options.nil?
+    raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" unless credentials_valid?
     
     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}' 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)
-    
+    url = "http://#{Configuration.host}#{PATH}?#{signed}"
+    log(:info, "performing rest call to url='#{url}'")
+   
+    response = HTTPI.get(url)
     if response.code == 200
       # force utf-8 chars, works only on 1.9 string
       resp = response.body
@@ -154,7 +153,7 @@ module ASIN
   def create_signed_query_string(params)
     # nice tutorial http://cloudcarpenters.com/blog/amazon_products_api_request_signing/
     params[:Service] = :AWSECommerceService
-    params[:AWSAccessKeyId] = @options[:key]
+    params[:AWSAccessKeyId] = Configuration.key
     # utc timestamp needed for signing
     params[:Timestamp] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ') 
   
@@ -162,8 +161,8 @@ module ASIN
     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)
+    request_to_sign = "GET\n#{Configuration.host}\n#{PATH}\n#{query}"
+    hmac = OpenSSL::HMAC.digest(DIGEST, Configuration.secret, request_to_sign)
   
     # don't forget to remove the newline from base64
     signature = CGI.escape(Base64.encode64(hmac).chomp)
@@ -171,7 +170,8 @@ module ASIN
   end
   
   def log(severity, message)
-    @options[:logger].send severity, message if @options[:logger]
+    Configuration.logger.send severity, message if Configuration.logger
   end
 
-end
+end
+

data/lib/asin/configuration.rb

@@ -0,0 +1,52 @@
+module ASIN
+  class Configuration
+    class << self
+
+      attr_accessor :secret, :key, :host, :logger
+
+      # Rails initializer configuration.
+      # 
+      # Expects at least +secret+ and +key+ for the API call:
+      # 
+      #   ASIN::Configuration.configure do |config|
+      #     config.secret = 'your-secret'
+      #     config.key = 'your-key'
+      #   end
+      #
+      # You may pass options as a hash as well:
+      #
+      #   ASIN::Configuration.configure(:secret => 'your-secret', :key => 'your-key')
+      # 
+      # ==== Options:
+      # 
+      # [secret] the API secret key
+      # [key] the API access key
+      # [host] the host, which defaults to 'webservices.amazon.com'
+      # [logger] a different logger than logging to STDERR (nil for no logging)
+      # 
+      def configure(options={})
+        init_config
+        if block_given?
+          yield self
+        else
+          options.each do |key, value|
+            send(:"#{key}=", value)
+          end
+        end
+        self
+      end
+
+      private
+
+      def init_config(force=false)
+        return if @init && !force
+        @init   = true
+        @secret = ''
+        @key    = ''
+        @host   = 'webservices.amazon.com'
+        @logger = Logger.new(STDERR)
+      end
+    end
+  end
+end
+

data/lib/asin/version.rb

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

data/rakefile.rb

@@ -1,6 +1,12 @@
 require "bundler"
 require "rake/rdoctask"
 require "rake/gempackagetask"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--format Fuubar", "--color", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
 
 Bundler::GemHelper.install_tasks
 

data/spec/asin_spec.rb

@@ -0,0 +1,58 @@
+ANY_ASIN = '1430218150'
+ANY_SEARCH = 'Learn Objective-C'
+
+describe ASIN do
+  before do
+    @helper = ASIN.client
+    @helper.configure :logger => nil
+
+    @secret = ENV['ASIN_SECRET']
+    @key = ENV['ASIN_KEY']
+    puts "configure #{@secret} and #{@key} for this test"
+  end
+
+  context "configuration" do
+    it "should fail without secret and key" do
+      lambda { @helper.lookup ANY_ASIN }.should raise_error(RuntimeError)
+    end
+
+    it "should fail with wrong configuration key" do
+      lambda { @helper.configure :wrong => 'key' }.should raise_error(NoMethodError)
+    end
+
+    it "should not override the configuration" do
+      config = @helper.configure :key => 'wont get overridden'
+      config.key.should_not be_nil
+
+      config = @helper.configure :secret => 'is also set'
+      config.key.should_not be_nil
+      config.secret.should_not be_nil
+    end
+
+    it "should work with a configuration block" do
+      config = ASIN::Configuration.configure do |config|
+        config.key = 'bla'
+      end
+      config.key.should eql('bla')
+    end
+  end
+
+  context "lookup and search" do
+    before do
+      @helper.configure :secret => @secret, :key => @key
+    end
+
+    it "should lookup a book" do
+      item = @helper.lookup(ANY_ASIN)
+      item.title.should =~ /Learn Objective/
+    end
+
+    it "should search a book with fulltext" do
+      items = @helper.search(ANY_SEARCH)
+      items.should have(10).things
+
+      items.first.title.should =~ /Learn Objective/
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+require 'rspec'
+require 'asin'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Peter Schr\xC3\xB6der"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 +01:00
+date: 2011-01-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,10 +41,10 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        - 4
         - 0
-        version: 0.4.0
+        version: 1.0.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,8 @@ dependencies:
         segments: 
         - 0
         - 7
-        - 6
-        version: 0.7.6
+        - 9
+        version: 0.7.9
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -73,13 +73,13 @@ dependencies:
         segments: 
         - 2
         - 1
-        - 5
-        - 2
-        version: 2.1.5.2
+        - 6
+        - 1
+        version: 2.1.6.1
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -87,12 +87,27 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
+        - 4
         - 0
-        - 9
-        - 10
-        version: 0.9.10
+        version: 2.4.0
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :development
+  version_requirements: *id006
 description: Amazon Simple INterface or whatever you want to call this.
 email: 
 - phoetmail@googlemail.com
@@ -111,11 +126,12 @@ files:
 - README.rdoc
 - asin.gemspec
 - lib/asin.rb
+- lib/asin/configuration.rb
 - lib/asin/item.rb
 - lib/asin/version.rb
 - rakefile.rb
-- test/test_asin.rb
-- test/test_helper.rb
+- spec/asin_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/phoet/asin
 licenses: []
@@ -149,5 +165,5 @@ signing_key:
 specification_version: 3
 summary: Simple interface to Amazon Item lookup.
 test_files: 
-- test/test_asin.rb
-- test/test_helper.rb
+- spec/asin_spec.rb
+- spec/spec_helper.rb

data/test/test_asin.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-
-class TestAsin < Test::Unit::TestCase
-
-
-  ANY_ASIN = '1430218150'
-  ANY_SEARCH = 'Learn Objective-C'
-
-  def setup
-    @helper = Object.new
-    @helper.extend ASIN
-  end
-
-  def test_lookup_with_configured_asin
-    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
-    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])
-
-    config = @helper.configure :different => 'is also set'
-    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

data/test/test_helper.rb

@@ -1,5 +0,0 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
-
-require 'test/unit'
-require 'mocha'
-require 'asin'