txtextcontrol-reportingcloud 1.0.0 → 1.0.1

checksums.yaml

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

data/README.md

@@ -8,7 +8,7 @@ This is the official Ruby wrapper for ReportingCloud, which is authored, maintai
 
 Before using ReportingCloud, please sign up to the service:
 
-[http://api.reporting.cloud](http://api.reporting.cloud)
+[https://portal.reporting.cloud](https://portal.reporting.cloud)
 
 ## Installation
 
@@ -34,7 +34,7 @@ You can read the [API documentation](https://textcontrol.github.io/txtextcontrol
 
     $ yard doc
 
-The resultant set of HTML files will be written to `~/txtextcontrol-reportingcloud/doc`.
+The resultant set of HTML files will be written to `~/txtextcontrol-reportingcloud-ruby/doc`.
 
 If you don't have YARD already installed, you can install it with RubyGems with the following command:
 

data/lib/txtextcontrol/reportingcloud.rb

@@ -21,7 +21,7 @@ module TXTextControl
   module ReportingCloud
   
     # Default API base url.
-    DEFAULT_BASE_URI = "http://api.reporting.cloud"
+    DEFAULT_BASE_URI = "https://api.reporting.cloud"
     # Default API version.
     DEFAULT_VERSION = "v1"
     # Default http request timeout in seconds.

data/lib/txtextcontrol/reportingcloud/account_settings.rb

@@ -16,7 +16,7 @@ module TXTextControl
   
     # 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.
+    #   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 
@@ -37,7 +37,7 @@ module TXTextControl
       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.
+      #   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 

data/lib/txtextcontrol/reportingcloud/merge_body.rb

@@ -25,7 +25,6 @@ module TXTextControl
     #   author.
     # @author Thorsten Kummerow (@thomerow)
     class MergeBody
-      attr_accessor :merge_data
       attr_accessor :template
       attr_accessor :merge_settings
       
@@ -37,14 +36,22 @@ module TXTextControl
       #   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
+        self.merge_data = merge_data
         @template = template
         @merge_settings = merge_settings
       end      
       
+      def merge_data=(val)
+        unless val.kind_of?(Array) && !val.empty? && val[0].kind_of?(Hash)
+          raise ArgumentError, "Merge data must be a non empty array of hashes."
+        end        
+        @merge_data = val
+      end
+      
+      def merge_data
+        @merge_data
+      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.

data/lib/txtextcontrol/reportingcloud/merge_settings.rb

@@ -99,11 +99,11 @@ module TXTextControl
           "removeEmptyImages" => @remove_empty_images,
           "removeTrailingWhitespace" => @remove_trailing_whitespace,
           "author" => @author,
-          "creationDate" => @creation_date.nil? ? nil : creation_date.iso8601,
+          "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,
+          "lastModificationDate" => @last_modification_date.nil? ? nil : @last_modification_date.iso8601,
           "userPassword" => @user_password
         }
       end

data/lib/txtextcontrol/reportingcloud/reportingcloud.rb

@@ -28,11 +28,11 @@ module TXTextControl
     # 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" 
+    # @attr base_uri [String] The API base url. Is set to "+https://api.reporting.cloud+" 
     #   by default.
-    # @attr api_version [String] The API version. Is set to "v1" 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.
+    #   +10+ by default.
     # @author Thorsten Kummerow (@thomerow)
     class ReportingCloud
       attr_accessor :username
@@ -43,7 +43,7 @@ module TXTextControl
                    
       # @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" 
+      # @param base_url [String] The API base url. Is set to "+https://api.reporting.cloud+" 
       #   by default.
       def initialize(username, password, base_url = nil)
         base_url ||= DEFAULT_BASE_URI
@@ -84,13 +84,14 @@ module TXTextControl
       # 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+ 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]  
+      # @param append [Boolean] Specifies whether the documents should be appened 
+      #   to one resulting document when more than 1 data row is passed.
       # @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)
@@ -131,12 +132,12 @@ module TXTextControl
       
       # 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
+      # @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.
+      #   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
@@ -173,7 +174,7 @@ module TXTextControl
         end
       end
       
-      # Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx)
+      # 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. 
@@ -246,9 +247,9 @@ module TXTextControl
       
       # 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.
+      #   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+ and +:tx+.
       # @return [String] The created document encoded as a Base64 string.
       def convert_document(template_data, return_format = :pdf)
         # Parameter validation
@@ -265,10 +266,10 @@ module TXTextControl
       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 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] 
+      # @param body [Object, Hash, String] The request body.
       # @return [Net::HTTPResponse] The HTTP response.
       private
       def request(request_uri, request_type = :get, params = nil, body = nil)
@@ -276,6 +277,7 @@ module TXTextControl
         query_string = query_string_from_hash(params)
         
         http = Net::HTTP.new(@base_uri.host, @base_uri.port)
+        http.use_ssl = @base_uri.scheme == "https"
         http.read_timeout = read_timeout
         
         # Get correct request type

data/lib/txtextcontrol/reportingcloud/template.rb

@@ -16,6 +16,7 @@ require 'date'
 module TXTextControl
   module ReportingCloud
   
+    # Holds information about a template in the template storage.
     # @attr_reader template_name [String] The template file name.
     # @attr_reader modified [DateTime] The date and time the template file was
     #   last modified.

data/lib/txtextcontrol/reportingcloud/version.rb

@@ -13,6 +13,6 @@
 
 module TXTextControl
   module ReportingCloud
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txtextcontrol-reportingcloud
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Thorsten Kummerow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,8 +62,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
-- ".vscode/settings.json"
 - Gemfile
 - LICENSE.md
 - README.md

data/.travis.yml

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

data/.vscode/settings.json

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