invisiblehand 0.1.2 → 0.1.3

data/README.md

@@ -86,6 +86,10 @@ If the API returns any error information, an `InvisibleHand::Error::APIError` is
 thrown and the `#message` method of the error object will contain the error
 output from the API.
 
+The `InvisibleHand::Error::APIError` object also contains `#url` and
+`#raw_response` methods that give you what URL on the API got hit and what the
+raw response from the server was for debugging purposes.
+
 ### Logging
 
 The InvisibleHand gem does have debug logging that goes to an internal `Logger`
@@ -108,6 +112,19 @@ The gem looks for a DEBUG environment variable. If DEBUG is set, debugging
 information will be printed out to the screen. This includes URL information
 every time an API call is made.
 
+Alternately, if you want to do ad-hoc debugging on single API calls you can pass
+in a debugging option:
+
+``` ruby
+require 'invisiblehand'
+
+api = InvisibleHand::API.new :app_id => "id", :app_key => "key"
+
+api.products query: "nickelback", debug: true
+#=> Result is the same as normal, you'll just get verbose debugging output to
+#   the gem's internal logger (which you can override, see Logging above).
+```
+
 ## Development
 
 To run tests, first you will need a valid `invisiblehand.yml` config file inside

data/invisiblehand.sample.yml

@@ -1,11 +1,11 @@
 :app_id:  "your app id here"
 :app_key: "your app key here"
 
-# The endpoint is the region of the API you would like to hit. The regions are
+# The :region is the region of the API you would like to hit. The regions are
 # detailed in the developer documentation:
 #
 #   https://developer.getinvisiblehand.com/documentation#intro
 #
 # The option will default to the US if you do not explicitly specify it.
 #
-# :endpoint: us.api.invisiblehand.co.uk
+# :region: us

data/lib/invisiblehand/api.rb

@@ -44,7 +44,6 @@ module InvisibleHand
       end
 
       @config[:protocol] = @config[:use_ssl] == false ? "http://" : "https://"
-      @config[:endpoint] ||= "us.api.invisiblehand.co.uk"
     end
 
     def products opts = {}
@@ -69,7 +68,7 @@ module InvisibleHand
 
     def api_call method, path, opts = {}
       query = url_params_from opts
-      url   = "#{@config[:protocol]}#{@config[:endpoint]}#{path}?#{query}"
+      url   = "#{@config[:protocol]}#{endpoint}#{path}?#{query}"
 
       if opts[:debug]
         debug { api_raw_request method, url }
@@ -80,6 +79,19 @@ module InvisibleHand
 
     private
 
+    # Gets the endpoint of the API to hit. Prioritises the :region config
+    # parameter over :endpoint. In the event that neither are presents, defaults
+    # to the US.
+    def endpoint
+      if @config[:region]
+        "#{@config[:region]}.api.invisiblehand.co.uk"
+      elsif @config[:endpoint]
+        @config[:endpoint]
+      else
+        "us.api.invisiblehand.co.uk"
+      end
+    end
+
     def debug &block
       old_log_level = logger.level
       logger.level  = ::Logger::DEBUG

data/lib/invisiblehand/version.rb

@@ -1,5 +1,5 @@
 module InvisibleHand
   unless const_defined? :VERSION
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/spec/api_spec.rb

@@ -5,86 +5,96 @@ describe InvisibleHand::API do
   # yourself if you wish to run tests.
   let(:api_config) { File.join(File.dirname(__FILE__), 'invisiblehand.yml') }
 
-  let(:api)        { InvisibleHand::API.new(api_config) }
-  let(:product)    { api.products["results"].first }
-  let(:product_id) { product["id"] }
-  let(:page)       { product["best_page"] }
-
-  describe "#products" do
-    subject    { api.products }
-    it         { should be_a Hash }
-    its(:keys) { should include "results" }
-    its(:keys) { should include "info" }
-  end
+  ["uk", "us", "ca", "de"].each do |region|
+    describe "Region: #{region}" do
+      let :api do
+        conf = YAML.load_file(api_config)
+        conf = conf.merge :region => region
 
