deepstack 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd245c6bb369aed6c65f88277a186cd283d396b5eeafa28bc10e854dfbd027c
-  data.tar.gz: b428c594d92837534124004c0ff0ef4f0b0c2aad0a2cf40ef4faa69f38d904d3
+  metadata.gz: dc0409e409422c065962aa065244f20658c764c904462935936b05c1950e771a
+  data.tar.gz: 074e0f2e9f309f72aaa402ef5e1b3bd469da172bbb60679a2a59b218f4a2a7ac
 SHA512:
-  metadata.gz: 1f4d4c306447142dd071a6a4a28ce8f36f2170cf23160401e7cbf1786d9b8124e9c72e1a144c13096b62ad03a361fe4684f0aa8d9fab4aee0b921017ed0fff8c
-  data.tar.gz: 2a7c706fbfe815f7faf5ce06294f1eff65c2c9aeec3cdddb865e97348475cf1ee3478b9152444e4a92ae3697eeae3ad4e97a1fd47edff3247578eae52b340953
+  metadata.gz: '0923fd828175f78a7bc90a40623c6ed7ec8ce8681876ab340697309c9557bdbf2551f10567b4df4dd861c2121e2cd37c62b47f06803e08f8cc0b1a5739e68d89'
+  data.tar.gz: b9be9f1439d69f939f2dbf66842264a750e47d8cba455ff528b7879f115f3510e45690f8ff7a804e1b23428a5313c44c147049b3bcc269db31b4887f7c03b34e

data/lib/deepstack/custom.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Deepstack
+module DeepStackModule
   # Custom Model
   module Custom
     #
@@ -28,9 +28,9 @@ 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
     #

data/lib/deepstack/detection.rb

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

data/lib/deepstack/face.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-module Deepstack
+module DeepStackModule
   # 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
     #
@@ -23,9 +23,9 @@ module Deepstack
     # 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

data/lib/deepstack/scene.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-module Deepstack
+module DeepStackModule
   # 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/deepstack/version.rb

@@ -3,7 +3,7 @@
 #
 # Holds project version constant
 #
-module Deepstack
-  # @return [String] Version of Deepstack helper libraries
-  VERSION = '0.0.1'
+class DeepStack
+  # @return [String] Version of DeepStack helper libraries
+  VERSION = '1.0.0'
 end

data/lib/deepstack.rb

@@ -9,103 +9,101 @@ 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
+# 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
+  #
+  # 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)
+  #
+  # 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)
 
-    private
+    process_result(result)
+  end
 
-    def build_uri(path)
-      URI.join(@base_url, '/v1/', path)
-    end
+  private
 
-    def post(uri, **args)
-      Net::HTTP.post_form(uri, args)
-    end
+  def build_uri(path)
+    URI.join(@base_url, '/v1/', path)
+  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 post(uri, **args)
+    Net::HTTP.post_form(uri, args)
+  end
 
-    def combine_images_and_args(*images, **args)
-      stringify_keys(args).concat(image_form_data(images.flatten))
-    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 stringify_keys(hash)
-      hash.map { |k, v| [k.to_s, v] }
-    end
+  def combine_images_and_args(*images, **args)
+    stringify_keys(args).concat(image_form_data(images.flatten))
+  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 stringify_keys(hash)
+    hash.map { |k, v| [k.to_s, v] }
+  end
 
-    def image_entry(name, image)
-      [name, image].tap { |result| result << { filename: "#{name}.jpg" } unless image.instance_of? File }
-    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 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
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jimmy Tanagra
@@ -48,5 +48,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A Ruby wrapper for Deepstack API
+summary: A Ruby wrapper for DeepStack API
 test_files: []