kooaba 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,75 @@
+# kooaba
+
+This gem is currently in Beta phase. We advise you not to use this in a production system!
+
+This is a lightweight gem (no other dependencies) for accessing the [kooaba APIs](http://kooaba.github.com).
+
+## Installation
+
+1. Make sure you have an account on the kooaba platform at [https://platform.kooaba.com/](https://platform.kooaba.com). In the API Access section you will find your API keys for uploading items and making queries.
+
+
+2. Install the kooaba gem:
+
+
+    gem install kooaba
+
+
+## Uploading an item
+
+In order to upload items into your account, you need an UPLOAD\_KEY and a BUCKET\_ID. Both of these you can find in your account at https://platform.kooaba.com .
+
+    require 'rubygems'
+    require 'kooaba'
+
+    # set the upload key
+    Kooaba.upload_key = <UPLOAD_KEY>
+
+    # initialize the item
+    item = Kooaba::Item.new(
+      :title => "A lake",
+      :metadata => nil,
+      :image_files => <PATH_TO_IMAGE_ON_LOCAL_SYSTEM>,
+      :referenceId => "lake"
+      )
+
+    # select the bucket you want to put the item into
+    bucket_id = <BUCKET_ID>
+
+    # upload the item
+    response = Kooaba.upload(item, bucket_id)
+
+    puts "Response code: #{response.code}"
+    puts "Response body: #{response.body}"
+
+
+The reponse will look like:
+
+    Response code: 201
+    Response body: {"uuid":"d956a280-d678-4260-9115-d0382175ae90","enabled":true,"images":[{"sha1":"3d3d8d00cdaf3de4f346f84e83e207780a7e2afe"}]}
+
+
+
+## Making a query
+
+To make a query you need a QUERY_KEY which you can find under the API Access section in your account at https://platform.kooaba.com .
+
+    require 'rubygems'
+    require 'kooaba'
+
+    # set the query key
+    Kooaba.query_key = <QUERY_KEY>
+
+    # send the query to the kooaba servers
+    query = Kooaba::Query.new(:image_path => <PATH_TO_QUERY_IMAGE_ON_LOCAL_SYSTEM>)
+    response = Kooaba.query(query)
+
+    # inspect the result
+    puts "Response code: #{response.code}"
+    puts "Response body: #{response.body}"
+
+
+The response will look like this:
+
+    Response code: 200
+    Response body: {"query_id":"698c666aa23348a0b5ef54d9bc2d7ca3","results":[{"item_uuid":"4b641fc5-2c50-44b5-b529-c9e4092ec47f","bucket_uuid":"108695a2-7825-4a98-8bda-b980782c5e33","service_id":"object_retrieval","score":3.301587,"recognitions":[{"score":3.301587,"id":"image.sha1:dd96b28d55db1492c8dd9709ba480efd287fa122","reference_projection":[{"x":6.596069,"y":2.501495},{"x":-4.0,"y":1153.0},{"x":1851.0,"y":1160.0},{"x":1834.0,"y":3.0}],"bounding_box":[{"x":427.0,"y":28.0},{"x":427.0,"y":1090.0},{"x":1644.0,"y":1090.0},{"x":1644.0,"y":28.0}]}],"title":"A lake"},{"item_uuid":"b9914fad-5064-437d-b84b-71c9d69fd248","bucket_uuid":"108695a2-7825-4a98-8bda-b980782c5e33","service_id":"object_retrieval","score":3.301587,"recognitions":[{"score":3.301587,"id":"image.sha1:dd96b28d55db1492c8dd9709ba480efd287fa122","reference_projection":[{"x":6.596069,"y":2.501495},{"x":-4.0,"y":1153.0},{"x":1851.0,"y":1160.0},{"x":1834.0,"y":3.0}],"bounding_box":[{"x":427.0,"y":28.0},{"x":427.0,"y":1090.0},{"x":1644.0,"y":1090.0},{"x":1644.0,"y":28.0}]}],"title":"A lake"}]}

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/query.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "kooaba.rb")
+
+# set the query key
+Kooaba.query_key = <QUERY_KEY>
+
+# send the query to the kooaba servers
+query = Kooaba::Query.new(:image_path => <PATH_TO_IMAGE>)
+response = Kooaba.query(query)
+
+# inspect the result
+puts "Response code: #{response.code}"
+puts "Response body: #{response.body}"

data/examples/upload.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "kooaba.rb")
+
+# set the upload key
+Kooaba.upload_key = <UPLOAD_KEY>
+
+# initialize the item
+item = Kooaba::Item.new(
+  :title => "A lake",
+  :metadata => nil,
+  :image_files => <PATH_TO_IMAGE>,
+  :referenceId => "lake"
+  )
+
+# select the bucket you want to put the item into
+bucket_id = <BUCKET_ID>
+
+# upload the item
+response = Kooaba.upload(item, bucket_id)
+
+puts "Response code: #{response.code}"
+puts "Response body: #{response.body}"

