turing_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa6c1846c1c5e9e1f03cc1643f49324f64edfca7
+  data.tar.gz: 352244d70243062bfc3a876e4ffa31afe211302b
+SHA512:
+  metadata.gz: 357e815a177bc4c82b5278206e3edda45f58bde7172396d273c1ad499228d751fafd5eb52c5847ee60759288bc032d7863d9e200385ec92537d2002ddfe8226c
+  data.tar.gz: 5a090b7381d2a92ff2a951a5e5e8c969abd50a1be9796f3fe97b76222b3d84fe91c24d2c4773946046f79875c6023c9f9d683f235e8ba3a0e35ddaa8b2d02dd1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at harvesh@turingiq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in turing_api.gemspec
+gem 'byebug'
+gem 'httparty', '~> 0.16.2'
+gem 'json'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    multi_xml (0.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  httparty (~> 0.16.2)
+  json
+  rspec
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Harvesh Kumar
+
+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,193 @@
+# TuringAPI
+
+Turing visual search and visually similar recommendations API library for RUBY. The REST API documentation can be found here: [https://api.turingiq.com/doc/](https://api.turingiq.com/doc/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'turing_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install turing_api
+
+
+
+## Usage
+
+Initialize
+--------
+
+```ruby
+#You can initialize the `VisualAPI` class with below parameters.
+
+api_key = 'your_api_key' # You can get API key when you login at: https://www.turingiq.com/login
+mode = 'live'            # the mode can be either `live` or `sandbox`. Default mode is `live`.
+@visual = Turing::VisualAPI.new('api_key', 'mode')
+```
+
+This library uses namespacing. When instantiating the object, you need to either use the fully qualified namespace:
+
+```ruby
+@visual = Turing::VisualAPI.new('your_api_key')
+```
+
+Or alias it:
+
+```ruby
+require './lib/VisualAPI'
+
+@visual = Turing::VisualAPI.new(ENV['your_api_key'])
+```
+
+Autocrop
+--------
+
+Detect objects in image and get bounding boxes around objects detected.
+
+```ruby
+# image_url is required field.
+image_url = "https://example.com/image_url.jpg"
+
+# now let's call the API.
+resp = @visual.auto_crop(image_url)
+```
+
+The bounding boxes returned by this method can be given to visual search to improve visual search quality.
+
+
+Insert
+------
+
+You need to insert images to our index to query on them. The insert function can be written as below.
+
+```ruby
+# id is required field.
+id = 'image_id'
+
+# image_url is required field.
+image_url = "https://example.com/image_url.jpg"
+
+# Filters argument is optional. You can specify upto 3 filters as per example given below.
+# Filters can be useful when querying images from our index. You can apply any filter
+# as per your requirement.
+filters = ["filter1" => "onefilter", "filter2" => "twofilter", "filter3" => "threefilter"]
+
+# Metadata is optional. You can pass additional information about your image which will be
+# returned when you query image from our index.
+metadata = ["title" => "Image Title"]
+
+# now let's call the API.
+resp = @visual.create(id, image_url, filters, metadata)
+```
+
+Update
+------
+
+If you need to update information to indexed image, you can use update function. If you call update function for id which is not already indexed, it will insert the image to index.
+
+```ruby
+# id is required field. Provide id for which you need to update the information.
+id = 'image_id'
+
+# image_url is optional field. You can pass `null` if you would like to keep URL unchanged.
+image_url = "https://example.com/image_url.jpg"
+
+# Filters argument is optional. You can specify upto 3 filters as per example given below.
+# Filters can be useful when querying images from our index. You can apply any filter
+# as per your requirement. The filters you provide here will be overwritten.
+filters = ["filter1" => "onefilter", "filter2" => "twofilter", "filter3" => "threefilter"]
+
+# Metadata is optional. You can pass additional information about your image which will be
+# returned when you query image from our index. Existing metadata values will be overwritten
+# based on keys supplied to this array.
+metadata = ["title" => "Image Title"]
+
+# now let's call the API.
+resp = @visual.update(id, image_url, filters, metadata)
+```
+
+Delete
+------
+
+You can delete image from index with this method.
+
+```ruby
+# id is required field.
+id = 'image_id'
+
+# now let's call the API.
+resp = @visual.delete(id)
+```
+
+Visual Search
+-------------
+
+Visual search can be used to search indexed images based on query image.
+
+```ruby
+# image_url is required field. The API will perform visual search on the image and return
+image_url = "https://example.com/image_url.jpg"
+
+# crop_box is optional field. You can supply empty array if you don't want to specify crop box.
+# The format of crop box is [xmin, ymin, xmax, ymax]
+crop_box = [188, 256, 656, 928]
+
+# Filters argument is optional. You can specify upto 3 filters.
+# For example, if you specify filter1 = "nike", it will only return images which are indexed with
+# "nike" as filter1.
+filters = ["filter1" => "nike"]
+
+# now let's call the API.
+resp = @visual.search(image_url, crop_box, filters)
+```
+
+Visual Recommendations
+----------------------
+
+Visual recommendations give visually similar image recommendations which can be used to display recommendation widget on e-commerce sites which greatly improved CTR and conversion rates.
+
+```ruby
+# image_url is required field. The API will perform visual search on the image and return
+id = "some_product_id"
+
+# Filters argument is optional. You can specify upto 3 filters.
+# For example, if you specify filter1 = "nike", it will only return images which are indexed with
+# "nike" as filter1.
+filters = ["filter1" => "nike"]
+
+# now let's call the API.
+resp = @visual.similar(id, filters)
+```
+
+Run Tests
+----------------------
+
+```sh
+API_KEY='api_key' rspec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/turingiq/turing-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TuringAPI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/turingiq/turing-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "turing_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/turing_api/version.rb

@@ -0,0 +1,3 @@
+module TuringAPI
+  VERSION = "1.0.0"
+end

data/lib/turing_api.rb

@@ -0,0 +1,127 @@
+require "turing_api/version"
+require 'httparty'
+require 'byebug'
+require 'json'
+require './lib/visual_api_exception'
+
+module TuringAPI
+  class VisualAPI
+    attr_accessor :api_key, :api_version, :mode, :base_url, :headers
+    
+    def similar(id, filters=[])
+      begin
+        request = @mode=="live" ? "similar" : "demo-similar"
+        requested_url = @base_url+"#{request}/#{id}"
+        body = !filters.empty? ? {:filter1=>"#{filters[0]['filter1']}", :filter2=>"#{filters[0]['filter2']}", :filter3=>"#{filters[0]['filter3']}" } : {}
+        response = HTTParty.get(requested_url, headers: @headers, :body => body)
+        response_data = response.body
+        data = JSON.parse(response_data)
+        data
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+    def search(url, crop=[], filters=[])
+      begin
+        request = @mode=="live" ? "similar" : "demo-similar"
+        requested_url = @base_url+"#{request}/search"
+        crop_size = !crop.empty? ? crop.join(",") : nil
+        filter1 = !filters.empty? ? filters[0]['filter1'] : ""
+        filter2 = !filters.empty? ? filters[0]['filter2'] : ""
+        filter3 = !filters.empty? ? filters[0]['filter3'] : ""
+        request = HTTParty.post(requested_url, headers: @headers, :body => {:url=>"#{url}", :crop=>"#{crop_size}", :filter1=>"#{filter1}", :filter2=>"#{filter2}", :filter3=>"#{filter3}" })
+        response_data = request.body
+        data = JSON.parse(response_data)
+        data
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+    def auto_crop(url)
+      begin
+        requested_url = @base_url+"autocrop"
+        request = HTTParty.get(requested_url, headers: @headers, :body => {:url=>"#{url}"})
+        response_data = request.body
+        data = JSON.parse(response_data)
+        data  
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+    def create(url, id, filters=[], metadata=[])
+      begin
+        request = @mode=="live" ? "similar" : "demo-similar"
+        requested_url = @base_url+"#{request}/create"
+        filter1 = !filters.empty? ? filters[0]['filter1'] : " "
+        filter2 = !filters.empty? ? filters[0]['filter2'] : " "
+        filter3 = !filters.empty? ? filters[0]['filter3'] : " "
+        title = !metadata.empty? ? metadata[0]['title'] : " "
+        request = HTTParty.post(requested_url, headers: @headers, :body => {:url=>"#{url}", :id=>id, :filter1=>"#{filter1}", :filter2=>"#{filter2}", :filter3=>"#{filter3}", :title=>"#{title}" })
+        response_data = request.body
+        data = JSON.parse(response_data)
+        data
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+    def update(url, id, filters=[], metadata=[])
+      begin
+        request = @mode=="live" ? "similar" : "demo-similar"
+        requested_url = @base_url+"#{request}/create"
+        url = url if !url.nil?
+        filter1 = !filters.empty? ? filters[0]['filter1'] : " "
+        filter2 = !filters.empty? ? filters[0]['filter2'] : " "
+        filter3 = !filters.empty? ? filters[0]['filter3'] : " "
+        title = !metadata.empty? ? metadata[0]['title'] : " "
+        request = HTTParty.post(requested_url, headers: @headers, :body => {:url=>"#{url}", :id=>id, :filter1=>"#{filter1}", :filter2=>"#{filter2}", :filter3=>"#{filter3}", :title=>"#{title}" })
+        response_data = request.body
+        data = JSON.parse(response_data)
+        data
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+    def delete(id)
+      begin
+        request = @mode=="live" ? "similar" : "demo-similar"
+        requested_url = @base_url+"#{request}/#{id}"
+        response = HTTParty.delete(requested_url, headers: @headers)
+        response_data = response.body
+        data = JSON.parse(response_data)
+        data
+      rescue JSON::ParserError => e 
+        puts "Error message - #{e.message}"
+      end
+    end
+
+
+    private
+    def initialize(api_key, mode="live", api_version="v1")
+      if api_key.nil? || api_key.empty?
+        raise VisualAPIException.new('API key is not provided.')
+      else
+        self.api_key = api_key
+      end
+
+      if api_version != 'v1'
+        raise VisualAPIException.new("Currenly only 'v1' is supported for api version")
+      else
+        self.api_version = api_version
+      end
+      
+      if mode != 'live' && mode != 'sandbox'
+        raise VisualAPIException.new("Mode can only be either 'live' or 'sandbox'. You provided: #{mode}")
+      else
+        self.mode = mode
+      end
+
+      self.base_url = "https://api.turingiq.com/#{api_version}/"
+      self.headers = { 'Authorization' => "Bearer #{api_key}" }
+    end
+  end
+end

data/lib/visual_api_exception.rb

@@ -0,0 +1,2 @@
+class VisualAPIException < Exception
+end

data/turing_api.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "turing_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "turing_api"
+  spec.version       = TuringAPI::VERSION
+  spec.authors       = ["Turing Analytics"]
+  spec.email         = ["mail@turingiq.com"]
+
+  spec.summary       = "A gem for Turing Analytics API."
+  spec.description   = "Turing Analytics is driven by a vision to develop solutions powered by machine learning to help businesses make data driven decisions."
+  spec.homepage      = "https://api.turingiq.com/doc/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: turing_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Turing Analytics
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Turing Analytics is driven by a vision to develop solutions powered by
+  machine learning to help businesses make data driven decisions.
+email:
+- mail@turingiq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/turing_api.rb
+- lib/turing_api/version.rb
+- lib/visual_api_exception.rb
+- turing_api.gemspec
+homepage: https://api.turingiq.com/doc/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: A gem for Turing Analytics API.
+test_files: []