caterpillar-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e13990d758ec7cbc03b733047c4c6b0e978538a9
-  data.tar.gz: d33f0e4ba4a3af69db7e0a51901bf9a8c8ab0355
+  metadata.gz: 12f0ab5f24fb15ddb5fe358d1c3dff0bc098352e
+  data.tar.gz: 90e4842c8916881151e41dff6791fb4670288fca
 SHA512:
-  metadata.gz: 8184a6b5c113608bf45873196189205508b529c37800f1139d86988c10b94b3cbefce0b4d7272a180dd6a6dbd10bc1c78c3b568e7fb77a96b881bbc85f228b12
-  data.tar.gz: 5167c96f7c3e0aee48d9dd7d19ec5fef43322bb1bb7551b8fd56c160574f403d523c80456c1a33a7cfbeddc9295d16885bcea98b2496fb29766dd674698466cb
+  metadata.gz: 3816cc00fe2986d173e403a71d86a6c18dd418aee9e447f0feb86e78e3da505e65468c66f9923c7f519e689890ae098786d838b904998dfd8bf55e5832b2f8f4
+  data.tar.gz: a913ec5243e49ad948cbd58608f553e8fc1b269a003f9773f4d4a5bfdfdca0d7dacdb14dd6b2fb4f6ea983df30c8cb51602a39f0b445b3f04e2d350f8391e6e5

data/README.md

@@ -1,4 +1,4 @@
-# Caterpillar-Ruby
+# Caterpillar
 
 This Ruby gem is a simple wrapper around the Caterpillar API. [Caterpillar](https://caterpillar.io) is a web service that allows you to convert html to pdf.
 
@@ -23,22 +23,20 @@ Or install it yourself as:
 Set the following attributes in you Ruby app:
 
 ```
-Caterpillar.api_key = 'YOUR_CATERPILLAR_API_KEY'
-Caterpillar.api_version =  'v1'
-Caterpillar.base_uri = 'https://api.caterpillar.io'
+Caterpillar.api_key = 'YOUR_CATERPILLAR_API_KEY' # required
+Caterpillar.api_version = 'YOUR_API_VERSION' # optional, default: 'v1'
+Caterpillar.base_uri = 'YOUR_API_BASE_URI' # optional, default: 'https://api.caterpillar.io'
 ```
 
 For a Rails app you can execute:
 
     $ rails generate caterpillar:install
 
-or create an initializer `config/initializers/caterpillar.rb`
+or create an initializer `config/initializers/caterpillar.rb`:
 
 ```
 Caterpillar.configure do |config|
   config.api_key = 'YOUR_CATERPILLAR_API_KEY'
-  config.api_version = 'v1'
-  config.base_uri = 'https://api.caterpillar.io'
 end
 ```
 
@@ -58,16 +56,18 @@ The `create` call can also take a block, like so:
 
 ```
 Caterpillar.create(source: content) do |file, response|
-  #file is a tempfile holding the response body
-  #reponse is the HTTParty response object
+  # file is a tempfile holding the response body
+  # response is the HTTParty response object
 end
 ```
 
 `create` will return an [HTTParty](https://github.com/jnunemaker/httparty) response object, which will be the new file (or errors, if the request was not valid).
 
-The only required parameter is:
+The only **required parameter** is:
   * `:source` - a string containing the HTML or URL for creating the document
 
+For a Rails app you can pass a view as source by converting it to an HTML string using [render_to_string](http://apidock.com/rails/ActionController/Base/render_to_string).
+
 You might want to set other options in that hash:
 
 | Option | Type | Description |
@@ -116,13 +116,13 @@ You might want to set other options in that hash:
 `:password_protect` | `Hash` | Refer next section for more details
 
 ## Password Protect
-You can passowrd protect PDF using AES 256, AES 128, RC4 (128 & 40) encryption algorithms supported by Adobe Reader.
+You can password protect PDF using AES 256, AES 128, RC4 (128 & 40) encryption algorithms supported by Adobe Reader.
 
 To encrypt PDF you need to pass `:password_protect` hash in the `create` method call along with the following **required parameters**:
 * `:password` - a string containing the secret password which will be further used to unlock the PDF
-* `:key_length` - a number which defines the encryption alogirthm to be used. Values can be **40, 128 and 256** only.
+* `:key_length` - a number which defines the encryption algorithm to be used. Values can be **40, 128 and 256** only.
 
-You might want to set other options for each encryption alogrithm inside `:restrections` hash:
+You might want to set other options for each encryption algorithm inside `:restrictions` hash:
 
 *Key Length:* **40**
 
@@ -157,7 +157,7 @@ You might want to set other options for each encryption alogrithm inside `:restr
 Caterpillar.create(
     source: content,
     password_protect: {
-        pasword: 'YOUR_PASSWORD_HERE',
+        password: 'YOUR_PASSWORD_HERE',
         key_length: 128,
         restrictions: {
             print: 'low',

data/lib/caterpillar-ruby.rb

@@ -10,7 +10,11 @@ module Caterpillar
     attr_accessor :api_version
     attr_accessor :base_uri
 
+
     def configure
+      @api_version = 'v1'
+      @base_uri = 'https://api.caterpillar.io'
+
       yield self
     end
 

data/lib/caterpillar-ruby/version.rb

@@ -1,3 +1,3 @@
 module Caterpillar
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/generators/caterpillar/initializer.rb

@@ -1,5 +1,3 @@
 Caterpillar.configure do |config|
   config.api_key = 'YOUR_CATERPILLAR_API_KEY'
-  config.api_version = 'v1'
-  config.base_uri = 'https://api.caterpillar.io'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caterpillar-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nitish Sharma
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A simple ruby client for the Caterpillar API