emporium 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+spec/config.yml

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in supermarket.gemspec
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# Emporium
+
+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.
+
+ ```ruby
+ gem "emporium"
+ ```
+
+**Requires Ruby 1.9.2 or later.**
+
+
+## Usage
+
+Given a UPC returns a product object that gets populated calling fetch. The Code class takes UPC-A or EAN digits
+
+ ```ruby
+ require 'emporium'
+
+ product = Emporium::Product.new "066661234567"
+ product.use :amazon
+ product.fetch!
+ ```
+
+## Development
+
+This gem is created by Hugo Bastien and is under the MIT License.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/emporium.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "emporium/version"
+
+Gem::Specification.new do |s|
+  s.name        = "emporium"
+  s.version     = Emporium::VERSION
+  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.rubyforge_project = "emporium"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'ruby-hmac'
+
+  s.add_development_dependency "rspec"
+end

data/lib/emporium/code.rb

@@ -0,0 +1,38 @@
+module Emporium
+  class Code
+    attr_accessor :value
+    
+    def initialize(value)
+      @value, @check_digit, @code = value, value[-1, 1].to_i, value.chop
+      attach_methods!
+    end
+    
+    def valid?
+      return unless (@value =~ /^[0-9]+$/) != nil
+      compute(@code.odds, @code.evens) == @check_digit
+    end
+    
+  private
+    def compute(odds, evens)
+      # source http://en.wikipedia.org/wiki/Universal_Product_Code#Check_digits
+      remainder = (odds.inject(:+) * 3 + evens.inject(:+)) % 10
+      remainder == 0 ? remainder : 10 - remainder
+    end
+  
+    def attach_methods!
+      @code.instance_eval do
+        def odds
+          self.subset(/(.).?/)
+        end
+      
+        def evens
+          self.subset(/.(.)?/)
+        end
+      
+        def subset(filter)
+          self.scan(filter).flatten.map{ |s| s.to_i }
+        end
+      end
+    end
+  end
+end

data/lib/emporium/product.rb

@@ -0,0 +1,86 @@
+module Emporium
+  class Product
+    attr_accessor :code
+    
+    def initialize(code, options={})
+      @code = ::Code.new(code)
+      raise "invalid code" unless @code.valid?
+      @options = options.merge! code: @code.value
+    end
+    
+    def fetch!
+      if @@service == :amazon
+        create ::Nokogiri::XML(open("#{@@service_url}?#{signed_query}"))
+      end
+    end
+
+    def self.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
+
+    class_option :access_key, :secret, :associate_tag
+    class_option :service, :service_url
+
+    def method_missing(name, *args)
+      if self.instance_variables.include? :"@#{name}"
+        self.instance_variable_get("@#{name}")
+      else
+        super
+      end
+    end
+    
+  private
+
+    def create(result)
+      if @@service == :amazon
+        result.search("ItemAttributes").children.each do |value|
+          self.instance_variable_set("@#{value.name.downcase}",  value.content)
+        end
+      end
+    end
+  
+    def params
+      {
+        "Service" => "AWSECommerceService",
+        "Operation" => "ItemLookup",
+        "IdType" => "UPC",
+        "ItemId" => @code.value,
+        "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
+
+    def to_query(hash)
+      hash.sort.collect { |k, v| [encode(k), encode(v.to_s)].join("=") }.join("&")
+    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")
+    end
+
+    def request
+      "GET\nwebservices.amazon.com\n/onca/xml\n#{to_query(params)}"
+    end
+
+  end
+end

data/lib/emporium/version.rb

@@ -0,0 +1,3 @@
+module Emporium
+  VERSION = "0.0.1"
+end

data/lib/emporium.rb

@@ -0,0 +1,11 @@
+require "emporium/version"
+require "emporium/code"
+require "emporium/product"
+
+require 'hmac'
+require 'hmac-sha2'
+require 'time'
+require 'cgi'
+require 'base64'
+require 'nokogiri'
+require 'open-uri'

data/spec/emporium/emporium_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Product do
+  before(:each) do
+    Product.service = :amazon
+    Product.service_url = "http://webservices.amazon.com/onca/xml"
+    Product.access_key = CONFIG["access_key"]
+    Product.associate_tag = CONFIG["associate_tag"]
+    Product.secret = CONFIG["secret"]
+  end
+
+  it "uses the amazon service" do
+    Product.service.should be :amazon
+  end
+
+  describe "#new" do
+    it "creates an instance from a upc" do
+      product = Product.new("036000241457")
+      product.should be_an_instance_of Product
+    end
+    
+    it "fails to create an instance if no upc is given" do
+      lambda { Product.new() }.should raise_error
+    end
+    
+    it "fails to create an instance if invalid upc is given" do
+      lambda { Product.new("036000241452") }.should raise_error
+    end
+
+    it "has options in options if provided" do
+      product = Product.new("036000241457", secret: 'secret')
+      product.instance_eval { @options[:secret] }.should match 'secret'
+    end
+  end
+
+  describe "#fetch!" do
+    product = Product.new("610839331574")
+
+    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.should match 'Asus'
+    end
+
+  end
+end
+
+describe Code do
+  describe "#valid?" do
+    it "returns true for a valid UPC" do
+      code = Code.new("036000241457")
+      code.valid?.should be true
+    end
+    
+    it "returns false for an invalid UPC" do
+      code = Code.new("036000241452")
+      code.valid?.should_not be true
+    end
+  end
+end
+    

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'emporium'
+require 'yaml'
+
+CONFIG = YAML.load_file('./spec/config.yml')
+include Emporium

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: emporium
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Hugo Bastien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "Early release, only uses amazon product advertising API "
+email: 
+- hugobast@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- emporium.gemspec
+- lib/emporium.rb
+- lib/emporium/code.rb
+- lib/emporium/product.rb
+- lib/emporium/version.rb
+- spec/emporium/emporium_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hugobast/emporium
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      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
+test_files: 
+- spec/emporium/emporium_spec.rb
+- spec/spec_helper.rb