emporium 0.0.3.alpha → 0.0.3

data/README.md

@@ -2,6 +2,7 @@
 
 Automatic identification and data capture library to read UPC/EAN and get as much information as it possibly can.
 
+
 ## Installation
 
 Add to your Gemfile and run the `bundle` command to install it.
@@ -12,8 +13,11 @@ Add to your Gemfile and run the `bundle` command to install it.
 
 **Requires Ruby 1.9.2 or later.**
 
+
 ## Configuration
 
+### Amazon
+
  ```ruby
  service = Emporium::Services::Amazon.configuration do |config|
    config.access_key = "access_key"
@@ -22,6 +26,15 @@ Add to your Gemfile and run the `bundle` command to install it.
  end
  ```
 
+### Google
+
+ ```ruby
+ service = Emporium::Services::Google.configuration do |config|
+   config.access_key = "access_key"
+   config.cme = "cse" # custom search engine
+ end
+ ```
+
 
 ## Usage
 
@@ -36,7 +49,29 @@ Give it a UPC to fetch a product object. The Code only takes UPC-A digits
  ```
 
 
-
 ## Development
 
-This gem is under the MIT License.
+Questions or problems? Please post them on the [issue tracker](https://github.com/hugobast/emporium/issues). 
+
+You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`. Create a yml file under the spec folder that looks like this first:
+
+```yaml
+amazon:
+  secret: <secret>
+  access_key: <access_key>
+  associate_tag: <associate_tag>
+
+google:
+  access_key: <access_key>
+  cse: <custom_search_engine>
+```
+
+## Licence
+
+Copyright (c) 2011 Hugo Bastien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/emporium.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Hugo Bastien"]
   s.email       = ["hugobast@gmail.com"]
   s.homepage    = "https://github.com/hugobast/emporium"
