bubo 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "json", ">= 0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "fakeweb", ">= 1.2.8"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb (>= 1.2.8)
+  jeweler (~> 1.5.2)
+  json
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Hajo Nils Krabbenhöft
+
+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/README.rdoc

@@ -0,0 +1,24 @@
+= Bubo
+
+Bubo is an amazing owl. It can memorize your whole image collection and perform fast near-duplicate searches.
+See askbubo.com for more detail.
+
+== Using the Bubo search engine
+ 
+* b = Bubo.new('email@example.com','API_KEY_HERE')
+* b.add_image('MyFirstImage','https://example.com/images/1.jpg')
+* b.add_image ...
+* Now you might need to wait some time for the system to finish indexing your images. You can check the current status with: b.images_status
+* b.retrieve('https://example.com/images/1-cropped.jpg')
+
+== If you encounter any problems
+Feel free to contact me:
+Hajo Nils Krabbenhoeft
+spratpix GmbH & Co. KG
+hajo AT spratpix DOT com
+
+== Copyright
+
+Copyright (c) 2010 Hajo Nils Krabbenhoeft | spratpix GmbH & Co. KG. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bubo"
+  gem.homepage = "http://github.com/fxtentacle/bubo"
+  gem.license = "MIT"
+  gem.summary = "Bubo Image Search API"
+  gem.description = "Index your image collection, then do an optical search in it."
+  gem.email = "hajo@spratpix.com"
+  gem.authors = ["Hajo Nils Krabbenhöft"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bubo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/bubo.rb

@@ -0,0 +1,107 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+
+class Bubo
+  # Create a new Bubo API object.
+  #
+  # You can freely generate API keys on http://api.askbubo.com/users/new
+  #
+  # If you have any questions, mail {Hajo Nils Krabbenhoeft}[mailto:hajo@spratpix.com].
+  def initialize(email, api_key, host='bubo.heroku.com', port=80)
+    @settings = { :email => email, :api_key => api_key, :host => host, :port => port }
+  end
+
+  # Returns the email and api_key you specified when generating this object.
+  def api_verification
+    { :email => @settings[:email], :api_key => @settings[:api_key] }
+  end
+
+  # Returns the hostname of the currently used Bubo API provider.
+  def host
+    @settings[:host]
+  end
+
+  # Returns the port number of the currently used Bubo API provider.
+  def port
+    @settings[:port]
+  end
+
+  # Retrieve current system status.
+  # Return value will look like: 
+  #
+  # {"FAIL"=>0, "OK"=>13, "TODO"=>0, "UPDATE"=>"IDLE"}
+  def images_status
+    JSON.parse( send('images') )
+  end
+
+  # Add a new image to your searchable collection.
+  # Returns true or false
+  def add_image(key, url)
+    send('images/add', :post, {:key => key, :url => url}) == 'OK'
+  end
+  
+  # Remove an image from your searchable collection.
+  # Returns true or false
+  def remove_image(key)
+    send('images/remove', :post, {:key => key}) == 'OK'
+  end
+
+  # Get the analysis status of an image in your collection.
+  # Returns either:
+  #
+  # "OK\t<NUMBER>" where <NUMBER> is the number of feature points used for searching
+  #
+  # or
+  #
+  # "FAIL\t<ERROR MESSAGE>"
+  def inspect_image(key)
+    send('images/inspect', :get, {:key => key})
+  end
+
+  # Retrieve an array of keys of images, which failed to import.
+  # Returns something like:
+  #
+  # ["keyA", "anotherKey", "keyC"]
+  def failed_image_keys
+    send('images/failures').split("\n")
+  end
+
+  # Download the url given and search for matching images using an optical near-duplicate search algorithm.
+  # Returns an array of strings. Each member is either a comment line starting with # or a search result.
+  # Search result lines are formatted as:
+  #
+  # "<KEY>\t<SCORE>\t<MATRIX>"
+  #
+  # KEY is the key you specified when adding the image
+  # SCORE is a confidence score from 0 to 1 with anything above 0.9 considered excellent
+  # MATRIX is a 2x3 affine transformation matrix which can be used to transform the image specified by KEY as to cover the search image.
+  def retrieve(url)
+    send('images/retrieve', :post, {:url => url}).split("\n")
+  end
+
+private
+
+  def send(path, method = :get, form_data = {})
+    form_data = form_data.merge(api_verification)
+    form_data = form_data.inject({}) { |m, (k, v)| m[k.to_s] = v; m }
+
+    response = ''
+    http = Net::HTTP.new(host, port)
+    http.start do |http|
+      if(method == :get)
+        request = Net::HTTP::Get.new('/'+path)
+      else
+        request = Net::HTTP::Post.new('/'+path)
+      end
+      request.set_form_data(form_data)
+      response = http.request(request)
+      response = response.body.strip
+    end
+    
+    response
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bubo'
+
+class Test::Unit::TestCase
+end

data/test/test_bubo.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBubo < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: bubo
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- "Hajo Nils Krabbenh\xC3\xB6ft"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: json
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  name: fakeweb
+  prerelease: false
+  version_requirements: *id006
+description: Index your image collection, then do an optical search in it.
+email: hajo@spratpix.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/bubo.rb
+- test/helper.rb
+- test/test_bubo.rb
+has_rdoc: true
+homepage: http://github.com/fxtentacle/bubo
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bubo Image Search API
+test_files: 
+- test/helper.rb
+- test/test_bubo.rb