aspose_omr_cloud 18.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d085e110d20f09d2c9e4602b70423bdf04950a88
+  data.tar.gz: 56f94b1baa1b802996df116b1133336b7fdf4483
+SHA512:
+  metadata.gz: 34f573df9213e426dcd089d7f296fcef565aed9aa1e6c779a7a929ae925f85c387e3192b2fa4663715087f18cf5b4bde854b87960999f153b30bc5684f9e59f3
+  data.tar.gz: d5f31e95075b6f8a83c12d62706b975e43817993053da26f0afad2254984d7b841964402659ffdea8782c8f1ddf1915db01b4854a70b8f1851d39ed3543aab30

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2001-2018 Aspose Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Aspose.OMR for Cloud
+
+[Aspose.OMR for Cloud](https://products.aspose.cloud/omr/cloud) is a REST API that helps you to perform optical mark recognition in the cloud. We provide a series of [SDKs](https://github.com/aspose-omr-cloud). Along with that, you can get [binaries](https://github.com/aspose-omr-cloud/aspose-omr-cloud-dotnet/releases) to start working immediately and recognize various OMR forms. Developers can embed [optical recognition](https://en.wikipedia.org/wiki/Optical_mark_recognition) in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using Aspose.OMR API in your project.
+
+## Quickstart
+
+You can perform tasks out of the box without writing a single line of code with our [GUI client](https://github.com/aspose-omr-cloud/aspose-omr-cloud-dotnet/releases). You can also refer to the [client documentation](https://docs.aspose.cloud/display/omrcloud/Aspose.OMR.Client+Application).
+
+## Using OMR Cloud API in your Ruby projects
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.1
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Requirements
+Ruby 2.3 and later
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build asposeomrcloud.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./asposeomrcloud-1.0.0.gem
+```
+(for development, run `gem install --dev ./asposeomrcloud-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'asposeomrcloud', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby, then add the following in the Gemfile:
+
+    gem 'asposeomrcloud', :git => 'https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Optional requirements
+
+To take full advantage of Aspose.OMR for Cloud, _aspose/storage-sdk-ruby_ is required. Just run `gem install aspose_storage_cloud`. You may refer to official [Aspose Storage SDK](https://github.com/aspose-storage-cloud/aspose-storage-cloud-ruby) to get more information.
+
+## Usage
+
+### Receive Cloud Keys
+Aspose.Cloud credentials are required to use Aspose.OMR for Cloud API. You can acquire App SID and App Key by registrating at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud). It will take only a couple of minutes.
+
+### Code example
+You can check out [OMR Demo](demo) project to get started with Aspose.OMR for Cloud.
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AsposeOmrCloud::OmrApi* | [**post_run_omr_task**](docs/OmrApi.md#post_run_omr_task) | **POST** /omr/{name}/runOmrTask | Run specific OMR task
+
+
+## Documentation for Models
+
+ - [AsposeOmrCloud::AsposeResponse](docs/AsposeResponse.md)
+ - [AsposeOmrCloud::FileInfo](docs/FileInfo.md)
+ - [AsposeOmrCloud::OMRFunctionParam](docs/OMRFunctionParam.md)
+ - [AsposeOmrCloud::OMRResponseDetails](docs/OMRResponseDetails.md)
+ - [AsposeOmrCloud::OmrResponseContent](docs/OmrResponseContent.md)
+ - [AsposeOmrCloud::OmrResponseInfo](docs/OmrResponseInfo.md)
+ - [AsposeOmrCloud::Payload](docs/Payload.md)
+ - [AsposeOmrCloud::RecognitionStatistics](docs/RecognitionStatistics.md)
+ - [AsposeOmrCloud::ServerStat](docs/ServerStat.md)
+ - [AsposeOmrCloud::OMRResponse](docs/OMRResponse.md)
+
+
+## Authentication
+
+Library uses OAUTH2 internally
+
+## Author
+
+Aspose Pty Ltd (https://www.aspose.com)

data/docs/AsposeResponse.md

@@ -0,0 +1,9 @@
+# AsposeOmrCloud::AsposeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Indicates operation's status | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/FileInfo.md

@@ -0,0 +1,11 @@
+# AsposeOmrCloud::FileInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the file | [optional] 
+**size** | **Integer** | Size of the image in bytes | 
+**data** | **String** | File data packed in base64 string | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/OMRFunctionParam.md

@@ -0,0 +1,10 @@
+# AsposeOmrCloud::OMRFunctionParam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**function_param** | **String** | FunctionParam  depends on operation | [optional] 
+**additional_param** | **String** | AdditionalParam depends on operation  | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/OMRResponse.md

@@ -0,0 +1,13 @@
+# AsposeOmrCloud::OMRResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Indicates operation's status | [optional] 
+**error_code** | **Integer** | Integer field that indicates whether any critical errors occured during task execution | [optional] 
+**error_text** | **String** | String description of occured critical error. Empty if no critical errors occured | [optional] 
+**payload** | [**Payload**](Payload.md) | Payload | [optional] 
+**server_stat** | [**ServerStat**](ServerStat.md) | Server statistics | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/OMRResponseDetails.md

@@ -0,0 +1,11 @@
+# AsposeOmrCloud::OMRResponseDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_messages** | **Array<String>** | Warnings and other messages regarding task, etc. | [optional] 
+**task_result** | **String** | Indicates if each particular task passed or failed, | [optional] 
+**recognition_statistics** | [**Array<RecognitionStatistics>**](RecognitionStatistics.md) | RecognitionStatistics | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/OmrApi.md

@@ -0,0 +1,41 @@
+# AsposeOmrCloud::OmrApi
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_run_omr_task**](OmrApi.md#post_run_omr_task) | **POST** /omr/{name}/runOmrTask | Run specific OMR task
+
+
+# **post_run_omr_task**
+> OMRResponse post_run_omr_task(name, action_name, opts)
+
+Run specific OMR task
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of the file to recognize. | 
+ **action_name** | **String**| Action name ['CorrectTemplate', 'FinalizeTemplate', 'RecognizeImage'] | 
+ **param** | [**OMRFunctionParam**](OMRFunctionParam.md)| Function params, specific for each actionName | [optional] 
+ **storage** | **String**| Image's storage. | [optional] 
+ **folder** | **String**| Image's folder. | [optional] 
+
+### Return type
+
+[**OMRResponse**](OMRResponse.md)
+
+### Authorization
+
+Library uses OAUTH2 authorization internally
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

data/docs/OmrResponseContent.md

@@ -0,0 +1,12 @@
+# AsposeOmrCloud::OmrResponseContent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_id** | **String** | GUID string that is used to identify template on server This value is assigned after Template Correction and used later in Template Finalization and Image Recognition | [optional] 
+**execution_time** | **Float** | Indicates how long it took to perform task on server. | 
+**response_files** | [**Array<FileInfo>**](FileInfo.md) | This structure holds array of files returned in response Type and content of files differes depending on action | [optional] 
+**info** | [**OmrResponseInfo**](OmrResponseInfo.md) |  | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/OmrResponseInfo.md

@@ -0,0 +1,12 @@
+# AsposeOmrCloud::OmrResponseInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**response_version** | **String** | String value representing version of the response. | [optional] 
+**processed_tasks_count** | **Integer** | Total amount of processed tasks | 
+**successful_tasks_count** | **Integer** | Total amount of successful tasks, i.e. tasks that completed without errors | 
+**details** | [**OMRResponseDetails**](OMRResponseDetails.md) | Additional information regarding performed task. | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/Payload.md

@@ -0,0 +1,9 @@
+# AsposeOmrCloud::Payload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | [**OmrResponseContent**](OmrResponseContent.md) | OMR result | [optional] 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/RecognitionStatistics.md

@@ -0,0 +1,12 @@
+# AsposeOmrCloud::RecognitionStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Gets or sets Name | [optional] 
+**task_messages** | **Array<String>** | Warnings and other messages regarding task, etc. | [optional] 
+**task_result** | **String** | Indicates if each particular task passed or failed, | [optional] 
+**run_seconds** | **Float** | Gets or sets RunSeconds | 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/docs/ServerStat.md

@@ -0,0 +1,10 @@
+# AsposeOmrCloud::ServerStat
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage_download_time** | **String** | Get or set StorageDownloadTime | 
+**omr_function_call_time** | **String** | Get or set OmrFunctionCallTime | 
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

data/lib/aspose_omr_cloud.rb

@@ -0,0 +1,65 @@
+=begin
+Copyright (c) 2018 Aspose Pty Ltd. All Rights Reserved.
+
+Licensed under the MIT (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby/blob/master/LICENSE
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+#Aspose.OMR for Cloud API Reference
+
+#Aspose.OMR for Cloud helps performing optical mark recognition in the cloud
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'aspose_omr_cloud/api_client'
+require 'aspose_omr_cloud/api_error'
+require 'aspose_omr_cloud/version'
+require 'aspose_omr_cloud/configuration'
+
+# Models
+require 'aspose_omr_cloud/models/aspose_response'
+require 'aspose_omr_cloud/models/file_info'
+require 'aspose_omr_cloud/models/omr_function_param'
+require 'aspose_omr_cloud/models/omr_response_details'
+require 'aspose_omr_cloud/models/omr_response_content'
+require 'aspose_omr_cloud/models/omr_response_info'
+require 'aspose_omr_cloud/models/payload'
+require 'aspose_omr_cloud/models/recognition_statistics'
+require 'aspose_omr_cloud/models/server_stat'
+require 'aspose_omr_cloud/models/omr_response'
+
+# APIs
+require 'aspose_omr_cloud/api/omr_api'
+
+module AsposeOmrCloud
+  class << self
+    # Customize default settings for the SDK using block.
+    #   AsposeOmrCloud.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/aspose_omr_cloud/api/omr_api.rb

@@ -0,0 +1,127 @@
+=begin
+Copyright (c) 2018 Aspose Pty Ltd. All Rights Reserved.
+
+Licensed under the MIT (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby/blob/master/LICENSE
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+#Aspose.OMR for Cloud API Reference
+
+#Aspose.OMR for Cloud helps performing optical mark recognition in the cloud
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require "uri"
+
+module AsposeOmrCloud
+  class OmrApi
+    attr_accessor :api_client
+    
+    # OmrApi constructor
+    # 
+    # @param app_key App Key
+    # @param app_sid App SID
+    # @param base_path Base Path
+    # @param debugging debugging (true to enable, false to disable)
+    # @param api_client custom instance of ApiClient class
+    def initialize(app_key, app_sid, base_path = nil, debugging = false, api_client = ApiClient.default)
+      @api_client = api_client
+      @api_client.config.app_key = app_key if app_key
+      @api_client.config.app_sid = app_sid if app_sid
+      @api_client.config.debugging = debugging
+      if base_path
+        uri = URI.parse(base_path)
+        @api_client.config.scheme = uri.scheme
+        if uri.port.to_s.empty?
+          @api_client.config.host = uri.host
+        else
+          @api_client.config.host = "#{uri.host}:#{uri.port}"
+        end
+      end
+    end
+
+    # Run specific OMR task
+    # 
+    # @param name Name of the file to recognize.
+    # @param action_name Action name ['CorrectTemplate', 'FinalizeTemplate', 'RecognizeImage']
+    # @param [Hash] opts the optional parameters
+    # @option opts [OMRFunctionParam] :param Function params, specific for each actionName
+    # @option opts [String] :storage Image's storage.
+    # @option opts [String] :folder Image's folder.
+    # @return [OMRResponse]
+    def post_run_omr_task(name, action_name, opts = {})
+      data, _status_code, _headers = post_run_omr_task_with_http_info(name, action_name, opts)
+      return data
+    end
+
+    # Run specific OMR task
+    # 
+    # @param name Name of the file to recognize.
+    # @param action_name Action name ['CorrectTemplate', 'FinalizeTemplate', 'RecognizeImage']
+    # @param [Hash] opts the optional parameters
+    # @option opts [OMRFunctionParam] :param Function params, specific for each actionName
+    # @option opts [String] :storage Image's storage.
+    # @option opts [String] :folder Image's folder.
+    # @return [Array<(OMRResponse, Fixnum, Hash)>] OMRResponse data, response status code and response headers
+    def post_run_omr_task_with_http_info(name, action_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OmrApi.post_run_omr_task ..."
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling OmrApi.post_run_omr_task"
+      end
+      # verify the required parameter 'action_name' is set
+      if @api_client.config.client_side_validation && action_name.nil?
+        fail ArgumentError, "Missing the required parameter 'action_name' when calling OmrApi.post_run_omr_task"
+      end
+      # resource path
+      local_var_path = "/omr/{name}/runOmrTask".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'actionName'] = action_name
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+      query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'param'])
+      auth_names = ['oauth']
+      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 => 'OMRResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OmrApi#post_run_omr_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end