cloudmersive-barcode-api-client 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc82e32c02d0e4ccc8b1a79e18525212799cea62dfeddb58e1eb23f016136e34
-  data.tar.gz: f61d32c9f37bf8979b083f87517150ff82d5475b231b3aceca5e326b04647da6
+  metadata.gz: a3f4b5fa446a6650e5537260094fceccf3b3882033fea9f1491a8084e6bb7537
+  data.tar.gz: 357301368e4ff6a7f8cdb4b4417c77e36b2991220a294cf9a7e212aacfeb314d
 SHA512:
-  metadata.gz: ffa0f2156f966b5ba103d9f5efcbe518c7a7e83cf40adc48560574a82c05c49188327075b517f8518c1ead4ea6070c5c56b7231325947ab1cf57facb1a43ca5a
-  data.tar.gz: 6a82a159a0e9402f5e36ef13405e909f270e375785189b0f2b4f098d507334bcb746491c7c5b8e54d86e8ba19f38f60c74809479a487ee55903c9a6de651d900
+  metadata.gz: 0ab222d85f2b2d40e8c125a53f2adf401c7b63e0170e9709fc7f34afc421afd604aa22d99f198d0fa9a441aec377ae9bb484332b0a101e6034429f04d3f69d66
+  data.tar.gz: c4c80b4a8791918b242c8cd0176201df023b725efc4de9efb1d538bb7207298e61fe60f9d25c1859c6c5c591f82bde1e7c793fb2b9797c3d79d07e70e0f0ac24

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,110 @@
+# cloudmersive-barcode-api-client
+
+CloudmersiveBarcodeApiClient - the Ruby gem for the barcodeapi
+
+Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.2
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-barcode-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-barcode-api-client-2.0.2.gem
+```
+(for development, run `gem install --dev ./cloudmersive-barcode-api-client-2.0.2.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 'cloudmersive-barcode-api-client', '~> 2.0.2'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-barcode-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'cloudmersive-barcode-api-client'
+
+# Setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::BarcodeLookupApi.new
+
+value = 'value_example' # String | Barcode value
+
+
+begin
+  #Lookup EAN barcode value, return product data
+  result = api_instance.barcode_lookup_ean_lookup(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveBarcodeApiClient::BarcodeLookupApi* | [**barcode_lookup_ean_lookup**](docs/BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
+*CloudmersiveBarcodeApiClient::BarcodeScanApi* | [**barcode_scan_image**](docs/BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
+*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
+*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean8**](docs/GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
+*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_qr_code**](docs/GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
+*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upca**](docs/GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
+*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upce**](docs/GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
+
+
+## Documentation for Models
+
+ - [CloudmersiveBarcodeApiClient::BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
+ - [CloudmersiveBarcodeApiClient::BarcodeScanResult](docs/BarcodeScanResult.md)
+ - [CloudmersiveBarcodeApiClient::ProductMatch](docs/ProductMatch.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cloudmersive-barcode-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#barcodeapi
+
+#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-barcode-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-barcode-api-client"
+  s.version     = CloudmersiveBarcodeApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/barcode-api"
+  s.summary     = "Generate and recognize 1D and 2D barcodes."
+  s.description = "Generate and recognize 1D and 2D barcodes."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/BarcodeLookupApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveBarcodeApiClient::BarcodeLookupApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**barcode_lookup_ean_lookup**](BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
+
+
+# **barcode_lookup_ean_lookup**
+> BarcodeLookupResponse barcode_lookup_ean_lookup(value)
+
+Lookup EAN barcode value, return product data
+
+Lookup an input EAN barcode and return key details about the product
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::BarcodeLookupApi.new
+
+value = 'value_example' # String | Barcode value
+
+
+begin
+  #Lookup EAN barcode value, return product data
+  result = api_instance.barcode_lookup_ean_lookup(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| Barcode value | 
+
+### Return type
+
+[**BarcodeLookupResponse**](BarcodeLookupResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/BarcodeLookupResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveBarcodeApiClient::BarcodeLookupResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if operation was successful, false otherwise | [optional] 
+**matches** | [**Array<ProductMatch>**](ProductMatch.md) | Resulting product matches for the input barcode | [optional] 
+
+

data/docs/BarcodeScanApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveBarcodeApiClient::BarcodeScanApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**barcode_scan_image**](BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
+
+
+# **barcode_scan_image**
+> BarcodeScanResult barcode_scan_image(image_file)
+
+Scan and recognize an image of a barcode
+
+Scan an image or photo of a barcode and return the result.  Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::BarcodeScanApi.new
+
+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
+  #Scan and recognize an image of a barcode
+  result = api_instance.barcode_scan_image(image_file)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling BarcodeScanApi->barcode_scan_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **image_file** | **File**| Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported. | 
+
+### Return type
+
+[**BarcodeScanResult**](BarcodeScanResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/BarcodeScanResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveBarcodeApiClient::BarcodeScanResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**barcode_type** | **String** | The type of the barcode; possible values are AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB | [optional] 
+**raw_text** | **String** | The barcode text | [optional] 
+
+

data/docs/GenerateBarcodeApi.md

@@ -0,0 +1,283 @@
+# CloudmersiveBarcodeApiClient::GenerateBarcodeApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**generate_barcode_ean13**](GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
+[**generate_barcode_ean8**](GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
+[**generate_barcode_qr_code**](GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
+[**generate_barcode_upca**](GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
+[**generate_barcode_upce**](GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
+
+
+# **generate_barcode_ean13**
+> File generate_barcode_ean13(value)
+
+Generate a EAN-13 code barcode as PNG file
+
+Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
+
+value = 'value_example' # String | Barcode value to generate from
+
+
+begin
+  #Generate a EAN-13 code barcode as PNG file
+  result = api_instance.generate_barcode_ean13(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean13: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| Barcode value to generate from | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: image/png
+
+
+
+# **generate_barcode_ean8**
+> File generate_barcode_ean8(value)
+
+Generate a EAN-8 code barcode as PNG file
+
+Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
+
+value = 'value_example' # String | Barcode value to generate from
+
+
+begin
+  #Generate a EAN-8 code barcode as PNG file
+  result = api_instance.generate_barcode_ean8(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean8: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| Barcode value to generate from | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: image/png
+
+
+
+# **generate_barcode_qr_code**
+> File generate_barcode_qr_code(value)
+
+Generate a QR code barcode as PNG file
+
+Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
+
+value = 'value_example' # String | QR code text to convert into the QR code barcode
+
+
+begin
+  #Generate a QR code barcode as PNG file
+  result = api_instance.generate_barcode_qr_code(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling GenerateBarcodeApi->generate_barcode_qr_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| QR code text to convert into the QR code barcode | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: image/png
+
+
+
+# **generate_barcode_upca**
+> File generate_barcode_upca(value)
+
+Generate a UPC-A code barcode as PNG file
+
+Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
+
+value = 'value_example' # String | UPC-A barcode value to generate from
+
+
+begin
+  #Generate a UPC-A code barcode as PNG file
+  result = api_instance.generate_barcode_upca(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling GenerateBarcodeApi->generate_barcode_upca: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| UPC-A barcode value to generate from | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: image/png
+
+
+
+# **generate_barcode_upce**
+> File generate_barcode_upce(value)
+
+Generate a UPC-E code barcode as PNG file
+
+Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-barcode-api-client'
+# setup authorization
+CloudmersiveBarcodeApiClient.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 = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
+
+value = 'value_example' # String | UPC-E barcode value to generate from
+
+
+begin
+  #Generate a UPC-E code barcode as PNG file
+  result = api_instance.generate_barcode_upce(value)
+  p result
+rescue CloudmersiveBarcodeApiClient::ApiError => e
+  puts "Exception when calling GenerateBarcodeApi->generate_barcode_upce: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| UPC-E barcode value to generate from | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: image/png
+
+
+