pixmatch 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = Pixmatch
 
-Pixmatch REST API client library for TinEye[http://www.tineye.com/] reverse-image search.
+Pixmatch REST API client library for Pixmatch[http://ideeinc.com/products/pixmatch/], automated image matching API by Idee[http://ideeinc.com]. Given an image to look for, it locates identical or modified images within or between large scale image collections.
 
 == Using
 
@@ -55,7 +55,7 @@ Pixmatch REST API client library for TinEye[http://www.tineye.com/] reverse-imag
       <<: *settings
       username: '<your username>'
       password: '<your password>'
-      endpoint: 'http://<your url>.tineye.com'
+      endpoint: '<your url>.tineye.com'
 * Run 'bundle install'
 * Test with 'rspec spec'
 * Send pull requests.

data/lib/pixmatch/api.rb

@@ -3,19 +3,19 @@ require File.expand_path('../request', __FILE__)
 # Adapted from the Ruby Twitter gem.
 # @see https://github.com/jnunemaker/twitter
 module Pixmatch
-	# @private
-	class API
-		# @private
-		attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
-		
-		# Creates a new API
-		def initialize(options = {})
-			options = Pixmatch.options.merge(options)
-			Configuration::VALID_OPTIONS_KEYS.each do |key|
-				send("#{key}=", options[key])
-			end
-		end
-		
-		include Request
-	end
+  # @private
+  class API
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+    
+    # Creates a new API
+    def initialize(options = {})
+      options = Pixmatch.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+    include Request
+  end
 end

data/lib/pixmatch/client.rb

@@ -1,15 +1,15 @@
 # Adapted from the Ruby Twitter gem.
 # @see https://github.com/jnunemaker/twitter
 module Pixmatch
-	# Wrapper for the Pixmatch REST API
-	class Client < API
-		Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
-		
-		include Pixmatch::Client::Ping
-		include Pixmatch::Client::Count
-		include Pixmatch::Client::Add
-		include Pixmatch::Client::List
-		include Pixmatch::Client::Delete
-		include Pixmatch::Client::Search
-	end
+  # Wrapper for the Pixmatch REST API
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+    
+    include Pixmatch::Client::Ping
+    include Pixmatch::Client::Count
+    include Pixmatch::Client::Add
+    include Pixmatch::Client::List
+    include Pixmatch::Client::Delete
+    include Pixmatch::Client::Search
+  end
 end

data/lib/pixmatch/configuration.rb

@@ -1,49 +1,49 @@
 # Adapted from the Ruby Twitter gem.
 # @see https://github.com/jnunemaker/twitter
 module Pixmatch
-	# Defines constants and methods related to configuration.
-	module Configuration
-		# An array of valid keys in the options hash when configuring a {Flixated::API}.
-		VALID_OPTIONS_KEYS = [
-			:username,
-			:password,
-			:endpoint
-		].freeze
-	
-		# By default, don't set a username.
-		DEFAULT_USERNAME = nil.freeze
-		
-		# By default, don't set a password.
-		DEFAULT_PASSWORD = nil.freeze
-		
-		# The endpoint that will be used to connect if none is set.
-		DEFAULT_ENDPOINT = 'https://api.tineye.com'.freeze
-		
-		# @private
-		attr_accessor(*VALID_OPTIONS_KEYS)
-		
-		# When this module is extended, set all configuration options to their default values.
-		def self.extended(base)
-			base.reset
-		end
-		
-		# Convenience method to allow configuration options to be set in a block.
-		def configure
-			yield self
-		end
-		
-		# Create a hash of options and their values.
-		def options
-			VALID_OPTIONS_KEYS.inject({}) do |option,key|
-				option.merge!(key => send(key))
-			end
-		end
-		
-		# Reset all configuration options to default.
-		def reset
-			self.username               = DEFAULT_USERNAME
-			self.password               = DEFAULT_PASSWORD
-			self.endpoint               = DEFAULT_ENDPOINT
-		end
-	end
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Flixated::API}.
+    VALID_OPTIONS_KEYS = [
+      :username,
+      :password,
+      :endpoint
+    ].freeze
+  
+    # By default, don't set a username.
+    DEFAULT_USERNAME = nil.freeze
+    
+    # By default, don't set a password.
+    DEFAULT_PASSWORD = nil.freeze
+    
+    # The endpoint that will be used to connect if none is set.
+    DEFAULT_ENDPOINT = 'https://api.tineye.com'.freeze
+    
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+    
+    # When this module is extended, set all configuration options to their default values.
+    def self.extended(base)
+      base.reset
+    end
+    
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+    
+    # Create a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option,key|
+        option.merge!(key => send(key))
+      end
+    end
+    
+    # Reset all configuration options to default.
+    def reset
+      self.username               = DEFAULT_USERNAME
+      self.password               = DEFAULT_PASSWORD
+      self.endpoint               = DEFAULT_ENDPOINT
+    end
+  end
 end

data/lib/pixmatch/request.rb

@@ -2,27 +2,27 @@ require 'uri'
 require 'rest_client'
 
 module Pixmatch
-	module Request		
-		private
-		
-		def request(http_method, path, query_params = {}, data_params = {})
-		  capture RestClient::Request.new({ 
-		    method: http_method,
-		    url: "#{endpoint}/#{paramify(path, query_params)}", 
-		    user: username,
-		    password: password
-		   }.merge(data_params)).execute   			
-		end
-		
-		def capture(response)
-			json = Utils.parse_json(response)
-		  Utils.handle_error(json)
-			json
-		end
-		
-		def paramify(path, params)
+  module Request		
+    private
+    
+    def request(http_method, path, query_params = {}, data_params = {})
+      capture RestClient::Request.new({ 
+        method: http_method,
+        url: "#{endpoint}/#{paramify(path, query_params)}", 
+        user: username,
+        password: password
+       }.merge(data_params)).execute   			
+    end
+    
+    def capture(response)
+      json = Utils.parse_json(response)
+      Utils.handle_error(json)
+      json
+    end
+    
+    def paramify(path, params)
       URI.encode("#{path}/?#{params.map { |k,v| "#{k}=#{v}" }.join('&')}")
     end
     
-	end
+  end
 end

data/lib/pixmatch/utils.rb

@@ -1,5 +1,5 @@
 require 'hashie'
-require 'yajl'
+require 'json'
 
 module Pixmatch
   # @private
@@ -11,7 +11,7 @@ module Pixmatch
       
       # Parses JSON and returns a Hashie::Mash
       def self.parse_json(json)
-        Hashie::Mash.new(Yajl::Parser.new.parse(json))
+        Hashie::Mash.new(JSON.parse(json))
       end
   end
 end

data/lib/pixmatch/version.rb

@@ -1,3 +1,3 @@
 module Pixmatch
-	VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/pixmatch.rb

@@ -8,23 +8,23 @@ require File.expand_path('../pixmatch/client', __FILE__)
 # Adapted from the Ruby Twitter gem.
 # @see https://github.com/jnunemaker/twitter
 module Pixmatch
-	extend Configuration
-	
-	# Alias for pixmatch::Client.new
-	#
-	# @return {pixmatch::Client}
-	def self.client(options = {})
-		Pixmatch::Client.new(options)
-	end
-	
-	# Delegate to pixmatch::Client
-	def self.method_missing(method, *args, &block)
-		return super unless client.respond_to?(method)
-		client.send(method, *args, &block)
-	end
-	
-	# Delegate to pixmatch::Client
-	def self.respond_to?(method)
-		return client.respond_to?(method) || super
-	end
+  extend Configuration
+  
+  # Alias for pixmatch::Client.new
+  #
+  # @return {pixmatch::Client}
+  def self.client(options = {})
+    Pixmatch::Client.new(options)
+  end
+  
+  # Delegate to pixmatch::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+  
+  # Delegate to pixmatch::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
 end

metadata

@@ -1,126 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: pixmatch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  segments:
-  - 0
-  - 1
-  - 0
-  prerelease: false
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: !!null 
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-13 00:00:00.000000000 -04:00
-default_executable: !!null 
+date: 2011-06-02 00:00:00.000000000 -04:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &86264460 !ruby/object:Gem::Requirement
+  requirement: &73142630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.1
-        segments:
-        - 1
-        - 6
-        - 1
   type: :runtime
   prerelease: false
-  version_requirements: *86264460
+  version_requirements: *73142630
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &86264070 !ruby/object:Gem::Requirement
+  name: json
+  requirement: &73142020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
-        segments:
-        - 0
-        - 8
-        - 1
+        version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *86264070
+  version_requirements: *73142020
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &86263680 !ruby/object:Gem::Requirement
+  requirement: &73141620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
-        segments:
-        - 1
-        - 0
-        - 0
   type: :runtime
   prerelease: false
-  version_requirements: *86263680
+  version_requirements: *73141620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &86263290 !ruby/object:Gem::Requirement
+  requirement: &73141140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.5.0
-        segments:
-        - 2
-        - 5
-        - 0
   type: :development
   prerelease: false
-  version_requirements: *86263290
+  version_requirements: *73141140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &86262900 !ruby/object:Gem::Requirement
+  requirement: &73140550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.10
-        segments:
-        - 1
-        - 0
-        - 10
   type: :development
   prerelease: false
-  version_requirements: *86262900
+  version_requirements: *73140550
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &86262510 !ruby/object:Gem::Requirement
+  requirement: &73139280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
-        segments:
-        - 1
-        - 5
-        - 2
+        version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *86262510
+  version_requirements: *73139280
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &86262120 !ruby/object:Gem::Requirement
+  requirement: &73138540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.4
-        segments:
-        - 0
-        - 6
-        - 4
   type: :development
   prerelease: false
-  version_requirements: *86262120
+  version_requirements: *73138540
 description: Pixmatch REST API client library for Ruby
 email: dblock@dblock.org
 executables: []
@@ -145,13 +113,11 @@ files:
 - lib/pixmatch/version.rb
 - LICENSE.txt
 - README.rdoc
-- spec/pixmatch_spec.rb
-- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/dblock/pixmatch
 licenses:
 - MIT
-post_install_message: !!null 
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -163,21 +129,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -137474991
+      hash: 1011322973
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
 requirements: []
-rubyforge_project: !!null 
-rubygems_version: 1.3.7
-signing_key: !!null 
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
 specification_version: 3
 summary: Pixmatch REST API client library for Ruby
-test_files:
-- spec/pixmatch_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/pixmatch_spec.rb

@@ -1,87 +0,0 @@
-require 'yaml'
-
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Pixmatch" do
-  before(:each) do
-    Pixmatch.configure do |config|
-      pixmatch_yml = File.join(File.dirname(__FILE__), '../config/pixmatch.yml')
-      pixmatch_yml = File.join(File.dirname(__FILE__), '../config/pixmatch.yml.default') if ! File.exists?(pixmatch_yml)
-      raise "missing config/pixmatch.yml" if ! File.exists?(pixmatch_yml) 
-      pixmatch_config = YAML.load_file(pixmatch_yml)['test']
-      config.username = pixmatch_config['username']
-      config.password = pixmatch_config['password']
-      config.endpoint = pixmatch_config['endpoint']
-    end
-  end
-  describe "methods" do
-    it "ping" do
-      response = Pixmatch.ping()
-      response['status'].should == "ok"
-      response['method'].should == "ping"
-    end
-    it "count" do
-      count = Pixmatch.count()
-      count.is_a?(Integer).should be_true
-      count.should >= 0
-    end
-    it "add with one path" do
-      response = Pixmatch.add(File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg'))
-      response['status'].should == "ok"
-      response['method'].should == "add"
-    end
-    it "add with one path as an array" do
-      response = Pixmatch.add([ File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg') ])
-      response['status'].should == "ok"
-      response['method'].should == "add"
-    end
-    it "add with one File object" do
-      response = Pixmatch.add(File.new(File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg')))
-      response['status'].should == "ok"
-      response['method'].should == "add"
-    end
-    it "add with one File object as an array" do
-      response = Pixmatch.add([ File.new(File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg')) ])
-      response['status'].should == "ok"
-      response['method'].should == "add"
-    end
-    it "add with an array of File objects" do      
-      response = Pixmatch.add(Dir.glob(File.join(File.dirname(__FILE__), 'assets/*.jpg')))
-      response['status'].should == "ok"
-      response['method'].should == "add"
-    end
-    it "list" do
-      result = Pixmatch.list()
-      result.is_a?(Array).should be_true
-      result.size.should >= 0
-    end
-    it "delete with one name" do
-      Pixmatch.add([ File.new(File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg')) ])
-      count = Pixmatch.count
-      response = Pixmatch.delete('mona-lisa.jpg')
-      response['status'].should == "ok"
-      response['method'].should == "delete"
-      Pixmatch.count.should == count - 1
-    end
-    it "delete an array of names" do
-      Pixmatch.add(Dir.glob(File.join(File.dirname(__FILE__), 'assets/*.jpg')))
-      count = Pixmatch.count
-      filenames = Dir.glob(File.join(File.dirname(__FILE__), 'assets/*.jpg')).map { |f| File.basename(f) }
-      response = Pixmatch.delete(filenames)
-      response['status'].should == "ok"
-      response['method'].should == "delete"
-      Pixmatch.count.should == count - filenames.size
-    end
-    it "search" do      
-      Pixmatch.add(Dir.glob(File.join(File.dirname(__FILE__), 'assets/*.jpg')))
-      response = Pixmatch.search(File.join(File.dirname(__FILE__), 'assets/mona-lisa.jpg'))
-      response.is_a?(Array).should be_true
-      response.size.should >= 0
-      response.each { |result|
-        result.is_a?(Hash).should be_true
-        result.has_key?('score').should be_true
-        result.has_key?('filename').should be_true
-      }
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,11 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'rspec'
-require 'pixmatch'
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-
-end