clarifai-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2aaf992b5f89e18825c6fe7d333c149a4cf32ab
-  data.tar.gz: 37359e89ae991252ac8fdad362c41027fc08f2d3
+  metadata.gz: 5be6cebafc81e05908db735da87c5fbdb0940102
+  data.tar.gz: 4f6cdf1efd108c823b239b056793e8c2e30c9a73
 SHA512:
-  metadata.gz: 2a30cd070f84203bdb827473e6944456016dfd7d90dde2eefb5422357e803d17874bbdd94eab2b6f3b4fad48f25c7cfb26ad2a4d7df931aac560ea5a4ac52efe
-  data.tar.gz: 48eba4b5a9ae29db66eb33af4d5747f486235f1f2a8508ef85f2c58f42dcaa4764ec2821088f664e07e23a9233e14278224a8007b82d1dbd0b8f5460df18bc01
+  metadata.gz: eada820d2430b077964e4453ddf8cad8fccae884ac4a16297079a8420db20d5092ce2b048ee2e64c6f926c6b3ae12d371d336dbc99bb01bdcfdd4ae36416b3db
+  data.tar.gz: dae8da72ef309e32ea535a553b24ba5b336240362b7e695fabffe8e04d7ee3e864b3099ed6fbc0cca20922078ce33c2d87f90539615bc718d65004a35daec6f6

data/README.md

@@ -22,7 +22,94 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialize
+
+    $ rails g clarifai:install
+
+### Config Client ID, Client Secret
+
+Insert your application info in ```config/initializers/clarifai.rb```
+
+### How to detect image
+
+```ruby
+Clarifai::Rails::Detector.new(image_url).image
+```
+
+Return ```Clarifai::Rails::Image``` object
+
+### For multiple images
+
+```ruby
+Clarifai::Rails::Detector.new([image_url_1, image_url_2]).images
+```
+
+Return array ```Clarifai::Rails::Image``` object
+
+
+With ```image``` is ```Clarifai::Rails::Image``` object
+
+#### Get tags
+
+```
+image.tags
+```
+Return for you is a String array, it is tags list
+
+#### Get tags with percent in image
+
+```
+image.tags_with_percent
+```
+Return is a Hash with key is tag and value is percent
+
+#### Get url
+
+```
+image.url
+```
+Return ia a String
+
+#### Get docid
+
+```
+image.docid
+```
+Return ia a Number
+
+#### Get docid_str
+
+```
+image.docid_str
+```
+Return ia a String
+
+#### Check status
+
+```
+image.success?
+```
+AND
+
+```
+image.error?
+```
+
+#### Get status_code
+
+```
+image.status_code
+```
+Return ia a String
+
+Can you see more info at https://developer.clarifai.com/docs/status_codes
+
+#### Get status_msg
+
+```
+image.status_messages
+```
+Return ia a String
 
 ## Development
 
@@ -32,7 +119,7 @@ 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]/clarifai-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ThanhKhoaIT/clarifai-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/clarifai/rails.rb

@@ -4,6 +4,7 @@ module Clarifai
     autoload :Token, "clarifai/rails/token"
     autoload :Detector, "clarifai/rails/detector"
     autoload :Image, "clarifai/rails/image"
+    autoload :Error, "clarifai/rails/error"
 
     def self.setup
       yield self

data/lib/clarifai/rails/detector.rb

@@ -11,31 +11,51 @@ module Clarifai
         @@clarifai_token_expire ||= Time.current
       end
 
-      def image
+      def to_hash
         @data_urls ||= fetch
-        Clarifai::Rails::Image.new(@data_urls["results"].first)
+        JSON.parse(@data_urls).symbolize_keys
+      end
+
+      def results
+        to_hash[:results]
       end
 
       def images
-        @data_urls ||= fetch
-        @data_urls["results"].map do |json|
+        results.map do |json|
           Clarifai::Rails::Image.new(json)
         end
       end
 
+      def image
+        Clarifai::Rails::Image.new(results.first)
+      end
+
+      # Status method
+
+      def error
+        Clarifai::Rails::Error.detector(to_hash[:status_code])
+      end
+
+      def error?
+        error.present?
+      end
+
+      def success?
+        error.blank?
+      end
+
       private
 
       def fetch
         new_token if @@clarifai_token_expire <= Time.current
         params_string = @@urls.join("&url=")