data/kooaba.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kooaba/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kooaba"
+  s.version     = Kooaba::VERSION
+  s.authors     = ["Cristi Prodan"]
+  s.email       = ["prodan@kooaba.com"]
+  s.homepage    = "https://github.com/kooaba/kooaba-ruby"
+  s.summary     = %q{A gem for accessing the kooaba APIs}
+  s.description = %q{A lightweight gem for accessing the kooaba APIs. For more information on the APIs check out http://kooaba.github.com}
+
+  s.rubyforge_project = "kooaba"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/kooaba.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), '/kooaba/*.rb')].each {|file| require file }

data/lib/kooaba/base.rb

@@ -0,0 +1,28 @@
+module Kooaba
+  QUERY_URL  = "https://query-api.kooaba.com/v4/"
+  UPLOAD_URL = "https://upload-api.kooaba.com/api/v4/"
+
+  def self.upload_key=(upload_key)
+    @@upload_key = upload_key
+  end
+
+  def self.query_key=(query_key)
+    @@query_key = query_key
+  end
+
+  def self.upload_key
+    @@upload_key
+  end
+
+  def self.query_key
+    @@query_key
+  end
+
+  def self.upload(item, bucket_id)
+    UploadRequest.new(item, bucket_id).start
+  end
+
+  def self.query(image_path)
+    QueryRequest.new(image_path).start
+  end
+end

data/lib/kooaba/item.rb

@@ -0,0 +1,19 @@
+module Kooaba
+
+  class Item
+    attr_accessor :title
+    attr_accessor :metadata
+    attr_accessor :enabled
+    attr_accessor :reference_id
+    attr_accessor :image_files
+
+    def initialize(options = {})
+      @title        = options[:title]
+      @metadata     = options[:metadata]
+      @enabled      = options[:enabled] || true
+      @reference_id = options[:reference_id]
+      @image_files  = options[:image_files] || []
+    end
+  end
+
+end

data/lib/kooaba/multipart_message.rb

@@ -0,0 +1,75 @@
+#
+# Class implementing the MIME multipart message format (currently only containing the "Form Data" subtype)
+#
+# Created 2008-10-30 by Joachim Fornallaz <fornallaz@kooaba.com>
+#
+
+module Kooaba
+  module TypedFile
+    attr_accessor :content_type
+  end
+
+  class MultipartMessage
+
+    def initialize
+      @file_parts = []
+      @text_parts = []
+    end
+
+    def add_file_part(name, file, type)
+      case file
+      when String
+        io = open(file)
+      else
+        io = file
+      end
+
+      unless io.respond_to?(:content_type)
+        io.extend(TypedFile)
+        content_type = (type == "image/jpeg") ? "image/jpg" : type
+        io.content_type = content_type
+      end
+
+      @file_parts << [name, io]
+    end
+
+    def add_text_part(name, text)
+      @text_parts << [name, text]
+    end
+
+    def content_type
+      "multipart/form-data; boundary=#{boundary_token}"
+    end
+
+    def body
+      boundary_marker = "--#{boundary_token}\r\n"
+      body = @text_parts.map { |param|
+        (name, value) = param
+        boundary_marker + text_to_multipart(name, value)
+      }.join('') + @file_parts.map { |param|
+        (name, value) = param
+        boundary_marker + data_to_multipart(name, value)
+      }.join('') + "--#{boundary_token}--\r\n"
+    end
+
+    protected
+
+    def boundary_token
+      @boundary_token ||= [Array.new(8) {rand(256)}].join
+    end
+
+    def data_to_multipart(key, data)
+      filename = data.respond_to?(:original_filename) ? data.original_filename : File.basename(data.path)
+      mime_type = data.content_type
+      part = "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{filename}\"\r\n"
+      part += "Content-Transfer-Encoding: binary\r\n"
+      part += "Content-Type: #{mime_type}\r\n\r\n#{data.read}\r\n"
+      data.rewind
+      part
+    end
+
+    def text_to_multipart(key,value)
+      "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n#{value}\r\n"
+    end
+  end
+end