-  describe "#product" do
-    subject { product }
-    it      { should_not be_nil }
-  end
+        InvisibleHand::API.new(conf)
+      end
 
-  describe "#live_price" do
-    describe "with live price url" do
-      subject { api.live_price(page["live_price_url"]) }
-      it      { should be_a Float }
-    end
+      let(:product)    { api.products["results"].first }
+      let(:product_id) { product["id"] }
+      let(:page)       { product["best_page"] }
 
-    describe "with vanilla page url" do
-      subject { api.live_price(page["original_url"]) }
-      it      { should be_a Float }
-    end
-  end
+      describe "#products" do
+        subject    { api.products }
+        it         { should be_a Hash }
+        its(:keys) { should include "results" }
+        its(:keys) { should include "info" }
+      end
 
-  describe "ad-hoc debug flag" do
-    specify "the debug option to a single call should not break things" do
-      expect do
-        api.live_price(page["original_url"], :debug => true)
-      end.to_not raise_error
-    end
-  end
+      describe "#product" do
+        subject { product }
+        it      { should_not be_nil }
+      end
 
-  describe "invalid config" do
-    specify "no app_id or api_key should throw error" do
-      expect do
-        InvisibleHand::API.new
-      end.to raise_error InvisibleHand::Error::InvalidConfig
-    end
-  end
+      describe "#live_price" do
+        describe "with live price url" do
+          subject { api.live_price(page["live_price_url"]) }
+          it      { should be_a Float }
+        end
 
-  describe "invalid api calls" do
-    describe "#product" do
-      specify "should throw InvisibleHand::Error::APIError on invalid ID" do
-        expect do
-          api.product "not a real id at all, lol"
-        end.to raise_error InvisibleHand::Error::APIError
+        describe "with vanilla page url" do
+          subject { api.live_price(page["original_url"]) }
+          it      { should be_a Float }
+        end
       end
-    end
 
-    describe "#live_price" do
-      specify "should throw InvisibleHand::Error::APIError on invalid URL" do
-        expect do
-          api.live_price "not a real url, rofl"
-        end.to raise_error InvisibleHand::Error::APIError
+      describe "ad-hoc debug flag" do
+        specify "the debug option to a single call should not break things" do
+          expect do
+            api.live_price(page["original_url"], :debug => true)
+          end.to_not raise_error
+        end
       end
-    end
-  end
 
-  describe "errors" do
-    describe InvisibleHand::Error::APIError do
-      subject do
-        error = nil
+      describe "invalid config" do
+        specify "no app_id or api_key should throw error" do
+          expect do
+            InvisibleHand::API.new
+          end.to raise_error InvisibleHand::Error::InvalidConfig
+        end
+      end
 
-        begin
-          api.live_price "not a real url"
-        rescue InvisibleHand::Error::APIError => e
-          error = e
+      describe "invalid api calls" do
+        describe "#product" do
+          specify "should throw InvisibleHand::Error::APIError on invalid ID" do
+            expect do
+              api.product "not a real id at all, lol"
+            end.to raise_error InvisibleHand::Error::APIError
+          end
         end
 
-        error
+        describe "#live_price" do
+          specify "should throw InvisibleHand::Error::APIError on invalid URL" do
+            expect do
+              api.live_price "not a real url, rofl"
+            end.to raise_error InvisibleHand::Error::APIError
+          end
+        end
       end
 
-      its(:url)          { should be_a String }
-      its(:raw_response) { should be_a String }
-      its(:message)      { should be_a String }
+      describe "errors" do
+        describe InvisibleHand::Error::APIError do
+          subject do
+            error = nil
+
+            begin
+              api.live_price "not a real url"
+            rescue InvisibleHand::Error::APIError => e
+              error = e
+            end
+
+            error
+          end
+
+          its(:url)          { should be_a String }
+          its(:raw_response) { should be_a String }
+          its(:message)      { should be_a String }
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invisiblehand
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -110,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3726614589269803000
+      hash: 1556147975806628177
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3726614589269803000
+      hash: 1556147975806628177
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24