-  s.summary     = %q{Emporium fetches information about a product from it's UPC}
-  s.description = %q{Early release, only uses amazon product advertising API }
+  s.summary     = %q{Emporium fetches information about a product from it's UPC (GTIN-12)}
+  s.description = %q{Uses Amazon's product advertising API or Google's Shopping Search API}
 
   s.rubyforge_project = "emporium"
 
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'nokogiri'
   s.add_dependency 'ruby-hmac'
+  s.add_dependency 'json'
 
   s.add_development_dependency "rspec"
 end

data/lib/emporium/product.rb

@@ -9,13 +9,22 @@ module Emporium
     end
     
     def fetch!
+      @service.response
       create @service.response
     end
 
-    def use(service)
-      @service = service.new(code: @code.value)
+    def use(service, options={})
+      options.merge!(code: @code.value)
+      @service = service.new(options)
     end
-
+    
+  private
+    def create(hash)
+      hash.each do |key, value|
+        self.instance_variable_set("@#{key.to_s}",  value)
+      end
+    end
+    
     def method_missing(name, *args)
       if self.instance_variables.include? :"@#{name}"
         self.instance_variable_get("@#{name}")
@@ -23,12 +32,5 @@ module Emporium
         super
       end
     end
-    
-  private
-    def create(response)
-      response.search("ItemAttributes").children.each do |value|
-        self.instance_variable_set("@#{value.name.downcase}",  value.content)
-      end
-    end
   end
 end

data/lib/emporium/services/amazon.rb

@@ -1,72 +1,57 @@
+require 'hmac'
+require 'hmac-sha2'
+require 'base64'
+require 'nokogiri'
+
 module Emporium
   module Services
     class Amazon
+      include Emporium::Services::Options
+
+      service_attr_accessor :access_key, :secret, :associate_tag
+
       def initialize(options={})
         @options = options
       end
 
       def response
-        res = ::Nokogiri::XML(open("http://webservices.amazon.com/onca/xml?#{signed_query}"))
-        message = res.search('Message')
-        raise message.children.first.content unless message.empty?
-        res
+        attributes
       end
 
     private
-      def params
-        {
-          "Service" => "AWSECommerceService",
-          "Operation" => "ItemLookup",
-          "IdType" => @options[:type] || "UPC",
-          "ItemId" => @options[:code],
-          "SearchIndex" => @options[:search_index] || "All",
-          "ResponseGroup" => @options[:response_group] || "Medium",
-          "Version" => @options[:version] || "2011-08-01",
-          "AssociateTag" => @@associate_tag,
-          "Timestamp" => Time.now.iso8601,
-          "AWSAccessKeyId" => @@access_key
-        }
-      end
+      include Emporium::Services::Utilities
 
-      def to_query(hash)
-        hash.sort.collect { |k, v| [encode(k), encode(v.to_s)].join("=") }.join("&")
+      def attributes
+        response = ::Nokogiri::XML(open("http://webservices.amazon.com/onca/xml?#{signed_query}"))
+        message = response.search('Message')
+        raise message.children.first.content unless message.empty?
+        hash_from_xml response.search('ItemAttributes')
       end
 
       def signed_query
         digest = HMAC::SHA256.digest(@@secret, request)
         signature = Base64.encode64(digest).chomp
-        to_query(params.merge "Signature" => signature)
-      end
-
-      def encode(value)
-        CGI.escape(value).gsub("%7E", "~").gsub("+", "%20")
+        query(params.merge "Signature" => signature)
       end
 
       def request
-        "GET\nwebservices.amazon.com\n/onca/xml\n#{to_query(params)}"
+        "GET\nwebservices.amazon.com\n/onca/xml\n#{query(params)}"
       end
-      class << self
-
-        def configuration
-          yield self
-        end
-
-        def class_option(*symbols)
-          symbols.each do |symbol|
-            class_eval(<<-EOS)
-              def self.#{symbol}
-                @@#{symbol}
-              end
 
-              def self.#{symbol}=(value)
-                @@#{symbol} = value
-              end
-            EOS
-          end
-        end
+      def params
+        {
+          'Service'         => 'AWSECommerceService',
+          'Operation'       => 'ItemLookup',
+          'IdType'          => @options[:type]            || 'UPC',
+          'ItemId'          => @options[:code],
+          'SearchIndex'     => @options[:search_index]    || 'All',
+          'ResponseGroup'   => @options[:response_group]  || 'Medium',
+          'Version'         => @options[:version]         || '2011-08-01',
+          'AssociateTag'    => @@associate_tag,
+          'Timestamp'       => Time.now.iso8601,
+          'AWSAccessKeyId'  => @@access_key
+        }
       end
-
-      class_option :access_key, :secret, :associate_tag
     end
   end
 end

data/lib/emporium/services/google.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+module Emporium
+  module Services
+    class Google
+      include Emporium::Services::Options
+      service_attr_accessor :access_key, :cse
+
+      def initialize(options={})
+        @options = options
+      end
+
+      def response
+        attributes
+      end
+
+    private
+      include Emporium::Services::Utilities
+
+      def attributes
+        response = open(request)
+        hash = hash_from_json(response.read)
+        raise message unless hash["totalItems"] > 0
+        hash["items"][0]["product"]
+      end
+
+      def message
+        "q=#{@options[:code]} generated no results"
+      end
+
+      def request
+        "https://www.googleapis.com/shopping/search/v1/public/products?#{query(params)}"
+      end
+
+      def params
+        {
+          'q'       => @options[:code],
+          'alt'     => @options[:alt]     || 'json',
+          'country' => @options[:country] || 'US',
+          'key'     => @@access_key
+        }
+      end
+    end
+  end
+end

data/lib/emporium/services/options.rb

@@ -0,0 +1,31 @@
+module Emporium
+  module Services
+
+    module Options
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def configuration
+          yield self
+        end
+
+        def service_attr_accessor(*symbols)
+          symbols.each do |symbol|
+            class_eval(<<-EOS)
+              def self.#{symbol}
+                @@#{symbol}
+              end
+
+              def self.#{symbol}=(value)
+                @@#{symbol} = value
+              end
+            EOS
+          end
+        end
+      end
+    end
+  
+  end
+end

data/lib/emporium/services/utilities.rb

@@ -0,0 +1,29 @@
+module Emporium
+  module Services
+    module Utilities
+      def hash_from_xml(xml)
+        # Only the first level elements for now
+
+        result_hash = {}
+        xml.children.each do |value|
+          result_hash[value.name.downcase.to_sym] = value.content
+        end
+        result_hash
+      end
+
+      def hash_from_json(json)
+        JSON.parse(json)
+      end
+
+      def query(hash)
+        hash.sort.collect { 
+          |k, v| [encode(k), encode(v.to_s)].join("=") 
+        }.join("&")
+      end
+
+      def encode(value)
+        CGI.escape(value)
+      end
+    end
+  end
+end

data/lib/emporium/services.rb

@@ -1,9 +1,8 @@
+require 'emporium/services/options'
+require 'emporium/services/utilities'
 require 'emporium/services/amazon'
+require 'emporium/services/google'
 
-require 'hmac'
-require 'hmac-sha2'
 require 'time'
 require 'cgi'
-require 'base64'
 require 'open-uri'
-require 'nokogiri'

data/lib/emporium/version.rb

@@ -1,3 +1,3 @@
 module Emporium
-  VERSION = "0.0.3.alpha"
+  VERSION = "0.0.3"
 end

data/spec/emporium/emporium_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
 Emporium::Services::Amazon.configuration do |config|
-  config.access_key = CONFIG["access_key"]
-  config.associate_tag = CONFIG["associate_tag"]
-  config.secret = CONFIG["secret"]
+  config.access_key = AMAZON["access_key"]
+  config.associate_tag = AMAZON["associate_tag"]
+  config.secret = AMAZON["secret"]
+end
+
+Emporium::Services::Google.configuration do |config|
+  config.access_key = GOOGLE["access_key"]
+  config.cse = GOOGLE["cse"]
 end
 
 describe Emporium::Product do
   describe "#new" do
-    it "creates an instance from a upc" do
-      product = Emporium::Product.new("036000241457")
-      product.should be_an_instance_of Emporium::Product
-    end
-    
     it "fails to create an instance if no upc is given" do
       lambda { Emporium::Product.new() }.should raise_error
     end
@@ -24,16 +24,33 @@ describe Emporium::Product do
 
   describe "#fetch!" do
     product = Emporium::Product.new("610839331574")
-    product.use Emporium::Services::Amazon
 
-    it "should fetch product information" do
-      lambda { product.fetch! }.should_not raise_error
+    describe "using the amazon service" do
+      product.use Emporium::Services::Amazon
+
+      it "should fetch product information" do
+        lambda { product.fetch! }.should_not raise_error
+      end
+
+      it "should create attributes for the product" do
+        product.fetch!
+        product.brand.downcase.should match 'asus'
+      end
     end
 
-    it "should create attributes for the product" do
-      product.fetch!
-      product.brand.should match 'Asus'
+    describe "using the google service" do
+      product.use Emporium::Services::Google
+      
+      it "should fetch product information" do
+        lambda { product.fetch! }.should_not raise_error
+      end
+
+      it "should create attributes for the product" do
+        product.fetch!
+        product.brand.downcase.should match 'asus'
+      end
     end
+
   end
 
   describe "#use" do
@@ -48,20 +65,45 @@ end
 describe Emporium::Services::Amazon do
   describe "#new" do
     it "should initialize with options" do
-      options = {some: "option"}
+      options = { some: "option" }
       service = Emporium::Services::Amazon.new(options)
       service.instance_variable_get('@options')[:some].should match "option"
     end
   end
 
   describe "#response" do
-    it "should return an XML document" do
+    it "should return a Hash" do
       service = Emporium::Services::Amazon.new(code: "610839331574")
-      service.response.should be_a_kind_of ::Nokogiri::XML::Document
+      service.response.should be_an_instance_of Hash
     end
 
     it "should raise an error if nothing is found" do
-      lambda { Emporium::Services::Amazon.new(code: "036000241452").response }.should raise_error
+      lambda {
+        Emporium::Services::Amazon.new(code: "036000241452").response
+      }.should raise_error
+    end
+  end
+end
+
+describe Emporium::Services::Google do
+  describe "#new" do
+    it "should initialize with options" do
+      options = { some: "option" }
+      service = Emporium::Services::Amazon.new(options)
+      service.instance_variable_get('@options')[:some].should match "option"
+    end
+  end
+
+  describe "#response" do
+    it "should return a Hash" do
+      service = Emporium::Services::Google.new(code: "610839331574")
+      service.response.should be_an_instance_of Hash
+    end
+
+    it "should return an error if nothing is found" do
+      lambda {
+        service = Emporium::Services::Google.new(code: "ASjh@89a2$").response
+      }.should raise_error
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,3 +2,5 @@ require 'emporium'
 require 'yaml'
 
 CONFIG = YAML.load_file('./spec/config.yml')
+AMAZON = CONFIG["amazon"]
+GOOGLE = CONFIG["google"]

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: emporium
 version: !ruby/object:Gem::Version 
-  prerelease: 6
-  version: 0.0.3.alpha
+  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors: 
 - Hugo Bastien
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-05 00:00:00 Z
+date: 2011-12-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -35,7 +35,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -43,9 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
-description: "Early release, only uses amazon product advertising API "
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Uses Amazon's product advertising API or Google's Shopping Search API
 email: 
 - hugobast@gmail.com
 executables: []
@@ -66,6 +77,9 @@ files:
 - lib/emporium/product.rb
 - lib/emporium/services.rb
 - lib/emporium/services/amazon.rb
+- lib/emporium/services/google.rb
+- lib/emporium/services/options.rb
+- lib/emporium/services/utilities.rb
 - lib/emporium/version.rb
 - spec/emporium/emporium_spec.rb
 - spec/spec_helper.rb
@@ -86,16 +100,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: emporium
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Emporium fetches information about a product from it's UPC
+summary: Emporium fetches information about a product from it's UPC (GTIN-12)
 test_files: 
 - spec/emporium/emporium_spec.rb
 - spec/spec_helper.rb