rubix-api 0.0.1 → 0.0.2

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubix-api.gemspec
+gemspec
+
+
+gem 'faraday'
+
+group :test do
+  gem 'rspec'
+  gem 'fakeweb'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    rubix-api (0.0.2)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    fakeweb (1.3.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    json (1.8.1)
+    multipart-post (2.0.0)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fakeweb
+  faraday
+  rake
+  rspec
+  rubix-api!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Salvador
+
+MIT License
+
+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.md

@@ -0,0 +1,56 @@
+# Rubix::Api
+Ruby wrapper for Rubix api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubix-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubix-api
+
+## Usage
+
+First you need to require the gem and you initialize the client by instantiating the Rubix class. To do this you need your _access token_ and you can **optionally** specify _api version_ and _domain_.  
+
+    require 'rubix-api'
+    
+    client = Rubix.new(access_token, version, domain) # Version and domain are optional
+
+To list categories.
+    client.list_categories
+
+To list patterns you need to pass _page_number_ as the only parameter.
+
+    client.list_patterns(2) #where "2" means the page number
+
+To delete patterns you need to pass the pattern_id as the only parameter.
+
+    client.delete_pattern(100) #where "100" means the pattern_id
+    
+To add a matching pattern you need to pass the _file_ itself or an _file url_ for it, a _label_, and the _category name_ to which the pattern belongs. 
+
+    client.add_pattern({file: FIle, remote_file_url: "http://example.com/path/to/scene", label: 'uid', category_name: 'matching'})
+    
+To use feature matching, a file or file url is needed, as well as a minimum ratio and a minimum matches amount. 
+  
+    client.feature_matching({file, remote_file_url, mr: 0.9, mma: 150}) 
+
+For OCR, Rubix needs the path to image or the file itself, and optionally, the area to be scanned.
+
+    client.ocr({file, remote_file_url, rectangles: [[x1,y1.x2,y2],..,[x1,y1,x2,y2]]}
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/{rubix/rubix.rb → rubix.rb}

@@ -1,3 +1,6 @@
+require 'json'
+require 'faraday'
+
 class Rubix
 
   class ResponseError < Exception ; end

data/rubix-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#require 'rubix/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubix-api"
+  spec.version       = '0.0.2'
+  spec.authors       = ["Yeti Media"]
+  spec.email         = ["nicolas55ar@gmail.com"]
+  spec.description   = "Wrapper for Rubix Api"
+  spec.summary       = "Rubix gem"
+  spec.homepage      = "http://github.com/Yeti-Media/rubix-ruby"
+  spec.license       = "MIT"
+
+  spec.files            = `git ls-files`.split($\)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'json'
+  
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'json'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/rubix_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Rubix do
+  before do
+    @access_token = 'access_token'
+    @version = 'v1'
+    @domain = 'http://api.rubix.io'
+    @client = Rubix.new(@access_token)
+  end
+
+  it "should list categories" do
+    json_response = [{"id"=>72, :title => 'matching'}]
+    FakeWeb.register_uri(:get, "#{@domain}/api/#{@version}/categories", body: json_response.to_json, status: 200,
+                         user_key: @access_token)
+    response = @client.list_categories
+    response[0]['title'].should == 'matching'
+  end
+
+  it "should list patterns" do
+    json_response = [{"id"=>72, :label => 'BrandId'}]
+    FakeWeb.register_uri(:get, "#{@domain}/api/#{@version}/patterns?page=2", body: json_response.to_json, status: 200,
+                         user_key: @access_token)
+    response = @client.list_patterns(2)
+    response[0]['label'].should == 'BrandId'
+  end
+
+  it "should delete a pattern" do
+    json_response = {"id"=>72, :label => 'BrandId'}
+    FakeWeb.register_uri(:delete, "#{@domain}/api/#{@version}/patterns/2", body: json_response.to_json, status: 200,
+                         user_key: @access_token)
+    response = @client.delete_pattern(2)
+    response['id'].should == 72
+  end
+
+  it "should initialize the client" do
+    @client.client.url_prefix.to_s.should == "#{@domain}/"
+    @client.access_token.should == @access_token
+    @client.version.should == @version
+  end
+
+  it "should correctly add a pattern" do
+    file_url = "http://example.com/path/to/image.png"
+    label = 'uid'
+    category = 'matching'
+    json_response = {"id"=>72, "file"=>{"url"=>file_url}, "label"=>label, "category_id"=>2}
+    FakeWeb.register_uri(:post, "#{@domain}/api/#{@version}/patterns", body: json_response.to_json, status: 200,
+                         user_key: @access_token)
+    response = @client.add_pattern(remote_file_url: file_url, label: label, category_name: category)
+    response['label'].should == label
+    response['file']['url'].should == file_url 
+  end 
+
+  it "should correctly feature match" do
+    json_response = {"label"=>'image.png', "values"=>[{"center"=>{"x"=>165.933654785156, "y"=>261.701690673828}}, "label"=>"uid", "pattern_url"=>"/uploads/pattern/1/matching/image.png" ]}
+    FakeWeb.register_uri(:post, "#{@domain}/api/#{@version}/patterns/feature_matcher", body: json_response.to_json,
+                         status: 200, user_key: @access_token)
+    response = @client.add_pattern(remote_file_url: "http://example.com/path/to/image.png", mr: 0.9, mma: 150)
+    response['label'].should == 'uid' # don't know why reponse['label'] is matching to the 'label' insde 'values'
+  end 
+ 
+  # it "should correctly ocr" do
+  #   #json_response = {"matches"=>[{"pattern"=>"xWpvxEx6tTo4GPxTGSTm1Qz99HD9AYPBiwrr", "percentage"=>95, "scene"=>"image", "pattern_url"=>"/uploads/pattern/1/comparison/imagexzcxxzc.png", "label"=>"yeti"}], "scenario_url"=>"image.png"}
+  #   FakeWeb.register_uri(:post, "#{@domain}/api/#{@version}/patterns/ocr", body: json_response.to_json, status: 200)
+  #   response = @client.add_pattern(remote_file_url: "http://example.com/path/to/image.png")
+  #   response['text'].should == 'uid'
+  # end 
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+#require '../lib/rubix/rubix'
+require File.expand_path('../../lib', __FILE__) + '/rubix/rubix.rb'
+require 'fakeweb'
+require 'faraday'
+require 'json'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubix-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +130,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rubix/rubix.rb
-homepage: ''
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubix.rb
+- rubix-api.gemspec
+- spec/lib/rubix_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Yeti-Media/rubix-ruby
 licenses:
 - MIT
 post_install_message: 
@@ -92,4 +164,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rubix gem
-test_files: []
+test_files:
+- spec/lib/rubix_spec.rb
+- spec/spec_helper.rb