deepstack 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be874725c205c1b4c704649e99506f362fc711eeff315d9616deb112f7caecd5
-  data.tar.gz: f3a54bde1b2d8a533e9af9c58154a9004c7133f3e383d8e612a91d6052187fe1
+  metadata.gz: 830f650f0001d9ace30cbcf6758aa58cae9d4bf7089300f0e22261e58274e1cb
+  data.tar.gz: 2a9b1c9d03f3c04d6f159f9216b85791904f8c279155c9142bf5248eb719769a
 SHA512:
-  metadata.gz: 9c7d7c9f0abe1465489936961e9cc297c1e9961b2e6afe6b2612fea975b5b0cc0c24a95748fd6fe14e5b45e480d15a27237ad5e5b01d4f84a8617258a659fcc1
-  data.tar.gz: d4d9f966dd440a3cd3031c3ba64b029d0f94b427945d64b77cd23aea3f1a900de2fea85a2f24ddd49fca8c1c821c7e3c6b7c63a9e120fc38e481ed1452ec388b
+  metadata.gz: fc573a46b62325ef299af50d25a7c9c760df25025f87f1c8c1eb588a3ee148fceb38ace946d3d39e92236d48c96da4f474a239ecfc2821660886e6f020b77ea4
+  data.tar.gz: '08e0a71c109b87a81ef475aa85e8ea2750ed615adf65a03299b4b3df805911fac898597f94a4cdb5aa597fa03fab6367ccf04004c7545980e3a6b2261ff86d1d'

data/lib/deep_stack/custom_model.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 class DeepStack
-  # Custom Model
+  # Support for using Custom Models with DeepStack
   module CustomModel
     #
-    # Return predictions using a custom model
+    # Return predictions using a custom model.
+    # Custom models are *.pt models that have been saved in DeepStack's modelstore directory.
+    # See https://docs.deepstack.cc/custom-models/deployment/index.html
     #
     # @param [String] model custom model name
     # @param [Object] image binary data or a File object

data/lib/deep_stack/deep_stack.rb

@@ -6,6 +6,7 @@ require_relative 'face'
 require_relative 'detection'
 require_relative 'scene'
 require_relative 'custom_model'
+require_relative 'image'
 require_relative 'version'
 
 # DeepStack API
@@ -13,6 +14,7 @@ class DeepStack
   include DeepStack::Face
   include DeepStack::Detection
   include DeepStack::Scene
+  include DeepStack::Image
   include DeepStack::CustomModel
 
   #
@@ -20,15 +22,27 @@ class DeepStack
   #
   # @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
+  # @param [String] api_key an optional API-KEY to use when connecting to DeepStack
+  # @param [Integer] verify_mode sets the flags for server the certification verification at
+  #                  beginning of SSL/TLS session.
+  #                  +OpenSSL::SSL::VERIFY_NONE+ or +OpenSSL::SSL::VERIFY_PEER+ are acceptable.
   #
   # @example
   #   DeepStack.new('http://127.0.0.1:5000')
   #
-  def initialize(base_url, api_key: nil, admin_key: nil)
+  #   # Using API KEY:
+  #   DeepStack.new('http://127.0.0.1:5000', api_key: 'secret', admin_key: 'supersecret')
+  #
+  #   # Connect to SSL with a self-signed certificate
+  #   DeepStack.new('https://localhost:443', verify_mode: OpenSSL::SSL::VERIFY_NONE)
+  #
+  def initialize(base_url, api_key: nil, admin_key: nil, verify_mode: 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
+    uri = URI(base_url)
+    http_options = {}
+    http_options[:verify_mode] = verify_mode if verify_mode
+    @http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.instance_of?(URI::HTTPS), **http_options)
   end
 
   #
@@ -60,9 +74,7 @@ class DeepStack
   # Close the HTTP connection to DeepStack server
   #
   def close
-    @http_mutex.synchronize do
-      @http.finish if @http&.started?
-    end
+    @http.finish if @http&.started?
   end
 
   private
@@ -79,11 +91,8 @@ class DeepStack
     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
+    @http.start unless @http.started?
+    @http.request(req)
   end
 
   def combine_images_and_args(*images, **args)

data/lib/deep_stack/face.rb

@@ -77,5 +77,24 @@ class DeepStack
       target = 'vision/face/register'
       api_post(target, images, userid: userid)&.dig('success') == true
     end
+
+    #
+    # Call DeepStack's Face Match service. Compare two different pictures and tells the similarity between them.
+    #
+    # @example
+    #   image1 = File.read('obama1.jpg')
+    #   image2 = File.read('obama2.jpg')
+    #   puts deepstack.face_match(image1, image2) > 0.6 ? 'similar' : 'different'
+    #
+    # @param [Array] *images two images to compare
+    # @param [kwargs] **args optional arguments to the API call
+    #
+    # @return [Float] The similarity score (0-1)
+    # @return [nil] if failed
+    #
+    def face_match(*images, **args)
+      target = 'vision/face/match'
+      api_post(target, images, **args)&.dig('similarity')
+    end
   end
 end

data/lib/deep_stack/image.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+class DeepStack
+  # Support Image Enhance feature
+  module Image
+    #
+    # Enhance image {https://docs.deepstack.cc/api-reference/index.html#image-enhance}
+    #
+    # @param [Image] image the raw image data or a File object of an image file
+    #
+    # @return [Image] the enhanced image object
+    # @return [nil] if failed
+    #
+    def enhance_image(image)
+      target = 'vision/enhance'
+      result = api_post(target, image)
+      return unless result&.dig('success') == true
+
+      Base64.decode64(result['base64'])
+    end
+  end
+end

data/lib/deep_stack/scene.rb

@@ -4,14 +4,15 @@ class DeepStack
   # Scene Recognition
   module Scene
     #
-    # Return
+    # Call the scene recognition API to classify an image into one of the supported scenes.
     #
     # @param [Object] image binary data or a File object
     # @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)
       target = 'vision/scene'
       api_post(target, image, **options)

data/lib/deep_stack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jimmy Tanagra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -21,6 +21,7 @@ files:
 - lib/deep_stack/deep_stack.rb
 - lib/deep_stack/detection.rb
 - lib/deep_stack/face.rb
+- lib/deep_stack/image.rb
 - lib/deep_stack/scene.rb
 - lib/deep_stack/version.rb
 - lib/deepstack.rb