vacuum 0.2.0 → 0.2.1

data/README.md

@@ -35,12 +35,17 @@ req.build operation:    'ItemSearch',
           search_index: 'Books',
           keywords:     'Deleuze'
 res = req.get
+
+res.valid? or raise res.code
+
+p res.body
 ```
 
-Or accomplish the same search less verbosely:
+Or run the same search less verbosely:
 
 ```ruby
 res = req.search :books, 'Deleuze'
+p res.body
 ```
 
 The response wraps a [Nokogiri] [6] document:
@@ -52,14 +57,12 @@ res.xml
 And lets you drop down to any node:
 
 ```ruby
-if res.valid?
-  res.find('Item') do |item|
-    p item
-  end
+res.find('Item') do |item|
+  p item
 end
 ```
 
-You will find more examples [here] [7].
+Browse more examples [here] [7].
 
 ## Amazon Marketplace Web Services API
 

data/lib/vacuum.rb

@@ -21,9 +21,10 @@ require 'vacuum/version'
 
 # Vacuum is a Ruby wrapper to various Amazon Web Services (AWS) APIs.
 module Vacuum
-  class BadLocale     < ArgumentError; end
-  class MissingKey    < ArgumentError; end
-  class MissingSecret < ArgumentError; end
+  BadLocale     = Class.new ArgumentError
+  BadResponse   = Class.new StandardError
+  MissingKey    = Class.new ArgumentError
+  MissingSecret = Class.new ArgumentError
 
   class << self
     def new(api, &blk)
@@ -31,7 +32,7 @@ module Vacuum
       when /^mws/
         require 'vacuum/mws'
         Request::MWS.new do |config|
-          config.api = api.slice(4, api.size).to_sym 
+          config.api = api.slice(4, api.size).to_sym
           blk.call config
         end
       when :product_advertising

data/lib/vacuum/product_advertising.rb

@@ -3,5 +3,5 @@
 end
 
 module Vacuum
-  class MissingTag < ArgumentError; end
+  MissingTag = Class.new(ArgumentError)
 end

data/lib/vacuum/request/base.rb

@@ -70,6 +70,19 @@ module Vacuum
         Response.const_get(class_basename).new res.body, res.status
       end
 
+      # Performs the AWS API request.
+      #
+      # Raises a Bad Response if the response is not valid.
+      #
+      # Returns a Vacuum::Response::Base or a subclass thereof.
+      def get!
+        unless (res = get).valid?
+          raise BadResponse, "#{res.code} #{res['Code'].first}"
+        end
+
+        res
+      end
+
       # Returns the Hash parameters of the AWS API request.
       def parameters
         default_parameters.merge @parameters

data/lib/vacuum/request/product_advertising.rb

@@ -11,7 +11,9 @@ module Vacuum
       #
       #   request.find '0679753354', response_group: 'Images'
       #
-      # Returns a Vacuum::Response.
+      # Raises a Bad Response if response is not valid.
+      #
+      # Returns a Vacuum::Response::ProductAdvertising.
       def look_up(*item_ids)
         given_params = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
 
@@ -36,7 +38,7 @@ module Vacuum
           end
         build! params
 
-        get
+        get!
       end
 
       # Searches for items that satisfy the given criteria, including one or
@@ -56,6 +58,9 @@ module Vacuum
       #   request.search :books, power: 'author:lacan and not fiction',
       #                          sort:  'relevancerank'
       #
+      # Raises a Bad Response if response is not valid.
+      #
+      # Returns a Vacuum::Response::ProductAdvertising.
       def search(index, query_or_params = nil)
         params = case query_or_params
                  when String
@@ -66,7 +71,7 @@ module Vacuum
         build! params.merge! 'Operation'   => 'ItemSearch',
                              'SearchIndex' => Utils.camelize(index.to_s)
 
-        get
+        get!
       end
 
       # Returns the Addressable::URI URL of the Product Advertising API

data/lib/vacuum/version.rb

@@ -1,3 +1,3 @@
 module Vacuum
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/support/shared_examples/request.rb

@@ -86,6 +86,53 @@ shared_examples 'a request' do
     end
   end
 
+  describe '#get!' do
+    let(:response_class) do
+      Vacuum::Response.const_get request.send(:class_basename)
+    end
+
+    context 'when response is bad' do
+      let(:mock_response) do
+        body = <<-XML.gsub!(/>\s+</, '><').strip!
+          <?xml version=\"1.0\" ?>
+          <ErrorResponse>
+            <Error>
+              <Code>RequestThrottled</Code>
+              <Message>Request from 192.168.0.1 is throttled.</Message>
+            </Error>
+            <RequestID>123</RequestID>
+          </ErrorResponse>
+        XML
+
+        response_class.new body, 503
+      end
+
+      before do
+        request.stub!(:get).and_return mock_response
+      end
+
+      it 'raises a Bad Response error' do
+        expect do
+          request.get!
+        end.to raise_error Vacuum::BadResponse, '503 RequestThrottled'
+      end
+    end
+
+    context 'when response is OK' do
+      let(:mock_response) do
+        response_class.new('', 200)
+      end
+
+      before do
+        request.stub!(:get).and_return mock_response
+      end
+
+      it 'returns the response' do
+        request.get!.should eql mock_response
+      end
+    end
+  end
+
   describe '#parameters' do
     it 'includes default parameters' do
       request.parameters.should have_key 'AWSAccessKeyId'

data/spec/vacuum/request/product_advertising_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module Vacuum
   module Request
     describe ProductAdvertising do
+      let(:mock_response) do
+        Response::ProductAdvertising.new '', 200
+      end
+
       let(:request) do
         described_class.new do |config|
           config.key = 'key'
@@ -15,7 +19,7 @@ module Vacuum
 
       describe '#look_up' do
         before do
-          request.stub! :get
+          request.stub!(:get).and_return mock_response
         end
 
         let(:parameters) do
@@ -71,6 +75,10 @@ module Vacuum
           request.parameters
         end
 
+        before do
+          request.stub!(:get).and_return mock_response
+        end
+
         context 'when given a search index and a keyword' do
           before do
             request.search :foo, 'bar'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70130080587320 !ruby/object:Gem::Requirement
+  requirement: &70156392348820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70130080587320
+  version_requirements: *70156392348820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70130080586800 !ruby/object:Gem::Requirement
+  requirement: &70156392348380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70130080586800
+  version_requirements: *70156392348380
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70130080586300 !ruby/object:Gem::Requirement
+  requirement: &70156392347700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70130080586300
+  version_requirements: *70156392347700
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70130080585780 !ruby/object:Gem::Requirement
+  requirement: &70156392347120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70130080585780
+  version_requirements: *70156392347120
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70130080585140 !ruby/object:Gem::Requirement
+  requirement: &70156392346540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70130080585140
+  version_requirements: *70156392346540
 description: ! 'Vacuum is a wrapper to various Amazon Web Services (AWS) APIs, including
 
   Product Advertising and Marketplace Web Services (MWS).