Skip to content

Commit b2dcee7

Browse files
product-teamproduct-team
committed
Updated sources
1 parent 3aed5f9 commit b2dcee7

57 files changed

Lines changed: 6522 additions & 1 deletion

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Gemfile‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
gemspec
4+
5+
group :development, :test do
6+
gem 'rake', '~> 12.0.0'
7+
end

‎README.md‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,53 @@
1-
# groupdocs-annotation-cloud-ruby
1+
# GroupDocs.Annotation Cloud Ruby SDK
22
Ruby gem for communicating with the GroupDocs.Annotation Cloud API
3+
4+
## Installation
5+
6+
A gem of groupdocs_annotation_cloud is available at [rubygems.org](https://rubygems.org). You can install it with:
7+
8+
```shell
9+
gem install groupdocs_annotation_cloud
10+
```
11+
12+
To add dependency to your app copy following into your Gemfile and run `bundle install`:
13+
14+
```
15+
gem "groupdocs_annotation_cloud", "~> 18.7"
16+
```
17+
18+
## Getting Started
19+
20+
Please follow the [installation](#installation) procedure and then run the following code:
21+
```ruby
22+
# Load the gem
23+
require 'groupdocs_annotation_cloud'
24+
25+
# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
26+
app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
27+
app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
28+
29+
# Create instance of the API class
30+
api = GroupDocsAnnotationCloud.from_keys(app_sid, app_key)
31+
32+
# Retrieve supported file-formats
33+
response = api.get_supported_file_formats
34+
35+
# Print out supported file-formats
36+
puts("Supported file-formats:")
37+
response.formats.each do |format|
38+
puts("#{format.file_format} (#{format.extension})")
39+
end
40+
```
41+
42+
## Licensing
43+
GroupDocs.Annotation Cloud Ruby SDK licensed under [MIT License](LICENSE).
44+
45+
## Resources
46+
+ [**Website**](https://www.groupdocs.cloud)
47+
+ [**Product Home**](https://products.groupdocs.cloud/annotation/cloud)
48+
+ [**Documentation**](https://docs.groupdocs.cloud/display/annotationcloud/Home)
49+
+ [**Free Support Forum**](https://forum.groupdocs.cloud/c/annotation)
50+
+ [**Blog**](https://blog.groupdocs.cloud/category/groupdocs-annotation-cloud-product-family)
51+
52+
## Contact Us
53+
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/annotation).

‎Rakefile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
require 'rake/testtask'
2+
3+
Rake::TestTask.new do |t|
4+
t.pattern = "test/*/test_*.rb"
5+
end

‎groupdocs_annotation_cloud.gemspec‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
require './lib/groupdocs_annotation_cloud/version'
2+
3+
Gem::Specification.new do |spec|
4+
spec.name = 'groupdocs_annotation_cloud'
5+
spec.version = GroupDocsAnnotationCloud::VERSION
6+
spec.platform = Gem::Platform::RUBY
7+
spec.license = 'MIT'
8+
spec.summary = 'GroupDocs.Annotation Cloud Ruby SDK'
9+
spec.description = 'Ruby gem for communicating with the GroupDocs.Annotation Cloud API'
10+
spec.author = 'GroupDocs'
11+
spec.email = 'support@groupdocs.cloud'
12+
spec.homepage = 'https://products.groupdocs.cloud/annotation/ruby'
13+
spec.metadata = { 'source_code_uri' => 'https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby' }
14+
15+
spec.add_runtime_dependency 'faraday', '~> 0.14.0'
16+
spec.add_runtime_dependency 'mimemagic', '~> 0.3.2'
17+
spec.add_runtime_dependency 'addressable', '~> 2.5.0', '>= 2.5.0'
18+
19+
spec.add_development_dependency 'groupdocs_storage_cloud', '~> 18.6', '>= 18.5'
20+
spec.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.3'
21+
22+
spec.files = Dir['lib/**/*.rb']
23+
spec.require_paths = ['lib']
24+
spec.required_ruby_version = '~> 2.3'
25+
end

‎lib/groupdocs_annotation_cloud.rb‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# ------------------------------------------------------------------------------------
2+
# <copyright company="Aspose Pty Ltd" file="groupdocs_annotation_cloud.rb">
3+
# Copyright (c) 2003-2018 Aspose Pty Ltd
4+
# </copyright>
5+
# <summary>
6+
# Permission is hereby granted, free of charge, to any person obtaining a copy
7+
# of this software and associated documentation files (the "Software"), to deal
8+
# in the Software without restriction, including without limitation the rights
9+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
# copies of the Software, and to permit persons to whom the Software is
11+
# furnished to do so, subject to the following conditions:
12+
#
13+
# The above copyright notice and this permission notice shall be included in all
14+
# copies or substantial portions of the Software.
15+
#
16+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
# SOFTWARE.
23+
# </summary>
24+
# ------------------------------------------------------------------------------------
25+
26+
# Common files
27+
require_relative 'groupdocs_annotation_cloud/api_client'
28+
require_relative 'groupdocs_annotation_cloud/api_error'
29+
require_relative 'groupdocs_annotation_cloud/version'
30+
require_relative 'groupdocs_annotation_cloud/configuration'
31+
32+
# Models
33+
require_relative 'groupdocs_annotation_cloud/models/annotation_info'
34+
require_relative 'groupdocs_annotation_cloud/models/annotation_reply_info'
35+
require_relative 'groupdocs_annotation_cloud/models/document_info'
36+
require_relative 'groupdocs_annotation_cloud/models/image_pages'
37+
require_relative 'groupdocs_annotation_cloud/models/link'
38+
require_relative 'groupdocs_annotation_cloud/models/link_element'
39+
require_relative 'groupdocs_annotation_cloud/models/page_info'
40+
require_relative 'groupdocs_annotation_cloud/models/row_info'
41+
require_relative 'groupdocs_annotation_cloud/models/value_type'
42+
require_relative 'groupdocs_annotation_cloud/models/annotation_api_link'
43+
require_relative 'groupdocs_annotation_cloud/models/image_page'
44+
require_relative 'groupdocs_annotation_cloud/models/point'
45+
require_relative 'groupdocs_annotation_cloud/models/rectangle'
46+
47+
# APIs
48+
require_relative 'groupdocs_annotation_cloud/api/annotation_api'
49+
require_relative 'groupdocs_annotation_cloud/api/image_info_api'
50+
require_relative 'groupdocs_annotation_cloud/api/image_pages_api'
51+
require_relative 'groupdocs_annotation_cloud/api/pdf_file_api'
52+
53+
module GroupDocsAnnotationCloud
54+
# Main module
55+
class << self
56+
# Initialize SDK with API keys.
57+
#
58+
# app_sid = "xxx"
59+
# app_key = "xxx"
60+
#
61+
# GroupDocsAnnotationCloud.from_keys(app_sid, app_key)
62+
def from_keys(app_sid, app_key)
63+
AnnotationApi.from_keys(app_sid, app_key)
64+
end
65+
66+
# Initialize SDK with Configuration.
67+
#
68+
# app_sid = "xxx"
69+
# app_key = "xxx"
70+
#
71+
# config = GroupDocsAnnotationCloud::Configuration.new(app_sid, app_key)
72+
# config.debugging = true
73+
# config.temp_folder_path = "./temp"
74+
#
75+
# GroupDocsAnnotationCloud.from_config(config)
76+
def from_config(config)
77+
AnnotationApi.from_config(config)
78+
end
79+
end
80+
end

0 commit comments

Comments
 (0)