txtextcontrol-reportingcloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d69459cfc7d065e32d143d4f0448fc607a858ae5
+  data.tar.gz: ed780300dadb6a31f12f3785983efb806a3a70eb
+SHA512:
+  metadata.gz: 0ec77b3c5a03931cb1068abcf690cb9156b1f7a62da9ce5770faa65fa3551006114bcbc27cc939aaecf037e93b0cb7ea3ea4bcb96f8ca6939317780765bd3841
+  data.tar.gz: 4c052c90eb063f0a1700257c7f9a47f44107ff4b656bcd38550907366f6177d36a43d342d269ea317033ad71c89938e5c5a8edfeffccea07d0f426e2e3801b4f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.4

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "editor.tabSize": 2
+}

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in txtextcontrol-reportingcloud.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,18 @@
+## Copyright © 2016, Text Control GmbH. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+  disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,46 @@
+![Logo](https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/resource/rc_logo_512.png)
+
+# ReportingCloud Ruby Wrapper
+
+This is the official Ruby wrapper for ReportingCloud, which is authored, maintained and fully supported by [Text Control](http://www.textcontrol.com).
+
+[http://www.reporting.cloud](http://www.reporting.cloud)
+
+Before using ReportingCloud, please sign up to the service:
+
+[http://api.reporting.cloud](http://api.reporting.cloud)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'txtextcontrol-reportingcloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install txtextcontrol-reportingcloud
+
+## API documentation (YARD)
+
+All the source code in this library is documented using [YARD](http://yardoc.org/).
+
+You can read the [API documentation](https://textcontrol.github.io/txtextcontrol-reportingcloud-ruby/) online, or build it yourself, using the following command:
+
+    $ yard doc
+
+The resultant set of HTML files will be written to `~/txtextcontrol-reportingcloud/doc`.
+
+If you don't have YARD already installed, you can install it with RubyGems with the following command:
+
+    $ gem install yard
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TextControl/txtextcontrol-reportingcloud-ruby.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "txtextcontrol/reportingcloud"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/core_ext/string.rb

@@ -0,0 +1,28 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+# Extensions to class String.
+# @author Thorsten Kummerow (@thomerow)
+class String
+
+  # Removes the first and last characters from a string and returns the 
+  # manipulated string.
+  # @return [String] The string without its first and last characters.
+  def remove_first_and_last 
+    if self.length == 0 then return '' end
+    result = self.dup
+    result[0] = ''
+    if result.length > 0 then result[result.length - 1] = '' end
+    return result
+  end
+end

data/lib/txtextcontrol/reportingcloud.rb

@@ -0,0 +1,31 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+require "txtextcontrol/reportingcloud/version"
+require_relative "./reportingcloud/reportingcloud.rb"
+
+# The TXTextControl module.
+module TXTextControl
+
+  # The ReportingCloud module.
+  module ReportingCloud
+  
+    # Default API base url.
+    DEFAULT_BASE_URI = "http://api.reporting.cloud"
+    # Default API version.
+    DEFAULT_VERSION = "v1"
+    # Default http request timeout in seconds.
+    DEFAULT_TIMEOUT = 10
+    
+  end
+end

data/lib/txtextcontrol/reportingcloud/account_settings.rb

@@ -0,0 +1,88 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+module TXTextControl
+  module ReportingCloud
+  
+    # Represents ReportingCloud account settings.
+    # @attr_reader [String, Symbol] serial_number The serial number that is attached to the 
+    #   account. Possible values are :free, :trial and a 13 character long serial number.
+    # @attr_reader [Integer] created_documents The number of created documents in the 
+    #   current month.
+    # @attr_reader [Integer] uploaded_templates The number of uploaded templates to the 
+    #   template storage.
+    # @attr_reader [Integer] max_documents The maximum number of documents that can be 
+    #   created per month.
+    # @attr_reader [Integer] max_templates The maximum number of templates that can be 
+    #   uploaded to the template storage.
+    # @attr_reader [DateTime] valid_until The date until the current subscription is valid.
+    #   Can be nil.
+    # @author Thorsten Kummerow (@thomerow)
+    class AccountSettings
+      attr_reader :serial_number
+      attr_reader :created_documents
+      attr_reader :uploaded_templates
+      attr_reader :max_documents
+      attr_reader :max_templates
+      attr_reader :valid_until
+      
+      # @param [String, Symbol] serial_number The serial number that is attached to the 
+      #   account. Possible values are :free, :trial and a 13 character long serial number.
+      # @param [Integer] created_documents The number of created documents in the 
+      #   current month.
+      # @param [Integer] uploaded_templates The number of uploaded templates to the 
+      #   template storage.
+      # @param [Integer] max_documents The maximum number of documents that can be 
+      #   created per month.
+      # @param [Integer] max_templates The maximum number of templates that can be 
+      #   uploaded to the template storage.
+      # @param [DateTime] valid_until The date until the current subscription is valid.
+      #   Can be nil.
+      def initialize(serial_number, created_documents, uploaded_templates, max_documents, max_templates, valid_until = nil)
+        case serial_number.downcase
+          when "trial"
+            @serial_number = :trial
+          when "free"
+            @serial_number = :free
+          else 
+            @serial_number = serial_number
+        end                
+        @created_documents = Integer(created_documents)
+        @uploaded_templates = Integer(uploaded_templates)
+        @max_documents = Integer(max_documents)
+        @max_templates = Integer(max_templates)
+        case valid_until
+          when DateTime
+            @valid_until = valid_until
+          when String
+            @valid_until = DateTime.iso8601(valid_until)
+          else
+            @valid_until = nil      
+        end
+      end
+      
+      # Creates an AccountSettings instance from a hash.
+      # @param [Hash] hash The hash to try and create an AccountSettings instance from.
+      # @return [AccountSettings] A newly created AccountSettings instance.
+      def self.from_camelized_hash(hash)
+        sn = hash["serialNumber"]
+        cd = hash["createdDocuments"]
+        ut = hash["uploadedTemplates"]
+        md = hash["maxDocuments"]
+        mt = hash["maxTemplates"]
+        vu = hash["validUntil"]
+        return AccountSettings.new(sn, cd, ut, md, mt, vu)
+      end
+    end
+  end
+end

data/lib/txtextcontrol/reportingcloud/merge_body.rb

@@ -0,0 +1,60 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+require "txtextcontrol/reportingcloud/merge_settings"
+
+module TXTextControl
+  module ReportingCloud
+  
+    # Used to pass data to the merge method.
+    # @attr merge_data [Array<Hash>] The merge data. Must be an array of hashes.
+    # @attr template [String] Base64 encoded template document.
+    #   Supported formats are RTF, DOC, DOCX and TX. 
+    # @attr merge_settings [MergeSettings] Merge settings to specify 
+    #   merge properties and document properties such as title and 
+    #   author.
+    # @author Thorsten Kummerow (@thomerow)
+    class MergeBody
+      attr_accessor :merge_data
+      attr_accessor :template
+      attr_accessor :merge_settings
+      
+      # The constructor.
+      # @param merge_data [Array<Hash>] The merge data. Must be an array of hashes.
+      # @param template [String] Base64 encoded template document.
+      #   Supported formats are RTF, DOC, DOCX and TX.
+      # @param merge_settings [MergeSettings] Merge settings to specify 
+      #   merge properties and document properties such as title and 
+      #   author.
+      def initialize(merge_data, merge_settings = nil, template = nil)
+        unless merge_data.kind_of?(Array) && !merge_data.empty? && merge_data[0].kind_of?(Hash)
+          raise ArgumentError, "Merge data must be a non empty array of hashes."
+        end
+        @merge_data = merge_data
+        @template = template
+        @merge_settings = merge_settings
+      end      
+      
+      # Converts a MergeBody instance to a hash while converting the attribute names
+      # from snake case to camel case.
+      # @return [Hash] A hash representing the MergeBody instance.
+      def to_camelized_hash
+        return {
+          "mergeData" => @merge_data,
+          "template" => @template,
+          "mergeSettings" => @merge_settings.nil? ? nil : merge_settings.to_camelized_hash
+        }
+      end
+    end
+  end 
+end

data/lib/txtextcontrol/reportingcloud/merge_settings.rb

@@ -0,0 +1,112 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+module TXTextControl
+  module ReportingCloud
+  
+    # Holds the merge settings needed by the merge method.
+    # @attr remove_empty_fields [Boolean] Specifies whether empty fields
+    #   should be removed from the template or not.
+    # @attr remove_empty_blocks [Boolean] Specifies whether the content of 
+    #   empty merge blocks should be removed from the template or not.
+    # @attr remove_empty_images [Boolean] Specifies whether images which 
+    #   don't have merge data should be removed from the template or not.
+    # @attr remove_trailing_whitespace [Boolean] Specifies whether trailing 
+    #   whitespace should be removed before saving a document.
+    # @attr author [String] The document's author.
+    # @attr creation_date [DateTime] The document's creation date.
+    # @attr creator_application [String] The application which created the document.
+    # @attr document_subject [String] The document's subject.
+    # @attr document_title [String] The document's title.
+    # @attr last_modification_date [DateTime] The document's last modification date.
+    # @attr user_password [String] The password needed to open the document.
+    # @author Thorsten Kummerow (@thomerow)
+    class MergeSettings
+      attr_accessor :remove_empty_fields
+      attr_accessor :remove_empty_blocks
+      attr_accessor :remove_empty_images
+      attr_accessor :remove_trailing_whitespace
+      attr_accessor :author
+      attr_accessor :creator_application
+      attr_accessor :document_subject
+      attr_accessor :document_title
+      attr_accessor :user_password
+            
+      def initialize
+        @remove_empty_fields = true
+        @remove_empty_blocks = true
+        @remove_empty_images = true
+        @remove_trailing_whitespace = true
+        
+        @author = nil
+        @creation_date = nil
+        @creator_application = nil
+        @document_subject = nil
+        @document_title = nil
+        @last_modification_date = nil
+        @user_password = nil
+      end 
+      
+      def creation_date
+        @creation_date
+      end
+      
+      def creation_date=(val)
+        case val
+          when nil
+            @creation_date = nil
+          when String 
+            @creation_date = DateTime.iso8601(val)
+          when DateTime
+            @creation_date = val
+          else raise ArgumentError, "Value must be a string or an instance of type DateTime."
+        end
+      end
+      
+      def last_modification_date
+        @last_modification_date
+      end
+      
+      def last_modification_date=(val)
+        case val
+          when nil
+            @last_modification_date = nil
+          when String 
+            @last_modification_date = DateTime.iso8601(val)
+          when DateTime
+            @last_modification_date = val
+          else raise ArgumentError, "Value must be a string or an instance of type DateTime."
+        end         
+      end
+      
+      # Converts a MergeSettings instance to a hash while converting the attribute names
+      # from snake case to camel case.
+      # @return [Hash] A hash representing the MergeSettings instance.
+      def to_camelized_hash
+        return {
+          "removeEmptyFields" => @remove_empty_fields,
+          "removeEmptyBlocks" => @remove_empty_blocks,
+          "removeEmptyImages" => @remove_empty_images,
+          "removeTrailingWhitespace" => @remove_trailing_whitespace,
+          "author" => @author,
+          "creationDate" => @creation_date.nil? ? nil : creation_date.iso8601,
+          "creatorApplication" => @creator_application,
+          "documentSubject" => @document_subject,
+          "documentTitle" => @document_title,
+          "lastModificationDate" => @last_modification_date.nil? ? nil : last_modification_date.iso8601,
+          "userPassword" => @user_password
+        }
+      end
+    end
+  end
+end

data/lib/txtextcontrol/reportingcloud/reportingcloud.rb

@@ -0,0 +1,322 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+require "uri"
+require "net/http"
+require "json"
+require "ostruct"
+require "cgi"
+require 'txtextcontrol/reportingcloud/template'
+require 'txtextcontrol/reportingcloud/account_settings'
+require 'txtextcontrol/reportingcloud/template_name_validator'
+require 'txtextcontrol/reportingcloud/template_data_validator'
+require 'core_ext/string'
+
+module TXTextControl
+  module ReportingCloud
+  
+    # The main wrapper class.
+    # @attr username [String] The user name.
+    # @attr password [String] The password.
+    # @attr base_uri [String] The API base url. Is set to "http://api.reporting.cloud" 
+    #   by default.
+    # @attr api_version [String] The API version. Is set to "v1" by default.
+    # @attr read_timeout [Integer] The timeout for HTTP requests in seconds. Is set to
+    #   10 by default.
+    # @author Thorsten Kummerow (@thomerow)
+    class ReportingCloud
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :base_uri
+      attr_accessor :api_version
+      attr_accessor :read_timeout
+                   
+      # @param username [String] The user name.
+      # @param password [String] The password.
+      # @param base_url [String] The API base url. Is set to "http://api.reporting.cloud" 
+      #   by default.
+      def initialize(username, password, base_url = nil)
+        base_url ||= DEFAULT_BASE_URI
+        @username = username
+        @password = password
+        @api_version = DEFAULT_VERSION
+        @read_timeout = DEFAULT_TIMEOUT   
+        @base_uri = URI.parse(base_url)
+      end
+      
+      # Lists all templates from the template storage.
+      # @return [Array<Template>] An array of Template objects.
+      def list_templates
+        res = request("/templates/list", :get)
+        if res.kind_of? Net::HTTPSuccess
+          templates = Array.new
+          data = JSON.parse(res.body, object_class: OpenStruct)
+          data.each do |elem|
+            templates.push(Template.new(elem.templateName, elem.modified, elem.size))
+          end
+          return templates
+        else
+          raise res.body
+        end
+      end
+      
+      # Returns the number of templates in the template storage.
+      # @return [Integer] The number of templates in the template storage.
+      def get_template_count
+        res = request("/templates/count", :get)
+        if res.kind_of? Net::HTTPSuccess
+          return Integer(res.body)
+        else
+          raise res.body
+        end
+      end
+      
+      # 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.
+      # @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. 
+      #   If no template name is specified, the template must be uploaded in the 
+      #   MergeBody object of this request.
+      # @param append [Boolean]  
+      # @return [Array<String>] An array of the created documents as 
+      #   Base64 encoded strings. 
+      def merge_document(merge_body, template_name = nil, return_format = :pdf, append = false)
+        if !template_name.to_s.empty? && !merge_body.template.nil?   # .to_s.empty: check for nil or ''
+          raise ArgumentError, "Template name and template data must not be present at the same time."
+        elsif template_name.to_s.empty? && merge_body.template.nil?
+          raise ArgumentError, "Either a template name or template data have to be present."
+        end
+        
+        # Create query parameters
+        params = {
+          :returnFormat => return_format,
+          :append => append
+        }
+        unless template_name.to_s.empty? 
+          params[:templateName] = template_name
+        end
+        
+        # Send request
+        res = request("/document/merge", :post, params, merge_body)
+        if res.kind_of? Net::HTTPSuccess
+          return JSON.parse(res.body)
+        else
+          raise res.body 
+        end        
+      end
+      
+      # Returns the account settings.
+      # @return [AccountSettings] The account settings.
+      def get_account_settings
+        res = request("/account/settings", :get)
+        if res.kind_of? Net::HTTPSuccess
+          return AccountSettings.from_camelized_hash(JSON.parse(res.body))
+        else
+          raise res.body 
+        end
+      end      
+      
+      # Returns a list of thumbnails of a specific template.
+      # @param template_name [String] The filename of the template in the template storage.
+      # @param zoom_factor [Integer] An Integer value between 1 and 400 to set the
+      #   percentage zoom factor of the created thumbnail images.
+      # @param from_page [Integer] An Integer value that specifies the first page.
+      # @param to_page [Integer] An Integer value that specifies the last page.
+      # @param image_format [Symbol] Defines the image format of the returned thumbnails.
+      #   Possible values are :png, :jpg, :gif and :bmp.
+      # @return [Array<String>] An array of Base64 encoded images.
+      def get_template_thumbnails(template_name, zoom_factor, from_page = 1, to_page = 0, image_format = :png)
+        # Prepare query parameters
+        params = {
+          :templateName => template_name,
+          :zoomFactor => zoom_factor,
+          :fromPage => from_page,
+          :toPage => to_page,
+        }
+        if image_format != :png
+          params[:imageFormat] = image_format 
+        end
+        
+        # Send request
+        res = request("/templates/thumbnails", :get, params)
+        if res.kind_of? Net::HTTPSuccess
+          return JSON.parse(res.body)
+        else
+          raise res.body
+        end        
+      end
+      
+      # Deletes a template from the template storage.
+      # @param template_name [String] The filename of the template to be deleted 
+      #   from the template storage.
+      # @return [void]
+      def delete_template(template_name)
+        # Parameter validation
+        TemplateNameValidator.validate(template_name)
+        
+        res = request("/templates/delete", :delete, { :templateName => template_name })
+        unless res.kind_of? Net::HTTPSuccess
+          raise res.body 
+        end
+      end
+      
+      # Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx)
+      # @param template_name [String] The filename of the template in the template storage.
+      #   Existing files with the same filename will be overwritten.
+      # @param template_data [String] A document encoded as a Base64 string. 
+      #   The supported formats are DOC, DOCX, RTF and TX.
+      # @return [void]
+      def upload_template(template_name, template_data)
+        # Parameter validation
+        TemplateNameValidator.validate(template_name)
+        TemplateDataValidator.validate(template_data)
+        
+        res = request("/templates/upload", :post, { :templateName => template_name }, template_data)
+        unless res.kind_of? Net::HTTPSuccess
+          raise res.body 
+        end        
+      end
+      
+      # Returns the selected template from the storage.
+      # @param template_name [String] The filename of the template in the template storage.
+      # @return [String] The template document data as a Base64 encoded string.
+      def download_template(template_name)
+        # Parameter validation
+        TemplateNameValidator.validate(template_name)
+
+        res = request("/templates/download", :get, { :templateName => template_name })        
+        if res.kind_of? Net::HTTPSuccess
+          return res.body.remove_first_and_last
+        else
+          raise res.body
+        end
+      end
+      
+      # Checks whether a template exists in the template storage.
+      # @param template_name [String] The filename of the template to be 
+      #   checked for availability in the template storage.
+      # @return [Boolean] Returns if the template with the given name exists in
+      #   the template storage.
+      def template_exists?(template_name)
+        # Parameter validation
+        TemplateNameValidator.validate(template_name)
+
+        res = request("/templates/exists", :get, { :templateName => template_name })                       
+        if res.kind_of? Net::HTTPSuccess
+          case res.body
+            when "true"
+              return true
+            when "false"
+              return false
+            else raise "Unknown response value received." 
+          end
+        else
+          raise res.body
+        end
+      end
+      
+      # Returns the number of pages of a template in the template storage.
+      # @param template_name [String] The filename of the template in the template
+      #   storage to retrieve the number of pages for.
+      # @return [Integer] The number of pages in the template.
+      def get_template_page_count(template_name)
+        # Parameter validation
+        TemplateNameValidator.validate(template_name)
+        
+        res = request("/templates/pagecount", :get, { :templateName => template_name })
+        if res.kind_of? Net::HTTPSuccess
+          return Integer(res.body)
+        else
+          raise res.body
+        end        
+      end
+      
+      # Converts a document to another format.
+      # @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.
+      # @return [String] The created document encoded as a Base64 string.
+      def convert_document(template_data, return_format = :pdf)
+        # Parameter validation
+        TemplateDataValidator.validate(template_data)
+        
+        res = request("/document/convert", :post, { :returnFormat => return_format }, template_data)
+        if res.kind_of? Net::HTTPSuccess
+          # Remove leading and trailing quote from string 
+          # (inexplicably JSON.parse chokes on simple strings)
+          return res.body.remove_first_and_last
+        else
+          raise res.body 
+        end                
+      end
+      
+      # Performs a HTTP request of a given type.
+      # @param request_type [Symbol] The type of the request. Possible values are :get, 
+      # :post and :delete.
+      # @param params [Hash] The query parameters.
+      # @param body [Object, Hash, String] 
+      # @return [Net::HTTPResponse] The HTTP response.
+      private
+      def request(request_uri, request_type = :get, params = nil, body = nil)
+        # Generate query string from given parameters
+        query_string = query_string_from_hash(params)
+        
+        http = Net::HTTP.new(@base_uri.host, @base_uri.port)
+        http.read_timeout = read_timeout
+        
+        # Get correct request type
+        req_type = nil
+        case request_type
+          when :get
+            req_type = Net::HTTP::Get
+          when :post
+            req_type = Net::HTTP::Post
+          when :delete 
+            req_type = Net::HTTP::Delete
+          else raise "Unknown HTTP request type."
+        end 
+        
+        # Create HTTP request
+        req = req_type.new("/#{@api_version}#{request_uri}#{query_string}", initheader = { "Content-Type" => "application/json" })
+        req.basic_auth(@username, @password);
+        # If body data is present, use it directly if it is a string or 
+        # else convert it to json
+        if !body.nil?
+          if body.kind_of? String
+            req.body = "\"" + body + "\""
+          elsif body.kind_of? Hash
+            req.body = body.to_json
+          elsif body.respond_to?(:to_camelized_hash)
+            req.body = body.to_camelized_hash.to_json
+          elsif body.respond_to?(:to_hash)
+            req.body = body.to_hash.to_json
+          end
+        end
+        # Send request
+        return http.request(req)
+      end
+      
+      # Generates a query string from a hash
+      private
+      def query_string_from_hash(hash)
+        return "?" + hash.collect { |k, v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&') unless hash.nil?
+        return ""
+      end
+      
+    end    
+  end
+end

data/lib/txtextcontrol/reportingcloud/template.rb

@@ -0,0 +1,40 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+require 'date'
+
+module TXTextControl
+  module ReportingCloud
+  
+    # @attr_reader template_name [String] The template file name.
+    # @attr_reader modified [DateTime] The date and time the template file was
+    #   last modified.
+    # @attr_reader size [Integer] The size of the template file in bytes.
+    # @author Thorsten Kummerow (@thomerow)
+    class Template
+      attr_reader :template_name
+      attr_reader :modified
+      attr_reader :size
+      
+      def initialize(template_name, modified, size)
+        @template_name = template_name
+        if modified.is_a?(DateTime)
+          @modified = modified
+        else
+          @modified = DateTime.iso8601(modified) 
+        end
+        @size = size
+      end      
+    end
+  end
+end

data/lib/txtextcontrol/reportingcloud/template_data_validator.rb

@@ -0,0 +1,30 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+module TXTextControl
+  module ReportingCloud
+  
+    # Internal method parameter validator class.
+    # @author Thorsten Kummerow (@thomerow)
+    class TemplateDataValidator
+    
+      # Checks if a given value is a String, is not nil and not empty.
+      # @param template_data [String] The string to validate.
+      # @return [Boolean]
+      def self.validate(template_data)
+        raise ArgumentError, "Template data must be a Base64 encoded string." if !template_data.kind_of? String
+        raise ArgumentError, "No template data given." if template_data.to_s.empty?
+      end
+    end
+  end
+end

data/lib/txtextcontrol/reportingcloud/template_name_validator.rb

@@ -0,0 +1,30 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+module TXTextControl
+  module ReportingCloud
+  
+    # Internal method parameter validator class.
+    # @author Thorsten Kummerow (@thomerow)
+    class TemplateNameValidator
+    
+      # Checks if a given value is a String, is not nil and not empty.
+      # @param template_name [String] The string to validate.
+      # @return [Boolean]
+      def self.validate(template_name)
+        raise ArgumentError, "Template name must be a String." if !template_name.kind_of? String 
+        raise ArgumentError, "No template name given." if template_name.to_s.empty?
+      end
+    end
+  end
+end

data/lib/txtextcontrol/reportingcloud/version.rb

@@ -0,0 +1,18 @@
+# ReportingCloud Ruby Wrapper
+#
+# Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access 
+# ReportingCloud in Ruby.
+#
+# Go to http://www.reporting.cloud to learn more about ReportingCloud
+# Go to https://github.com/TextControl/txtextcontrol-reportingcloud-ruby for the 
+# canonical source repository.
+#
+# License: https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md
+#
+# Copyright: © 2016 Text Control GmbH
+
+module TXTextControl
+  module ReportingCloud
+    VERSION = "1.0.0"
+  end
+end

data/txtextcontrol-reportingcloud.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'txtextcontrol/reportingcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "txtextcontrol-reportingcloud"
+  spec.version       = TXTextControl::ReportingCloud::VERSION
+  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.homepage      = "http://www.reporting.cloud"
+  spec.licenses      = ["BSD-2-Clause"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: txtextcontrol-reportingcloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thorsten Kummerow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud)
+  to access ReportingCloud in Ruby.
+email:
+- thorsten@textcontrol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".vscode/settings.json"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/core_ext/string.rb
+- lib/txtextcontrol/reportingcloud.rb
+- lib/txtextcontrol/reportingcloud/account_settings.rb
+- lib/txtextcontrol/reportingcloud/merge_body.rb
+- lib/txtextcontrol/reportingcloud/merge_settings.rb
+- lib/txtextcontrol/reportingcloud/reportingcloud.rb
+- lib/txtextcontrol/reportingcloud/template.rb
+- lib/txtextcontrol/reportingcloud/template_data_validator.rb
+- lib/txtextcontrol/reportingcloud/template_name_validator.rb
+- lib/txtextcontrol/reportingcloud/version.rb
+- resource/rc_logo_1024.png
+- resource/rc_logo_256.png
+- resource/rc_logo_512.png
+- txtextcontrol-reportingcloud.gemspec
+homepage: http://www.reporting.cloud
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ReportingCloud Ruby Wrapper
+test_files: []
+has_rdoc: