docraptor 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6b898db0c2631364545a4da3f3a87ef8a249e7e1db737091e42a8095dc2ba4
-  data.tar.gz: 38cc4dd86eb0ae69502ee42c6bdd8cfc1715f8b9b425aa15c4a8089a3edaa609
+  metadata.gz: e59619a7e4c76658472337dcfedf6ecbb1a6e4cbc6bedfcb7aa80adc4fe33ae9
+  data.tar.gz: 69095f9007180960bdae69017a5a6dedf48ad1d475b0d87db92951c8a8525a14
 SHA512:
-  metadata.gz: 648892ceb32bc298f8fe5689873212106f8059d47b009164d69ccec923a8437e2209e9f7a4d30de0bda430a1a5bb260ab34133797a3a8d796b3b515119120c58
-  data.tar.gz: 1479aabfe153182ef3e0afc66b9c7e5105a2c7873cbe3fe640c6078411895dc30bbb17d58568d22db55a3383f542c2feb9ad140c4ac054de9c58f89244adeb6f
+  metadata.gz: 45931088e15d3312c18b7f55b51f07c263796ee90d5942c246a60b026ac6eea0f3fae14e3b2e1dba1f2335ff9596f5152005891033e5f01602a22558488d532e
+  data.tar.gz: 945ffc6a58c560588f05c4d8252046250af740e6804978b956f2e04785d9aa4cbc41c059b695ad656248dae3968fc2f766a12e6bf6f153cdeda925a038bb48d1

data/.docker_env.list

@@ -0,0 +1,3 @@
+TRACE
+TEST_OUTPUT_DIR=/app/tmp/test_output
+BUNDLE_PATH=/app/tmp/cache/bundle

data/.generator-language-identifier

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

data/.generator-revision

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

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.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+  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,27 @@
+.gitignore
+.gitlab-ci.yml
+.rspec
+.rubocop.yml
+.travis.yml
+Gemfile
+README.md
+Rakefile
+docraptor.gemspec
+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.1.0-SNAPSHOT

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

@@ -22,11 +22,27 @@
 # 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
+
+# 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/
-.gitignore
-LICENSE
-Rakefile
+
+# This seems to be a script related to developing openapi-generator and making
+# new test APIs.
+git_push.sh
+
+# 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,107 @@
+# 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.0.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.0.0.gem
+```
+
+(for development, run `gem install --dev ./docraptor-3.0.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'
+
+### 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', document_content: 'document_content_example'}) # Doc | The document to be created.
+
+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
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication
+

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
+# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
+AllCops:
+  TargetRubyVersion: 2.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+#Style/StringLiterals:
+#  Enabled: true
+#  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: false
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true

data/.runtime-environments

@@ -0,0 +1,10 @@
+# Versions without patch numbers will test the latest patch version. We include
+# specific patch versions to provide consistency. We include version numbers
+# without the patch version in order to automatically test the latest patch
+# version of each minor version.
+# DR gem itself requires >= 2.4, so 2.3 is out
+# 2.4: /app/lib/docraptor/models/async_doc.rb:111:in `build_from_hash': undefined method `transform_keys'
+ruby:2.5
+ruby:2.6
+ruby:2.7
+ruby:3.0

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+script:
+  - bundle install --path vendor/bundle
+  - bundle exec rspec
+  - gem build docraptor.gemspec
+  - gem install ./docraptor-3.0.0.gem

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 3.0.0 [November 15, 2022]
+* Switch API host to more secure api.docraptor.com (dropping old TLS)
+* Remove support for rubies <2.5
+* Switch from swagger v2.4.19 to openapi-generator v6.0.1 (better maintained)
+
+### 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/Gemfile

@@ -3,5 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.3.3'
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
 end

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,25 +42,20 @@ 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
 
-The majority of the code in this repo is generated using swagger-codegen on [docraptor.yaml](docraptor.yaml). You can modify this file and regenerate the client using `script/generate_language ruby`.
+The majority of the code in this repo is generated using openapi-generator on [docraptor.yaml](docraptor.yaml). You can modify this file and regenerate the client using `script/generate_language`.
 
 
 ## Release Process
@@ -70,14 +63,14 @@ The majority of the code in this repo is generated using swagger-codegen on [doc
 1. Pull latest master
 2. Merge feature branch(es) into master
 3. `script/test`
-4. Increment version in code:
-  - `swagger-config.json`
+4. Increment version: `generator-config.json`
+5. Run `script/generate_language` to update generated version numbers:
   - `lib/docraptor/version.rb`
-5. Update [CHANGELOG.md](CHANGELOG.md)
-6. Commit "Release version vX.Y.Z"
-7. `rake release`
-8. Verify package release at https://rubygems.org/gems/docraptor
-9. Refresh documentation on docraptor.com
+6. Update [CHANGELOG.md](CHANGELOG.md)
+7. Commit "Release version vX.Y.Z"
+8. `rake release[<name of your git remote corresponding to DocRaptor/docraptor-ruby>]`
+9. Verify package release at https://rubygems.org/gems/docraptor
+10. Refresh documentation on docraptor.com
 
 
 ## Version Policy

data/Rakefile

@@ -1,5 +1,4 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
 begin
   require 'rspec/core/rake_task'

data/docraptor.gemspec

@@ -5,10 +5,10 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0-SNAPSHOT
 
 =end
 
@@ -24,25 +24,12 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/docraptor/docraptor-ruby"
   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.license     = "MIT"
+  s.required_ruby_version = ">= 2.5"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.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.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 test`.split("\n")