cloudmersive-image-recognition-api-client 1.2.9

data/docs/ResizeApi.md

@@ -0,0 +1,69 @@
+# CloudmersiveImageRecognitionApiClient::ResizeApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**resize_post**](ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image with parameters
+
+
+# **resize_post**
+> String resize_post(max_width, max_height, image_file)
+
+Resize an image with parameters
+
+Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-image-recognition-api-client'
+# setup authorization
+CloudmersiveImageRecognitionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveImageRecognitionApiClient::ResizeApi.new
+
+max_width = 56 # Integer | Maximum width of the output image - final image will be as large as possible while less than or equial to this width
+
+max_height = 56 # Integer | Maximum height of the output image - final image will be as large as possible while less than or equial to this height
+
+image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+
+
+begin
+  #Resize an image with parameters
+  result = api_instance.resize_post(max_width, max_height, image_file)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling ResizeApi->resize_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **max_width** | **Integer**| Maximum width of the output image - final image will be as large as possible while less than or equial to this width | 
+ **max_height** | **Integer**| Maximum height of the output image - final image will be as large as possible while less than or equial to this height | 
+ **image_file** | **File**| Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: image/png
+
+
+

data/docs/VehicleLicensePlateDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::VehicleLicensePlateDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | Was the image processed successfully? | [optional] 
+**detected_license_plates** | [**Array<DetectedLicensePlate>**](DetectedLicensePlate.md) | License plates found in the image | [optional] 
+**detected_license_plate_count** | **Integer** | The number of license plates detected in the image | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

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

