docraptor 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e59619a7e4c76658472337dcfedf6ecbb1a6e4cbc6bedfcb7aa80adc4fe33ae9
-  data.tar.gz: 69095f9007180960bdae69017a5a6dedf48ad1d475b0d87db92951c8a8525a14
+  metadata.gz: ae5113eeec4fbe7b113fe5f92c8fb7175e672beadb72ab3e96fd458484e8e5d2
+  data.tar.gz: 8923f22767e21a57af7afbf6082b9da27a23e2781ecd35947f2229ecf9ba889a
 SHA512:
-  metadata.gz: 45931088e15d3312c18b7f55b51f07c263796ee90d5942c246a60b026ac6eea0f3fae14e3b2e1dba1f2335ff9596f5152005891033e5f01602a22558488d532e
-  data.tar.gz: 945ffc6a58c560588f05c4d8252046250af740e6804978b956f2e04785d9aa4cbc41c059b695ad656248dae3968fc2f766a12e6bf6f153cdeda925a038bb48d1
+  metadata.gz: 72383235430a25aa8faa722dcdc353376ef8d9bffd2e663698b09b3149895c5bb63b3c699897ffaa7627e5275f4477017322583d6e8ebcff77d3b8136694d7ac
+  data.tar.gz: cb9a0f14cc1da9022ffd07cce3ad670e4eb742285bb6a13074af4b7edf5418da97b3d106c8cb59ec1777f21850a7d01ce3f35ee18043229de8680518d1432502

data/.docker_env.list

@@ -1,3 +1,5 @@
 TRACE
 TEST_OUTPUT_DIR=/app/tmp/test_output
 BUNDLE_PATH=/app/tmp/cache/bundle
+INSIDE_DOCKER=true
+SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock

data/.docker_mounts.list

