clarification 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8daa3c9b734cebcb402ecf17267c816986b9fb63
-  data.tar.gz: 5a97cf519409b9d2d93369a959b806935dc35604
+  metadata.gz: e64a471ed5071485e467ef49e82658ab0b349c63
+  data.tar.gz: 92f9619926fa087af02ac0b1ab7cbe88606d9b29
 SHA512:
-  metadata.gz: 68e625faabe30c5d21402b4d042bcda745db52ea47655663c3d7feb1f5629eef979b4166c961f031e17e461eb37234190679730db868fb284b24ee64c0f05517
-  data.tar.gz: a4a44a02633d75efbfe5bd3f4bbffb4cb4e87a4278db92715dd3251ae540166f812ce23a9cb7b4dcef11a77067c6d95ace9bec7870192dad1ee74be89da65362
+  metadata.gz: 9de55bd0c81de343006762c2cdee4b6420f77d7a9746a97ca2d251a1d0184c3165c63c9beceab886bd96f6e1df2de02077370c9e0db26de11df122f380fac246
+  data.tar.gz: 576bc98bf184e7f9ca6b1d23352707dd6a807f19c5b2b15aece2b125d945f4e1af8aa788b872f8ac4a8f68a76b37bd3b884ab621dc8bea5691804314f2b3e7f7

data/.travis.yml

@@ -2,4 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.1
+  - 2.3
+  - 2.2
 before_install: gem install bundler -v 1.15.4

data/README.md

@@ -1,4 +1,9 @@
-# Clarification - DO NOT INSTALL - IN DEVELOPMENT
+[![Gem Version](https://badge.fury.io/rb/clarification.svg)](https://badge.fury.io/rb/clarification)
+[![Build Status](https://travis-ci.org/nicholalexander/clarification.svg?branch=master)](https://travis-ci.org/nicholalexander/clarification)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb0dd6cce7ec48a191696780951c5efe)](https://www.codacy.com/app/nicholalexander/clarification?utm_source=github.com&utm_medium=referral&utm_content=nicholalexander/clarification&utm_campaign=Badge_Grade)
+
+
+# Clarification
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clarification`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -22,32 +27,69 @@ Or install it yourself as:
 
 Configure the gem as you would normally.
 
-```
+```ruby
   Clarification.configure do |config|
     config.api_key = 'a_big_secret_you_got_from_clarifai'
-    config.end_points = [:food]
+    config.end_points = [:food, :general]
   end
 ```
 
 This should also work nicely inside a rails initializer.
 
+Each endpoint initialized in your configuration will be called.  _So any predictions using a client configured with :food and :general will make two API requests._
+
 ## Usage
 
-You
+```ruby
+client = Clarification::Client.new
+response = client.predict(some_public_url_of_an_image)
+```
 
-client = Clarification::Client.new(:faces, :food)
-response = client.analyze(some_public_url)
+### Prediction
 
-Each endpoint initialized will be called.  So this analyze action will call two separate API routes and will count as two uses of your key.
+The response object returned from the prediction is a hash containing a nicely parsed result for each of the models called.  In our example, we initialized with two models so we will have response[:food] and response[:general].  Each of those model results have an object which has three pieces of relevant information: status, concepts, and response_json.  
 
+Thusly you can do things like this:
+
+```ruby
+response[:food].concepts.each do |concept|
+  if concept.value > 0.90
+    puts "#{concept.name}"
+  end
+end
 ```
-response[:faces].face_count 
-# => 3
-response[:food].concepts.first
-# => { concept_name: "cake",
-       confidence: .89 }
+
+```ruby
+response[:general].response_json
 ```
 
+```ruby
+if response[:food].status.code == 10000
+  puts response[:food].status.description
+end
+```
+
+All the objects are OpenStructs currently, but I suspect this will change shortly.
+
+As a convenience, the client also maintains the parsed response in the last_response variable.
+
+```ruby
+client.predict(some_public_url_of_an_image)
+client.last_response #=> {:food => Objectifier...}
+```
+
+## TODO's
+
+Lots and lots of things.  Amongst them:
+
+* validate public model selections
+* error handling
+* predict multiple images per call
+* predict video
+* use workflows
+* searching
+* training custom models
+
 ## 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.
@@ -56,7 +98,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clarification. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicholalexander/clarification. 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.
+
+https://codeclimate.com/github/nicholalexander/clarification
+https://www.codacy.com/app/nicholalexander/clarification
+
 
 ## License
 
@@ -64,4 +110,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Clarification project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clarification/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Clarification project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nicholalexander/clarification/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -6,9 +6,17 @@ require "clarification"
 # 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.
 
+Clarification.configure do |config|
+  config.api_key = 'f7cc628178994e16b2470ae739ef927a'
+  config.default_models = [:food]
+end
+
+@target_url = 'https://www.cicis.com/media/1138/pizza_trad_pepperoni.png'
+
+@client = Clarification::Client.new
+@response = @client.predict(@target_url)
+
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"
 Pry.start
 
-# require "irb"
-# IRB.start(__FILE__)

data/clarification.gemspec

@@ -21,11 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>=2.2'
+
+  spec.add_runtime_dependency "json"
+
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
-
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codacy-coverage"
+  
 end

data/lib/clarification/client.rb

@@ -1,45 +1,25 @@
 module Clarification
   class Client
 
+    attr_reader :active_models, :last_response
+
     def initialize
-      
+      raise "No Configuration Found." if Clarification.configuration.nil?
+      @active_models = Clarification.configuration.default_models
+      @last_response = nil
     end
     
-    def request(url)
-
-      r = Requester.new(:food)
-      response = r.get(url)
-
+    def predict(url)
+      requester = Requester.new(@active_models)
+      response = requester.get(url)
+      @last_response = Enrich.new(response).run
+      return @last_response
     end
 
-
-    def make_request
-      uri = URI.parse("https://api.clarifai.com/v2/models/bd367be194cf45149e75f01d59f77ba7/outputs")
-      request = Net::HTTP::Post.new(uri)
-      request.content_type = "application/json"
-      request["Authorization"] = "Key f7cc628178994e16b2470ae739ef927a"
-      request.body = JSON.dump({
-        "inputs" => [
-          {
-            "data" => {
-              "image" => {
-                "url" => "https://samples.clarifai.com/food.jpg"
-              }
-            }
-          }
-        ]
-      })
-
-      req_options = {
-        use_ssl: uri.scheme == "https",
-      }
-
-      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-        http.request(request)
-      end
-
-      puts response
+    def set_models(model_array)
+      @active_models = model_array
     end
 
   end
+
 end

data/lib/clarification/configuration.rb

@@ -1,9 +1,10 @@
 module Clarification
   class Configuration
-    attr_accessor :api_key
+    attr_accessor :api_key, :default_models
 
     def initialize
       @api_key = 'YOUR_API_KEY'
+      @default_models = []
     end
 
   end

data/lib/clarification/end_points.rb

@@ -1,8 +1,22 @@
 module Clarification
   BASE_URL = 'https://api.clarifai.com/v2/models/'.freeze
-  APPAREL = 'e0be3b9d6a454f0493ac3a30784001ff'.freeze
-  CELEBRITY = 'e466caa0619f444ab97497640cefc4dc'.freeze
-  COLOR = 'eeed0b6733a644cea07cf4c60f87ebb7'.freeze
-  DEMOGRAPHICS = 'c0c0ac362b03416da06ab3fa36fb58e3'.freeze
-  FOOD = 'bd367be194cf45149e75f01d59f77ba7'.freeze
+
+  PUBLIC_MODELS = {
+    apparel: 'e0be3b9d6a454f0493ac3a30784001ff',
+    celebrity: 'e466caa0619f444ab97497640cefc4dc',
+    color: 'eeed0b6733a644cea07cf4c60f87ebb7',
+    demographics: 'c0c0ac362b03416da06ab3fa36fb58e3',
+    face_detection: 'a403429f2ddf4b49b307e318f00e528b',
+    face_embedding: 'd02b4508df58432fbb84e800597b8959',
+    focus: 'c2cf7cecd8a6427da375b9f35fcd2381',
+    food: 'bd367be194cf45149e75f01d59f77ba7',
+    general: 'aaa03c23b3724a16a56b629203edc62c',
+    general_embedding: 'bbb5f41425b8468d9b7a554ff10f8581',
+    logo: 'c443119bf2ed4da98487520d01a0b1e3',
+    moderation: 'd16f390eb32cad478c7ae150069bd2c6',
+    nsfw: 'e9576d86d2004ed1a38ba0cf39ecb4b1',
+    travel: 'eee28c313d69466f836ab83287a54ed9',
+    wedding: 'c386b7a870114f4a87477c0824499348'
+  }
+
 end

data/lib/clarification/enrich.rb

@@ -0,0 +1,21 @@
+module Clarification
+  class Enrich
+
+    attr_reader :results
+    
+    def initialize(response_array)
+      @response_array = response_array
+      @results = {}
+    end
+
+    def run
+      @response_array.each do |model_name, raw_response |
+        @results[model_name] = Objectifier.new(raw_response.body)
+      end
+
+      return @results
+    end
+
+  end
+
+end

data/lib/clarification/objectifier.rb

@@ -0,0 +1,21 @@
+module Clarification
+  class Objectifier
+
+    attr_reader :response_json, :status, :concepts
+
+    def initialize(response)
+      @response_json = JSON.parse(response)
+      @status = OpenStruct.new(@response_json["status"])
+      @concepts = []
+
+      build_concept_objects
+    end
+
+    def build_concept_objects
+      @response_json["outputs"][0]["data"]["concepts"].each do |concept|
+        @concepts << OpenStruct.new(concept)
+      end
+    end
+
+  end
+end

data/lib/clarification/requester.rb

@@ -1,12 +1,20 @@
 module Clarification
   class Requester
 
-    def initialize(model)
-      @model = model
+    def initialize(model_array)
+      @model_array = model_array
     end
 
     def get(target_url)
-      uri = uri_builder
+      response = {}
+      @model_array.each do |model|
+        response[model] = get_with_model(target_url, model)
+      end
+      return response
+    end
+
+    def get_with_model(target_url, model)
+      uri = uri_builder(model)
       body = body_builder(target_url)
       request = request_builder(uri, body)
       options = options_builder(uri)
@@ -18,7 +26,6 @@ module Clarification
       return response
     end
 
-
     private
 
     def body_builder(url)
@@ -35,8 +42,10 @@ module Clarification
       }
     end
 
-    def uri_builder
-      uri = URI.parse("https://api.clarifai.com/v2/models/bd367be194cf45149e75f01d59f77ba7/outputs")
+    def uri_builder(model)
+      model_key = Clarification::PUBLIC_MODELS[model]
+      url = "#{Clarification::BASE_URL}#{model_key}/outputs"
+      uri = URI.parse(url)
     end
 
     def request_builder(uri, body)

data/lib/clarification/version.rb

@@ -1,3 +1,3 @@
 module Clarification
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/clarification.rb

@@ -1,6 +1,8 @@
 require "clarification/client"
 require "clarification/configuration"
 require "clarification/end_points"
+require "clarification/enrich"
+require "clarification/objectifier"
 require "clarification/requester"
 require "clarification/version"
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clarification
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Nichol Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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
@@ -94,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codacy-coverage
+  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: Alpha Version - configure, access Clarifai set end points, interrogate
   responses.
 email:
@@ -118,6 +160,8 @@ files:
 - lib/clarification/client.rb
 - lib/clarification/configuration.rb
 - lib/clarification/end_points.rb
+- lib/clarification/enrich.rb
+- lib/clarification/objectifier.rb
 - lib/clarification/requester.rb
 - lib/clarification/version.rb
 homepage: https://github.com/nicholalexander/clarification
@@ -132,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="