cloudmersive-image-recognition-api-client 2.0.1 → 2.0.2

data/spec/api/face_api_spec.rb

@@ -0,0 +1,120 @@
+=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'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::FaceApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FaceApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FaceApi' do
+    it 'should create an instance of FaceApi' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::FaceApi)
+    end
+  end
+
+  # unit tests for face_compare
+  # Compare and match faces
+  # Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image.  The reference image (second parameter) should contain exactly one face.
+  # @param input_image Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image.  Common file formats such as PNG, JPEG are supported.
+  # @param match_face Image of a single face to compare and match against.
+  # @param [Hash] opts the optional parameters
+  # @return [FaceCompareResponse]
+  describe 'face_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 face_crop_first
+  # Crop image to face with square crop
+  # Crop an image to the face (rectangular crop).  If there is more than one face present, choose the first one.
+  # @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
+  # @return [String]
+  describe 'face_crop_first 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 face_crop_first_round
+  # Crop image to face with round crop
+  # Crop an image to the face (circular/round crop).  If there is more than one face present, choose the first one.
+  # @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
+  # @return [String]
+  describe 'face_crop_first_round 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 face_detect_age
+  # Detect the age of people in an image
+  # Identify the age, position, and size of human faces in an image, along with a recognition confidence level.  People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.
+  # @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
+  # @return [AgeDetectionResult]
+  describe 'face_detect_age 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 face_detect_gender
+  # Detect the gender of people in an image
+  # Identify the gender, position, and size of human faces in an image, along with a recognition confidence level.  People in the image should be facing the camera.
+  # @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
+  # @return [GenderDetectionResult]
+  describe 'face_detect_gender 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 face_locate
+  # Detect and find faces in an image
+  # Locate the positions of all faces in an image
+  # @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
+  # @return [FaceLocateResponse]
+  describe 'face_locate 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 face_locate_with_landmarks
+  # Detect and find faces and landmarks eyes and nose and mouth in image
+  # Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
+  # @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
+  # @return [FaceLocateWithLandmarksResponse]
+  describe 'face_locate_with_landmarks 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/api/filter_api_spec.rb

@@ -0,0 +1,141 @@
+=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'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::FilterApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FilterApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FilterApi' do
+    it 'should create an instance of FilterApi' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::FilterApi)
+    end
+  end
+
+  # unit tests for filter_black_and_white
+  # Convert image to black-and-white grayscale
+  # Remove color from the image by converting to a grayscale, black-and-white image
+  # @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
+  # @return [String]
+  describe 'filter_black_and_white 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 filter_despeckle
+  # Despeckle to remove point noise from the image
+  # Remove point noise / despeckle the input image
+  # @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
+  # @return [String]
+  describe 'filter_despeckle 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 filter_edge_detect
+  # Detect and highlight edges in an image
+  # Perform an edge detection operation on the input image
+  # @param radius Radius in pixels of the edge detection operation; a larger radius will produce a greater effect
+  # @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
+  # @return [String]
+  describe 'filter_edge_detect 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 filter_emboss
+  # Emboss an image
+  # Perform an emboss operation on the input image
+  # @param radius Radius in pixels of the emboss operation; a larger radius will produce a greater effect
+  # @param sigma Sigma, or variance, of the emboss operation
+  # @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
+  # @return [String]
+  describe 'filter_emboss 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 filter_gaussian_blur
+  # Perform a guassian blur on the input image
+  # Perform a gaussian blur on the input image
+  # @param radius Radius in pixels of the blur operation; a larger radius will produce a greater blur effect
+  # @param sigma Sigma, or variance, of the gaussian blur operation
+  # @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
+  # @return [String]
+  describe 'filter_gaussian_blur 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 filter_motion_blur
+  # Perform a motion blur on the input image
+  # Perform a motion blur on the input image at a specific angle
+  # @param radius Radius in pixels of the blur operation; a larger radius will produce a greater blur effect
+  # @param sigma Sigma, or variance, of the motion blur operation
+  # @param angle Angle of the motion blur in degrees
+  # @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
+  # @return [String]
+  describe 'filter_motion_blur 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 filter_posterize
+  # Posterize the image by reducing distinct colors
+  # Reduce the unique number of colors in the image to the specified level
+  # @param levels Number of unique colors to retain in the output image
+  # @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
+  # @return [String]
+  describe 'filter_posterize 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 filter_swirl
+  # Swirl distort the image
+  # Swirl distort the image by the specified number of degrees
+  # @param degrees Degrees of swirl
+  # @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
+  # @return [String]
+  describe 'filter_swirl 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/api/info_api_spec.rb

