cloudmersive-image-recognition-api-client 2.0.4 → 2.0.5

data/lib/cloudmersive-image-recognition-api-client/models/image_similarity_hash_response.rb

@@ -0,0 +1,196 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveImageRecognitionApiClient
+  # Result of performing an image hash operation
+  class ImageSimilarityHashResponse
+    # True if successful, false otherwise
+    attr_accessor :successful
+
+    # String representing image perceptual hash value; values with smaller Hamming Distances are more similar than ones with large Hamming Distances
+    attr_accessor :image_hash
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'image_hash' => :'ImageHash'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'image_hash' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'ImageHash')
+        self.image_hash = attributes[:'ImageHash']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          image_hash == o.image_hash
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, image_hash].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveImageRecognitionApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-image-recognition-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveImageRecognitionApiClient
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 end

data/spec/api/recognize_api_spec.rb

@@ -130,4 +130,43 @@ describe 'RecognizeApi' do
     end
   end
 
+  # unit tests for recognize_similarity_compare
+  # Compare two images for similarity
+  # Generates an image similarity score using Deep Learning between 0.0 and 1.0, values closer to 1.0 indicate greater similarity
+  # @param base_image Image file to compare against.  Common file formats such as PNG, JPEG are supported.
+  # @param comparison_image Image to compare to the base image.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal.
+  # @return [String]
+  describe 'recognize_similarity_compare test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recognize_similarity_hash
+  # Generate a perceptual image hash
+  # Generates a hash value for the image; hash values that are closer together in terms of Hamming Distance are more similar.
+  # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal.
+  # @return [ImageSimilarityHashResponse]
+  describe 'recognize_similarity_hash test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recognize_similarity_hash_distance
+  # Calculates the similarity between two perceptual image hashes
+  # Calculates the similarity between two perceptual image hashes by computing the Hamming Distance between them.
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [ImageSimilarityHashDistanceResponse]
+  describe 'recognize_similarity_hash_distance test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/image_similarity_comparison_response_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::ImageSimilarityComparisonResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ImageSimilarityComparisonResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::ImageSimilarityComparisonResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageSimilarityComparisonResponse' do
+    it 'should create an instance of ImageSimilarityComparisonResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::ImageSimilarityComparisonResponse)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "are_images_similar"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "image_similarity_score"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/image_similarity_hash_distance_request_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ImageSimilarityHashDistanceRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageSimilarityHashDistanceRequest' do
+    it 'should create an instance of ImageSimilarityHashDistanceRequest' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest)
+    end
+  end
+  describe 'test attribute "image_hash1"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "image_hash2"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/image_similarity_hash_distance_response_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ImageSimilarityHashDistanceResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageSimilarityHashDistanceResponse' do
+    it 'should create an instance of ImageSimilarityHashDistanceResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceResponse)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "image_similarity_score"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/image_similarity_hash_response_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::ImageSimilarityHashResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ImageSimilarityHashResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::ImageSimilarityHashResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageSimilarityHashResponse' do
+    it 'should create an instance of ImageSimilarityHashResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::ImageSimilarityHashResponse)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "image_hash"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end