Skip to content
Ruby library for communicating with the Aspose.Imaging Cloud API
Ruby
Branch: master
Clone or download
Latest commit 2ea24f5 Dec 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
TestData
docs Updated package name Dec 23, 2019
lib Updated version Dec 23, 2019
test
.gitignore Add .gitignore Jul 29, 2019
EXAMPLES.md Add examples Nov 27, 2019
README.md Updated package name Dec 23, 2019
Rakefile Add filter effect API Nov 27, 2019
aspose-imaging-cloud.gemspec

README.md

aspose_imaging_cloud

AsposeImagingCloud - the Ruby gem for the Aspose.Imaging Cloud API Reference

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 3.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build aspose_imaging_cloud.gemspec

Then either install the gem locally:

gem install ./aspose_imaging_cloud.gem

(for development, run gem install --dev ./aspose_imaging_cloud.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'aspose_imaging_cloud', '~> 19.12'

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 'aspose_imaging_cloud', :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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'aspose_imaging_cloud'

# Setup authorization
AsposeImagingCloud.configure do |config|
  # Configure OAuth2 access token for authorization: JWT
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = AsposeImagingCloud::ImagingApi.new

search_context_id = 'search_context_id_example' # String | Search context identifier.

image_id = 'image_id_example' # String | Image identifier.

opts = { 
  image_data: File.new('/path/to/file.txt'), # File | Input image
  folder: 'folder_example', # String | Folder.
  storage: 'storage_example' # String | Storage
}

begin
  #Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
  api_instance.add_search_image(search_context_id, image_id, opts)
rescue AsposeImagingCloud::ApiError => e
  puts "Exception when calling ImagingApi->add_search_image: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api-qa.aspose.cloud/v3.0

Class Method HTTP request Description
AsposeImagingCloud::ImagingApi add_search_image POST /imaging/ai/imageSearch/{searchContextId}/image Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi append_tiff POST /imaging/tiff/{name}/appendTiff Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images).
AsposeImagingCloud::ImagingApi compare_images POST /imaging/ai/imageSearch/{searchContextId}/compare Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi convert_tiff_to_fax GET /imaging/tiff/{name}/toFax Update parameters of existing TIFF image accordingly to fax parameters.
AsposeImagingCloud::ImagingApi copy_file PUT /imaging/storage/file/copy/{srcPath} Copy file
AsposeImagingCloud::ImagingApi copy_folder PUT /imaging/storage/folder/copy/{srcPath} Copy folder
AsposeImagingCloud::ImagingApi create_cropped_image POST /imaging/crop Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_folder PUT /imaging/storage/folder/{path} Create the folder
AsposeImagingCloud::ImagingApi create_image_features POST /imaging/ai/imageSearch/{searchContextId}/features Extract images features and add them to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_image_frame POST /imaging/frames/{frameId} Get separate frame from existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_image_search POST /imaging/ai/imageSearch/create Create new search context.
AsposeImagingCloud::ImagingApi create_image_tag POST /imaging/ai/imageSearch/{searchContextId}/addTag Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_bmp POST /imaging/bmp Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_emf POST /imaging/emf Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_gif POST /imaging/gif Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_jpeg POST /imaging/jpg Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_jpeg2000 POST /imaging/jpg2000 Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_psd POST /imaging/psd Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_svg POST /imaging/svg Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_tiff POST /imaging/tiff Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_web_p POST /imaging/webp Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_modified_wmf POST /imaging/wmf Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_resized_image POST /imaging/resize Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_rotate_flipped_image POST /imaging/rotateflip Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_saved_image_as POST /imaging/saveAs Export existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_updated_image POST /imaging/updateImage Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi create_web_site_image_features POST /imaging/ai/imageSearch/{searchContextId}/features/web Extract images features from web page and add them to search context
AsposeImagingCloud::ImagingApi crop_image GET /imaging/{name}/crop Crop an existing image.
AsposeImagingCloud::ImagingApi delete_file DELETE /imaging/storage/file/{path} Delete file
AsposeImagingCloud::ImagingApi delete_folder DELETE /imaging/storage/folder/{path} Delete folder
AsposeImagingCloud::ImagingApi delete_image_features DELETE /imaging/ai/imageSearch/{searchContextId}/features Deletes image features from search context.
AsposeImagingCloud::ImagingApi delete_image_search DELETE /imaging/ai/imageSearch/{searchContextId} Deletes the search context.
AsposeImagingCloud::ImagingApi delete_search_image DELETE /imaging/ai/imageSearch/{searchContextId}/image Delete image and images features from search context
AsposeImagingCloud::ImagingApi download_file GET /imaging/storage/file/{path} Download file
AsposeImagingCloud::ImagingApi extract_image_features GET /imaging/ai/imageSearch/{searchContextId}/image2features Extract features from image without adding to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi extract_image_frame_properties POST /imaging/frames/{frameId}/properties Get separate frame properties of existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi extract_image_properties POST /imaging/properties Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi filter_effect_image PUT /imaging/{name}/filterEffect Apply filtering effects to an existing image.
AsposeImagingCloud::ImagingApi find_image_duplicates GET /imaging/ai/imageSearch/{searchContextId}/findDuplicates Find images duplicates.
AsposeImagingCloud::ImagingApi find_images_by_tags POST /imaging/ai/imageSearch/{searchContextId}/findByTags Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi find_similar_images GET /imaging/ai/imageSearch/{searchContextId}/findSimilar Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi get_disc_usage GET /imaging/storage/disc Get disc usage
AsposeImagingCloud::ImagingApi get_file_versions GET /imaging/storage/version/{path} Get file versions
AsposeImagingCloud::ImagingApi get_files_list GET /imaging/storage/folder/{path} Get all files and folders within a folder
AsposeImagingCloud::ImagingApi get_image_features GET /imaging/ai/imageSearch/{searchContextId}/features Gets image features from search context.
AsposeImagingCloud::ImagingApi get_image_frame GET /imaging/{name}/frames/{frameId} Get separate frame from existing TIFF image.
AsposeImagingCloud::ImagingApi get_image_frame_properties GET /imaging/{name}/frames/{frameId}/properties Get separate frame properties of existing TIFF image.
AsposeImagingCloud::ImagingApi get_image_properties GET /imaging/{name}/properties Get properties of an image.
AsposeImagingCloud::ImagingApi get_image_search_status GET /imaging/ai/imageSearch/{searchContextId}/status Gets the search context status.
AsposeImagingCloud::ImagingApi get_search_image GET /imaging/ai/imageSearch/{searchContextId}/image Get image from search context
AsposeImagingCloud::ImagingApi modify_bmp GET /imaging/{name}/bmp Update parameters of existing BMP image.
AsposeImagingCloud::ImagingApi modify_emf GET /imaging/{name}/emf Process existing EMF imaging using given parameters.
AsposeImagingCloud::ImagingApi modify_gif GET /imaging/{name}/gif Update parameters of existing GIF image.
AsposeImagingCloud::ImagingApi modify_jpeg GET /imaging/{name}/jpg Update parameters of existing JPEG image.
AsposeImagingCloud::ImagingApi modify_jpeg2000 GET /imaging/{name}/jpg2000 Update parameters of existing JPEG2000 image.
AsposeImagingCloud::ImagingApi modify_psd GET /imaging/{name}/psd Update parameters of existing PSD image.
AsposeImagingCloud::ImagingApi modify_svg GET /imaging/{name}/svg Update parameters of existing SVG image.
AsposeImagingCloud::ImagingApi modify_tiff GET /imaging/{name}/tiff Update parameters of existing TIFF image.
AsposeImagingCloud::ImagingApi modify_web_p GET /imaging/{name}/webp Update parameters of existing WEBP image.
AsposeImagingCloud::ImagingApi modify_wmf GET /imaging/{name}/wmf Process existing WMF image using given parameters.
AsposeImagingCloud::ImagingApi move_file PUT /imaging/storage/file/move/{srcPath} Move file
AsposeImagingCloud::ImagingApi move_folder PUT /imaging/storage/folder/move/{srcPath} Move folder
AsposeImagingCloud::ImagingApi object_exists GET /imaging/storage/exist/{path} Check if file or folder exists
AsposeImagingCloud::ImagingApi resize_image GET /imaging/{name}/resize Resize an existing image.
AsposeImagingCloud::ImagingApi rotate_flip_image GET /imaging/{name}/rotateflip Rotate and/or flip an existing image.
AsposeImagingCloud::ImagingApi save_image_as GET /imaging/{name}/saveAs Export existing image to another format.
AsposeImagingCloud::ImagingApi storage_exists GET /imaging/storage/{storageName}/exist Check if storage exists
AsposeImagingCloud::ImagingApi update_image GET /imaging/{name}/updateImage Perform scaling, cropping and flipping of an existing image in a single request.
AsposeImagingCloud::ImagingApi update_image_features PUT /imaging/ai/imageSearch/{searchContextId}/features Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi update_search_image PUT /imaging/ai/imageSearch/{searchContextId}/image Update image and images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
AsposeImagingCloud::ImagingApi upload_file PUT /imaging/storage/file/{path} Upload file

Documentation for Models

Documentation for Authorization

JWT

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A
You can’t perform that action at this time.