clarinet 0.5.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'yard'
+end
+
+group :development, :test do
+  gem 'rake'
+end
+
+group :test do
+  gem 'mocha', '1.2.1'
+  gem 'rspec', '3.6.0'
+  gem 'simplecov', '0.15.0', require: false
+  gem 'webmock', '3.0.1'
+end

data/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2016-, Jaakko Rinta-Filppula
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+Clarinet [![Build Status](https://travis-ci.org/tophattom/clarinet.svg?branch=master)](https://travis-ci.org/tophattom/clarinet)
+===
+
+Ruby client for [Clarifai](https://clarifai.com) API v2.
+
+Clarinet matches Clarifai's official JavaScript SDK almost 1:1.
+Method names are mostly the same expect in `snake_case` as opposed
+to `camelCase` in the JS library.
+
+## Dependencies
+
+* `addressable`
+* `httparty`
+
+## Install
+
+## Usage
+
+```ruby
+# Your client ID and secret
+api_key = '...'
+
+# Initialize
+client = Clarinet::App.new api_key
+
+# Get predictions for image with URL.
+# Response keys are symbolized.
+outputs = client.models.predict(Clarinet::Model::GENERAL, 'https://samples.clarifai.com/metro-north.jpg')
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--color", '--format doc']
+end

data/clarinet.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'lib/clarinet/version'
+
+Gem::Specification.new do |s|
+  s.name = 'clarinet'
+  s.version = Clarinet::VERSION
+  s.summary = 'Clarifai API client'
+  s.description = 'Simple client to interface with the Clarifai API v2'
+  s.authors = ['Jaakko Rinta-Filppula']
+  s.email = 'jaakko.rf@gmail.com'
+  s.homepage = 'https://github.com/tophattom/clarinet'
+  s.license = 'ISC'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency 'httparty', ['~> 0.14']
+  s.add_dependency 'addressable', ['~> 2.5']
+end

data/lib/clarinet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'clarinet/status'
+require 'clarinet/error/error'
+require 'clarinet/utils'
+
+require 'clarinet/client'
+
+require 'clarinet/concept'
+require 'clarinet/concepts'
+require 'clarinet/input'
+require 'clarinet/inputs'
+
+require 'clarinet/model'
+require 'clarinet/models'
+
+require 'clarinet/app'

data/lib/clarinet/app.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Clarinet
+  class App
+
+    # @!visibility private
+    attr_reader :client
+
+    # @return [Clarinet::Concepts]
+    attr_reader :concepts
+
+    # @return [Clarinet::Inputs]
+    attr_reader :inputs
+
+    # @return [Clarinet::Models]
+    attr_reader :models
+
+    # @param api_key [String] Clarifai API key
+    def initialize(api_key)
+      @client = Clarinet::Client.new api_key
+
+      @concepts = Clarinet::Concepts.new self
+      @inputs = Clarinet::Inputs.new self
+      @models = Clarinet::Models.new self
+    end
+
+  end
+end

data/lib/clarinet/client.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+module Clarinet
+  # @!visibility private
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.clarifai.com/v2'
+    format :plain
+    headers 'Content-Type' => 'application/json'
+
+    def initialize(api_key)
+      @auth_headers = {
+        'Authorization' => "Key #{api_key}"
+      }
+    end
+
+    def models(options = {})
+      with_response_parsing do
+        self.class.get '/models', headers: @auth_headers, query: options
+      end
+    end
+
+    def model(id)
+      with_response_parsing do
+        self.class.get "/models/#{id}", headers: @auth_headers
+      end
+    end
+
+    def model_output_info(id)
+      with_response_parsing do
+        self.class.get "/models/#{id}/output_info", headers: @auth_headers
+      end
+    end
+
+    def model_train(id)
+      with_response_parsing do
+        self.class.post "/models/#{id}/versions", header: @auth_headers
+      end
+    end
+
+    def model_versions(id, options = {})
+      with_response_parsing do
+        self.class.get "/models/#{id}/versions", headers: @auth_headers, query: options
+      end
+    end
+
+    def models_search(query)
+      body = { model_query: query }
+
+      with_response_parsing do
+        self.class.post '/models/searches', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def models_update(data)
+      with_response_parsing do
+        self.class.patch '/models', headers: @auth_headers, body: data.to_json
+      end
+    end
+
+    def outputs(model_id, inputs, config = {})
+      body = { inputs: inputs }
+      body[:model] = { output_info: { output_config: config } } unless config.empty?
+
+      with_response_parsing do
+        self.class.post "/models/#{model_id}/outputs", headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def concepts(options = {})
+      with_response_parsing do
+        self.class.get '/concepts', headers: @auth_headers, query: options
+      end
+    end
+
+    def concept(id)
+      with_response_parsing do
+        self.class.get "/concepts/#{id}", headers: @auth_headers
+      end
+    end
+
+    def concepts_search(query)
+      body = { concept_query: query }
+
+      with_response_parsing do
+        self.class.post '/concepts/searches', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def inputs_create(concepts)
+      body = { concepts: concepts }
+
+      with_response_parsing do
+        self.class.post '/concepts', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def inputs(options = {})
+      with_response_parsing do
+        self.class.get '/inputs', headers: @auth_headers, query: options
+      end
+    end
+
+    def inputs_create(inputs)
+      body = { inputs: inputs }
+
+      with_response_parsing do
+        self.class.post '/inputs', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def input_delete(id)
+      with_response_parsing do
+        self.class.delete "/inputs/#{id}", headers: @auth_headers
+      end
+    end
+
+    def inputs_delete(ids)
+      body = { ids: ids }
+
+      with_response_parsing do
+        self.class.delete '/inputs', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def inputs_delete_all
+      body = { delete_all: true }
+
+      with_response_parsing do
+        self.class.delete '/inputs', headers: @auth_headers, body: body.to_json
+      end
+    end
+
+    def inputs_status
+      with_response_parsing do
+        self.class.get '/inputs/status', headers: @auth_headers
+      end
+    end
+
+    def inputs_update(data)
+      with_response_parsing do
+        self.class.patch '/inputs', headers: @auth_headers, body: data.to_json
+      end
+    end
+
+
+    private
+
+      def with_response_parsing(&block)
+        response = yield
+        data = JSON.parse response.parsed_response, symbolize_names: true
+        Clarinet::Utils.check_response_status data[:status]
+        data
+      end
+
+  end
+end

data/lib/clarinet/concept.rb

@@ -0,0 +1,22 @@
+module Clarinet
+  class Concept
+
+    attr_reader :id
+    attr_reader :name
+    attr_reader :app_id
+    attr_reader :value
+    attr_reader :created_at
+    attr_reader :raw_data
+
+    def initialize(raw_data = {})
+      @raw_data = raw_data
+
+      @id = raw_data[:id]
+      @name = raw_data[:name]
+      @created_at = raw_data[:created_at]
+      @app_id = raw_data[:app_id]
+      @value = raw_data[:value]
+    end
+
+  end
+end

data/lib/clarinet/concepts.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Clarinet
+  class Concepts
+    extend Forwardable
+
+    delegate [:[], :each, :map, :find, :select, :reject] => :@concepts
+
+    def initialize(app, raw_data = [])
+      @app = app
+      @raw_data = raw_data
+
+      @concepts = raw_data.map do |concept_data|
+        Clarinet::Concept.new concept_data
+      end
+    end
+
+    def create(concepts)
+      concepts = [concepts] unless concepts.is_a? Array
+      concepts = concepts.map { |concept| format_concept(concept) }
+
+      data = @app.client.concepts.create concepts
+      Clarinet::Concepts.new @app, data[:concepts]
+    end
+
+    def list(options = { page: 1, per_page: 20 })
+      data = @app.client.concepts options
+      Clarinet::Concepts.new @app, data[:concepts]
+    end
+
+    def get(id)
+      data = @app.client.concept id
+      Clarinet::Concept.new data[:concept]
+    end
+
+    def search(name, language = nil)
+      query = {
+        name: name,
+        language: language
+      }
+
+      data = @app.client.concepts_search query
+      Clarinet::Concepts.new @app, data[:concepts]
+    end
+
+  end
+end

data/lib/clarinet/error/error.rb

@@ -0,0 +1,29 @@
+module Clarinet
+  module Error
+    class ApiError < StandardError
+      attr_accessor :code
+      attr_accessor :description
+      attr_accessor :details
+    end
+
+    class InvalidAuthTokenError < ApiError
+
+    end
+
+    class ApiKeyNotFoundError < ApiError
+
+    end
+
+    class BadRequestFormatError < ApiError
+
+    end
+
+    class InvalidRequestError < ApiError
+
+    end
+
+    class ImageDecodingError < ApiError
+
+    end
+  end
+end

data/lib/clarinet/input.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Clarinet
+  class Input
+
+    attr_reader :id
+    attr_reader :created_at
+    attr_reader :image_url
+    attr_reader :concepts
+    attr_reader :score
+    attr_reader :metadata
+    attr_reader :raw_data
+
+    def initialize(app, raw_data)
+      @app = app
+
+      @id = raw_data[:id]
+      @created_at = raw_data[:created_at]
+      @image_url = raw_data[:data][:image_url]
+
+      @concepts = Clarinet::Concepts.new app, raw_data[:data][:concepts]
+
+      @score = raw_data[:score]
+      @metadata = raw_data[:data][:metadata]
+
+      @raw_data = raw_data
+    end
+
+    def merge_concepts(concepts, metadata = nil)
+      update 'merge', concepts: concepts, metadata: metadata
+    end
+
+    def delete_concepts(concepts, metadata = nil)
+      update 'remove', concepts: concepts, metadata: metadata
+    end
+
+    def overwrite_concepts(concepts, metadata = nil)
+      update 'overwrite', concepts: concepts, metadata: metadata
+    end
+
+    private
+
+      def update(action, concepts: [], metadata: nil)
+        input_data = {}
+        input_data[:concepts] = concepts unless concepts.empty?
+        input_data[:metadata] = metadata unless metadata.nil?
+
+        data = {
+          action: action,
+          inputs: [
+            {
+              id: id,
+              data: input_data
+            }
+          ]
+        }
+
+        response_data = @app.client.inputs_update data
+        Clarinet::Input.new response_data[:input]
+      end
+
+  end
+end