docraptor 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6b898db0c2631364545a4da3f3a87ef8a249e7e1db737091e42a8095dc2ba4
-  data.tar.gz: 38cc4dd86eb0ae69502ee42c6bdd8cfc1715f8b9b425aa15c4a8089a3edaa609
+  metadata.gz: bfd3d5b8d3364bd02c04b712136686d4a714f6cd3ab3fced0c7efae7e9709ee0
+  data.tar.gz: 89d4fb74883b56c49a71eef45487534474a8f9fa0ae8fc065a592e6a1ae7340c
 SHA512:
-  metadata.gz: 648892ceb32bc298f8fe5689873212106f8059d47b009164d69ccec923a8437e2209e9f7a4d30de0bda430a1a5bb260ab34133797a3a8d796b3b515119120c58
-  data.tar.gz: 1479aabfe153182ef3e0afc66b9c7e5105a2c7873cbe3fe640c6078411895dc30bbb17d58568d22db55a3383f542c2feb9ad140c4ac054de9c58f89244adeb6f
+  metadata.gz: 964a77fd28bb343dd5410b01e5b6981f631fd5c0ed047225b2dc048b8070249d9d704bb7a4bd289d154b406e8b794a2ac71e7d031af047bb8c47a0500c86b29d
+  data.tar.gz: 90787b9656e2455038833d260caf62b7aa48ce833d3de5e1483c1a9893feed6e0deb5d4cb995ee565510c0c3bfabe7e851decdf5cae00fd0389dc07d8319ff90

data/.swagger-codegen/VERSION

@@ -1 +1 @@
-2.4.14
+2.4.19

data/.swagger-revision

@@ -1 +1 @@
-v2.4.14
+v2.4.19

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.10
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 2.0.0 [June 1, 2021]
+* Add support for ruby 3.x (remove `URI.encode`)
+* Remove support for rubies <2.3
+
 ### 1.4.0 [July 31, 2020]
 * add support for hosted documents
 * upgrade to latest swagger 2.4.14

data/README.md

@@ -18,9 +18,7 @@ bundle install
 ```
 
 
-## Usage
-
-See [examples](examples/) for runnable examples with file output, error handling, etc.
+## Basic Usage
 
 ```ruby
 DocRaptor.configure do |config|