-        response = open("https://api.clarifai.com/v1/tag?url=#{params_string}", "Authorization" => "Bearer #{@@clarifai_token["access_token"]}")
-
-        JSON.parse(response.read)
+        response = open("https://api.clarifai.com/v1/tag?url=#{params_string}", "Authorization" => "Bearer #{@@clarifai_token[:access_token]}")
+        response.read
       end
 
       def new_token
-        @@clarifai_token = Clarifai::Rails::Token.new.create
-        @@clarifai_token_expire = Time.current + @@clarifai_token["expires_in"]
+        @@clarifai_token = Clarifai::Rails::Token.new.create.symbolize_keys
+        @@clarifai_token_expire = Time.current + @@clarifai_token[:expires_in]
       end
 
     end

data/lib/clarifai/rails/error.rb

@@ -0,0 +1,60 @@
+module Clarifai
+  module Rails
+
+    class Error < StandardError
+
+      def initialize(code, text)
+        @error_code = code
+        @error_text = text
+      end
+
+      def code
+        @error_code
+      end
+
+      def message
+        @error_text
+      end
+
+      def self.detector(status_code)
+        error = case status_code
+                when "PARTIAL_ERROR"
+                  PartialError.new(200, "Some images in request have failed. Please review the error messages per image.")
+                when "ALL_ERROR"
+                  AllError.new(400, "Bad request.")
+                when "CLIENT_ERROR"
+                  error_code = 400
+                  error_text = "Data loading failed, see results for details."
+                when "SERVER_ERROR"
+                  error_code = 500
+                  error_text = "Data failed to process, see results for details."
+                when "TOKEN_APP_INVALID"
+                  error_code = 401
+                  error_text = "Application for this token is not valid. Please ensure that you are using ID and SECRET from same application."
+                when "TOKEN_EXPIRED"
+                  error_code = 401
+                  error_text = "Token has expired, you must generate a new access token."
+                when "TOKEN_INVALID"
+                  error_code = 401
+                  error_text = "Token is not valid. Please use valid tokens for a application in your account."
+                when "TOKEN_NONE"
+                  error_code = 401
+                  error_text = "Authentication credentials were not provided in request."
+                when "TOKEN_NO_SCOPE"
+                  error_code = 401
+                  error_text = "Token does not have the required scope to access resources."
+                end
+
+        return error if error.present?
+      end
+
+      class PartialError < Error; end
+      class AllError < Error; end
+      class ClientError < Error; end
+      class ServerError < Error; end
+      class TokenAppInvalid < Error; end
+
+    end
+
+  end
+end

data/lib/clarifai/rails/image.rb

@@ -15,15 +15,14 @@ module Clarifai
       end
 
       def tags
-        return nil if is_error?
-        json[:result]["tag"]["classes"]
+        raise error if error?
+        result["tag"]["classes"]
       end
 
       def tags_with_percent
-        return nil if is_error?
         tags_hash = {}
         tags.each_with_index do |tag, index|
-          tags_hash["#{tag}"] = json[:result]["tag"]["probs"][index]
+          tags_hash["#{tag}"] = result["tag"]["probs"][index]
         end
         tags_hash.symbolize_keys
       end
@@ -37,21 +36,29 @@ module Clarifai
       end
 
       def docid_str
-        json[:result]["docid_str"]
+        result["docid_str"]
       end
 
-      def is_error?
-        status_code != "OK"
+      def error
+        Clarifai::Rails::Error.detector(status_code)
       end
 
-      def is_success?
-        status_code == "OK"
+      def error?
+        error.present?
       end
 
-      protected
+      def success?
+        error.blank?
+      end
+
+      private
 
       attr_reader :json
 
+      def result
+        json[:result]
+      end
+
     end
   end
 end

data/lib/clarifai/rails/version.rb

@@ -1,5 +1,5 @@
 module Clarifai
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/generators/templates/clarifai.rb

@@ -1,7 +1,7 @@
 Clarifai::Rails.setup do |config|
 
-  config.client_id = ""
+  config.client_id = "your clarifai client id"
 
-  config.client_secret = ""
+  config.client_secret = "your clarifai client secret"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clarifai-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Karl Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,7 @@ files:
 - lib/clarifai-rails.rb
 - lib/clarifai/rails.rb
 - lib/clarifai/rails/detector.rb
+- lib/clarifai/rails/error.rb
 - lib/clarifai/rails/image.rb
 - lib/clarifai/rails/token.rb
 - lib/clarifai/rails/version.rb