@@ -0,0 +1,59 @@
+=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'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::InfoApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InfoApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::InfoApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InfoApi' do
+    it 'should create an instance of InfoApi' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::InfoApi)
+    end
+  end
+
+  # unit tests for info_get_dominant_color
+  # Returns the dominant colors of the image
+  # Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first.  These are the primary perceptual colors used in the image as perceived by a viewer.
+  # @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
+  # @return [DominantColorResult]
+  describe 'info_get_dominant_color 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 info_get_metadata
+  # Returns the image metadata including EXIF and resolution
+  # Returns the metadata information on the image, including file type, EXIF (if available), and resolution.
+  # @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
+  # @return [ImageMetadata]
+  describe 'info_get_metadata 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/api/nsfw_api_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'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::NsfwApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'NsfwApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::NsfwApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NsfwApi' do
+    it 'should create an instance of NsfwApi' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::NsfwApi)
+    end
+  end
+
+  # unit tests for nsfw_classify
+  # Not safe for work NSFW racy content classification
+  # Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.
+  # @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
+  # @return [NsfwResult]
+  describe 'nsfw_classify 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/api/recognize_api_spec.rb

@@ -0,0 +1,133 @@
+=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'
+
+# Unit tests for CloudmersiveImageRecognitionApiClient::RecognizeApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RecognizeApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecognizeApi' do
+    it 'should create an instance of RecognizeApi' do
+      expect(@instance).to be_instance_of(CloudmersiveImageRecognitionApiClient::RecognizeApi)
+    end
+  end
+
+  # unit tests for recognize_describe
+  # Describe an image in natural language
+  # Generate an English language text description of the image as a sentence.
+  # @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
+  # @return [ImageDescriptionResponse]
+  describe 'recognize_describe 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_detect_and_unskew_document
+  # Detect and unskew a photo of a document
+  # Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image.  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
+  # @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] :post_processing_effect Optional, post-processing effects to apply to the email, default is None.  Possible values are None and BlackAndWhite (force the image into a black and white view to aid in OCR operations).
+  # @return [String]
+  describe 'recognize_detect_and_unskew_document 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_detect_objects
+  # Detect objects including types and locations in an image
+  # Identify the position, size and description of objects in an image, along with a recognition confidence level.  Detects both human people and objects in an image.
+  # @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
+  # @return [ObjectDetectionResult]
+  describe 'recognize_detect_objects 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_detect_people
+  # Detect people including locations in an image
+  # Identify the position, and size of human people in an image, along with a recognition confidence level.  People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.
+  # @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
+  # @return [ObjectDetectionResult]
+  describe 'recognize_detect_people 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_detect_text_fine
+  # Detect fine text in a photo of a document
+  # Identify the position, and size of small/fine text within a photograph of a document.  Identify the location of small text in a photo - such as words and other forms of high density text.  Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt.  For OCR purposes - please see our Deep Learning OCR APIs.
+  # @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
+  # @return [FineTextDetectionResult]
+  describe 'recognize_detect_text_fine 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_detect_text_large
+  # Detect large text in a photo
+  # Identify the position, and size of large text within a photograph.  Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text.  Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
+  # @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
+  # @return [TextDetectionResult]
+  describe 'recognize_detect_text_large 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_detect_vehicle_license_plates
+  # Detect vehicle license plates in an image
+  # Identify the position, and size, and content of vehicle license plates in an image.  License plates should be within 15-20 degrees on-axis to the camera.  Supported image formats are JPG, PNG and BMP.
+  # @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
+  # @return [VehicleLicensePlateDetectionResult]
+  describe 'recognize_detect_vehicle_license_plates 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_find_symbol
+  # Find the location of a symbol in an image
+  # Determine if an image contains a symbol, and if so, the location of that symbol in the image.
+  # @param input_image Image file to search through for the target image.
+  # @param target_image Image to find in the input image.
+  # @param [Hash] opts the optional parameters
+  # @return [FindSymbolResult]
+  describe 'recognize_find_symbol test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end