deepstack 0.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd245c6bb369aed6c65f88277a186cd283d396b5eeafa28bc10e854dfbd027c
-  data.tar.gz: b428c594d92837534124004c0ff0ef4f0b0c2aad0a2cf40ef4faa69f38d904d3
+  metadata.gz: caf4cf801a5a99ff308e5afc06ed19dac86d8348388c519880770d482fd1bb0b
+  data.tar.gz: de77bacb1bd1ffb46c4dff277ab16e1195ef423f005ad98394b49cab6e248fa3
 SHA512:
-  metadata.gz: 1f4d4c306447142dd071a6a4a28ce8f36f2170cf23160401e7cbf1786d9b8124e9c72e1a144c13096b62ad03a361fe4684f0aa8d9fab4aee0b921017ed0fff8c
-  data.tar.gz: 2a7c706fbfe815f7faf5ce06294f1eff65c2c9aeec3cdddb865e97348475cf1ee3478b9152444e4a92ae3697eeae3ad4e97a1fd47edff3247578eae52b340953
+  metadata.gz: 6836c3bc1e6dc367542c4bd9e3e089ddf2cf3a7e612d6230dfabf3f3a38a4651965eead00bba50dd5916e5a9d8fcc44c624f3743b17165fbda24cff8c9ea7ec8
+  data.tar.gz: 5f5c98987f6fae82a67ef8fa57a557aa300bd22da6108a8575eabe6e3ac8d1f301f57caad1f86b533629b503d53db4bb40e101ff630abddce1b2659637e2b177

data/lib/{deepstack → deep_stack}/custom.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Deepstack
+class DeepStack
   # Custom Model
   module Custom
     #
@@ -28,16 +28,15 @@ module Deepstack
     #
     # @param [String] model custom model name
     # @param [Object] image binary data or a File object
-    # @param [Hash] options additional fields for Deepstack, e.g. min_confidence: 0.5
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
-    # @return [Array] if successful, an array of Deepstack predictions
+    # @return [Array] if successful, an array of DeepStack predictions
     #
     # @return [nil] if error
     #
     def custom_inference(model, image, **options)
       target = "vision/custom/#{model}"
-      api_post(target, image, options)
-      predictions
+      api_post(target, image, options)&.dig('predictions')
     end
   end
 end

data/lib/deep_stack/deep_stack.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'face'
+require_relative 'detection'
+require_relative 'scene'
+require_relative 'custom'
+require_relative 'version'
+
+# DeepStack API
+class DeepStack
+  include DeepStack::Face
+  include DeepStack::Detection
+  include DeepStack::Scene
+  include DeepStack::Custom
+
+  #
+  # Create a deepstack object connected to the given URL
+  #
+  # @param [String] base_url the url to DeepStack's server:port
+  # @param [String] api_key an optional API-KEY to use when connecting to DeepStack
+  # @param [String] admin_key an optional ADMIN-KEY to use when connecting to DeepStack
+  #
+  # @example
+  #   DeepStack.new('http://127.0.0.1:5000')
+  #
+  def initialize(base_url, api_key: nil, admin_key: nil)
+    @base_url = base_url
+    @auth = { api_key: api_key, admin_key: admin_key }.select { |_k, v| v } # remove nil values
+    @http_mutex = Mutex.new
+  end
+
+  #
+  # Make a POST request to DeepStack path target
+  #
+  # @param [String] path to the DeepStack API URL
+  # @param [Array] images zero or more images to post
+  # @param [Hash] args additional named fields to post
+  #
+  # @return [Hash] if successful, the json data returned by DeepStack, nil otherwise
+  #
+  def api_post(path, *images, **args)
+    uri = build_uri(path)
+    args = @auth.merge(args)
+
+    result = nil
+    10.times do
+      result = images ? post_files(uri, images.flatten, **args) : post(uri, args)
+      break unless result.is_a?(Net::HTTPRedirection)
+
+      uri.path = result['location']
+    end
+    raise Net::HTTPClientException, 'Too many redirections' if result.is_a?(Net::HTTPRedirection)
+
+    process_result(result)
+  end
+
+  #
+  # Close the HTTP connection to DeepStack server
+  #
+  def close
+    @http_mutex.synchronize do
+      @http&.finish
+      @http = nil
+    end
+  end
+
+  private
+
+  def build_uri(path)
+    URI.join(@base_url, '/v1/', path)
+  end
+
+  def post(uri, **args)
+    Net::HTTP.post_form(uri, args)
+  end
+
+  def post_files(uri, *images, **args)
+    form_data = combine_images_and_args(images.flatten, **args)
+    req = Net::HTTP::Post.new(uri)
+    req.set_form(form_data, 'multipart/form-data')
+    @http_mutex.synchronize do
+      @http ||= Net::HTTP.start(uri.hostname, uri.port)
+      @http.request(req)
+    end
+  end
+
+  def combine_images_and_args(*images, **args)
+    stringify_keys(args).concat(image_form_data(images.flatten))
+  end
+
+  def stringify_keys(hash)
+    hash.map { |k, v| [k.to_s, v] }
+  end
+
+  #
+  # Return an array of image entries for form data.
+  # The field name is 'image' for a single image
+  # For multiple images, the field names will be 'image1', 'image2', ...
+  #
+  # @param [Array<Object>] images an array of raw image data or a File object
+  #
+  # @return [Array] the image entries for set_form
+  #
+  def image_form_data(*images)
+    images = images.flatten
+    return [image_entry('image', images.first)] if images.length == 1
+
+    images.map.with_index(1) { |image, i| image_entry("image#{i}", image) }
+  end
+
+  def image_entry(name, image)
+    [name, image].tap { |result| result << { filename: "#{name}.jpg" } unless image.instance_of? File }
+  end
+
+  def process_result(result)
+    result.is_a?(Net::HTTPSuccess) ? JSON.parse(result.body) : nil
+  end
+end

data/lib/{deepstack → deep_stack}/detection.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
-module Deepstack
+class DeepStack
   # APIs related to object detection
   module Detection
     #
     # Perform object detection
     #
     # @param [Object] image raw image data or a File object of an image file
-    # @param [Hash] options additional fields for Deepstack, e.g. min_confidence: 0.5
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
     # @return [Array] a list of predictions, or nil on error
     #
     def detect_objects(image, **options)
       target = 'vision/detection'
-      api_post(target, image, **options)
-      predictions
+      api_post(target, image, **options)&.dig('predictions')
     end
   end
 end

data/lib/{deepstack → deep_stack}/face.rb

@@ -1,36 +1,34 @@
 # frozen_string_literal: true
 
-module Deepstack
+class DeepStack
   # APIs related to face recognition
   module Face
     #
     # Perform face recognition
     #
     # @param [Object] image binary data or a File object
-    # @param [Hash] options additional fields for Deepstack, e.g. min_confidence: 0.5
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
-    # @return [Array] if successful, an array of Deepstack predictions
+    # @return [Array] if successful, an array of DeepStack predictions
     #
     # @return [nil] if error
     #
     def recognize_faces(image, **options)
       target = 'vision/face/recognize'
-      api_post(target, image, **options)
-      predictions
+      api_post(target, image, **options)&.dig('predictions')
     end
 
     #
     # Detect faces in an image
     #
     # @param [Object] image binary data or a File object
-    # @param [Hash] options additional fields for Deepstack, e.g. min_confidence: 0.5
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
-    # @return [Array] if successful, an array of Deepstack predictions
+    # @return [Array] if successful, an array of DeepStack predictions
     #
     def detect_faces(image, **options)
       target = 'vision/face/' # the URL ends with a slash
-      api_post(target, image, **options)
-      predictions
+      api_post(target, image, **options)&.dig('predictions')
     end
 
     #
@@ -64,8 +62,7 @@ module Deepstack
     #
     def delete_face(userid)
       target = 'vision/face/delete'
-      api_post(target, userid: userid)
-      success?
+      api_post(target, userid: userid)&.dig('success') == true
     end
 
     #
@@ -78,8 +75,7 @@ module Deepstack
     #
     def register_face(userid, *images)
       target = 'vision/face/register'
-      api_post(target, images, userid: userid)
-      success?
+      api_post(target, images, userid: userid)&.dig('success') == true
     end
   end
 end

data/lib/{deepstack → deep_stack}/scene.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-module Deepstack
+class DeepStack
   # Scene Recognition
   module Scene
     #
     # Return
     #
     # @param [Object] image binary data or a File object
-    # @param [Hash] options additional fields for Deepstack, e.g. min_confidence: 0.5
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
-    # @return [Hash] if successful, Deepstack result hash {'label' => 'scene', 'confidence' => 2.2}
+    # @return [Hash] if successful, DeepStack result hash {'label' => 'scene', 'confidence' => 2.2}
     #
     # @return [nil] if error
     def identify_scene(image, **options)

data/lib/deep_stack/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+#
+# Holds project version constant
+#
+class DeepStack
+  # @return [String] Version of DeepStack helper libraries
+  VERSION = '1.2.0'
+end

data/lib/deepstack.rb

@@ -1,111 +1,3 @@
 # frozen_string_literal: true
 
-require 'pp'
-require 'net/http'
-require 'json'
-require_relative 'deepstack/face'
-require_relative 'deepstack/detection'
-require_relative 'deepstack/scene'
-require_relative 'deepstack/custom'
-require_relative 'deepstack/version'
-
-module Deepstack
-  # Deepstack API
-  class API
-    include Deepstack::Face
-    include Deepstack::Detection
-    include Deepstack::Scene
-    include Deepstack::Custom
-
-    attr_reader :duration, :predictions, :success
-
-    # Create a deepstack object connected to the given URL
-    def initialize(base_url)
-      @base_url = base_url
-    end
-
-    #
-    # The result of the last call
-    #
-    # @return [Boolean] true if the last call was successful
-    #
-    def success?
-      @success == true
-    end
-
-    #
-    # Make a POST request to Deepstack path target
-    #
-    # @param [String] path to the Deepstack API URL
-    # @param [Array] images zero or more images to post
-    # @param [Hash] args additional named fields to post
-    #
-    # @return [Hash] if successful, the json data returned by Deepstack, nil otherwise
-    #
-    def api_post(path, *images, **args)
-      uri = build_uri(path)
-
-      result = nil
-      10.times do
-        result = images ? post_files(uri, images.flatten, **args) : post(uri, args)
-        break unless result.is_a?(Net::HTTPRedirection)
-
-        uri.path = result['location']
-      end
-      raise Net::HTTPClientException, 'Too many redirections' if result.is_a?(Net::HTTPRedirection)
-
-      process_result(result)
-    end
-
-    private
-
-    def build_uri(path)
-      URI.join(@base_url, '/v1/', path)
-    end
-
-    def post(uri, **args)
-      Net::HTTP.post_form(uri, args)
-    end
-
-    def post_files(uri, *images, **args)
-      form_data = combine_images_and_args(images.flatten, **args)
-      req = Net::HTTP::Post.new(uri)
-      req.set_form(form_data, 'multipart/form-data')
-      Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(req) }
-    end
-
-    def combine_images_and_args(*images, **args)
-      stringify_keys(args).concat(image_form_data(images.flatten))
-    end
-
-    def stringify_keys(hash)
-      hash.map { |k, v| [k.to_s, v] }
-    end
-
-    #
-    # Return an array of image entries for form data.
-    # The field name is 'image' for a single image
-    # For multiple images, the field names will be 'image1', 'image2', ...
-    #
-    # @param [Array<Object>] images an array of raw image data or a File object
-    #
-    # @return [Array] the image entries for set_form
-    #
-    def image_form_data(*images)
-      images = images.flatten
-      return [image_entry('image', images.first)] if images.length == 1
-
-      images.map.with_index(1) { |image, i| image_entry("image#{i}", image) }
-    end
-
-    def image_entry(name, image)
-      [name, image].tap { |result| result << { filename: "#{name}.jpg" } unless image.instance_of? File }
-    end
-
-    def process_result(result)
-      @result = result.is_a?(Net::HTTPSuccess) ? JSON.parse(result.body) : nil
-      %w[success duration predictions].each { |attrib| instance_variable_set("@#{attrib}", @result&.dig(attrib)) }
-      @result
-    end
-  end
-end
+require_relative 'deep_stack/deep_stack'

metadata

@@ -1,36 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jimmy Tanagra
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email:
 - jcode@tanagra.id.au
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/deep_stack/custom.rb
+- lib/deep_stack/deep_stack.rb
+- lib/deep_stack/detection.rb
+- lib/deep_stack/face.rb
+- lib/deep_stack/scene.rb
+- lib/deep_stack/version.rb
 - lib/deepstack.rb
-- lib/deepstack/custom.rb
-- lib/deepstack/detection.rb
-- lib/deepstack/face.rb
-- lib/deepstack/scene.rb
-- lib/deepstack/version.rb
 homepage: https://github.com/jimtng/deepstack-ruby
 licenses:
 - EPL-2.0
 metadata:
   homepage_uri: https://github.com/jimtng/deepstack-ruby
   source_code_uri: https://github.com/jimtng/deepstack-ruby
+  documentation_uri: https://rubydoc.info/gems/deepstack
   changelog_uri: https://github.com/jimtng/deepstack-ruby/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -45,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for Deepstack API
+summary: A Ruby wrapper for DeepStack API
 test_files: []

data/lib/deepstack/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Holds project version constant
-#
-module Deepstack
-  # @return [String] Version of Deepstack helper libraries
-  VERSION = '0.0.1'
-end