kairos_rb 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62aff8a43a999f4077156566806ed8af7148028f35707391ee5b9efa9f339974
+  data.tar.gz: d00c212593d91d3746149a20ef652b1af1df9ecc5028ee99eda2ea924f3f0afc
+SHA512:
+  metadata.gz: a95909ed0376549fde908751fa84693a31d35143a91311d8992080e217a8c0a19b105108d3932dbfacc1917f113f04e24607d0c852a91ab818c99f1bf54e7d06
+  data.tar.gz: 934e93f02887ae38173f09f7e4f001610a59af2f5577ab2c86e2a8c352c405c5476844a430616052d3bbf22c300b64c4d86bee7cdbce9c7e84afd31685d8c91f

data/.byebug_history

@@ -0,0 +1,9 @@
+continue
+default_headers.merge(headers)
+default_headers = { 'app_id' => @app_id, 'app_key' => @app_key }
+headers
+continue
+connection.headers
+connection
+faraday.headers
+faraday

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

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/.rubocop.yml

@@ -0,0 +1,37 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.6.3
+
+Metrics/LineLength:
+  Max: 130
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 35
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 6
+
+Style/MixinUsage:
+  Exclude:
+    - bin/*
+
+Metrics/AbcSize:
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kairos_rb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    kairos_rb (0.1.0)
+      faraday
+      faraday_middleware
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.11.1)
+    jaro_winkler (1.5.3)
+    multipart-post (2.1.1)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.6.0)
+    vcr (5.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.2)
+  byebug
+  kairos_rb!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  vcr
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mateusz Urbański
+
+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,24 @@
+# KairosRB
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kairos_rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kairos_rb
+
+## Usage
+
+Check https://github.com/MatUrbanski/kairos_rb/blob/master/spec/kairos_rb/client_spec.rb for more details
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'kairos_rb'
+
+# 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/kairos_rb.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kairos_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kairos_rb'
+  spec.version       = KairosRB::VERSION
+  spec.authors       = ['Mateusz Urbański']
+  spec.email         = ['mateuszurbanski@yahoo.pl']
+
+  spec.summary       = 'Ruby wrapper for Kairos API.'
+  spec.description   = 'Ruby wrapper for Kairos API. See https://www.kairos.com/docs/api/#overview for more details.'
+  spec.homepage      = 'https://github.com/maturbanski/kairos_rb'
+  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'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # 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(__dir__)) 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_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'typhoeus'
+
+  spec.add_development_dependency 'bundler', '~> 2.0.2'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'vcr'
+end

data/lib/kairos_rb/client.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module KairosRB
+  class Client
+    def initialize(app_id:, app_key:)
+      @connection = KairosRB::Connection.new(
+        app_id: app_id,
+        app_key: app_key
+      )
+    end
+
+    def enroll(image:, gallery_name:, subject_id:, selector: nil)
+      body = { gallery_name: gallery_name, image: image, subject_id: subject_id, selector: selector }
+
+      @connection.call(
+        method: 'post',
+        url: '/enroll',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def verify(image:, gallery_name:, subject_id:, selector: nil)
+      body = { gallery_name: gallery_name, image: image, subject_id: subject_id, selector: selector }
+
+      @connection.call(
+        method: 'post',
+        url: '/verify',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def recognize(image:, gallery_name:, selector: nil, min_head_scale: nil, threshold: nil, max_num_results: nil)
+      body = {
+        'image' => image,
+        'gallery_name' => gallery_name,
+        'selector' => selector,
+        'MinHeadScale' => min_head_scale,
+        'threshold' => threshold,
+        'max_num_results' => max_num_results
+      }
+
+      @connection.call(
+        method: 'post',
+        url: '/recognize',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def detect(image:, selector: nil, min_head_scale: nil)
+      body = { 'image' => image, 'selector' => selector, 'MinHeadScale' => min_head_scale }
+
+      @connection.call(
+        method: 'post',
+        url: '/detect',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def all_galeries
+      @connection.call(
+        method: 'post',
+        url: '/gallery/list_all',
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def gallery_details(gallery_name:)
+      body = { gallery_name: gallery_name }
+
+      @connection.call(
+        method: 'post',
+        url: '/gallery/view',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def gallery_subject(gallery_name:, subject_id:)
+      body = { gallery_name: gallery_name, subject_id: subject_id }
+
+      @connection.call(
+        method: 'post',
+        url: '/gallery/view_subject',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def remove_subject_from_gallery(gallery_name:, subject_id:)
+      body = { gallery_name: gallery_name, subject_id: subject_id }
+
+      @connection.call(
+        method: 'post',
+        url: '/gallery/remove_subject',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def remove_gallery(gallery_name:)
+      body = { gallery_name: gallery_name }
+
+      @connection.call(
+        method: 'post',
+        url: '/gallery/remove',
+        body: body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def add_media(media:, landmarks: 1, timeout: 10)
+      @connection.call(
+        method: 'post',
+        url: "/v2/media?source=#{media}&landmarks=#{landmarks}&timeout=#{timeout}",
+        headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      )
+    end
+
+    def get_media(media_id:)
+      @connection.call(
+        method: 'get',
+        url: "/v2/media/#{media_id}",
+        headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      )
+    end
+
+    def media_analytics(media_id:)
+      @connection.call(
+        method: 'get',
+        url: "/v2/analytics/#{media_id}",
+        headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      )
+    end
+
+    def remove_media(media_id:)
+      @connection.call(
+        method: 'delete',
+        url: "/v2/media/#{media_id}",
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+  end
+end

data/lib/kairos_rb/connection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KairosRB
+  class Connection
+    def initialize(app_id:, app_key:)
+      @app_id  = app_id
+      @app_key = app_key
+
+      @connection = Faraday.new(
+        'https://api.kairos.com'
+      ) do |conn|
+        conn.response :json, content_type: /\bjson$/
+        conn.use      Faraday::Response::RaiseError
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def call(url:, method:, headers: {}, body: nil)
+      default_headers = { 'app_id' => @app_id, 'app_key' => @app_key }
+      all_headers     = default_headers.merge(headers)
+
+      body = @connection.send(method, url) do |req|
+        req.body    = body
+        req.headers = req.headers.merge(all_headers)
+      end.body
+    end
+  end
+end

data/lib/kairos_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KairosRB
+  VERSION = '1.0'
+end

data/lib/kairos_rb.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'faraday_middleware'
+require 'faraday'
+require 'kairos_rb/version'
+require 'kairos_rb/connection'
+require 'kairos_rb/client'
+require 'byebug'
+
+module KairosRB
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: kairos_rb
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Mateusz Urbański
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Kairos API. See https://www.kairos.com/docs/api/#overview
+  for more details.
+email:
+- mateuszurbanski@yahoo.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kairos_rb.gemspec
+- lib/kairos_rb.rb
+- lib/kairos_rb/client.rb
+- lib/kairos_rb/connection.rb
+- lib/kairos_rb/version.rb
+homepage: https://github.com/maturbanski/kairos_rb
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Kairos API.
+test_files: []