docraptor 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd3d5b8d3364bd02c04b712136686d4a714f6cd3ab3fced0c7efae7e9709ee0
-  data.tar.gz: 89d4fb74883b56c49a71eef45487534474a8f9fa0ae8fc065a592e6a1ae7340c
+  metadata.gz: ae5113eeec4fbe7b113fe5f92c8fb7175e672beadb72ab3e96fd458484e8e5d2
+  data.tar.gz: 8923f22767e21a57af7afbf6082b9da27a23e2781ecd35947f2229ecf9ba889a
 SHA512:
-  metadata.gz: 964a77fd28bb343dd5410b01e5b6981f631fd5c0ed047225b2dc048b8070249d9d704bb7a4bd289d154b406e8b794a2ac71e7d031af047bb8c47a0500c86b29d
-  data.tar.gz: 90787b9656e2455038833d260caf62b7aa48ce833d3de5e1483c1a9893feed6e0deb5d4cb995ee565510c0c3bfabe7e851decdf5cae00fd0389dc07d8319ff90
+  metadata.gz: 72383235430a25aa8faa722dcdc353376ef8d9bffd2e663698b09b3149895c5bb63b3c699897ffaa7627e5275f4477017322583d6e8ebcff77d3b8136694d7ac
+  data.tar.gz: cb9a0f14cc1da9022ffd07cce3ad670e4eb742285bb6a13074af4b7edf5418da97b3d106c8cb59ec1777f21850a7d01ce3f35ee18043229de8680518d1432502

data/.docker_env.list

@@ -0,0 +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-language-identifier

@@ -0,0 +1 @@
+ruby

data/.generator-revision

@@ -0,0 +1 @@
+v6.6.0

data/.github/pull_request_template.txt

@@ -0,0 +1,17 @@
+Why is this change needed?
+--------------------------
+
+How does it address the issue?
+------------------------------
+
+Any links to any relevant tickets, articles, or other resources?
+---------------------------------------------------------------
+
+Any screenshots?
+----------------
+
+Did you complete all of the following?
+--------------------------------------
+- Run test suite?
+- Add new tests?
+- Consider security implications and practices?

data/.gitignore

@@ -1,3 +1,6 @@
+# Generated by: https://openapi-generator.tech
+#
+
 *.gem
 *.rbc
 /.config
@@ -25,21 +28,24 @@ build/
 /.bundle/
 /vendor/bundle
 /lib/bundler/man/
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-.rvmrc
-.rubocop.yml
 
-## Ignore dumb OSX files
-.DS_Store
-Thumbs.db
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
 
-## Ignore baked in swagger generator
-swagger-codegen
 
-## Ignore dumb emacs files
-*~
+# EB Customizations
 
-## Ignore files that contain special keys
-.docraptor_key
+# Ignore this so we don't see a git modified status on each test run. Currently
+# the tests copy a different file into place for each ruby version, because the
+# same lock file won't work with every ruby version. We want those lock files
+# committed because it helps ensure the tests pass on this repo by ensuring a
+# static set of dependencies is used for each ruby version. A future improvement
+# could be to use docker to mount the correct lock file over top of the top
+# level lock file on each docker run, but that's a future exercise.
+Gemfile.lock

data/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+

data/.openapi-generator/FILES

@@ -0,0 +1,32 @@
+.gitignore
+.gitlab-ci.yml
+.rspec
+.rubocop.yml
+.travis.yml
+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
+lib/docraptor/api_error.rb
+lib/docraptor/configuration.rb
+lib/docraptor/models/async_doc.rb
+lib/docraptor/models/doc.rb
+lib/docraptor/models/doc_status.rb
+lib/docraptor/models/prince_options.rb
+lib/docraptor/version.rb
+spec/api/doc_api_spec.rb
+spec/api_client_spec.rb
+spec/configuration_spec.rb
+spec/models/async_doc_spec.rb
+spec/models/doc_spec.rb
+spec/models/doc_status_spec.rb
+spec/models/prince_options_spec.rb
+spec/spec_helper.rb

data/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.6.0

data/{.swagger-codegen-ignore → .openapi-generator-ignore}

@@ -22,11 +22,17 @@
 # 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
+
+# This seems to be a script related to developing openapi-generator and making
+# new test APIs.
 git_push.sh
-docs/
-.gitignore
-LICENSE
-Rakefile
+
+# Don't ignore this because we want to review the generated content to see if we
+# should update our own readme similarly. The most common example is an update
+# to the supported runtime versions, but it could also be an update to the
+# recommended usage that we would want to use.
+!README.md
+
+# Don't ignore this because we want to know about new files that the generator
+# ignores.
+!.gitignore

data/.review/README.md

@@ -0,0 +1,16 @@
+# Review newly generated files
+
+This directory helps with review of generated files where we lagely want
+the content to be custom.
+
+The project `README.md` is a good example. We heavily custimize
+`README.md` based on our particular use case. There are also important
+changes to the generated `README.md` that should be reviewed when it is
+updated. These include things like new minimum language versions, or
+client API changes.
+
+If you add the `README.md` to the `.openapi-generator-ignore` list then
+you never see the updates, making it easy to miss things. If you don't
+add it to the `.openapi-generator-ignore` list then any uncommitted
+updates to the `README.md` are lost when running
+`script/generate_language`.

data/.review/generated_files/.gitignore

@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.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/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.review/generated_files/README.md

@@ -0,0 +1,108 @@
+# docraptor
+
+DocRaptor - the Ruby gem for the DocRaptor
+
+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.1.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build docraptor.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./docraptor-3.1.0.gem
+```
+
+(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.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'docraptor', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+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 "Exception when calling DocApi->create_async_doc: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.docraptor.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DocRaptor::DocApi* | [**create_async_doc**](docs/DocApi.md#create_async_doc) | **POST** /async_docs | 
+*DocRaptor::DocApi* | [**create_doc**](docs/DocApi.md#create_doc) | **POST** /docs | 
+*DocRaptor::DocApi* | [**create_hosted_async_doc**](docs/DocApi.md#create_hosted_async_doc) | **POST** /hosted_async_docs | 
+*DocRaptor::DocApi* | [**create_hosted_doc**](docs/DocApi.md#create_hosted_doc) | **POST** /hosted_docs | 
+*DocRaptor::DocApi* | [**expire**](docs/DocApi.md#expire) | **PATCH** /expire/{id} | 
+*DocRaptor::DocApi* | [**get_async_doc**](docs/DocApi.md#get_async_doc) | **GET** /download/{id} | 
+*DocRaptor::DocApi* | [**get_async_doc_status**](docs/DocApi.md#get_async_doc_status) | **GET** /status/{id} | 
+
+
+## Documentation for Models
+
+ - [DocRaptor::AsyncDoc](docs/AsyncDoc.md)
+ - [DocRaptor::Doc](docs/Doc.md)
+ - [DocRaptor::DocStatus](docs/DocStatus.md)
+ - [DocRaptor::PrinceOptions](docs/PrinceOptions.md)
+
+
+## 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
+)
+```
+