diff --git a/README.md b/README.md index 7ba530b..315b437 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ ![Logo](https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/resource/rc_logo_512.png) -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK [![Gem Version](https://badge.fury.io/rb/txtextcontrol-reportingcloud.svg)](https://badge.fury.io/rb/txtextcontrol-reportingcloud) -This is the official Ruby wrapper for ReportingCloud, which is authored, maintained and fully supported by [Text Control](http://www.textcontrol.com). +This is the official Ruby SDK for the ReportingCloud Web API. It is authored, maintained and fully supported by [Text Control](http://www.textcontrol.com). [http://www.reporting.cloud](http://www.reporting.cloud) diff --git a/lib/core_ext/string.rb b/lib/core_ext/string.rb index 6a61bb5..1f00ded 100644 --- a/lib/core_ext/string.rb +++ b/lib/core_ext/string.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud.rb b/lib/txtextcontrol/reportingcloud.rb index d16dc2e..1fb0652 100644 --- a/lib/txtextcontrol/reportingcloud.rb +++ b/lib/txtextcontrol/reportingcloud.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/account_settings.rb b/lib/txtextcontrol/reportingcloud/account_settings.rb index 17956d5..71b44d4 100644 --- a/lib/txtextcontrol/reportingcloud/account_settings.rb +++ b/lib/txtextcontrol/reportingcloud/account_settings.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/api_key.rb b/lib/txtextcontrol/reportingcloud/api_key.rb index 819618c..241403d 100644 --- a/lib/txtextcontrol/reportingcloud/api_key.rb +++ b/lib/txtextcontrol/reportingcloud/api_key.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/append_body.rb b/lib/txtextcontrol/reportingcloud/append_body.rb index ace2120..b4724f6 100644 --- a/lib/txtextcontrol/reportingcloud/append_body.rb +++ b/lib/txtextcontrol/reportingcloud/append_body.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/append_document.rb b/lib/txtextcontrol/reportingcloud/append_document.rb index 78f92a7..07208b7 100644 --- a/lib/txtextcontrol/reportingcloud/append_document.rb +++ b/lib/txtextcontrol/reportingcloud/append_document.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/document_settings.rb b/lib/txtextcontrol/reportingcloud/document_settings.rb index 27f490f..cda16f7 100644 --- a/lib/txtextcontrol/reportingcloud/document_settings.rb +++ b/lib/txtextcontrol/reportingcloud/document_settings.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/find_and_replace_body.rb b/lib/txtextcontrol/reportingcloud/find_and_replace_body.rb index c78fda2..a6471df 100644 --- a/lib/txtextcontrol/reportingcloud/find_and_replace_body.rb +++ b/lib/txtextcontrol/reportingcloud/find_and_replace_body.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/incorrect_word.rb b/lib/txtextcontrol/reportingcloud/incorrect_word.rb index 70417e9..c00a21b 100644 --- a/lib/txtextcontrol/reportingcloud/incorrect_word.rb +++ b/lib/txtextcontrol/reportingcloud/incorrect_word.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/merge_block.rb b/lib/txtextcontrol/reportingcloud/merge_block.rb index f610687..701f4c0 100644 --- a/lib/txtextcontrol/reportingcloud/merge_block.rb +++ b/lib/txtextcontrol/reportingcloud/merge_block.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/merge_body.rb b/lib/txtextcontrol/reportingcloud/merge_body.rb index 8db8921..fd2dc99 100644 --- a/lib/txtextcontrol/reportingcloud/merge_body.rb +++ b/lib/txtextcontrol/reportingcloud/merge_body.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/merge_field.rb b/lib/txtextcontrol/reportingcloud/merge_field.rb index 093b15e..57d8e7a 100644 --- a/lib/txtextcontrol/reportingcloud/merge_field.rb +++ b/lib/txtextcontrol/reportingcloud/merge_field.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/merge_settings.rb b/lib/txtextcontrol/reportingcloud/merge_settings.rb index c0243f4..b43b2fe 100644 --- a/lib/txtextcontrol/reportingcloud/merge_settings.rb +++ b/lib/txtextcontrol/reportingcloud/merge_settings.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/reportingcloud.rb b/lib/txtextcontrol/reportingcloud/reportingcloud.rb index 7cf86f3..574cef0 100644 --- a/lib/txtextcontrol/reportingcloud/reportingcloud.rb +++ b/lib/txtextcontrol/reportingcloud/reportingcloud.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the @@ -30,7 +30,7 @@ module TXTextControl module ReportingCloud - # The main wrapper class. + # The main class. # @attr username [String] The user name. # @attr password [String] The password. # @attr base_uri [String] The API base url. Is set to "+https://api.reporting.cloud+" @@ -89,7 +89,7 @@ def get_template_count # Merges and returns a template from the template storage or an # uploaded template with JSON data. # @param return_format [Symbol] The format of the created document. Possible - # values are +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+ and +:tx+. + # values are +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+, +:tx+ and +:txt+. # @param merge_body [MergeBody] The MergeBody object contains the datasource # as a JSON data object and optionally, a template encoded as a Base64 string. # @param template_name [String] The name of the template in the template storage. @@ -131,7 +131,7 @@ def merge_document(merge_body, template_name = nil, return_format = :pdf, append # @param append_body [TXTextControl::ReportingCloud::AppendBody] The AppendBody object # contains the templates and a DocumentSettings object. # @param return_format [Symbol] The format of the created document. Possible - # values are +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+ and +:tx+. + # values are +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+, +:tx+ and +:txt+. # @param test [Boolean] Specifies whether it is a test run or not. A test run is # not counted against the quota and created documents contain a watermark. # @return [String] The resulting document as a Base64 string. @@ -285,7 +285,7 @@ def get_template_page_count(template_name) # @param template_data [String] The source document encoded as a Base64 string. # The supported document formats are +.rtf+, +.doc+, +.docx+, +.html+, +.pdf+ and +.tx+. # @param return_format [Symbol] The format of the created document. - # Possible values are: +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+ and +:tx+. + # Possible values are: +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+, +:tx+ and +:txt+. # @param test [Boolean] Specifies whether it is a test run or not. A test run is not # counted against the quota and created documents contain a watermark. # @return [String] The created document encoded as a Base64 string. @@ -331,7 +331,7 @@ def get_template_info(template_name) # If no template is specified, the template must be included in the FindAndReplaceBody # object of this request. # @param return_format [Symbol] The format of the created document. - # Possible values are: +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+ and +:tx+. + # Possible values are: +:pdf+, +:rtf+, +:doc+, +:docx+, +:html+, +:tx+ and +:txt+. # @param test [Boolean] Specifies whether it is a test run or not. A test run is not # counted against the quota and created documents contain a watermark. # @return [String] The created document encoded as a Base64 string. diff --git a/lib/txtextcontrol/reportingcloud/template.rb b/lib/txtextcontrol/reportingcloud/template.rb index 6adf324..ab5bb3e 100644 --- a/lib/txtextcontrol/reportingcloud/template.rb +++ b/lib/txtextcontrol/reportingcloud/template.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/template_data_validator.rb b/lib/txtextcontrol/reportingcloud/template_data_validator.rb index b8b43fb..85be9e2 100644 --- a/lib/txtextcontrol/reportingcloud/template_data_validator.rb +++ b/lib/txtextcontrol/reportingcloud/template_data_validator.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/template_info.rb b/lib/txtextcontrol/reportingcloud/template_info.rb index 5487f04..01bfb6d 100644 --- a/lib/txtextcontrol/reportingcloud/template_info.rb +++ b/lib/txtextcontrol/reportingcloud/template_info.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/template_name_validator.rb b/lib/txtextcontrol/reportingcloud/template_name_validator.rb index f32355f..37cebed 100644 --- a/lib/txtextcontrol/reportingcloud/template_name_validator.rb +++ b/lib/txtextcontrol/reportingcloud/template_name_validator.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the diff --git a/lib/txtextcontrol/reportingcloud/version.rb b/lib/txtextcontrol/reportingcloud/version.rb index 721ddcc..6b2672c 100644 --- a/lib/txtextcontrol/reportingcloud/version.rb +++ b/lib/txtextcontrol/reportingcloud/version.rb @@ -1,7 +1,7 @@ -# ReportingCloud Ruby Wrapper +# ReportingCloud Ruby SDK # -# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access -# ReportingCloud in Ruby. +# Official Ruby SDK for the ReportingCloud Web API. Authored, maintained and fully supported +# by Text Control GmbH. (http://www.textcontrol.com). # # Go to http://www.reporting.cloud to learn more about ReportingCloud # Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the @@ -13,6 +13,6 @@ module TXTextControl module ReportingCloud - VERSION = "1.2.0" + VERSION = "1.2.1" end end diff --git a/txtextcontrol-reportingcloud.gemspec b/txtextcontrol-reportingcloud.gemspec index 3abeecc..b7c8748 100644 --- a/txtextcontrol-reportingcloud.gemspec +++ b/txtextcontrol-reportingcloud.gemspec @@ -9,8 +9,8 @@ Gem::Specification.new do |spec| spec.authors = ["Thorsten Kummerow"] spec.email = ["thorsten@textcontrol.com"] - spec.summary = "ReportingCloud Ruby Wrapper" - spec.description = "Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access ReportingCloud in Ruby." + spec.summary = "ReportingCloud Ruby SDK" + spec.description = "Official Ruby SDK for the ReportingCloud Web API. Authored and supported by Text Control GmbH." spec.homepage = "http://www.reporting.cloud" spec.licenses = ["BSD-2-Clause"]