clarifai-rb 0.0.0 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bb4d11b3d84be9ebdbc6df9c8c9965f8d9dce137225df681ce0470ecf80a020
-  data.tar.gz: 9b6a1f09300506e303b60a66e56e0bca2048280886cf5b987cb9694b433a39eb
+  metadata.gz: 4179f4487a6395107a0e3e00c12c764db429acf574a488bba241f8056f238949
+  data.tar.gz: 73159320d487030e06eb48ec9b6f7726ec1a13caf49e2e531b711a3000145691
 SHA512:
-  metadata.gz: a1fe924db1d6dbdc8ef18e119c0071386ee603445edb346e5dfe846880f40c7402cc2babdd0c0766e97a3779949f7e5c8e0b74748726070dd935c315706d20fb
-  data.tar.gz: e12274b7b64cd85ab3f33025c790066fc4ee91165bea31b3cfdfb669ed31f7a941f266bf08f8178d913dbcb69f60a4182d875a1d1a62069822089126710d6127
+  metadata.gz: 46b73560483545c1bdf24a8e7c778f1a0e649fe5ae6b9a3aa7a2b48a31b06f0ef4044d0f97157681fc81ca0b7503470615a3303d8f4589ea356ed14d9c12a25e
+  data.tar.gz: 5aa23ff7b94a44858bfff238e8023cf5b193bbc48d7c946cb6e89b9b00e6561caf2ff5fb767da23eebf47e90397a42badbcbef8af3983ba07f919b96563967ef

data/.gitignore

@@ -1,10 +1,2 @@
-/.bundle/
-/.yardoc
 /Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Muhamad Rizky Sya'ban
+
+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,69 @@
+# clarifai-rb
+
+An unofficial Ruby wrapper for [Clarifai](https://www.clarifai.com/) V2 API with the latest `user_id` and `app_id` scoping.
+
+## Contents
+
+1. [Getting Started](https://github.com/shabanzo/clarifai-rb/blob/main/README.md#getting-started)
+2. [Configuration](https://github.com/shabanzo/clarifai-rb/blob/main/README.md#configuration)
+3. [Usage](https://github.com/shabanzo/clarifai-rb/blob/main/README.md#usage)
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```
+gem 'clarification'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+gem install clarifai-rb
+```
+
+## Configuration
+
+```ruby
+Clarifai.configure do |config|
+  config.user_id = '<your_user_id>'
+  config.app_id = '<your_app_id>'
+  config.pat = '<your_pat>' # Personal Access Tokens
+end
+```
+
+If you're using Rails, create a new file named `clarifai.rb` inside `config/initializers` and copy the configuration above.
+
+## Usage
+
+For single url:
+
+```ruby
+predict_instance = Clarifai::Predict.new(model_id: '<your_model_id>')
+predict_instance.call(
+  type: 'image',
+  urls: '<image_url>'
+)
+```
+
+For multiple urls:
+
+```ruby
+predict_instance = Clarifai::Predict.new(model_id: '<your_model_id>')
+predict_instance.call(
+  type: 'image',
+  urls: ['<image_url_1>', '<image_url_2>']
+)
+```
+
+### Supported types:
+
+1. image
+2. video
+3. text

data/clarifai-rb.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "clarifai-rb"
-  s.version     = "0.0.0"
+  s.version     = "0.0.5"
   s.summary     = "An unofficial Ruby wrapper for Clarifai API"
   s.description = "Alpha Version - Predict using Clarifai"
   s.authors     = ["Muhamad Rizky Sya'ban"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
     "https://rubygems.org/gems/clarifai-rb"
   s.license = "MIT"
   s.required_ruby_version = '>=2.2'
-  s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.add_dependency 'json', '>= 1.8'
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.metadata['documentation_uri'] = "https://github.com/shabanzo/clarifai-rb"
 end

data/lib/clarifai/predict.rb

@@ -14,6 +14,7 @@ module Clarifai
       raise "Type is not supported! (#{SUPPORTED_TYPES.join(', ')} only)" unless SUPPORTED_TYPES.include?(type)
       raise 'Input data not supported! (Array of Strings or String only)' unless valid_params?(urls)
 
+      urls = [urls] unless urls.is_a?(Array)
       http = setup_http_client
       request = setup_predict_request(type, urls)
       response = http.request(request)
@@ -63,14 +64,17 @@ module Clarifai
       { data: { image: { url: url } } }
     end
 
-    def predict_body(type, image_url)
-      { inputs: [{
-        data: {
-          "#{type}": {
-            url: image_url
+    def predict_body(type, urls)
+      inputs = urls.map do |url|
+        {
+          data: {
+            "#{type}": {
+              url: url
+            }
           }
         }
-      }] }.to_json
+      end
+      { inputs: inputs }.to_json
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clarifai-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.5
 platform: ruby
 authors:
 - Muhamad Rizky Sya'ban
@@ -9,21 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2023-09-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
+dependencies: []
 description: Alpha Version - Predict using Clarifai
 email: rizkyshaban@gmail.com
 executables: []
@@ -32,6 +18,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
+- README.md
+- clarifai-rb-0.0.0.gem
 - clarifai-rb.gemspec
 - lib/clarifai.rb
 - lib/clarifai/configuration.rb
@@ -41,6 +30,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  documentation_uri: https://github.com/shabanzo/clarifai-rb
 post_install_message:
 rdoc_options: []
 require_paths: