docraptor 1.1.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTA3YzEyMjlkN2Q2M2FlYzI2YjhkMWNiZWM3MTIxNTk1NmQ3YTI4OA==
-  data.tar.gz: !binary |-
-    NGUwYTQ0ZGE4YTY1MjhkYzkzYjM5MTdhNGM5ZDg0ZGQ1ODQ1YTNiNg==
+SHA256:
+  metadata.gz: bfd3d5b8d3364bd02c04b712136686d4a714f6cd3ab3fced0c7efae7e9709ee0
+  data.tar.gz: 89d4fb74883b56c49a71eef45487534474a8f9fa0ae8fc065a592e6a1ae7340c
 SHA512:
-  metadata.gz: !binary |-
-    YWQyN2Y0NjQ0N2IzMjJmMGRiYjY2MDk2NGZiOTA4MDU1NjRmZDZkYTViNzMx
-    ZTAwNmVkMzdhODgyYTlhZjQ0ZWVmN2YwNGNiOWU3NTlhODEwZGJiM2M3YmM0
-    MjFhNGVkYzQwYTE1Y2M4NjdjOWY3MjEyZjM3MDMxMmIwMjdhMmM=
-  data.tar.gz: !binary |-
-    ZTAxM2FhYjc4MTEwOThkZDE4ZTYxZjc0MmViMTBmNWMxYmU0ZTJkZDg5MGY4
-    NzhhZGE2M2YxOTgyNjA0NWJiY2QyMGM0MzhmMTBiZjRhNjEwMmJiNGE0OGEz
-    NjFkOWM5MDU3YzMzNWUxYTk1OGYzOThkOGFmYzZhMTcxMzNhMzI=
+  metadata.gz: 964a77fd28bb343dd5410b01e5b6981f631fd5c0ed047225b2dc048b8070249d9d704bb7a4bd289d154b406e8b794a2ac71e7d031af047bb8c47a0500c86b29d
+  data.tar.gz: 90787b9656e2455038833d260caf62b7aa48ce833d3de5e1483c1a9893feed6e0deb5d4cb995ee565510c0c3bfabe7e851decdf5cae00fd0389dc07d8319ff90

data/.gitignore

@@ -1,5 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc
+.rubocop.yml
+
+## Ignore dumb OSX files
 .DS_Store
 Thumbs.db
+
+## Ignore baked in swagger generator
 swagger-codegen
-/pkg
-Gemfile.lock
+
+## Ignore dumb emacs files
+*~
+
+## Ignore files that contain special keys
+.docraptor_key

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.swagger-codegen-ignore

@@ -0,0 +1,32 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+# Can't Touch This. Dun-dun-dun-dun. Dun dun. Dun dun.
+README.md
+CHANGELOG.md
+git_push.sh
+docs/
+.gitignore
+LICENSE
+Rakefile

data/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.4.19

data/.swagger-revision

@@ -1 +1 @@
-62fbcb9e8bec4a40569e51c7f316af85806628ee
+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,20 @@
+### 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
+
+### 1.3.0 [November 21, 2017]
+* Added support for `prince_options[pdf_title]` and `ignore_console_messages` options
+
+### 1.2.0 [August 22, 2017]
+* No changes from beta1
+
+### 1.2.0beta1 [August 9, 2017]
+* Re-runnning against newer swagger version (v.2.2.3), bumping many gem dependencies to much newer versions. Applications using client *should not* be affected.
+
 ### 1.1.0 [November 3, 2016]
 * Added support for pipeline API parameter
 

data/Gemfile

@@ -1,3 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/LICENSE