@@ -0,0 +1,60 @@
+=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: unset
+
+=end
+
+# Common files
+require 'cloudmersive-image-recognition-api-client/api_client'
+require 'cloudmersive-image-recognition-api-client/api_error'
+require 'cloudmersive-image-recognition-api-client/version'
+require 'cloudmersive-image-recognition-api-client/configuration'
+
+# Models
+require 'cloudmersive-image-recognition-api-client/models/age_detection_result'
+require 'cloudmersive-image-recognition-api-client/models/detected_license_plate'
+require 'cloudmersive-image-recognition-api-client/models/detected_object'
+require 'cloudmersive-image-recognition-api-client/models/draw_rectangle_instance'
+require 'cloudmersive-image-recognition-api-client/models/draw_rectangle_request'
+require 'cloudmersive-image-recognition-api-client/models/draw_text_instance'
+require 'cloudmersive-image-recognition-api-client/models/draw_text_request'
+require 'cloudmersive-image-recognition-api-client/models/face'
+require 'cloudmersive-image-recognition-api-client/models/face_locate_response'
+require 'cloudmersive-image-recognition-api-client/models/image_description_response'
+require 'cloudmersive-image-recognition-api-client/models/nsfw_result'
+require 'cloudmersive-image-recognition-api-client/models/object_detection_result'
+require 'cloudmersive-image-recognition-api-client/models/person_with_age'
+require 'cloudmersive-image-recognition-api-client/models/recognition_outcome'
+require 'cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result'
+
+# APIs
+require 'cloudmersive-image-recognition-api-client/api/artistic_api'
+require 'cloudmersive-image-recognition-api-client/api/edit_api'
+require 'cloudmersive-image-recognition-api-client/api/face_api'
+require 'cloudmersive-image-recognition-api-client/api/nsfw_api'
+require 'cloudmersive-image-recognition-api-client/api/recognize_api'
+require 'cloudmersive-image-recognition-api-client/api/resize_api'
+
+module CloudmersiveImageRecognitionApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveImageRecognitionApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+=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: unset
+
+=end
+
+require "uri"
+
+module CloudmersiveImageRecognitionApiClient
+  class ArtisticApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Transform an image into an artistic painting automatically
+    # Uses machine learning to automatically transform an image into an artistic painting.  Due to depth of AI processing, depending on image size this operation can take up to 20 seconds.
+    # @param style The style of the painting to apply.  To start, try \"udnie\" a painting style.  Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".
+    # @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]
+    def artistic_painting(style, image_file, opts = {})
+      data, _status_code, _headers = artistic_painting_with_http_info(style, image_file, opts)
+      return data
+    end
+
+    # Transform an image into an artistic painting automatically
+    # Uses machine learning to automatically transform an image into an artistic painting.  Due to depth of AI processing, depending on image size this operation can take up to 20 seconds.
+    # @param style The style of the painting to apply.  To start, try \"udnie\" a painting style.  Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".
+    # @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 [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def artistic_painting_with_http_info(style, image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ArtisticApi.artistic_painting ..."
+      end
+      # verify the required parameter 'style' is set
+      if @api_client.config.client_side_validation && style.nil?
+        fail ArgumentError, "Missing the required parameter 'style' when calling ArtisticApi.artistic_painting"
+      end
+      # verify the required parameter 'image_file' is set
+      if @api_client.config.client_side_validation && image_file.nil?
+        fail ArgumentError, "Missing the required parameter 'image_file' when calling ArtisticApi.artistic_painting"
+      end
+      # resource path
+      local_var_path = "/image/artistic/painting/{style}".sub('{' + 'style' + '}', style.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params["imageFile"] = image_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ArtisticApi#artistic_painting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,202 @@
+=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: unset
+
+=end
+
+require "uri"
+
+module CloudmersiveImageRecognitionApiClient
+  class EditApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Composite two images together
+    # Composites two input images together; a layered image onto a base image.  The first image you input is the base image.  The second image (the layered image) will be composited on top of this base image.  Supports PNG transparency.  To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.
+    # @param location Location to composite the layered images; possible values are: \"center\", \"top-left\", \"top-center\", \"top-right\", \"center-left\", \"center-right\", \"bottom-left\", \"bottom-center\", \"bottom-right\"
+    # @param base_image Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param layered_image Image to layer on top of the base image.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def edit_composite_basic(location, base_image, layered_image, opts = {})
+      data, _status_code, _headers = edit_composite_basic_with_http_info(location, base_image, layered_image, opts)
+      return data
+    end
+
+    # Composite two images together
+    # Composites two input images together; a layered image onto a base image.  The first image you input is the base image.  The second image (the layered image) will be composited on top of this base image.  Supports PNG transparency.  To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.
+    # @param location Location to composite the layered images; possible values are: \"center\", \"top-left\", \"top-center\", \"top-right\", \"center-left\", \"center-right\", \"bottom-left\", \"bottom-center\", \"bottom-right\"
+    # @param base_image Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param layered_image Image to layer on top of the base image.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def edit_composite_basic_with_http_info(location, base_image, layered_image, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditApi.edit_composite_basic ..."
+      end
+      # verify the required parameter 'location' is set
+      if @api_client.config.client_side_validation && location.nil?
+        fail ArgumentError, "Missing the required parameter 'location' when calling EditApi.edit_composite_basic"
+      end
+      # verify the required parameter 'base_image' is set
+      if @api_client.config.client_side_validation && base_image.nil?
+        fail ArgumentError, "Missing the required parameter 'base_image' when calling EditApi.edit_composite_basic"
+      end
+      # verify the required parameter 'layered_image' is set
+      if @api_client.config.client_side_validation && layered_image.nil?
+        fail ArgumentError, "Missing the required parameter 'layered_image' when calling EditApi.edit_composite_basic"
+      end
+      # resource path
+      local_var_path = "/image/edit/composite/{location}".sub('{' + 'location' + '}', location.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params["baseImage"] = base_image
+      form_params["layeredImage"] = layered_image
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#edit_composite_basic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Draw rectangle onto an image
+    # Draw one or more rectangles, with customized visuals, onto an image
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def edit_draw_rectangle(request, opts = {})
+      data, _status_code, _headers = edit_draw_rectangle_with_http_info(request, opts)
+      return data
+    end
+
+    # Draw rectangle onto an image
+    # Draw one or more rectangles, with customized visuals, onto an image
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def edit_draw_rectangle_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditApi.edit_draw_rectangle ..."
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling EditApi.edit_draw_rectangle"
+      end
+      # resource path
+      local_var_path = "/image/edit/draw/rectangle"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#edit_draw_rectangle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Draw text onto an image
+    # Draw one or more pieces of text, with customized visuals, onto an image
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def edit_draw_text(request, opts = {})
+      data, _status_code, _headers = edit_draw_text_with_http_info(request, opts)
+      return data
+    end
+
+    # Draw text onto an image
+    # Draw one or more pieces of text, with customized visuals, onto an image
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def edit_draw_text_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditApi.edit_draw_text ..."
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling EditApi.edit_draw_text"
+      end
+      # resource path
+      local_var_path = "/image/edit/draw/text"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#edit_draw_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end