kooaba 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem 'rake', :group => :test
+
 # Specify your gem's dependencies in kooaba.gemspec
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # kooaba
 
+[![Build Status](https://secure.travis-ci.org/kooaba/kooaba-api-v4-rubygem.png)](http://travis-ci.org/kooaba/kooaba-api-v4-rubygem)
+
 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).
@@ -27,10 +29,10 @@ In order to upload items into your account, you need a `data-key` and a `bucket-
 
     # initialize the item
     item = Kooaba::Item.new(
-      :title => "A lake",
-      :metadata => nil,
-      :image_files => <path-to-image-on-local-filesystem>,
-      :referenceId => "lake"
+      :title => "A lake",                                    # the title of the item (String)
+      :metadata => nil,                                      # metadata associated with the item. It must be a valid JSON String (String)
+      :image_files => [<path-to-image-on-local-filesystem>], # images associated with the item (Array of Strings)
+      :reference_id => "lake"                                # the reference id of an item (String)
       )
 
     # select the bucket you want to put the item into
@@ -39,16 +41,23 @@ In order to upload items into your account, you need a `data-key` and a `bucket-
     # upload the item
     response = Kooaba.upload(item, bucket_id)
 
+    # The response is a Net::HTTPResponse.
     puts "Response code: #{response.code}"
+    puts "Response message: #{response.message}"
     puts "Response body: #{response.body}"
 
+    puts "Item uuid: #{item.uuid}"
+    puts "Item enabled: #{item.enabled}"
+    puts "Item images sha1's: #{item.images_sha1.join(", ")}"
 
 The reponse will look like:
 
     Response code: 201
     Response body: {"uuid":"d956a280-d678-4260-9115-d0382175ae90","enabled":true,"images":[{"sha1":"3d3d8d00cdaf3de4f346f84e83e207780a7e2afe"}]}
 
-
+    Item uuid: d956a280-d678-4260-9115-d0382175ae90
+    Item enabled: true
+    Item images sha1's: 3d3d8d00cdaf3de4f346f84e83e207780a7e2afe
 
 ## Making a query
 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/examples/upload.rb

@@ -5,10 +5,10 @@ Kooaba.data_key = <data-key-secret-token>
 
 # initialize the item
 item = Kooaba::Item.new(
-  :title => "A lake",
-  :metadata => nil,
-  :image_files => <path-to-image-on-local-filesystem>,
-  :referenceId => "lake"
+  :title => "A lake",                                  # the title of the item (String)
+  :metadata => nil,                                    # metadata associated with the item. It must be a valid JSON String (String)
+  :image_files => <path-to-image-on-local-filesystem>, # images associated with the item (Array of Strings)
+  :reference_id => "lake"                              # the reference id of an item (String)
   )
 
 # select the bucket you want to put the item into

data/kooaba.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "json"
+  s.add_development_dependency "mocha"
+  s.add_runtime_dependency "json"
 end

data/lib/kooaba/base.rb

@@ -19,10 +19,12 @@ module Kooaba
   end
 
   def self.upload(item, bucket_id)
+    raise ArgumentError, "You need to specify the Data Key before uploading an item" if Kooaba::data_key == nil
     UploadRequest.new(item, bucket_id).start
   end
 
   def self.query(image_path)
+    raise ArgumentError, "You need to specify the Query Key before making queries" if Kooaba.query_key == nil
     QueryRequest.new(image_path).start
   end
 end

data/lib/kooaba/item.rb

@@ -1,6 +1,10 @@
 module Kooaba
 
   class Item
+
+    attr_accessor :uuid
+    attr_accessor :images_sha1
+
     attr_accessor :title
     attr_accessor :metadata
     attr_accessor :enabled
@@ -8,9 +12,14 @@ module Kooaba
     attr_accessor :image_files
 
     def initialize(options = {})
+      raise TypeError, "enabled should be true or false" unless [nil, true, false].include? options[:enabled]
+      if !options[:image_files].instance_of?(Array) && options[:image_files] != nil
+        raise TypeError, "image_files must be a list of paths (Array of Strings)"
+      end
+
       @title        = options[:title]
       @metadata     = options[:metadata]
-      @enabled      = options[:enabled] || true
+      @enabled      = options[:enabled] == nil ? true : options[:enabled]
       @reference_id = options[:reference_id]
       @image_files  = options[:image_files] || []
     end

data/lib/kooaba/multipart_message.rb

@@ -19,7 +19,7 @@ module Kooaba
     def add_file_part(name, file, type)
       case file
       when String
-        io = open(file)
+        io = File.open(file, "rb")
       else
         io = file
       end

data/lib/kooaba/query.rb

@@ -6,9 +6,13 @@ module Kooaba
     attr_accessor :user_data
 
     def initialize(options = {})
-      @image_path = options[:image_path]
-      @max_results = options[:max_results]
-      @user_data = options[:user_data]
+      if options[:image_path] == nil || options[:image_path] == ""
+        raise ArgumentError, "you need to provide the path of the query image"
+      end
+
+      @image_path  = options[:image_path]
+      @max_results = options[:max_results] || 10
+      @user_data   = options[:user_data]
     end
   end
 

data/lib/kooaba/upload_request.rb

@@ -4,6 +4,10 @@ require 'net/http'
 require 'net/https'
 require 'time'
 
+require 'json'
+require 'net/http'
+
+
 module Kooaba
 
   class UploadRequest
@@ -11,14 +15,17 @@ module Kooaba
     attr_accessor :message
     attr_accessor :bucket_id
 
+    attr_accessor :item
+
     def initialize(item, bucket_id)
+      @item = item
       @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('reference_id', 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
@@ -30,9 +37,17 @@ module Kooaba
     def start
       url = URI.parse(Kooaba::UPLOAD_URL + "buckets/" + bucket_id + "/items")
 
+      resp = make_request(url)
+      parse_request(resp)
+
+      return resp
+    end
+
+    def make_request(url)
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.read_timeout = 500
 
       req = Net::HTTP::Post.new(url.path)
 
@@ -41,7 +56,39 @@ module Kooaba
       req['content-type'] = @message.content_type
       req['authorization'] = "Token #{Kooaba.data_key}"
 
-      http.start { |h| h.request(req) }
+      http.request(req)
+    end
+
+    def parse_request(http_resp)
+      case http_resp
+      when Net::HTTPSuccess
+        parse_2xx(http_resp)
+      when Net::HTTPClientError
+        parse_4xx(http_resp)
+      when Net::HTTPServerError
+        parse_5xx(http_resp)
+      else
+        unknown_response(http_resp)
+      end
+    end
+
+    def parse_2xx(http_resp)
+      json = JSON.parse(http_resp.body)
+      @item.uuid = json["uuid"]
+      @item.enabled = json["enabled"]
+      @item.images_sha1 = json["images"].empty? ? [] : json["images"].map {|a| a["sha1"]}
+    end
+
+    def parse_4xx(http_resp)
+      # do nothing for now
+    end
+
+    def parse_5xx(http_resp)
+      # do nothing for now
+    end
+
+    def unknown_response(http_resp)
+      raise StandardError, "Unknown response: #{http_resp.code} #{http_resp.body} "
     end
 
   end

data/lib/kooaba/version.rb

@@ -1,3 +1,3 @@
 module Kooaba
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/test_base.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'kooaba'
+
+class BaseTest < Test::Unit::TestCase
+  def test_data_key
+    Kooaba.data_key = "123"
+    assert_equal Kooaba.data_key, "123"
+  end
+
+  def test_query_key
+    Kooaba.query_key = "123"
+    assert_equal Kooaba.query_key, "123"
+  end
+
+  def test_upload_no_key
+    assert_raise ArgumentError do
+      Kooaba.data_key = nil
+      Kooaba.upload(Kooaba::Item.new, "test")
+    end
+  end
+
+  def test_query_no_key
+    assert_raise ArgumentError do
+      Kooaba.query_key = nil
+      Kooaba.query("/path/to/image")
+    end
+  end
+end

data/test/test_item.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'kooaba'
+
+class ItemTest < Test::Unit::TestCase
+  def test_init_item
+    item = Kooaba::Item.new(
+      :title => "A lake",
+      :metadata => nil,
+      :image_files => ["/path/to/image"],
+      :reference_id => "lake",
+      :enabled => true
+      )
+
+    assert_equal item.title, "A lake"
+    assert_equal item.metadata, nil
+    assert_equal item.image_files, ["/path/to/image"]
+    assert_equal item.reference_id, "lake"
+    assert_equal item.enabled, true
+  end
+
+  def test_init_item_default_attributes
+    item = Kooaba::Item.new
+
+    assert_equal item.title, nil
+    assert_equal item.metadata, nil
+    assert_equal item.enabled, true
+    assert_equal item.reference_id, nil
+    assert_equal item.image_files, []
+  end
+
+  def test_init_wrong_type_for_enabled
+    assert_raise TypeError do
+      item = Kooaba::Item.new(
+        :enabled => 1
+        )
+    end
+  end
+
+  def test_init_wrong_type_for_image_files
+    assert_raise TypeError do
+      item = Kooaba::Item.new(
+        :image_files => "something"
+        )
+    end
+  end
+
+end

data/test/test_query.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'kooaba'
+
+class QueryTest < Test::Unit::TestCase
+  def test_query_init
+    query = Kooaba::Query.new(
+      :image_path => "/path/to/image.png",
+      :max_results => 2,
+      :user_data => "some data"
+      )
+
+    assert_equal query.image_path, "/path/to/image.png"
+    assert_equal query.max_results, 2
+    assert_equal query.user_data, "some data"
+  end
+
+  def test_query_no_image
+    assert_raise ArgumentError do
+      query = Kooaba::Query.new()
+    end
+  end
+
+  def test_default_parameters
+    query = Kooaba::Query.new(
+      :image_path => "/path/to/image.png"
+      )
+
+    assert_equal query.max_results, 10
+    assert_equal query.user_data, nil
+  end
+end

data/test/test_upload_request.rb

@@ -0,0 +1,42 @@
+require 'test/unit'
+require 'kooaba'
+require 'mocha/setup'
+
+class UploadRequestTest < Test::Unit::TestCase
+
+  include Kooaba
+
+  def test_parse_item
+    item = Item.new(:title => 1)
+    req = UploadRequest.new(item, "123")
+
+    http_resp = Net::HTTPSuccess.new(1.0, 200, "hi")
+    http_resp.stubs(:code).returns(200)
+    http_resp.stubs(:kind_of?).returns('Net::HTTPSuccess')
+    http_resp.stubs(:body).returns('{"uuid":"07382685-ba1d-47bf-be78-7be0db2ebf92","enabled":true,"images":[{"sha1":"14970c3a70d7d295250a10783c7e222625a757ea"},{"sha1":"704f8c649f41262a9232639573dc2210431ebf3b"}]}')
+
+    req.stubs(:make_request).returns(http_resp)
+    req.start
+
+    assert_equal item.uuid, "07382685-ba1d-47bf-be78-7be0db2ebf92"
+    assert_equal item.enabled, true
+    assert_equal item.images_sha1, ["14970c3a70d7d295250a10783c7e222625a757ea", "704f8c649f41262a9232639573dc2210431ebf3b"]
+  end
+
+  def test_parse_item_no_sha1s
+    item = Item.new(:title => 1)
+    req = UploadRequest.new(item, "123")
+
+    http_resp = Net::HTTPSuccess.new(1.0, 200, "hi")
+    http_resp.stubs(:code).returns(200)
+    http_resp.stubs(:kind_of?).returns('Net::HTTPSuccess')
+    http_resp.stubs(:body).returns('{"uuid":"07382685-ba1d-47bf-be78-7be0db2ebf92","enabled":true,"images":[]}')
+
+    req.stubs(:make_request).returns(http_resp)
+    req.start
+
+    assert_equal item.uuid, "07382685-ba1d-47bf-be78-7be0db2ebf92"
+    assert_equal item.enabled, true
+    assert_equal item.images_sha1, []
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kooaba
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Cristi Prodan
@@ -15,9 +15,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-11 00:00:00 Z
-dependencies: []
-
+date: 2013-01-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 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
@@ -29,6 +70,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -43,6 +85,10 @@ files:
 - lib/kooaba/query_request.rb
 - lib/kooaba/upload_request.rb
 - lib/kooaba/version.rb
+- test/test_base.rb
+- test/test_item.rb
+- test/test_query.rb
+- test/test_upload_request.rb
 homepage: https://github.com/kooaba/kooaba-api-v4-rubygem
 licenses: []
 
@@ -76,5 +122,8 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A gem for accessing the kooaba APIs
-test_files: []
-
+test_files: 
+- test/test_base.rb
+- test/test_item.rb
+- test/test_query.rb
+- test/test_upload_request.rb