data/lib/kooaba/query.rb

@@ -0,0 +1,15 @@
+module Kooaba
+
+  class Query
+    attr_accessor :image_path
+    attr_accessor :max_results
+    attr_accessor :user_data
+
+    def initialize(options = {})
+      @image_path = options[:image_path]
+      @max_results = options[:max_results]
+      @user_data = options[:user_data]
+    end
+  end
+
+end

data/lib/kooaba/query_request.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'time'
+
+module Kooaba
+
+  class QueryRequest
+
+    def initialize(query)
+      @message = MultipartMessage.new
+      content_type = `file --mime-type -b #{query.image_path}`.chop
+      @message.add_file_part('image', query.image_path, content_type)
+      @message.add_text_part('max_results', query.max_results) if query.max_results
+      @message.add_text_part('user_data', query.user_data) if query.user_data
+    end
+
+    #
+    # Returns the http response from the Kooaba servers.
+    #
+    def start
+      url = URI.parse(Kooaba::QUERY_URL + "query")
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      req = Net::HTTP::Post.new(url.path)
+
+      req.body = @message.body
+      req['date'] = Time.new.httpdate
+      req['content-type'] = @message.content_type
+      req['authorization'] = "Token #{Kooaba.query_key}"
+
+      http.start { |h| h.request(req) }
+    end
+
+  end
+
+end

data/lib/kooaba/upload_request.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'time'
+
+module Kooaba
+
+  class UploadRequest
+
+    attr_accessor :message
+    attr_accessor :bucket_id
+
+    def initialize(item, bucket_id)
+      @bucket_id = bucket_id
+      @message = MultipartMessage.new
+      item.image_files.each do |image_path|
+        content_type = `file --mime-type -b #{image_path}`
+        @message.add_file_part('images', image_path, content_type)
+      end
+      @message.add_text_part('referenceId', item.reference_id) if item.reference_id
+      @message.add_text_part('title', item.title) if item.title
+      @message.add_text_part('enabled', item.enabled)
+      @message.add_text_part('metadata', item.metadata) if item.metadata
+    end
+
+    #
+    # Returns the http response from the Kooaba servers.
+    #
+    def start
+      url = URI.parse(Kooaba::UPLOAD_URL + "buckets/" + bucket_id + "/items")
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      req = Net::HTTP::Post.new(url.path)
+
+      req.body = @message.body
+      req['date'] = Time.new.httpdate
+      req['content-type'] = @message.content_type
+      req['authorization'] = "Token #{Kooaba.upload_key}"
+
+      http.start { |h| h.request(req) }
+    end
+
+  end
+
+end

data/lib/kooaba/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: kooaba
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cristi Prodan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-18 00:00:00 Z
+dependencies: []
+
+description: A lightweight gem for accessing the kooaba APIs. For more information on the APIs check out http://kooaba.github.com
+email: 
+- prodan@kooaba.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/query.rb
+- examples/upload.rb
+- kooaba.gemspec
+- lib/kooaba.rb
+- lib/kooaba/base.rb
+- lib/kooaba/item.rb
+- lib/kooaba/multipart_message.rb
+- lib/kooaba/query.rb
+- lib/kooaba/query_request.rb
+- lib/kooaba/upload_request.rb
+- lib/kooaba/version.rb
+homepage: https://github.com/kooaba/kooaba-ruby
+licenses: []
+
+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: kooaba
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A gem for accessing the kooaba APIs
+test_files: []
+