@@ -1,13 +1,7 @@
-Copyright (c) 2010- Expected Behavior, LLC (http://expectedbehavior.com)
+Copyright © 2010-2017 Expected Behavior
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+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:
 
-    http://www.apache.org/licenses/LICENSE-2.0
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+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

@@ -18,14 +18,12 @@ bundle install
 ```
 
 
-## Usage
-
-See [examples](examples/) for runnable examples with file output, error handling, etc.
+## Basic Usage
 
 ```ruby
-DocRaptor.configure do |dr|
-  dr.username = "YOUR_API_KEY_HERE" # this key works for test documents
-  # dr.debugging = true
+DocRaptor.configure do |config|
+  config.username = "YOUR_API_KEY_HERE" # this key works for test documents
+  # config.debugging = true
 end
 
 $docraptor = DocRaptor::DocApi.new
@@ -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
@@ -76,7 +69,8 @@ The majority of the code in this repo is generated using swagger-codegen on [doc
 5. Update [CHANGELOG.md](CHANGELOG.md)
 6. Commit "Release version vX.Y.Z"
 7. `rake release`
-8. Refresh documentation on docraptor.com
+8. Verify package release at https://rubygems.org/gems/docraptor
+9. Refresh documentation on docraptor.com
 
 
 ## Version Policy

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler/setup'
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docraptor.gemspec

@@ -1,4 +1,17 @@
 # -*- encoding: utf-8 -*-
+
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 $:.push File.expand_path("../lib", __FILE__)
 require "docraptor/version"
 
@@ -6,28 +19,34 @@ Gem::Specification.new do |s|
   s.name        = "docraptor"
   s.version     = DocRaptor::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Elijah Miller", "Matthew Gordon"]
-  s.email       = ["elijah@expectedbehavior.com", "matt@expectedbehavior.com"]
+  s.authors     = ["Expected Behavior"]
+  s.email       = ["support@docraptor.com"]
   s.homepage    = "https://github.com/docraptor/docraptor-ruby"
-  s.summary     = %q{A wrapper for the DocRaptor HTML to PDF/XLS service.}
-  s.description = %q{A native client library for the DocRaptor HTML to PDF/XLS service.}
-  s.license     = "Apache-2.0"
-
-  s.add_runtime_dependency 'typhoeus', '~> 0.2', '>= 0.2.1'
-  s.add_runtime_dependency 'json', '~> 1.4', '>= 1.4.6'
-
-  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
-  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
-  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
-  s.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
-  s.add_development_dependency 'webmock', '~> 1.6', '>= 1.6.2'
+  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 = ">= 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'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
-  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  # added by script/fix_gemspec.rb.
+  s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
+  s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
+  # </added> : if the above lines are missing in the gemspec, then
+  # the matcher for autotest is probably broken
 
-  s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
-  # s.test_files    = `git ls-files spec`.split("\n")
+  s.files         = `git ls-files`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `git ls-files spec test`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
 end

data/docraptor.yaml

@@ -1,8 +1,13 @@
 swagger: '2.0'
 
-info:
-  version: "1.2.0"
-  title: DocRaptor v1
+info: # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object
+  version: "1.4.0"
+  title: DocRaptor
+  description: "A native client library for the DocRaptor HTML to PDF/XLS service."
+  termsOfService: "https://docraptor.com/tos"
+  license:
+    name: "MIT"
+    url: "https://mit-license.org/"
 
 host: docraptor.com
 basePath: /
@@ -50,14 +55,79 @@ paths:
           description: Unprocessable Entity
         500:
           description: Server Error
+
+  /hosted_docs:
+    post:
+      operationId: createHostedDoc
+      tags: [Doc]
+      description: >
+        Creates a hosted document synchronously.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: doc
+          in: body
+          description: The document to be created.
+          required: true
+          schema:
+            $ref: '#/definitions/Doc'
+      responses:
+        200:
+          description: Successful response
+          schema:
+            $ref: '#/definitions/DocStatus'
+        400:
+          description: Bad Request
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        422:
+          description: Unprocessable Entity
+        500:
+          description: Server Error
+
   /async_docs:
     post:
       operationId: createAsyncDoc
       tags: [Doc]
       description: >
         Creates a document asynchronously.
-        You must use a callback url or the the returned status id and the status api to find out when it completes.
-        Then use the download api to get the document.
+        You must use a callback url or the returned status id and the status API to find out when it completes.
+        Then use the download API to get the document.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: doc
+          in: body
+          description: The document to be created.
+          required: true
+          schema:
+            $ref: '#/definitions/Doc'
+      responses:
+        200:
+          description: Successful response
+          schema:
+            $ref: '#/definitions/AsyncDoc'
+        400:
+          description: Bad Request
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        422:
+          description: Unprocessable Entity
+        500:
+          description: Server Error
+
+  /hosted_async_docs:
+    post:
+      operationId: createHostedAsyncDoc
+      tags: [Doc]
+      description: >
+        Creates a hosted document asynchronously.
+        You must use a callback url or the returned status id and the status API to find out when it completes.
+        Then use the download API to get the document.
       security:
         - basicAuth: []
       parameters:
@@ -96,13 +166,12 @@ paths:
           in: path
           description: The status_id returned when creating an asynchronous document.
           required: true
-          schema:
-            $ref: '#/definitions/AsyncDocStatus'
+          type: string
       responses:
         200:
           description: Successful response
           schema:
-            $ref: '#/definitions/AsyncDocStatus'
+            $ref: '#/definitions/DocStatus'
         401:
           description: Unauthorized
         403:
@@ -115,14 +184,15 @@ paths:
       operationId: getAsyncDoc
       tags: [Doc]
       description: >
-        Downloads a document.
+        Downloads a finished document.
       security:
         - basicAuth: []
       parameters:
         - name: id
           in: path
-          description: The download_id returned from status request or a callback.
+          description: The download_id returned from an async status request or callback.
           required: true
+          type: string
       responses:
         200:
           description: Successful response
@@ -136,6 +206,30 @@ paths:
         500:
           description: Server Error
 
+  /expire/{id}:
+    patch:
+      operationId: expire
+      tags: [Doc]
+      description: >
+        Expires a previously created hosted doc.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: id
+          in: path
+          description: The download_id returned from status request or hosted document response.
+          required: true
+          type: string
+      responses:
+        200:
+          description: Successful response
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        500:
+          description: Server Error
+
 definitions:
   Doc:
     type: object
@@ -144,9 +238,6 @@ definitions:
       - document_type
       - document_content
     properties:
-      pipeline:
-        type: string
-        description: Specify a specific verison of the DocRaptor Pipeline to use.
       name:
         type: string
         description: A name for identifying your document.
@@ -171,17 +262,23 @@ definitions:
         type: boolean
         description: Enable test mode for this document. Test documents are not charged for but include a watermark.
         default: true
+      pipeline:
+        type: string
+        description: Specify a specific verison of the DocRaptor Pipeline to use.
       strict:
         type: string
         description: Force strict HTML validation.
-        default: none
         enum:
           - none
-          - true
+          - html
       ignore_resource_errors:
         type: boolean
         description: Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
         default: true
+      ignore_console_messages:
+        type: boolean
+        description: Prevent console.log from stopping document rendering during JavaScript execution.
+        default: false
       tag:
         type: string
         description: A field for storing a small amount of metadata with this document.
@@ -200,8 +297,14 @@ definitions:
         type: string
         description: >
           A URL that will receive a POST request after successfully completing an asynchronous document.
-          The POST data will include download_url and download_id similar to status api responses.
+          The POST data will include download_url and download_id similar to status API responses.
           WARNING: this only works on asynchronous documents.
+      hosted_download_limit:
+        type: integer
+        description: The number of times a hosted document can be downloaded.  If no limit is specified, the document will be available for an unlimited number of downloads.
+      hosted_expires_at:
+        type: string
+        description: The date and time at which a hosted document will be removed and no longer available. Must be a properly formatted ISO 8601 datetime, like 1981-01-23T08:02:30-05:00.
       prince_options:
         $ref: '#/definitions/PrinceOptions'
 
@@ -296,7 +399,8 @@ definitions:
           - auto
       version:
         type: string
-        description: Specify a specific verison of PrinceXML to use.
+        deprecated: true
+        description: Deprecated, use the appropriate `pipeline` version. Specify a specific verison of PrinceXML to use.
         # default: 10
         # disabled because Java will try to make an enum as 7_1 which fails
         # enum:
@@ -317,17 +421,22 @@ definitions:
         # disabled because Java will try to make an enum with PDF/A-1b which fails
         # enum:
         #   - PDF/A-1b
+        #   - PDF/A-3b # (Pipeline 6+)
+        #   - PDF/X-1a # (Pipeline 6+)
         #   - PDF/X-3:2003
         #   - PDF/X-4
+      pdf_title:
+        type: string
+        description: Specify the PDF title, part of the document's metadata.
 
   AsyncDoc:
     type: object
     properties:
       status_id:
         type: string
-        description: The identifier used to get the status of the document using the status api.
+        description: The identifier used to get the status of the document using the status API.
 
-  AsyncDocStatus:
+  DocStatus:
     type: object
     properties:
       status:
@@ -338,7 +447,7 @@ definitions:
         description: The URL where the document can be retrieved. This URL may only be used a few times.
       download_id:
         type: string
-        description: The identifier for downloading the document with the download api.
+        description: The identifier for downloading the document with the download API.
       message:
         type: string
         description: Additional information.