docraptor 2.0.0 → 3.1.0

data/{spec → .review/generated_files/spec}/spec_helper.rb

@@ -3,10 +3,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.6.0
 
 =end
 

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,13 @@
+# 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
+ruby:3.1
+ruby:3.2
+ruby:3.3-rc

data/.travis.yml

@@ -1,9 +1,11 @@
-sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.10
-  - 2.5.9
-  - 2.6.7
-  - 2.7.3
-  - 3.0.1
+  - 2.7
+  - 3.0
+  - 3.1
+script:
+  - bundle install --path vendor/bundle
+  - bundle exec rspec
+  - gem build docraptor.gemspec
+  - gem install ./docraptor-3.1.0.gem

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 3.1.0 [July 19, 2023]
+* Add new Prince API options for pdf_forms, iframes, and page_margin
+
+### 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

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

@@ -55,7 +55,7 @@ Stuck? We're experts at turning HTML into PDFs so please [email us](mailto:suppo
 
 ## 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
@@ -63,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. `script/release`
+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.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
@@ -24,26 +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 = ">= 2.3"
+  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_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.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")