@@ -44,20 +42,15 @@ response = $docraptor.create_doc(
 )
 ```
 
-Docs created like this are limited to 60 seconds to render, check out the [async example](examples/async.rb) which allows 10 minutes.
-
-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
+## Next Steps
 
+- Optionally store and get a URL for your converted document with [document hosting](https://docraptor.com/document-hosting)
+- View more [code examples](examples) with error handling, asynchronous creation, file saving, and document hosting.
+- Perfect your document styling with our [style and formatting reference](https://docraptor.com/documentation/style), and [API reference](https://docraptor.com/documentation/api). Easily add headers and footers, page breaks, page numbers, table of contents, and much more!
 
 ## 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.
+Stuck? We're experts at turning HTML into PDFs so please [email us](mailto:support@docraptor.com) if you run into trouble.
 
 
 ## Development

data/docraptor.gemspec

@@ -8,7 +8,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -25,10 +25,11 @@ Gem::Specification.new do |s|
   s.summary     = "A wrapper for the DocRaptor HTML to PDF/XLS service."
   s.description = "A native client library for the DocRaptor HTML to PDF/XLS service."
   s.license     = 'MIT'
-  s.required_ruby_version = ">= 1.9"
+  s.required_ruby_version = ">= 2.3"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'

data/examples/hosted_async.rb

@@ -23,7 +23,7 @@ Bundler.require
 require "open-uri"
 
 DocRaptor.configure do |dr|
-  dr.username  = "YOUR_API_KEY_HERE" # you will need a real api key to test hosted documents
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 

data/examples/hosted_sync.rb

@@ -23,7 +23,7 @@ Bundler.require
 require "open-uri"
 
 DocRaptor.configure do |dr|
-  dr.username  = "YOUR_API_KEY_HERE" # you will need a real api key to test hosted documents
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 

data/lib/docraptor.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/api/doc_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/api_client.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module DocRaptor
   class ApiClient
@@ -63,7 +63,7 @@ module DocRaptor
                             :message => response.return_message)
         else
           fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
+                            :response_headers => response.headers.to_h,
                             :response_body => response.body),
                response.status_message
         end
@@ -266,7 +266,7 @@ module DocRaptor
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body

data/lib/docraptor/api_error.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/configuration.rb

@@ -6,11 +6,11 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 
-require 'uri'
+require 'addressable/uri'
 
 module DocRaptor
   class Configuration
@@ -175,7 +175,7 @@ module DocRaptor
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

data/lib/docraptor/models/async_doc.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/models/doc.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/models/doc_status.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/models/prince_options.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/version.rb

@@ -6,10 +6,10 @@
 OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Swagger Codegen version: 2.4.19
 
 =end
 
 module DocRaptor
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end

data/script/fix_gemspec.rb

@@ -1,8 +1,10 @@
 # coding: utf-8
-bad_files       = %q{s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }}
-bad_test_files  = %q{s.test_files    = `find spec/*`.split("\n")}
-good_files      = %q{s.files         = `git ls-files`.split("\n").uniq.sort.select { |f| !f.empty? }}
-good_test_files = %q{s.test_files    = `git ls-files spec test`.split("\n")}
+bad_files         = %q{s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }}
+good_files        = %q{s.files         = `git ls-files`.split("\n").uniq.sort.select { |f| !f.empty? }}
+bad_test_files    = %q{s.test_files    = `find spec/*`.split("\n")}
+good_test_files   = %q{s.test_files    = `git ls-files spec test`.split("\n")}
+bad_ruby_version  = %q{s.required_ruby_version = ">= 1.9"}
+good_ruby_version = %q{s.required_ruby_version = ">= 2.3"}
 
 development_dependency_marker = %q{  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'}
 development_dependency_marker_plus_injection =
@@ -16,7 +18,12 @@ development_dependency_marker_plus_injection =
 
 filename = "docraptor.gemspec"
 content = File.read(filename)
-[bad_files, bad_test_files, development_dependency_marker].each do |bad_content_to_check|
+[
+  bad_files,
+  bad_test_files,
+  bad_ruby_version,
+  development_dependency_marker
+].each do |bad_content_to_check|
   unless content.include?(bad_content_to_check)
     raise "Couldn't find content in docraptor.gemspec. Check matchers in there for: “#{bad_content_to_check}”"
   end
@@ -24,6 +31,7 @@ end
 updated_content = content.dup
 updated_content.sub!(bad_files, good_files)
 updated_content.sub!(bad_test_files, good_test_files)
+updated_content.sub!(bad_ruby_version, good_ruby_version)
 updated_content.sub!(development_dependency_marker,
                      development_dependency_marker_plus_injection)
 

data/script/setup

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -e
+cd "$(dirname "$0")/.."
+
+rbenv which ruby || (brew upgrade ruby-build || true; rbenv install)
+
+# Setup rbenv so we can switch rubies below
+eval "$(rbenv init - --no-rehash)"
+
+for ruby_version in `ruby -ryaml -e 'puts YAML.load(File.read(".travis.yml"))["rvm"].join(" ")'`; do
+  rbenv versions --bare | grep "^${ruby_version}$" || rbenv install $ruby_version
+  rbenv shell $ruby_version
+  gem list -i bundler --version 2.2.15 >/dev/null || gem install bundler:2.2.15
+
+  bundle install
+done
+
+tput bold    # bold text
+tput setaf 2 # green text
+echo "****************************************************************"
+echo "*                                                              *"
+echo "*                         Good to go!                          *"
+echo "*                                                              *"
+echo "****************************************************************"
+tput sgr0    # reset to default text

data/script/test

@@ -8,17 +8,48 @@ bundler -v > /dev/null || (echo "bundler must be installed"; exit 1)
 
 bundle install
 
-cd test
-
 # runs a test file with PASS/FAIL message
 run_test() {
   ruby $1 && echo "PASS $1" || (echo "FAIL $1"; exit 1)
 }
 
-if [ "$1" == "" ]; then
-  for test in $(ls *.rb); do
-    run_test $test
-  done
+run_tests() {
+  if [ "$1" == "" ]; then
+    for test in $(ls *.rb); do
+      run_test $test
+    done
+  else
+    run_test $1.rb
+  fi
+}
+
+success="true"
+
+# Setup rbenv so we can switch rubies below
+eval "$(rbenv init - --no-rehash)"
+
+for ruby_version in `ruby -ryaml -e 'puts YAML.load(File.read(".travis.yml"))["rvm"].join(" ")'`; do
+  {
+    echo "testing ruby version $ruby_version" &&
+      rbenv shell $ruby_version &&
+      ( cd test && run_tests )
+  } || success="false"
+done
+
+if [ $success == "true" ]; then
+  tput bold    # bold text
+  tput setaf 2 # green text
+  echo "======================================"
+  echo "=              Passed                ="
+  echo "======================================"
+  tput sgr0    # reset to default text
+  exit 0
 else
-  run_test $1.rb
+  tput bold    # bold text
+  tput setaf 1 # red text
+  echo "======================================"
+  echo "=              FAILED                ="
+  echo "======================================"
+  tput sgr0    # reset to default text
+  exit 1
 fi

data/swagger-config.json

@@ -1,7 +1,7 @@
 {
     "gemName": "docraptor",
     "moduleName": "DocRaptor",
-    "gemVersion": "1.4.0",
+    "gemVersion": "2.0.0",
     "gemAuthor": "Expected Behavior",
     "gemAuthorEmail": "support@docraptor.com",
     "gemHomepage": "https://github.com/docraptor/docraptor-ruby",

data/test/expire_hosted.rb

@@ -2,13 +2,8 @@ require "bundler/setup"
 Bundler.require
 require 'open-uri'
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 
@@ -31,7 +26,7 @@ status_response = nil
   sleep 1
 end
 
-actual_document = open status_response.download_url
+actual_document = URI.parse(status_response.download_url).open
 IO.copy_stream(actual_document, output_file)
 
 output_type = `file -b #{output_file}`
@@ -42,7 +37,7 @@ raise "Output was not a PDF" unless output_type.start_with?("PDF")
 $docraptor.expire(status_response.download_id)
 
 begin
-  actual_document = open status_response.download_url
+  actual_document = URI.parse(status_response.download_url).open
 rescue OpenURI::HTTPError => http_error
   exit 0
 end

data/test/hosted_async.rb

@@ -2,13 +2,8 @@ require "bundler/setup"
 Bundler.require
 require "open-uri"
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 

data/test/hosted_sync.rb

@@ -2,13 +2,8 @@ require "bundler/setup"
 Bundler.require
 require "open-uri"
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 
@@ -24,7 +19,7 @@ output_payload = $docraptor.create_hosted_doc(
   hosted_expires_at: (Time.now + 86400).strftime('%FT%T%:z'), # 1 day from now
 )
 
-actual_document = open output_payload.download_url
+actual_document = URI.parse(output_payload.download_url).open
 IO.copy_stream(actual_document, output_file)
 
 output_type = `file -b #{output_file}`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Expected Behavior
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -34,42 +34,62 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +262,7 @@ files:
 - ".swagger-codegen-ignore"
 - ".swagger-codegen/VERSION"
 - ".swagger-revision"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -267,6 +288,7 @@ files:
 - script/fix_gemspec.rb
 - script/generate_language
 - script/post_generate_language
+- script/setup
 - script/swagger
 - script/test
 - script/update_from_upstream
@@ -294,14 +316,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A wrapper for the DocRaptor HTML to PDF/XLS service.