clarification 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e64a471ed5071485e467ef49e82658ab0b349c63
-  data.tar.gz: 92f9619926fa087af02ac0b1ab7cbe88606d9b29
+  metadata.gz: 14dba1413119dc7a3ad0e944dfcbd825b40eb326
+  data.tar.gz: 205ad9143ccb00f1b5f9777383358a2b9abd0870
 SHA512:
-  metadata.gz: 9de55bd0c81de343006762c2cdee4b6420f77d7a9746a97ca2d251a1d0184c3165c63c9beceab886bd96f6e1df2de02077370c9e0db26de11df122f380fac246
-  data.tar.gz: 576bc98bf184e7f9ca6b1d23352707dd6a807f19c5b2b15aece2b125d945f4e1af8aa788b872f8ac4a8f68a76b37bd3b884ab621dc8bea5691804314f2b3e7f7
+  metadata.gz: 31c796e17b2e9942b4f85340f979a7c08d268b6615b74ea234aca305cefc71e09810790f9d138f30ef72ba9d7e4742d3400049fb27e0cb83dbdbba8b5c047b0a
+  data.tar.gz: a93bab9d28a78f65105dd7efe3286b8db22843c16781d0db017a6932fe8dca53a0f609949761cc08a6e107ed00f455c7a96a7079663dc366cce4d12d94f3f3df

data/.gitignore

