docraptor-cli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8057932a008393a2af5ede0830d893c2154c8847
+  data.tar.gz: 2aba90e1ffaedc4675035b02494987158ae3c9b9
+SHA512:
+  metadata.gz: 21520e48134b3a3966a075fcb2e5e1217f292fa05c09241740f2e414ce3b72c179adeedc037ff4bcbedd2b378359fddaad7d80215cc83616313c47b0be0c84dd
+  data.tar.gz: 6486ce5522ed2d1ea91a8515f6fd2e7aac34642322207d93860d7e00d5677ff52914a99e013b567757d4b55c94e2f012e6328dd060414fcaba7a1d86ea30629c

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Thumbs.db
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### 0.0.1 [May 19, 2016]
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Expected Behavior
+
+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,84 @@
+# DocRaptor CLI
+
+**WARNING: This is a beta client and subject to serious change**
+
+This is a command line interface for using [DocRaptor API](https://docraptor.com/documentation) to convert [HTML to PDF and XLSX](https://docraptor.com).
+
+
+## Installation
+
+```bash
+gem install docraptor-cli
+```
+
+
+## Usage
+
+```bash
+docraptor local_file.html                              # local files
+docraptor https://docraptor.com/examples/invoice.html  # URLs are detected by prefix
+```
+
+The full DocRaptor API is available, see:
+
+```
+Usage: docraptor [options] <url/file>
+
+Server options:
+    -k, --key KEY                    The API Key to use when calling the service. Defaults to YOUR_API_KEY_HERE or ENV[DOCRAPTOR_API_KEY].
+    -s, --server SERVER              Make API requests against SERVER, scheme not required. Defaults to https://docraptor.com
+
+Document options:
+        --async                      Create document asynchronously(10 min limit). Defaults to synchronous(1 min limit).
+    -d, --debug                      Enable debug logging.
+        --no-ignore-resource-errors  Error when a resource cannot be downloaded.
+    -j, --javascript                 Enable DocRaptor JavaScript parsing. Defaults to no javascript.
+        --name NAME                  Give a name to this document. Defaults to a randomized string. Does not affect output filename.
+        --referrer URL               Set HTTP REFERRER when rendering. Defaults to localhost for file rendering or render url.
+        --strict STRICTNESS          Set HTML strictness. Defaults to none.
+        --test                       Create this as a test document. Defaults to non-test.
+    -t, --type TYPE                  Type of document to make, can be pdf, xls, xlsx. Defaults to pdf.
+
+Prince options:
+        --prince-baseurl URL         Set base url when rendering. Defaults to nothing for file rendering or render url.
+        --prince-css-dpi DPI         Set a base CSS DPI. Defaults value used by Prince is 96.
+
+...
+```
+
+
+
+We have guides for doing some of the common things:
+
+* [Headers and Footers](https://docraptor.com/documentation/style#pdf-headers-footers) including page skipping
+* [CSS Media Selector](https://docraptor.com/documentation/api#api_basic_pdf) to make the page look exactly as it does in your browser
+* Protect content with [HTTP authentication](https://docraptor.com/documentation/api#api_http_user) or [proxies](https://docraptor.com/documentation/api#api_http_proxy) so only DocRaptor can access them
+
+
+## More Help
+
+DocRaptor has a lot of more [styling](https://docraptor.com/documentation/style) and [implementation options](https://docraptor.com/documentation/api).
+
+Stuck? We're experts at using DocRaptor so please [email us](mailto:support@docraptor.com) if you run into trouble.
+
+
+## Development
+
+This code is a thin wrapper around the [docraptor gem](https://github.com/docraptor/docraptor-ruby) to make it suitable for command line users.
+
+
+## Release Process
+
+1. Pull latest master
+2. Merge feature branch(es) into master
+3. `script/test`
+4. Increment version in code:
+  - ...
+5. Update [CHANGELOG.md](CHANGELOG.md)
+6. Commit "Release version vX.Y.Z"
+7. `rake release`
+
+
+## Version Policy
+
+This library follows [Semantic Versioning 2.0.0](http://semver.org).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/setup"
+require "bundler/gem_tasks"

data/bin/docraptor

@@ -0,0 +1,328 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler"
+Bundler.require
+require "optparse"
+
+TYPES = %w(pdf xls xlsx)
+PRINT_STATUS_EVERY = 30
+
+def log(message)
+  STDERR.puts(message)
+end
+
+options = {
+  # Server Options
+  key:    ENV["DOCRAPTOR_API_KEY"] || "YOUR_API_KEY_HERE",
+  server: "https://docraptor.com",
+
+  # Document Options
+  javascript: false,
+  test:       false,
+  type:       "pdf",
+  strict:     "none",
+  async:      false,
+
+  # Script Options
+  open:  true,
+}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] <url/file>"
+
+
+  opts.separator ""
+  opts.separator "Server options:"
+
+  opts.on("-kKEY", "--key KEY", "The API Key to use when calling the service. Defaults to YOUR_API_KEY_HERE or ENV[DOCRAPTOR_API_KEY].") do |key|
+    options[:key] = key
+  end
+
+  opts.on("-sSERVER", "--server SERVER",
+          "Make API requests against SERVER, scheme not required. Defaults to #{options[:server]}") do |server|
+    if !server.include?("://")
+      scheme = server =~ /\Alocalhost/ ? "http" : "https"
+      server = "#{scheme}://#{server}"
+    end
+    options[:server] = server
+  end
+
+
+  opts.separator ""
+  opts.separator "Document options:"
+
+  opts.on("--async", "Create document asynchronously(10 min limit). Defaults to synchronous(1 min limit).") do |async|
+    options[:async] = async
+  end
+
+  opts.on("-d", "--debug", "Enable debug logging.") do
+    options[:debug] = true
+  end
+
+  opts.on("--no-ignore-resource-errors",
+          "Error when a resource cannot be downloaded.") do |ignore_resource_errors|
+    options[:ignore_resource_errors] = true
+  end
+
+  opts.on("-j", "--javascript", "Enable DocRaptor JavaScript parsing. Defaults to no javascript.") do |javascript|
+    options[:javascript] = javascript
+  end
+
+  opts.on("--name NAME", "Give a name to this document. Defaults to a randomized string. Does not affect output filename.") do |name|
+    options[:name] = name
+  end
+
+  opts.on("--referrer URL", "Set HTTP REFERRER when rendering. Defaults to localhost for file rendering or render url.") do |url|
+    options[:referrer] = url
+  end
+
+  opts.on("--strict STRICTNESS", "Set HTML strictness. Defaults to none.") do |strict|
+    options[:strict] = strict
+  end
+
+  opts.on("--test", "Create this as a test document. Defaults to non-test.") do |test|
+    options[:test] = test
+  end
+
+  opts.on("-t", "--type TYPE", TYPES, "Type of document to make, can be #{TYPES.join(', ')}. Defaults to pdf.") do |type|
+    options[:type] = type
+  end
+
+  opts.separator ""
+  opts.separator "Prince options:"
+
+  opts.on("--prince-baseurl URL", "Set base url when rendering. Defaults to nothing for file rendering or render url.") do |url|
+    options[:prince_baseurl] = url
+  end
+
+  opts.on("--prince-css-dpi DPI", "Set a base CSS DPI. Defaults value used by Prince is 96.") do |dpi|
+    options[:prince_css_dpi] = dpi
+  end
+
+  opts.on("--prince-disallow-annotate", "Disallow annotating the final PDF.") do |disallow|
+    options[:prince_disallow_annotate] = disallow
+  end
+
+  opts.on("--prince-disallow-copy", "Disallow copying the final PDF.") do |disallow|
+    options[:prince_disallow_copy] = disallow
+  end
+
+  opts.on("--prince-disallow-modify", "Disallow modifying the final PDF.") do |disallow|
+    options[:prince_disallow_modify] = disallow
+  end
+
+  opts.on("--prince-disallow-print", "Disallow printing the final PDF.") do |disallow|
+    options[:prince_disallow_print] = disallow
+  end
+
+  opts.on("--prince-encrypt", "Encrypt the output PDF.") do |encrypt|
+    options[:prince_encrypt] = encrypt
+  end
+
+  opts.on("--prince-key-bits BITS", "Set the encryption key size, must be used with --prince-encrypt.") do |key_bits|
+    options[:prince_key_bits] = key_bits
+  end
+
+  opts.on("--prince-input INPUT", "Set the input type for PDF: xml, html, auto.") do |input|
+    options[:prince_input] = input
+  end
+
+  opts.on("--prince-no-compress", "Disable PDF compression.") do |no_compress|
+    options[:prince_no_compress] = no_compress
+  end
+
+  opts.on("--prince-user-password PASS", "Set the user password for decrypting an encrypted PDF.") do |password|
+    options[:prince_user_password] = password
+  end
+
+  opts.on("--prince-owner-password PASS", "Set the owner password for decrypting an encrypted PDF.") do |password|
+    options[:prince_owner_password] = password
+  end
+
+  opts.on("--prince-insecure", "Set the insecure flag") do |insecure|
+    options[:prince_insecure] = insecure
+  end
+
+  opts.on("--prince-http-timeout SECS", "Set the timeout for HTTP connections made by prince") do |timeout_seconds|
+    options[:prince_http_timeout] = timeout_seconds
+  end
+
+  opts.on("--prince-http-user USER", "Set the user for setting basic auth credentials. Defaults to nothing for file rendering or render url.") do |user|
+    options[:prince_http_user] = user
+  end
+
+  opts.on("--prince-http-password PASS", "Set the password for setting basic auth credentials. Defaults to nothing for file rendering or render url.") do |password|
+    options[:prince_http_password] = password
+  end
+
+  opts.on("--prince-http-proxy PROXY", "Set the proxy server.") do |proxy|
+    options[:prince_http_proxy] = proxy
+  end
+
+  opts.on("--prince-javascript", "Enable PrinceXML JavaScript parsing. Defaults to false.") do |prince_javascript|
+    options[:prince_javascript] = prince_javascript
+  end
+
+  opts.on("--prince-media MEDIA", "Create this with a specific CSS media selector. Defaults to print.") do |prince_media|
+    options[:prince_media] = prince_media.to_s
+  end
+
+  opts.on("--prince-profile PROFILE", "Set the PDF Profile. PDF/A-1b PDF/X-3:2003 PDF/X-4") do |prince_profile|
+    options[:prince_profile] = prince_profile.to_s
+  end
+
+  opts.on("--prince-debug", "Enable PrinceXML debug logging.") do |prince_debug|
+    options[:prince_debug] = prince_debug
+  end
+
+  opts.on("--prince-version VERSION", "Create this with a specific PrinceXML version. Defaults to user setting.") do |prince_version|
+    options[:prince_version] = prince_version.to_s
+  end
+
+  opts.on("--prince-no-embed-fonts", "Disable font embelistiteming in PDF output.") do |no_embed_fonts|
+    options[:no_embed_fonts] = no_embed_fonts
+  end
+
+  opts.on("--prince-no-subset-fonts", "Disable font subsetting in PDF output.") do |no_subset_fonts|
+    options[:no_subset_fonts] = no_subset_fonts
+  end
+
+  opts.separator ""
+  opts.separator "Script options:"
+
+  opts.on("-o", "--[no-]open", "Automatically open output files. Defaults to true.") do |open|
+    options[:open] = open
+  end
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on("-c", "--common", "Set common development options: open, test, javascript enabled") do
+    options[:open] = true
+    options[:test] = true
+    options[:javascript] = true
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    log opts
+    exit
+  end
+end
+
+opt_parser.parse!(ARGV)
+
+file_or_url = ARGV.shift
+
+if !file_or_url
+  log opt_parser
+  abort
+end
+
+DocRaptor.configure do |dr|
+  dr.username = options[:key]
+  server = URI.parse(options[:server])
+  dr.host = "#{server.host}:#{server.port}"
+  dr.scheme = server.scheme
+  dr.debugging = options[:debug]
+end
+
+$docraptor = DocRaptor::DocApi.new
+
+all_doc_attributes = {
+  strict:                 options[:strict],
+  test:                   options[:test],
+  javascript:             options[:javascript],
+  document_type:          options[:type],
+  prince_options:         {},
+  async:                  options[:async],
+  ignore_resource_errors: options[:ignore_resource_errors],
+}
+
+all_doc_attributes[:prince_options][:version]       = options[:prince_version] if options[:prince_version]
+all_doc_attributes[:prince_options][:javascript]    = options[:prince_javascript] if options[:prince_javascript]
+all_doc_attributes[:prince_options][:media]         = options[:prince_media] if options[:prince_media]
+all_doc_attributes[:prince_options][:baseurl]       = options[:prince_baseurl] if options[:prince_baseurl]
+all_doc_attributes[:prince_options][:css_dpi]       = options[:prince_css_dpi] if options[:prince_css_dpi]
+all_doc_attributes[:prince_options][:disallow_annotate] = options[:prince_disallow_annotate] if options[:prince_disallow_annotate]
+all_doc_attributes[:prince_options][:disallow_copy] = options[:prince_disallow_copy] if options[:prince_disallow_copy]
+all_doc_attributes[:prince_options][:disallow_modify] = options[:prince_disallow_modify] if options[:prince_disallow_modify]
+all_doc_attributes[:prince_options][:disallow_print]= options[:prince_disallow_print] if options[:prince_disallow_print]
+all_doc_attributes[:prince_options][:encrypt]       = options[:prince_encrypt] if options[:prince_encrypt]
+all_doc_attributes[:prince_options][:key_bits]       = options[:prince_key_bits] if options[:prince_key_bits]
+all_doc_attributes[:prince_options][:input]       = options[:prince_input] if options[:prince_input]
+all_doc_attributes[:prince_options][:no_compress]   = options[:prince_no_compress] if options[:prince_no_compress]
+all_doc_attributes[:prince_options][:user_password] = options[:prince_user_password] if options[:prince_user_password]
+all_doc_attributes[:prince_options][:owner_password]= options[:prince_owner_password] if options[:prince_owner_password]
+all_doc_attributes[:prince_options][:http_user]     = options[:prince_http_user] if options[:prince_http_user]
+all_doc_attributes[:prince_options][:http_password] = options[:prince_http_password] if options[:prince_http_password]
+all_doc_attributes[:prince_options][:http_proxy]    = options[:prince_http_proxy] if options[:prince_http_proxy]
+all_doc_attributes[:prince_options][:http_timeout]  = options[:prince_http_timeout] if options[:prince_http_timeout]
+all_doc_attributes[:prince_options][:insecure]      = options[:prince_insecure] if options[:prince_insecure]
+all_doc_attributes[:prince_options][:debug]         = options[:prince_debug] if options[:prince_debug]
+all_doc_attributes[:prince_options][:profile]       = options[:prince_profile] if options[:prince_profile]
+all_doc_attributes[:prince_options][:no_embed_fonts] = options[:no_embed_fonts] if options[:no_embed_fonts]
+all_doc_attributes[:prince_options][:no_subset_fonts] = options[:no_subset_fonts] if options[:no_subset_fonts]
+
+if file_or_url.include?("://")
+  url = file_or_url
+  all_doc_attributes[:document_url] = url
+  all_doc_attributes[:referrer]     = options[:referrer] || url
+  all_doc_attributes[:prince_options][:baseurl] ||= url
+else
+  input_filename = file_or_url
+  all_doc_attributes[:referrer]         = options[:referrer] || "http://localhost/"
+  all_doc_attributes[:document_content] = File.read(input_filename)
+end
+
+all_doc_attributes.delete(:prince_options) if all_doc_attributes[:prince_options].empty?
+
+base_filename = rand(10**12).to_s(36) # random to make Preview refresh every time with ease
+
+def run_doc(options, all_doc_attributes, base_filename)
+  output_filename = "/tmp/#{base_filename}.#{options[:type]}"
+
+  doc_attributes = all_doc_attributes.merge(name: options[:name] || File.basename(output_filename))
+
+  log "Creating document #{doc_attributes[:name]} using #{options[:server]}"
+  pretty_doc_attributes = doc_attributes.dup
+  pretty_doc_attributes[:document_content] = pretty_doc_attributes[:document_content][0..30] + "..." if pretty_doc_attributes.include?(:document_content)
+  start = Time.now
+
+  if options[:async]
+    response = $docraptor.create_async_doc(doc_attributes)
+    status_id = response.status_id
+    t = Time.now.to_f
+    time_of_last_status_message = Time.now - PRINT_STATUS_EVERY
+    while !%w{completed failed}.include?((status_response = $docraptor.get_async_doc_status(status_id)).status)
+      if Time.now - time_of_last_status_message > PRINT_STATUS_EVERY
+        log "STATUS (#{status_id}, elapsed time: #{(Time.now.to_f - t).round(3)} sec): #{status_response.status.inspect}"
+        time_of_last_status_message = Time.now
+      end
+      sleep 1
+    end
+    log "Elapsed time: #{(Time.now.to_f - t).round(3)} secs"
+    if status_response.status == 'completed'
+      download_response = $docraptor.get_async_doc(status_response.download_id)
+      File.open(output_filename, "wb") do |file|
+        file.write(download_response)
+      end
+      system("open", output_filename) if options[:open]
+    else
+      log "Document failed: #{status_response.inspect}"
+      failures << [status_response, {status_id: status_id, name: doc_attributes[:name]}]
+    end
+  else
+    response = $docraptor.create_doc(doc_attributes)
+    log "  Success (%.3f seconds)" % (Time.now - start)
+    File.open(output_filename, "wb") do |file|
+      file.write(response)
+    end
+    system("open", output_filename) if options[:open]
+  end
+rescue DocRaptor::ApiError => e
+  log "ERROR: #{e.class}"
+  log e.response_body
+  exit 1
+end
+
+run_doc(options, all_doc_attributes, base_filename)

data/docraptor-cli.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "docraptor-cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docraptor-cli"
+  s.version     = DocRaptorCli::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Elijah Miller"]
+  s.email       = ["elijah.miller@gmail.com"]
+  s.homepage    = "https://github.com/docraptor/docraptor-cli"
+  s.summary     = %q{Command line interface for the DocRaptor HTML to PDF/XLS service.}
+  s.description = %q{A native command line client library for the DocRaptor HTML to PDF/XLS service.}
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'docraptor', '~> 0.3.0'
+
+  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
+  s.add_development_dependency 'rake', '~> 11.1', '>= 11.1.2'
+
+  s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
+  # s.test_files    = `git ls-files spec`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/docraptor-cli/version.rb

@@ -0,0 +1,3 @@
+module DocRaptorCli
+  VERSION = "0.0.1"
+end

data/script/test

@@ -0,0 +1,12 @@
+#!/bin/sh
+set -e
+cd "$(dirname "$0")/.."
+
+# check dependencies
+ruby -v > /dev/null    || (echo "ruby must be installed"; exit 1)
+bundler -v > /dev/null || (echo "bundler must be installed"; exit 1)
+
+bundle install
+
+echo "Testing not yet written for this repository."
+exit 1

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: docraptor-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elijah Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docraptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+description: A native command line client library for the DocRaptor HTML to PDF/XLS
+  service.
+email:
+- elijah.miller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/docraptor
+- docraptor-cli.gemspec
+- lib/docraptor-cli/version.rb
+- script/test
+homepage: https://github.com/docraptor/docraptor-cli
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Command line interface for the DocRaptor HTML to PDF/XLS service.
+test_files: []