vacuum 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d07486645b8ea810b09ea915c530618f63044dd6
+  data.tar.gz: 8e09b77ac5525b6f4ded9af4eaa1162d7b6e3ad3
+SHA512:
+  metadata.gz: 3c0961d922ddb4999cdbd597c24174b44b3619f9ed82cacf6cba40fe928c5c202c694404b9f43b2ca754d2b70b86e777d5058371ed8ca9ca3c8fecec77f0fb51
+  data.tar.gz: 913688bc90be1251d194b303d3737cbf30400392b9f65dc00f102dca5ddd52c6b8e128740f1cf54e90bdd975f3b2ef551c8906abc81b9b5061660e8f25548bb6

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2012 Hakan Ensari
+Copyright (c) 2013 Hakan Ensari
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -8,21 +8,63 @@ Vacuum is a Ruby wrapper to the [Amazon Product Advertising API][4].
 
 ## Usage
 
+Set up a request:
+
 ```ruby
 req = Vacuum.new
+  .configure(
+    aws_access_key_id:     'foo',
+    aws_secret_access_key: 'secret',
+    associate_tag:         'biz-val'
+  )
+```
+
+The locale defaults to the US. If you wish to use another locale, specify its
+ISO-3166 two-letter code when instantiating the request:
 
-req.configure key:    'foo',
-              secret: 'secret',
-              tag:    'biz-val'
+```ruby
+Vacuum.new('GB')
+```
 
+Make a request:
+
+```ruby
 params = { 'Operation'   => 'ItemSearch',
            'SearchIndex' => 'Books',
            'Keywords'    => 'Architecture' }
 
-req.get query: params # XPath is your friend.
+res = req.get(query: params)
+```
+
+Once you have a response, parse it with your favourite XML parser and parsing
+method.
+
+If you don't mind the performance hit, here is a simplistic solution based on
+[`MultiXml`][5]:
+
+```ruby
+require 'forwardable'
+require 'multi_xml'
+
+class Response
+  extend Forwardable
+
+  def_delegators :code, :body, :@response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def to_h
+    MultiXml.parse(body)
+  end
+end
+
+Response.new(res).to_h
 ```
 
 [1]: https://secure.travis-ci.org/hakanensari/vacuum.png
 [2]: http://travis-ci.org/hakanensari/vacuum
 [3]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
 [4]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
+[5]: https://github.com/sferik/multi_xml

data/lib/vacuum/request.rb

@@ -6,7 +6,6 @@ module Vacuum
     include Jeff
 
     BadLocale  = Class.new(ArgumentError)
-    MissingTag = Class.new(ArgumentError)
 
     # A list of Amazon Product Advertising API hosts.
     HOSTS = {
@@ -17,11 +16,11 @@ module Vacuum
       'FR' => 'ecs.amazonaws.fr',
       'IT' => 'webservices.amazon.it',
       'JP' => 'ecs.amazonaws.jp',
-      'UK' => 'ecs.amazonaws.co.uk',
+      'GB' => 'ecs.amazonaws.co.uk',
       'US' => 'ecs.amazonaws.com'
     }.freeze
 
-    params 'AssociateTag' => -> { tag },
+    params 'AssociateTag' => -> { associate_tag },
            'Service'      => 'AWSECommerceService',
            'Version'      => '2011-08-01'
 
@@ -31,6 +30,11 @@ module Vacuum
     #
     # Raises a Bad Locale error if locale is not valid.
     def initialize(locale = nil)
+      if locale == 'UK'
+        warn '[DEPRECATION] Use GB instead of UK'
+        locale = 'GB'
+      end
+
       host = HOSTS[locale || 'US'] or raise BadLocale
       self.endpoint = "http://#{host}/onca/xml"
     end
@@ -38,24 +42,22 @@ module Vacuum
     # Configure the Amazon Product Advertising API request.
     #
     # credentials - The Hash credentials of the API endpoint.
-    #               :key    - The String Amazon Web Services (AWS) key.
-    #               :secret - The String AWS secret.
-    #               :tag    - The String Associate Tag.
+    #               :aws_access_key_id     - The String Amazon Web Services
+    #                                        (AWS) key.
+    #               :aws_secret_access_key - The String AWS secret.
+    #               :associate_tag         - The String Associate Tag.
     #
-    # Returns nothing.
+    # Returns self.
     def configure(credentials)
       credentials.each { |key, val| self.send("#{key}=", val) }
+      self
     end
 
-    # Get the String Associate Tag.
-    #
-    # Raises a Missing Tag error if Associate Tag is missing.
-    def tag
-      @tag or raise MissingTag
-    end
-
-    # Sets the String Associate Tag.
-    attr_writer :tag
+    # Get/Sets the String Associate Tag.
+    attr_accessor :associate_tag
+    # Keep around old attribute for a while for backward compatibility.
+    alias :tag :associate_tag
+    alias :tag= :associate_tag=
 
     # Build a URL.
     #
@@ -64,8 +66,8 @@ module Vacuum
     # Returns the built URL String.
     def url(params)
       opts = {
-        :method => :get,
-        :query  => params
+        method: :get,
+        query:  params
       }
 
       [endpoint, build_options(opts).fetch(:query)].join('?')

data/lib/vacuum/version.rb

@@ -1,3 +1,3 @@
 module Vacuum
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,48 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: jeff
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
-    none: false
-  name: jeff
+        version: 0.7.0
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
-    none: false
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: A wrapper to the Amazon Product Advertising API
 email:
 - hakan.ensari@papercavalier.com
@@ -56,27 +51,27 @@ files:
 - LICENSE
 - README.md
 homepage: https://github.com/hakanensari/vacuum
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.9'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Amazon Product Advertising in Ruby
 test_files: []