invisiblehand 0.1.3 → 0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Sam Rose
+Copyright (c) 2013 InvisibleHand Software Limited
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -51,8 +51,9 @@ api = InvisibleHand::API.new "path/to/invisiblehand.yml"
 api.products({
   :query => "ipad"
 })
-#=> A massive hash that you can find details of at:
-#     https://developer.getinvisiblehand.com/documentation
+#=> An InvisibleHand::Response object that contains the methods #results and
+#   #info. #results is an array of InvisibleHand::Product objects and #info is
+#   a Hash of meta information on the request (number of results, etc.)
 
 # Search for products with sorting and ordering and a specific size.
 api.products({
@@ -61,8 +62,6 @@ api.products({
   :order => "desc",      # Direction to order results by
   :size => "100"         # Number of results to return
 })
-#=> A massive hash that you can find details of at:
-#     https://developer.getinvisiblehand.com/documentation
 
 # Do a live price search on a product (price comes back as the currency in the
 # URL you specify. On amazon.com you get dollars, amazon.co.uk you get pounds.)
@@ -75,11 +74,22 @@ api.live_price "http://api.invisiblehand.co.uk/v1/pages/live_price?url=http%3A%2
 
 # Search for a specific product by its Invisible Hand ID
 api.product "f619c3e117d50d1a2b10930e5b202336"
-#=> A hash containing details of this item. More info at:
-#     https://developer.getinvisiblehand.com/documentation
+#=> An InvisibleHand::Product object.
 
 ```
 
+### Region
+
+A little clarification surrounding what the `:region` parameter is for in the
+`invisiblehand.sample.yml` file.
+
+Because product data differs depending on where that product is being sold (for
+example, `amazon.com` and `amazon.co.uk` can differ in price and such), the API
+returns you only the data relevant to the region that you specify.
+
+A product that exists in our dataset and has only pages in the UK will not be
+returned for queries that are done on the US API endpoint.
+
 ### Errors
 
 If the API returns any error information, an `InvisibleHand::Error::APIError` is

data/lib/invisiblehand/api.rb

@@ -36,7 +36,7 @@ module InvisibleHand
 
       # The @config[:development] flag exists to bypass the app_id and app_key
       # check in this gem (not on the server) for internal testing reasons.
-      if valid_config?
+      if invalid_config? and !@config[:development]
         message = "Your config does not contain an app_id and app_key. " +
           "Both are required to make API calls."
 
@@ -44,14 +44,37 @@ module InvisibleHand
       end
 
       @config[:protocol] = @config[:use_ssl] == false ? "http://" : "https://"
+      @config[:version] ||= "1"
     end
 
     def products opts = {}
-      api_call :get, "/v1/products", opts
+      response = api_call :get, "/products", opts
+
+      if opts[:raw]
+        response
+      else
+        Response.new(response, self)
+      end
     end
 
     def product id, opts = {}
-      api_call :get, "/v1/products/#{CGI.escape(id)}", opts
+      response = api_call :get, "/products/#{CGI.escape(id)}", opts
+
+      if opts[:raw]
+        response
+      else
+        Product.new(response, self)
+      end
+    end
+
+    def page url, opts = {}
+      response = api_call :get, "/pages/?url=#{CGI.escape(url)}", opts
+
+      if opts[:raw]
+        response
+      else
+        Page.new(response, self)
+      end
     end
 
     def live_price url, opts = {}
@@ -61,14 +84,21 @@ module InvisibleHand
         json["price"]
       else
         opts[:url] = url
-        json = api_call :get, "/v1/pages/live_price", opts
+        json = api_call :get, "/pages/live_price", opts
         json["price"]
       end
     end
 
     def api_call method, path, opts = {}
+      if !@config[:development]
+        opts.merge!({
+          :app_id => @config[:app_id],
+          :app_key => @config[:app_key],
+        })
+      end
+
       query = url_params_from opts
-      url   = "#{@config[:protocol]}#{endpoint}#{path}?#{query}"
+      url   = "#{@config[:protocol]}#{endpoint}/v#{@config[:version]}#{path}?#{query}"
 
       if opts[:debug]
         debug { api_raw_request method, url }
@@ -96,8 +126,9 @@ module InvisibleHand
       old_log_level = logger.level
       logger.level  = ::Logger::DEBUG
       result        = block.call
-      logger.level  = old_log_level
       result
+    ensure
+      logger.level  = old_log_level
     end
 
     def api_raw_request method, url
@@ -124,7 +155,7 @@ module InvisibleHand
       params = hash.map do |key, value|
         # There are some parameters that will be passed to an API call that we
         # don't want to include in the query string. Filter them out here.
-        next if [:debug].include? key.to_sym
+        next if [:debug, :raw].include? key.to_sym
 
         "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
       end
@@ -132,10 +163,8 @@ module InvisibleHand
       params.compact.join('&')
     end
 
-    def valid_config?
-      @config[:app_id].nil? and
-        @config[:app_key].nil? and
-        !@config[:development]
+    def invalid_config?
+      (@config[:app_id].nil? or @config[:app_key].nil?)
     end
   end
 end

data/lib/invisiblehand/page.rb

@@ -0,0 +1,38 @@
+module InvisibleHand
+  class Page
+    # Array of fields that exist on a page returned from the InvisibleHand
+    # API.
+    FIELDS = [
+      :title,
+      :deeplink,
+      :original_url,
+      :price,
+      :currency,
+      :pnp,
+      :image_url,
+      :retailer_name,
+      :price_confidence,
+      :live_price_url,
+      :ean,
+      :upc,
+      :brand,
+      :model,
+      :mpn,
+      :isbn,
+      :asin,
+      :category,
+    ]
+
+    attr_accessor(*FIELDS)
+
+    def initialize raw, api
+      @api = api
+      @raw = raw
+      FIELDS.each { |key| self.send("#{key}=", @raw[key.to_s]) }
+    end
+
+    def live_price opts = {}
+      @api.live_price(self.live_price_url, opts)
+    end
+  end
+end

data/lib/invisiblehand/product.rb

@@ -0,0 +1,44 @@
+module InvisibleHand
+  class Product
+    # Array of fields that exist on a product returned from the InvisibleHand
+    # API.
+    FIELDS = [
+      :pages,
+      :ebay_pages,
+      :best_page,
+      :id,
+      :title,
+      :resource,
+      :upcs,
+      :eans,
+      :mpns,
+      :isbns,
+      :asins,
+      :brands,
+      :models,
+      :categories,
+      :image_url,
+      :number_of_pages,
+    ]
+
+    attr_accessor(*FIELDS)
+
+    def initialize raw, api
+      @api = api
+      @raw = raw
+      FIELDS.each { |key| self.send("#{key}=", @raw[key.to_s]) }
+
+      if @raw["pages"]
+        self.pages = @raw["pages"].map { |json| Page.new(json, @api) }
+      end
+
+      if @raw["ebay_pages"]
+        self.ebay_pages = @raw["ebay_pages"].map { |json| Page.new(json, @api) }
+      end
+
+      if @raw["best_page"]
+        self.best_page = Page.new(@raw["best_page"], @api)
+      end
+    end
+  end
+end

data/lib/invisiblehand/response.rb

@@ -0,0 +1,28 @@
+module InvisibleHand
+  class Response
+    include Enumerable
+
+    # Array of fields that exist on a response returned from the InvisibleHand
+    # API.
+    FIELDS = [
+      :info,
+      :results,
+    ]
+
+    attr_accessor(*FIELDS)
+
+    def initialize raw, api
+      @api = api
+      @raw = raw
+      FIELDS.each { |key| self.send("#{key}=", @raw[key.to_s]) }
+
+      if @raw["results"]
+        self.results = @raw["results"].map { |json| Product.new(json, @api) }
+      end
+    end
+
+    def each &block
+      self.results.each(&block)
+    end
+  end
+end

data/lib/invisiblehand/version.rb

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

data/samples/live_price.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'invisiblehand'
+
+api = InvisibleHand::API.new :app_id => "", :api_key => "", :region => "uk"
+
+begin
+  price = api.live_price "http://www.amazon.co.uk/Here-And-Now/dp/B0064Y9L9C"
+
+  puts "£%.2f" % price
+rescue InvisibleHand::Error::APIError => e
+  puts "Oh noes! There was an error: #{e.message}"
+end

data/samples/product.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'invisiblehand'
+
+api = InvisibleHand::API.new :app_id => "", :api_key => "", :region => "uk"
+
+begin
+  # The "78b4fb8fa97b8bc746726a32d3393833" bit is a product ID in our database.
+  # You aren't expected to know these beforehand, they will come from other API
+  # calls.
+  product = api.product "78b4fb8fa97b8bc746726a32d3393833"
+
+  product["pages"].each do |page|
+    puts "Retailer: %s" % page["retailer_name"]
+    puts "Title: %s" % page["title"]
+    puts "Price: £%.2f" % page["price"]
+    puts
+  end
+rescue InvisibleHand::Error::APIError => e
+  puts "Oh noes! There was an error: #{e.message}"
+end

data/samples/products.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'invisiblehand'
+
+api = InvisibleHand::API.new :app_id => "", :api_key => "", :region => "uk"
+
+begin
+  response = api.products(:query => "nickelback", :size => 5)
+
+  response["results"].each do |product|
+    puts "Title: %s" % product["best_page"]["title"]
+    puts "Price: £%.2f" % product["best_page"]["price"]
+    puts
+  end
+rescue InvisibleHand::Error::APIError => e
+  puts "Oh noes! There was an error: #{e.message}"
+end

data/spec/api_spec.rb

@@ -5,6 +5,15 @@ describe InvisibleHand::API do
   # yourself if you wish to run tests.
   let(:api_config) { File.join(File.dirname(__FILE__), 'invisiblehand.yml') }
 
+  before do
+    unless File.exist?(api_config)
+      puts "Your test config file does not exist. It should be at " +
+        "#{api_config}."
+
+      exit 1
+    end
+  end
+
   ["uk", "us", "ca", "de"].each do |region|
     describe "Region: #{region}" do
       let :api do
@@ -14,15 +23,22 @@ describe InvisibleHand::API do
         InvisibleHand::API.new(conf)
       end
 
-      let(:product)    { api.products["results"].first }
-      let(:product_id) { product["id"] }
-      let(:page)       { product["best_page"] }
+      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" }
+        subject       { api.products }
+        it            { should be_a InvisibleHand::Response }
+        its(:results) { should be_a Array }
+        its(:info)    { should be_a Hash }
+      end
+
+      describe "#products :raw => true" do
+        subject       { api.products :raw => true }
+        it            { should be_a Hash }
+        its(:keys)    { should include "results" }
+        its(:keys)    { should include "info" }
       end
 
       describe "#product" do
@@ -32,12 +48,12 @@ describe InvisibleHand::API do
 
       describe "#live_price" do
         describe "with live price url" do
-          subject { api.live_price(page["live_price_url"]) }
+          subject { page.live_price }
           it      { should be_a Float }
         end
 
         describe "with vanilla page url" do
-          subject { api.live_price(page["original_url"]) }
+          subject { api.live_price(page.original_url) }
           it      { should be_a Float }
         end
       end
@@ -45,7 +61,7 @@ describe InvisibleHand::API do
       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)
+            api.live_price(page.original_url, :debug => true)
           end.to_not raise_error
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invisiblehand
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -93,7 +93,13 @@ files:
 - lib/invisiblehand/api.rb
 - lib/invisiblehand/errors.rb
 - lib/invisiblehand/logger.rb
+- lib/invisiblehand/page.rb
+- lib/invisiblehand/product.rb
+- lib/invisiblehand/response.rb
 - lib/invisiblehand/version.rb
+- samples/live_price.rb
+- samples/product.rb
+- samples/products.rb
 - spec/api_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -110,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1556147975806628177
+      hash: -4521448315867850484
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1556147975806628177
+      hash: -4521448315867850484
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24