@@ -0,0 +1,4 @@
+# Specify mounts in `docker run --volume` format (source:target). Bash
+# expressions will be evaluated.
+$(pwd)/tmp/cache_${image//:/_}:/app/tmp/cache
+/run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock

data/.generator-revision

@@ -1 +1 @@
-v6.0.1
+v6.6.0

data/.gitlab-ci.yml

@@ -7,7 +7,7 @@
     - bundle install -j $(nproc)
   parallel:
     matrix:
-      - RUBY_VERSION: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
   image: "ruby:$RUBY_VERSION"
   cache:
     paths:

data/.openapi-generator/FILES

@@ -7,6 +7,11 @@ Gemfile
 README.md
 Rakefile
 docraptor.gemspec
+docs/AsyncDoc.md
+docs/Doc.md
+docs/DocApi.md
+docs/DocStatus.md
+docs/PrinceOptions.md
 lib/docraptor.rb
 lib/docraptor/api/doc_api.rb
 lib/docraptor/api_client.rb

data/.openapi-generator/VERSION

@@ -1 +1 @@
-6.1.0-SNAPSHOT
+6.6.0

data/.openapi-generator-ignore

@@ -23,16 +23,6 @@
 #!docs/README.md
 
 
-# These are autogenerated and aren't exactly what we want. We rely on the
-# readme, and website documentation.
-# TODO: Ideally, when updating the agent, it would be nice to see the
-# differences between when the previous version and the new version generated.
-# This would help make it more obvious when the agent supported a newer usage
-# pattern that we might prefer.
-# TODO: Consider if it's possible to make the generated docs more useful so we
-# might actually want to use them.
-docs/
-
 # This seems to be a script related to developing openapi-generator and making
 # new test APIs.
 git_push.sh

data/.review/generated_files/README.md

@@ -7,7 +7,7 @@ A native client library for the DocRaptor HTML to PDF/XLS service.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 3.0.0
+- Package version: 3.1.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build docraptor.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./docraptor-3.0.0.gem
+gem install ./docraptor-3.1.0.gem
 ```
 
-(for development, run `gem install --dev ./docraptor-3.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./docraptor-3.1.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'docraptor', '~> 3.0.0'
+    gem 'docraptor', '~> 3.1.0'
 
 ### Install from Git
 
@@ -64,7 +64,7 @@ DocRaptor.configure do |config|
 end
 
 api_instance = DocRaptor::DocApi.new
-doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf', document_content: 'document_content_example'}) # Doc | The document to be created.
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
 
 begin
   result = api_instance.create_async_doc(doc)
@@ -101,6 +101,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### basicAuth
 
 - **Type**: HTTP basic authentication

data/.review/generated_files/docs/AsyncDoc.md

@@ -0,0 +1,18 @@
+# DocRaptor::AsyncDoc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_id** | **String** | The identifier used to get the status of the document using the status API. | [optional] |
+
+## Example
+
+```ruby
+require 'docraptor'
+
+instance = DocRaptor::AsyncDoc.new(
+  status_id: null
+)
+```
+

data/.review/generated_files/docs/Doc.md

@@ -0,0 +1,50 @@
+# DocRaptor::Doc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for identifying your document. |  |
+| **document_type** | **String** | The type of document being created. |  |
+| **document_content** | **String** | The HTML data to be transformed into a document. You must supply content using document_content or document_url.  | [optional] |
+| **document_url** | **String** | The URL to fetch the HTML data to be transformed into a document. You must supply content using document_content or document_url.  | [optional] |
+| **test** | **Boolean** | Enable test mode for this document. Test documents are not charged for but include a watermark. | [optional][default to true] |
+| **pipeline** | **String** | Specify a specific verison of the DocRaptor Pipeline to use. | [optional] |
+| **strict** | **String** | Force strict HTML validation. | [optional] |
+| **ignore_resource_errors** | **Boolean** | Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop. | [optional][default to true] |
+| **ignore_console_messages** | **Boolean** | Prevent console.log from stopping document rendering during JavaScript execution. | [optional][default to false] |
+| **tag** | **String** | A field for storing a small amount of metadata with this document. | [optional] |
+| **help** | **Boolean** | Request support help with this request if it succeeds. | [optional][default to false] |
+| **javascript** | **Boolean** | Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere. | [optional][default to false] |
+| **referrer** | **String** | Set HTTP referrer when generating this document. | [optional] |
+| **callback_url** | **String** | 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. WARNING: this only works on asynchronous documents.  | [optional] |
+| **hosted_download_limit** | **Integer** | 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. | [optional] |
+| **hosted_expires_at** | **String** | 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. | [optional] |
+| **prince_options** | [**PrinceOptions**](PrinceOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docraptor'
+
+instance = DocRaptor::Doc.new(
+  name: null,
+  document_type: null,
+  document_content: null,
+  document_url: null,
+  test: null,
+  pipeline: null,
+  strict: null,
+  ignore_resource_errors: null,
+  ignore_console_messages: null,
+  tag: null,
+  help: null,
+  javascript: null,
+  referrer: null,
+  callback_url: null,
+  hosted_download_limit: null,
+  hosted_expires_at: null,
+  prince_options: null
+)
+```
+

data/.review/generated_files/docs/DocApi.md

@@ -0,0 +1,503 @@
+# DocRaptor::DocApi
+
+All URIs are relative to *https://api.docraptor.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_async_doc**](DocApi.md#create_async_doc) | **POST** /async_docs |  |
+| [**create_doc**](DocApi.md#create_doc) | **POST** /docs |  |
+| [**create_hosted_async_doc**](DocApi.md#create_hosted_async_doc) | **POST** /hosted_async_docs |  |
+| [**create_hosted_doc**](DocApi.md#create_hosted_doc) | **POST** /hosted_docs |  |
+| [**expire**](DocApi.md#expire) | **PATCH** /expire/{id} |  |
+| [**get_async_doc**](DocApi.md#get_async_doc) | **GET** /download/{id} |  |
+| [**get_async_doc_status**](DocApi.md#get_async_doc_status) | **GET** /status/{id} |  |
+
+
+## create_async_doc
+
+> <AsyncDoc> create_async_doc(doc)
+
+
+
+Creates a 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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_async_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_async_doc: #{e}"
+end
+```
+
+#### Using the create_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncDoc>, Integer, Hash)> create_async_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_async_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncDoc>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+[**AsyncDoc**](AsyncDoc.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_doc
+
+> String create_doc(doc)
+
+
+
+Creates a document synchronously. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_doc: #{e}"
+end
+```
+
+#### Using the create_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> create_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_hosted_async_doc
+
+> <AsyncDoc> create_hosted_async_doc(doc)
+
+
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_hosted_async_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_async_doc: #{e}"
+end
+```
+
+#### Using the create_hosted_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncDoc>, Integer, Hash)> create_hosted_async_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_hosted_async_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncDoc>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+[**AsyncDoc**](AsyncDoc.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_hosted_doc
+
+> <DocStatus> create_hosted_doc(doc)
+
+
+
+Creates a hosted document synchronously. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | The document to be created.
+
+begin
+  
+  result = api_instance.create_hosted_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_doc: #{e}"
+end
+```
+
+#### Using the create_hosted_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DocStatus>, Integer, Hash)> create_hosted_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_hosted_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocStatus>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) | The document to be created. |  |
+
+### Return type
+
+[**DocStatus**](DocStatus.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## expire
+
+> expire(id)
+
+
+
+Expires a previously created hosted doc. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The download_id returned from status request or hosted document response.
+
+begin
+  
+  api_instance.expire(id)
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->expire: #{e}"
+end
+```
+
+#### Using the expire_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> expire_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.expire_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->expire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The download_id returned from status request or hosted document response. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_async_doc
+
+> String get_async_doc(id)
+
+
+
+Downloads a finished document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The download_id returned from an async status request or callback.
+
+begin
+  
+  result = api_instance.get_async_doc(id)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc: #{e}"
+end
+```
+
+#### Using the get_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_async_doc_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_async_doc_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The download_id returned from an async status request or callback. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## get_async_doc_status
+
+> <DocStatus> get_async_doc_status(id)
+
+
+
+Check on the status of an asynchronously created document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The status_id returned when creating an asynchronous document.
+
+begin
+  
+  result = api_instance.get_async_doc_status(id)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_status: #{e}"
+end
+```
+
+#### Using the get_async_doc_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DocStatus>, Integer, Hash)> get_async_doc_status_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_async_doc_status_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocStatus>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The status_id returned when creating an asynchronous document. |  |
+
+### Return type
+
+[**DocStatus**](DocStatus.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+