caterpillar-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e13990d758ec7cbc03b733047c4c6b0e978538a9
+  data.tar.gz: d33f0e4ba4a3af69db7e0a51901bf9a8c8ab0355
+SHA512:
+  metadata.gz: 8184a6b5c113608bf45873196189205508b529c37800f1139d86988c10b94b3cbefce0b4d7272a180dd6a6dbd10bc1c78c3b568e7fb77a96b881bbc85f228b12
+  data.tar.gz: 5167c96f7c3e0aee48d9dd7d19ec5fef43322bb1bb7551b8fd56c160574f403d523c80456c1a33a7cfbeddc9295d16885bcea98b2496fb29766dd674698466cb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nitish Sharma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,180 @@
+# Caterpillar-Ruby
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'caterpillar-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caterpillar-ruby
+
+## Usage
+
+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'
+```
+
+For a Rails app you can execute:
+
+    $ rails generate caterpillar:install
+
+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
+```
+
+Once set, you can create a PDF document by calling:
+
+```
+Caterpillar.create(source: content, grayscale: true, no_images: true)
+```
+
+You can also create test PDF documents by calling (header and footer options donot work in test mode):
+
+```
+Caterpillar.create(source: content, test: true)
+```
+
+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
+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:
+  * `:source` - a string containing the HTML or URL for creating the document
+
+You might want to set other options in that hash:
+
+| Option | Type | Description |
+|:---|:---|:---|
+`:copies` | `Number` | Number of copies to print into the pdf
+`:grayscale` | `Boolean` | PDF will be generated in grayscale
+`:margin_bottom` | `Number` | Set the page bottom margin
+`:margin_left` | `Number` | Set the page left margin (default 10mm)
+`:margin_right` | `Number` | Set the page right margin (default 10mm)
+`:margin_top` | `Number` | Set the page top margin
+`:orientation` | `String` | Set orientation to Landscape or Portrait (default Portrait)
+`:page_size` | `String` | Set paper size to: A4, Letter, etc. (default A4)
+`:background` | `Boolean` | Do print background (default true)
+`:no_background` | `Boolean` | Do not print background
+`:disable_external_links` | `Boolean` | Do not make links to remote web pages
+`:enable_external_links` | `Boolean` | Make links to remote web pages (default true)
+`:disable_forms` | `Boolean` | Do not turn HTML form fields into pdf form fields (default true)
+`:enable_forms` | `Boolean` | Turn HTML form fields into pdf form fields
+`:images` | `Boolean` | Do load or print images (default true)
+`:no_images` | `Boolean` | Do not load or print images
+`:disable_internal_links` | `Boolean` | Do not make local links
+`:enable_internal_links` | `Boolean` | Make local links (default true)
+`:disable_javascript` | `Boolean` | Do not allow web pages to run javascript
+`:enable_javascript` | `Boolean` | Do allow web pages to run javascript (default true)
+`:javascript_delay` | `Number` | Wait some milliseconds for javascript finish (default 200)
+`:viewport_size` | `String` | Set viewport size if you have custom scrollbars or css attribute overflow to emulate window size
+`:zoom` | `Number` | Use this zoom factor (default 1)
+`:footer_center` | `Number`/`String` | Centered footer text
+`:footer_font_name` | `Number`/`String` | Set footer font name (default Arial)
+`:footer_font_size` | `Number`/`String` | Set footer font size (default 12)
+`:footer_html` | `String` | Adds a html footer
+`:footer_left` | `Number`/`String` | Left aligned footer text
+`:footer_line` | `Boolean` | Display line above the footer
+`:no_footer_line` | `Boolean` | Do not display line above the footer (default true)
+`:footer_right` | `Number`/`String` | Right aligned footer text
+`:footer_spacing` | `Number` | Spacing between footer and content in mm (default 0)
+`:header_center` | `Number`/`String` | Centered header text
+`:header_font_name` | `Number`/`String` | Set header font name (default Arial)
+`:header_font_size` | `Number`/`String` | Set header font size (default 12)
+`:header_html` | `String` | Adds a html header
+`:header_left` | `Number`/`String` | Left aligned header text
+`:header_line` | `Boolean` | Display line below the header
+`:no_header_line` | `Boolean` | Do not display line below the header (default true)
+`:header_right` | `Number`/`String` | Right aligned header text
+`:header_spacing` | `Number` | Spacing between header and content in mm (default 0)
+`: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.
+
+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.
+
+You might want to set other options for each encryption alogrithm inside `:restrections` hash:
+
+*Key Length:* **40**
+
+| Option | Value | Description |
+|:---|:---|:---|
+`:print` | `'y', 'n'` | Determines whether or not to allow printing.
+`:modify` | `'y', 'n'` | Determines whether or not to allow document modification.
+`:extract` | `'y', 'n'` | Determines whether or not to allow text/image extraction.
+`:annotate` | `'y', 'n'` | Determines whether or not to allow comments and form fill-in and signing.
+
+*Key Length:* **128**
+
+| Option | Value | Description |
+|:---|:---|:---|
+`:print` | `'full', 'low', 'none'` | **full**: allow full printing. **low**: allow low-resolution printing only. **none**: disallow printing.
+`:modify` | `'all', 'annotate', 'form', 'assembly', 'none'` | **all:** allow full document modification. **annotate:** allow comment authoring and form operations. **form:** allow form field fill-in and signing. **assembly:** allow document assembly only. **none:** allow no modifications.
+`:extract` | `'y', 'n'` | Determines whether or not to allow text/image extraction.
+`:use_aes` | `'y', 'n'` | AES encryption will be used instead of RC4 encryption.
+`:accessibility` | `'y', 'n'` | Determines whether or not to allow accessibility to visually impaired.
+
+*Key Length:* **256**
+
+| Option | Value | Description |
+|:---|:---|:---|
+`:print` | `'full', 'low', 'none'` | **full**: allow full printing. **low**: allow low-resolution printing only. **none**: disallow printing.
+`:modify` | `'all', 'annotate', 'form', 'assembly', 'none'` | **all:** allow full document modification. **annotate:** allow comment authoring and form operations. **form:** allow form field fill-in and signing. **assembly:** allow document assembly only. **none:** allow no modifications.
+`:extract` | `'y', 'n'` | Determines whether or not to allow text/image extraction.
+`:accessibility` | `'y', 'n'` | Determines whether or not to allow accessibility to visually impaired.
+
+**Example:**
+```
+Caterpillar.create(
+    source: content,
+    password_protect: {
+        pasword: 'YOUR_PASSWORD_HERE',
+        key_length: 128,
+        restrictions: {
+            print: 'low',
+            use_aes: 'y'
+        }
+    }
+)
+```
+
+## Meta
+
+Maintained by [KeepWorks](http://www.keepworks.com/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keepworks/caterpillar.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+desc 'Start console for gem'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'caterpillar-ruby'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "caterpillar"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/caterpillar_ruby.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caterpillar-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caterpillar-ruby"
+  spec.version       = Caterpillar::VERSION
+  spec.authors       = ["Nitish Sharma", "Nishit Hirani"]
+  spec.email         = ["nitish.sharma@keepworks.com", "nishit@keepworks.com"]
+
+  spec.summary       = %q{A simple ruby client for the Caterpillar API}
+  spec.description   = %q{Easily convert HTML to PDF in your Ruby app using Caterpillar API.}
+  spec.homepage      = "https://caterpillar.io"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "httparty"
+end

data/lib/caterpillar-ruby.rb

@@ -0,0 +1,52 @@
+require 'httparty'
+
+['caterpillar-ruby', 'core_ext'].each do |dir|
+  Dir[File.dirname(__FILE__) + '/' + dir + '/*.rb'].each { |file| require file }
+end
+
+module Caterpillar
+  class << self
+    attr_accessor :api_key
+    attr_accessor :api_version
+    attr_accessor :base_uri
+
+    def configure
+      yield self
+    end
+
+    def create(options = {})
+      raise NoApiKeyError.new('API Key is blank') if api_key.blank?
+      raise NoSourceError.new('Source is blank') if options[:source].blank?
+
+      options.deep_modify_keys!(:camelize)
+
+      query = {
+        source: options.delete(:source),
+        data: {
+          apiKey: api_key
+        }.merge!(options)
+      }
+
+      response = HTTParty.post("#{base_uri}/#{api_version}/documents/convert", query: query).force_encoding('UTF-8')
+
+      parsed_response = response.is_caterpillar_json?
+      raise APIError.new(parsed_response['message']) if parsed_response.present? && parsed_response['status'] == 0
+
+      if block_given?
+        return_value = nil
+
+        Tempfile.open('caterpillar') do |f|
+          f.sync = true
+          f.write(response)
+          f.rewind
+
+          return_value = yield f, response
+        end
+
+        return_value
+      else
+        response
+      end
+    end
+  end
+end

data/lib/caterpillar-ruby/error.rb

@@ -0,0 +1,5 @@
+module Caterpillar
+  APIError = Class.new(StandardError)
+  NoApiKeyError = Class.new(RuntimeError)
+  NoSourceError = Class.new(ArgumentError)
+end

data/lib/caterpillar-ruby/version.rb

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

data/lib/core_ext/blank.rb

@@ -0,0 +1,140 @@
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  CAT_BLANK_RE = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    CAT_BLANK_RE === self
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time #:nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/core_ext/hash.rb

@@ -0,0 +1,23 @@
+class Hash
+  def deep_modify_keys(modification = :symbolize)
+    if modification == :camelize
+      Hash[
+        self.map do |key, value|
+          [key.to_camelcase.to_sym, value.is_a?(Hash) ? value.deep_modify_keys(:camelize) : value]
+        end
+      ]
+    elsif modification == :underscorize
+      Hash[
+        self.map do |key, value|
+          [key.to_underscore.to_sym, value.is_a?(Hash) ? value.deep_modify_keys(:underscorize) : value]
+        end
+      ]
+    else
+      Hash[self.map { |key, value| [key.to_sym, value.is_a?(Hash) ? value.deep_modify_keys : value] }]
+    end
+  end
+
+  def deep_modify_keys!(modification = :symbolize)
+    self.replace(deep_modify_keys(modification))
+  end
+end

data/lib/core_ext/inflectors.rb

@@ -0,0 +1,13 @@
+module Inflectors
+  def to_camelcase
+    string = self.to_s.downcase
+    string.include?('_') ? string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { $2.capitalize.to_sym } : string.to_sym
+  end
+
+  def to_underscore
+    self.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').tr('-', '_').downcase
+  end
+end
+
+[String, Object].each { |klass| klass.include(Inflectors) }

data/lib/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+  def is_caterpillar_json?
+    JSON.parse(self)
+  rescue
+    false
+  end
+end

data/lib/generators/caterpillar/initializer.rb

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

data/lib/generators/caterpillar/install_generator.rb

@@ -0,0 +1,9 @@
+module Caterpillar
+  class InstallGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__)))
+
+    def copy_initializer
+      copy_file 'initializer.rb', 'config/initializers/caterpillar.rb'
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: caterpillar-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nitish Sharma
+- Nishit Hirani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily convert HTML to PDF in your Ruby app using Caterpillar API.
+email:
+- nitish.sharma@keepworks.com
+- nishit@keepworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caterpillar_ruby.gemspec
+- lib/caterpillar-ruby.rb
+- lib/caterpillar-ruby/error.rb
+- lib/caterpillar-ruby/version.rb
+- lib/core_ext/blank.rb
+- lib/core_ext/hash.rb
+- lib/core_ext/inflectors.rb
+- lib/core_ext/string.rb
+- lib/generators/caterpillar/initializer.rb
+- lib/generators/caterpillar/install_generator.rb
+homepage: https://caterpillar.io
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple ruby client for the Caterpillar API
+test_files: []