@@ -7,6 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+.DS_Store
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -2,10 +2,13 @@
 [![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.
+An unofficial Ruby wrapper for the [Clarifai](http://clarifai.com) API.  This currently uses v2 of the API and was partially created because other Ruby gems are using v1 which is being depricated in late 2017.
+
+Clarifai is an awesome service and hopefully this gem makes it easier to use it and to use AI image tagging in your Ruby apps.  Please let me know if there's something you'd like to see but don't or if you see something you wish you didn't.  Thanks!
+
+This gem is currently in development and there is lots likely to change so please be aware!
 
 ## Installation
 
@@ -25,18 +28,20 @@ Or install it yourself as:
 
 ## Configuration
 
-Configure the gem as you would normally.
+Configure the gem as you would normally configure a wonderful happy gem.
 
 ```ruby
   Clarification.configure do |config|
     config.api_key = 'a_big_secret_you_got_from_clarifai'
-    config.end_points = [:food, :general]
+    config.default_public_models = [: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._
+**Each endpoint initialized in your configuration will be called by default from the client.  So any predictions using a client configured with `:food` and `:general` will make two API requests.**
+
+This will change when [Workflow](https://clarifai.com/developer/guide/workflow#workflow) is implemented in the gem.
 
 ## Usage
 
@@ -47,7 +52,7 @@ response = client.predict(some_public_url_of_an_image)
 
 ### Prediction
 
-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.  
+The response object returned from the prediction is a hash containing a nicely parsed result for each of the models called.  In the above configuration example we have two models.  So we will have response[:food] and response[:general] after asking for a prediction.  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:
 
@@ -59,16 +64,18 @@ response[:food].concepts.each do |concept|
 end
 ```
 
-```ruby
-response[:general].response_json
-```
-
 ```ruby
 if response[:food].status.code == 10000
   puts response[:food].status.description
 end
 ```
 
+If you want the actual api response, it's here:
+
+```ruby
+response[:general].response_json
+```
+
 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.
@@ -78,6 +85,37 @@ client.predict(some_public_url_of_an_image)
 client.last_response #=> {:food => Objectifier...}
 ```
 
+### Search
+
+The client has a search object which can be used to index images with the Clarifai application identified by the API key.  
+
+Thusly you can do like this:
+
+```ruby
+image_array = [ url_to_picture_of_kitten, url_to_picture_of_pizza, url_to_picture_of_drake]
+client.search.index_images(image_array)
+```
+
+Once you have your images indexed, you can go and search them by concepts that might be in your picture as identified by Clarifai's general prediction model.
+
+```ruby
+results = client.search.by_concept('cat')
+results.hits.each do |hit|
+  puts hit.url if hit.score > .90
+end
+```
+
+The search client also saves the last search and searched concept as a matter of convenience.
+
+```ruby
+client.search.last_search.hits.count
+client.search.last_search.concept
+```
+
+Go and do likewise.
+
+### Train
+
 ## TODO's
 
 Lots and lots of things.  Amongst them:
@@ -86,6 +124,8 @@ Lots and lots of things.  Amongst them:
 * error handling
 * predict multiple images per call
 * predict video
+* better testing.
+* documentation
 * use workflows
 * searching
 * training custom models
@@ -94,15 +134,16 @@ Lots and lots of things.  Amongst them:
 
 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).
+The repo intentionally includes an api key in bin/console to make experimenting easy and quick.  If you plan on making a bunch of requests, you can easily sign up for [your own free key](https://clarifai.com/signup/).
 
 ## Contributing
 
 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
-
+You can also see various code reporting / CI info here:
+[travis ci](https://travis-ci.org/nicholalexander/clarification)  
+[codacy](https://www.codacy.com/app/nicholalexander/clarification)  
+[code climate](https://codeclimate.com/github/nicholalexander/clarification)   
 
 ## License
 

data/bin/console

@@ -2,19 +2,44 @@
 
 require "bundler/setup"
 require "clarification"
+require "yaml"
 
 # 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]
+  config.default_public_models = [:food, :general]
 end
 
-@target_url = 'https://www.cicis.com/media/1138/pizza_trad_pepperoni.png'
+@images = YAML.load_file("spec/support/images.yml")
+        
+@urls = [ @images[:mountains], @images[:kitten], @images[:drake] ]
+
+# models = [:apparel,
+#          :celebrity,
+#          :color,
+#          :demographics,
+#          :face_detection,
+#          :face_embedding,
+#          :focus,
+#          :food,
+#          :general,
+#          :general_embedding,
+#          :logo,
+#          :moderation,
+#          :nsfw,
+#          :travel,
+#          :wedding ]
 
 @client = Clarification::Client.new
-@response = @client.predict(@target_url)
+# @client.set_models(models)
+# @response = @client.predict(@target_url)
+
+# @client.search.index_image
+# @client.search.by_concepts
+# @client.search.by_images
+
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"

data/clarification.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nichol.alexander@gmail.com"]
 
   spec.summary       = %q{An unofficial API wrapper for the Clarifai Image and Video Recognition API.}
-  spec.description   = %q{Alpha Version - configure, access Clarifai set end points, interrogate responses.}
+  spec.description   = %q{Alpha Version - Predict and Search using Clarifai.}
   spec.homepage      = "https://github.com/nicholalexander/clarification"
   spec.license       = "MIT"
 

data/lib/clarification.rb

@@ -1,9 +1,15 @@
 require "clarification/client"
+require "clarification/concept"
 require "clarification/configuration"
 require "clarification/end_points"
 require "clarification/enrich"
+require "clarification/hit"
 require "clarification/objectifier"
+require "clarification/response"
+require "clarification/response/search_response"
 require "clarification/requester"
+require "clarification/requester/search_requester"
+require "clarification/search"
 require "clarification/version"
 
 require 'net/http'

data/lib/clarification/client.rb

@@ -1,23 +1,28 @@
 module Clarification
   class Client
 
-    attr_reader :active_models, :last_response
+    attr_reader :active_public_models, :last_response, :search
 
     def initialize
       raise "No Configuration Found." if Clarification.configuration.nil?
-      @active_models = Clarification.configuration.default_models
+      @active_public_models = Clarification.configuration.default_public_models
       @last_response = nil
+      @search = Search.new
     end
     
     def predict(url)
-      requester = Requester.new(@active_models)
+      requester = Requester.new(@active_public_models)
       response = requester.get(url)
       @last_response = Enrich.new(response).run
       return @last_response
     end
 
     def set_models(model_array)
-      @active_models = model_array
+      if model_array.class != Array
+        raise "Clarification expects an array of models."
+      end
+      
+      @active_public_models = model_array
     end
 
   end

data/lib/clarification/concept.rb

@@ -0,0 +1,4 @@
+module Clarification
+  class Concept < Struct.new(:name, :value)
+  end
+end

data/lib/clarification/configuration.rb

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

data/lib/clarification/end_points.rb

@@ -1,5 +1,6 @@
 module Clarification
-  BASE_URL = 'https://api.clarifai.com/v2/models/'.freeze
+  BASE_URL = 'https://api.clarifai.com/v2/'.freeze
+
 
   PUBLIC_MODELS = {
     apparel: 'e0be3b9d6a454f0493ac3a30784001ff',

data/lib/clarification/enrich.rb

@@ -12,7 +12,6 @@ module Clarification
       @response_array.each do |model_name, raw_response |
         @results[model_name] = Objectifier.new(raw_response.body)
       end
-
       return @results
     end
 

data/lib/clarification/hit.rb

@@ -0,0 +1,4 @@
+module Clarification
+  class Hit < Struct.new(:score, :url, :created_at)
+  end
+end

data/lib/clarification/objectifier.rb

@@ -1,21 +1,67 @@
 module Clarification
   class Objectifier
 
-    attr_reader :response_json, :status, :concepts
+    attr_reader :response_json, :status, :concepts, :error
 
     def initialize(response)
       @response_json = JSON.parse(response)
       @status = OpenStruct.new(@response_json["status"])
       @concepts = []
-
+      @error = nil
+      
       build_concept_objects
+      
     end
 
     def build_concept_objects
-      @response_json["outputs"][0]["data"]["concepts"].each do |concept|
-        @concepts << OpenStruct.new(concept)
+      
+      begin
+        concepts = @response_json.fetch("outputs").fetch(0).fetch("data", nil).fetch("concepts", nil)
+      rescue StandardError => e
+        @error = e
+        return
+      end
+
+      if concepts  
+        concepts.each do |concept_hash|
+  
+          name = concept_hash["name"]
+          value = concept_hash["value"]
+
+          concept = Concept.new(name, value)
+
+          @concepts << concept
+        end
+      else
+        data = @response_json.fetch("outputs").fetch(0).fetch("data", nil)
+        unless data.empty?
+          case @response_json['outputs'][0]['model']['name']
+          when "focus"
+            # concept.class = concept::focus
+            focus = OpenStruct.new(data["focus"])
+            regions = []
+            data["regions"].each do |region|
+              regions << OpenStruct.new(region)
+            end
+            focus_hash = {focus: focus, regions: regions}
+            @concepts << OpenStruct.new(focus_hash)
+            @concepts.first.name = "focus"
+          when "color"
+            # concept.class = concept::color
+            data["colors"].each do |color|
+              @concepts << OpenStruct.new(color)
+            end
+          when "general_embedding"
+            # concept.class = concept::embedding
+            @concepts << OpenStruct.new(data["embeddings"][0])
+            @concepts.first.name = "embedding"
+          end
+        end
       end
+
     end
 
   end
 end
+
+

data/lib/clarification/requester.rb

@@ -13,6 +13,8 @@ module Clarification
       return response
     end
 
+    private
+
     def get_with_model(target_url, model)
       uri = uri_builder(model)
       body = body_builder(target_url)
@@ -44,14 +46,14 @@ module Clarification
 
     def uri_builder(model)
       model_key = Clarification::PUBLIC_MODELS[model]
-      url = "#{Clarification::BASE_URL}#{model_key}/outputs"
+      url = "#{Clarification::BASE_URL}models/#{model_key}/outputs"
       uri = URI.parse(url)
     end
 
     def request_builder(uri, body)
       request = Net::HTTP::Post.new(uri)
       request.content_type = "application/json"
-      request["Authorization"] = "Key f7cc628178994e16b2470ae739ef927a"
+      request["Authorization"] = "Key #{Clarification.configuration.api_key}"
       request.body = JSON.dump(body)
 
       return request
@@ -61,10 +63,20 @@ module Clarification
       request_options = {
         use_ssl: uri.scheme == "https",
       }
-
       return request_options
     end
 
+    def get_response(uri, body)
+      request = request_builder(uri, body)
+      options = options_builder(uri)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, options) do |http|
+        http.request(request)
+      end
+
+      return response
+    
+    end
 
 
   end

data/lib/clarification/requester/search_requester.rb

@@ -0,0 +1,70 @@
+module Clarification
+  class SearchRequester < Clarification::Requester
+
+    def initialize
+    end
+
+    def index(target_urls)
+      uri = uri_builder("inputs")
+      body = body_builder(target_urls)
+      response = get_response(uri, body)
+      return response
+    end
+
+    def get_results_for_concept(concept)
+      uri = uri_builder("searches")
+      body = concept_body_builder(concept)
+      response = get_response(uri, body)
+      return response
+    end
+
+    private
+
+    def body_builder(target_urls)
+      # build individual inputs
+      inputs = []
+      target_urls.each do |url|
+        inputs << {
+          data: {
+            image: {
+              url: url
+            }
+          }
+        }
+      end
+
+      # wrap for api
+      {
+        inputs: inputs
+      }
+    end
+
+    def concept_body_builder(concept)
+      {
+        query: {
+          ands: [
+            {
+              output: {
+                data: {
+                  concepts: [
+                    {
+                      name: "#{concept}"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+      
+    end
+
+
+    def uri_builder(path)
+      url = "#{Clarification::BASE_URL}#{path}"
+      URI.parse(url)
+    end
+
+  end
+end

data/lib/clarification/response.rb

@@ -0,0 +1,4 @@
+module Clarification
+  class Response
+  end
+end

data/lib/clarification/response/search_response.rb

@@ -0,0 +1,27 @@
+module Clarification
+
+  class SearchResponse < Response
+
+    attr_reader :hits, :raw_response, :concept
+
+    def initialize(raw_response, concept)
+      @hits = []
+      @concept = concept
+      @raw_response = JSON.parse(raw_response)
+
+      parse_raw_response
+    end
+
+    private
+    def parse_raw_response
+      @raw_response['hits'].each do |hit|
+        score = hit["score"]
+        url = hit["input"]["data"]["image"]["url"]
+        created_at = hit["input"]["created_at"]
+        @hits << Hit.new(score, url, created_at)
+      end
+    end
+
+  end
+end
+

data/lib/clarification/search.rb

@@ -0,0 +1,29 @@
+module Clarification
+  class Search
+  
+    attr_reader :last_search
+
+    def initialize
+      @last_search = nil
+    end
+
+    def index_images(image_array)
+      search_requester = Clarification::SearchRequester.new
+      search_requester.index(image_array)
+      # need some useful response here
+    end
+
+    def by_images(_image_array)
+      raise "Not Implemented"
+    end
+
+    def by_concept(concept)
+      search_requester = Clarification::SearchRequester.new
+      raw_response = search_requester.get_results_for_concept(concept)
+      structured_response = Clarification::SearchResponse.new(raw_response.body, concept)
+      @last_search = structured_response
+      return structured_response
+    end
+
+  end
+end

data/lib/clarification/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clarification
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nichol Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -136,8 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Alpha Version - configure, access Clarifai set end points, interrogate
-  responses.
+description: Alpha Version - Predict and Search using Clarifai.
 email:
 - nichol.alexander@gmail.com
 executables: []
@@ -158,11 +157,17 @@ files:
 - clarification.gemspec
 - lib/clarification.rb
 - lib/clarification/client.rb
+- lib/clarification/concept.rb
 - lib/clarification/configuration.rb
 - lib/clarification/end_points.rb
 - lib/clarification/enrich.rb
+- lib/clarification/hit.rb
 - lib/clarification/objectifier.rb
 - lib/clarification/requester.rb
+- lib/clarification/requester/search_requester.rb
+- lib/clarification/response.rb
+- lib/clarification/response/search_response.rb
+- lib/clarification/search.rb
 - lib/clarification/version.rb
 homepage: https://github.com/nicholalexander/clarification
 licenses: