deepstack 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0409e409422c065962aa065244f20658c764c904462935936b05c1950e771a
-  data.tar.gz: 074e0f2e9f309f72aaa402ef5e1b3bd469da172bbb60679a2a59b218f4a2a7ac
+  metadata.gz: be874725c205c1b4c704649e99506f362fc711eeff315d9616deb112f7caecd5
+  data.tar.gz: f3a54bde1b2d8a533e9af9c58154a9004c7133f3e383d8e612a91d6052187fe1
 SHA512:
-  metadata.gz: '0923fd828175f78a7bc90a40623c6ed7ec8ce8681876ab340697309c9557bdbf2551f10567b4df4dd861c2121e2cd37c62b47f06803e08f8cc0b1a5739e68d89'
-  data.tar.gz: b9be9f1439d69f939f2dbf66842264a750e47d8cba455ff528b7879f115f3510e45690f8ff7a804e1b23428a5313c44c147049b3bcc269db31b4887f7c03b34e
+  metadata.gz: 9c7d7c9f0abe1465489936961e9cc297c1e9961b2e6afe6b2612fea975b5b0cc0c24a95748fd6fe14e5b45e480d15a27237ad5e5b01d4f84a8617258a659fcc1
+  data.tar.gz: d4d9f966dd440a3cd3031c3ba64b029d0f94b427945d64b77cd23aea3f1a900de2fea85a2f24ddd49fca8c1c821c7e3c6b7c63a9e120fc38e481ed1452ec388b

data/lib/deep_stack/custom_model.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class DeepStack
+  # Custom Model
+  module CustomModel
+    #
+    # Return predictions using a custom model
+    #
+    # @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
+    #
+    # @return [Array] if successful, an array of DeepStack predictions
+    #
+    # @return [nil] if error
+    #
+    def custom_model(model, image, **options)
+      target = "vision/custom/#{model}"
+      api_post(target, image, **options)&.dig('predictions')
+    end
+    # @deprecated Use {custom_model} instead
+    alias custom_inference custom_model
+  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_model'
+require_relative 'version'
+
+# DeepStack API
+class DeepStack
+  include DeepStack::Face
+  include DeepStack::Detection
+  include DeepStack::Scene
+  include DeepStack::CustomModel
+
+  #
+  # 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 if @http&.started?
+    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.start unless @http.started?
+      @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,6 +1,6 @@
 # frozen_string_literal: true
 
-module DeepStackModule
+class DeepStack
   # APIs related to object detection
   module Detection
     #
@@ -13,8 +13,7 @@ module DeepStackModule
     #
     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,6 +1,6 @@
 # frozen_string_literal: true
 
-module DeepStackModule
+class DeepStack
   # APIs related to face recognition
   module Face
     #
@@ -15,8 +15,7 @@ module DeepStackModule
     #
     def recognize_faces(image, **options)
       target = 'vision/face/recognize'
-      api_post(target, image, **options)
-      predictions
+      api_post(target, image, **options)&.dig('predictions')
     end
 
     #
@@ -29,8 +28,7 @@ module DeepStackModule
     #
     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 DeepStackModule
     #
     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 DeepStackModule
     #
     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,6 +1,6 @@
 # frozen_string_literal: true
 
-module DeepStackModule
+class DeepStack
   # Scene Recognition
   module Scene
     #

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

@@ -5,5 +5,5 @@
 #
 class DeepStack
   # @return [String] Version of DeepStack helper libraries
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

data/lib/deepstack.rb

@@ -1,109 +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'
-
-# DeepStack API
-class DeepStack
-  include DeepStackModule::Face
-  include DeepStackModule::Detection
-  include DeepStackModule::Scene
-  include DeepStackModule::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
+require_relative 'deep_stack/deep_stack'

metadata

@@ -1,36 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.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_model.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
 test_files: []

data/lib/deepstack/custom.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module DeepStackModule
-  # Custom Model
-  module Custom
-    #
-    # Register a custom inference method for convenience.
-    # The custom method is called "identify_<modelname>"
-    # Example:
-    #   deepstack.register_custom_model('license_plate')
-    #   deepstack.identify_license_plate(image)
-    #
-    # @param [Array] models a list of one or more custom model names to register
-    #
-    # @return [<Type>] <description>
-    #
-    def self.register_model(*models)
-      models.flatten.each do |model|
-        method_name = 'identify_'.concat model.gsub(/-+/, '_') # convert - to _
-        define_method(method_name) do |image, **options|
-          custom_inference(model, image, options)
-        end
-      end
-    end
-
-    #
-    # Return predictions using a custom model
-    #
-    # @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
-    #
-    # @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
-    end
-  end
-end