deepstack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bd245c6bb369aed6c65f88277a186cd283d396b5eeafa28bc10e854dfbd027c
+  data.tar.gz: b428c594d92837534124004c0ff0ef4f0b0c2aad0a2cf40ef4faa69f38d904d3
+SHA512:
+  metadata.gz: 1f4d4c306447142dd071a6a4a28ce8f36f2170cf23160401e7cbf1786d9b8124e9c72e1a144c13096b62ad03a361fe4684f0aa8d9fab4aee0b921017ed0fff8c
+  data.tar.gz: 2a7c706fbfe815f7faf5ce06294f1eff65c2c9aeec3cdddb865e97348475cf1ee3478b9152444e4a92ae3697eeae3ad4e97a1fd47edff3247578eae52b340953

data/lib/deepstack/custom.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Deepstack
+  # 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

data/lib/deepstack/detection.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module 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
+    #
+    # @return [Array] a list of predictions, or nil on error
+    #
+    def detect_objects(image, **options)
+      target = 'vision/detection'
+      api_post(target, image, **options)
+      predictions
+    end
+  end
+end

data/lib/deepstack/face.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module 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
+    #
+    # @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
+    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
+    #
+    # @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
+    end
+
+    #
+    # Get a list of registered faces
+    #
+    # @return [Array] a list of userids
+    #
+    def face_list
+      target = 'vision/face/list'
+      api_post(target)&.dig('faces')
+      # {"success"=>true, "faces"=>["face_1", "face_2"], "duration"=>0}
+    end
+
+    #
+    # Delete the given list of faces / userids
+    #
+    # @param [Array] userids a list of userids to delete
+    #
+    # @return [Hash] A hash of `userid => boolean` that indicates success/failure
+    #
+    def delete_faces(*userids)
+      userids.flatten.compact.to_h { |userid| [userid, delete_face(userid)] }
+    end
+
+    #
+    # Delete the given face / userid
+    #
+    # @param [String] userid to delete
+    #
+    # @return [Boolean] true when successful
+    #
+    def delete_face(userid)
+      target = 'vision/face/delete'
+      api_post(target, userid: userid)
+      success?
+    end
+
+    #
+    # Register a face
+    #
+    # @param [String] userid to register
+    # @param [Array] images facial image data in binary form or File object
+    #
+    # @return [Boolean] true when successful
+    #
+    def register_face(userid, *images)
+      target = 'vision/face/register'
+      api_post(target, images, userid: userid)
+      success?
+    end
+  end
+end

data/lib/deepstack/scene.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module 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
+    #
+    # @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)
+    end
+  end
+end

data/lib/deepstack/version.rb

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

data/lib/deepstack.rb

@@ -0,0 +1,111 @@
+# 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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: deepstack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Tanagra
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jcode@tanagra.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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
+  changelog_uri: https://github.com/jimtng/deepstack-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for Deepstack API
+test_files: []