convert_api 2.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87ee021afbce241b24e28e70245ec318a6c6ae799c1ff769cd6437a4065536f
-  data.tar.gz: b385c3030e308d7dde8d711f3b2f30d48303f5af6bc5208437b09ae329b50519
+  metadata.gz: 5fcd9fe8ad08c01b6cd0ca4e52208444ff3da05a10ebdf20eac4d6d8f443c94f
+  data.tar.gz: 9a4842f2843643892704f9ebfd134f98519c0a689a18fbfed0d7587b3e30330a
 SHA512:
-  metadata.gz: 0447ac667edc5df34913612ff81003dfbcdea39a345b1fc111ecfd28dd123651d0fa2218b4942258e4aecd32266438ae2768e593ceb5c0ff7573fbb4f389d26e
-  data.tar.gz: 57a409748204a607373d4b1d2a6db8b8d7ad68a02f4da5a6aab1bf023358e6d727972f29113c606d940686c854b3a261f2e690921a3345785c394f321364a32c
+  metadata.gz: dc25cd4c5fa5cd60d147d3831b7a9c24d012634681a6f1e6f5d1bb5b4095a91e56f49f30cfc890d940b5358a1e16cbd7712f05d8ccd8964eca5c5f15dd1c502b
+  data.tar.gz: afe7726d6c1e03bcc5e155c9abd593114a35857af0bc31de64dba8c0127f52449ed5368f494732202e9b77cf1d539ed1ade1c9fdcc25e98fc1578d4b5a9a71a2

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+
+## [3.0.1] — 2026-10-20
+
+### Fixed
+- No more warnings on load on current Rubies: `URI.regexp is obsolete` (Ruby 3.4+) and "CGI library is
+  removed from Ruby 4.0" (Ruby 4.0). The library now uses the RFC 2396 URI parser directly and requires
+  only `cgi/escape`. Behaviour is unchanged.
+
+### Changed
+- Tested on Ruby 3.2, 3.3, 3.4 and 4.0 (was 2.0–3.3 and JRuby). No Ruby version constraint was added: the
+  gem still installs on older Rubies, which are no longer tested.
+- The gem contains only `lib/`, `README.md`, `LICENSE.txt` and `CHANGELOG.md` (it used to ship the
+  repository's dotfiles, `Gemfile`, `Rakefile` and workflow). Its RubyGems page links to the source,
+  changelog and issues.
+- The specs that call ConvertAPI are tagged `live` and run only when `CONVERT_API_SECRET` is set.
+- Releases are now cut from a GitHub Release `v{version}` and pushed with RubyGems Trusted Publishing. See
+  [RELEASING.md](RELEASING.md).
+
+## [3.0.0] — 2024-09-14
+
+### Changed
+- Credentials are sent in the `Authorization` header and configured with `config.api_credentials` (an API
+  secret or token), which replaces `api_secret` and `token`.
+
+### Removed
+- Alternative converter support.
+
+## [2.0.0] — 2024-08-04
+
+### Added
+- Token authentication.
+
+[3.0.1]: https://github.com/ConvertAPI/convertapi-library-ruby/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/ConvertAPI/convertapi-library-ruby/compare/v2.0.0...v3.0.0
+[2.0.0]: https://github.com/ConvertAPI/convertapi-library-ruby/compare/v1.4.0...v2.0.0

data/README.md

@@ -2,7 +2,7 @@
 
 
 [![Gem](https://img.shields.io/gem/v/convert_api.svg)](https://rubygems.org/gems/convert_api)
-[![Build Status](https://github.com/ConvertAPI/convertapi-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/ConvertAPI/convertapi-ruby/actions)
+[![Build](https://github.com/ConvertAPI/convertapi-library-ruby/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/ConvertAPI/convertapi-library-ruby/actions/workflows/build.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 
@@ -23,20 +23,11 @@ gem 'convert_api'
 
 ### Configuration
 
-You can get your secret at https://www.convertapi.com/a/auth
+You can get your credentials at [https://www.convertapi.com/a/authentication](https://www.convertapi.com/a/authentication)
 
 ```ruby
 ConvertApi.configure do |config|
-  config.api_secret = 'your-api-secret'
-end
-```
-
-Or
-
-You can get your token at https://www.convertapi.com/a/access-tokens
-```ruby
-ConvertApi.configure do |config|
-  config.token = 'your-token'
+  config.api_credentials = 'api-token'
 end
 ```
 
@@ -108,7 +99,7 @@ puts result.files[0].size
 
 ### User information
 
-You can always check your remaining seconds programmatically by fetching [user information](https://www.convertapi.com/doc/user).
+You can always check your usage by fetching [user information](https://www.convertapi.com/doc/user).
 
 ```ruby
 user_info = ConvertApi.user
@@ -129,22 +120,21 @@ end
 
 ### More examples
 
-Find more advanced examples in the [examples/](https://github.com/ConvertAPI/convertapi-ruby/tree/master/examples) folder.
+Find more advanced examples in the [examples/](https://github.com/ConvertAPI/convertapi-library-ruby/tree/main/examples) folder.
 
 
 ## Development
 
-Run `CONVERT_API_SECRET=your_secret rake spec` to run the tests.
-
-Or
-
-Run `CONVERT_API_TOKEN=your_token rake spec` to run the tests.
+Run `bundle exec rake spec` to run the specs. Without an API token only the offline specs run; with
+`CONVERT_API_SECRET=your_api_token bundle exec rake spec` the specs that call ConvertAPI run too
+(set `CONVERT_API_BASE_URI` to test against another deployment).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. Releases are published from
+GitHub Releases only; see [RELEASING.md](RELEASING.md) and [CHANGELOG.md](CHANGELOG.md).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-library-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/convert_api/client.rb

@@ -1,6 +1,6 @@
 require 'net/https'
 require 'uri'
-require 'cgi'
+require 'cgi/escape'
 require 'json'
 
 module ConvertApi
@@ -30,7 +30,7 @@ module ConvertApi
 
     def get(path, params = {}, options = {})
       handle_response do
-        request = Net::HTTP::Get.new(request_uri(path, params), DEFAULT_HEADERS)
+        request = Net::HTTP::Get.new(request_uri(path, params), headers_with_auth)
 
         http(options).request(request)
       end
@@ -38,7 +38,7 @@ module ConvertApi
 
     def post(path, params, options = {})
       handle_response do
-        request = Net::HTTP::Post.new(request_uri(path), DEFAULT_HEADERS)
+        request = Net::HTTP::Post.new(request_uri(path), headers_with_auth)
         request.form_data = build_form_data(params)
 
         http(options).request(request)
@@ -101,12 +101,7 @@ module ConvertApi
     end
 
     def request_uri(path, params = {})
-      raise(AuthenticationError, 'API secret or Token not configured') if authentication.nil?
-
-      params_with_authentication = params.merge(authentication)
-      query = URI.encode_www_form(params_with_authentication)
-
-      base_uri.path + path + '?' + query
+      base_uri.path + path + '?' + URI.encode_www_form(params)
     end
 
     def build_form_data(params)
@@ -123,11 +118,16 @@ module ConvertApi
       data
     end
 
-    def authentication
-      return { Secret: config.api_secret } unless config.api_secret.nil?
-      return { Token: config.token } unless config.token.nil?
+    def headers_with_auth
+      DEFAULT_HEADERS.merge(auth_headers)
+    end
+
+    def auth_headers
+      { 'Authorization' => "Bearer #{api_credentials}" }
+    end
 
-      nil
+    def api_credentials
+      config.api_credentials || raise(AuthenticationError, 'API credentials not configured')
     end
 
     def base_uri

data/lib/convert_api/configuration.rb

@@ -1,7 +1,6 @@
 module ConvertApi
   class Configuration
-    attr_accessor :api_secret
-    attr_accessor :token
+    attr_accessor :api_credentials
     attr_accessor :base_uri
     attr_accessor :connect_timeout
     attr_accessor :read_timeout

data/lib/convert_api/task.rb

@@ -15,11 +15,9 @@ module ConvertApi
 
       from_format = @from_format || detect_format(params)
       read_timeout = @conversion_timeout + config.conversion_timeout_delta if @conversion_timeout
-      converter = detect_converter(params)
-      converter_path = converter ? "/converter/#{converter}" : ''
 
       response = ConvertApi.client.post(
-        "convert/#{from_format}/to/#{@to_format}#{converter_path}",
+        "convert/#{from_format}/to/#{@to_format}",
         params,
         read_timeout: read_timeout,
       )
@@ -70,14 +68,6 @@ module ConvertApi
       FormatDetector.new(resource, @to_format).run
     end
 
-    def detect_converter(params)
-      params.each do |key, value|
-        return value if key.to_s.downcase == 'converter'
-      end
-
-      nil
-    end
-
     def config
       ConvertApi.config
     end

data/lib/convert_api/version.rb

@@ -1,3 +1,3 @@
 module ConvertApi
-  VERSION = '2.0.0'
+  VERSION = '3.0.1'
 end

data/lib/convert_api.rb

@@ -10,7 +10,8 @@ require 'convert_api/file_param'
 require 'convert_api/format_detector'
 
 module ConvertApi
-  URI_REGEXP = URI::regexp(%w(http https))
+  # URI.regexp is obsolete since Ruby 3.4 and warns; the RFC 2396 parser is what it always used.
+  URI_REGEXP = (defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER).make_regexp(%w(http https))
   DEFAULT_URL_FORMAT = 'url'
 
   module_function

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: convert_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Tomas Rutkauskas
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,16 +61,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".github/workflows/publish.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- convert_api.gemspec
 - lib/convert_api.rb
 - lib/convert_api/client.rb
 - lib/convert_api/configuration.rb
@@ -83,11 +75,14 @@ files:
 - lib/convert_api/task.rb
 - lib/convert_api/upload_io.rb
 - lib/convert_api/version.rb
-homepage: https://github.com/ConvertAPI/convertapi-ruby
+homepage: https://github.com/ConvertAPI/convertapi-library-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/ConvertAPI/convertapi-library-ruby
+  changelog_uri: https://github.com/ConvertAPI/convertapi-library-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ConvertAPI/convertapi-library-ruby/issues
+  documentation_uri: https://www.convertapi.com/doc
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ConvertAPI client library
 test_files: []

data/.github/workflows/main.yml

@@ -1,28 +0,0 @@
-name: Build
-on: [push,pull_request]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version:
-          - 2.0
-          - 2.6
-          - 2.7
-          - 3.1
-          - 3.2
-          - 3.3
-          - jruby-9.1
-          - jruby-head
-    name: Ruby ${{ matrix.ruby-version }} sample
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-#          bundler-cache: true
-      - run: bundle install
-      - env:
-          CONVERT_API_SECRET: ${{ secrets.CONVERTAPI_SECRET }}
-          CONVERT_API_TOKEN: ${{ secrets.CONVERTAPI_TOKEN }}
-        run: bundle exec rake spec

data/.github/workflows/publish.yml

@@ -1,21 +0,0 @@
-name: Publish gem to rubygems
-on:
-  release:
-    types: [published]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-
-      # setup .gem/credentials
-      - run: mkdir -p ~/.gem
-      - env:
-          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-        run: >-
-          echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
-      - run: chmod 0600 ~/.gem/credentials
-
-      - run: gem build convert_api.gemspec --output=release.gem
-      - run: gem push release.gem

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.rspec

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

data/.ruby-version

@@ -1 +0,0 @@
-3.3.4

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in convert_api.gemspec
-gemspec

data/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/convert_api.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'convert_api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'convert_api'
-  spec.version       = ConvertApi::VERSION
-  spec.authors       = ['Tomas Rutkauskas']
-  spec.email         = ['support@convertapi.com']
-
-  spec.summary       = %q{ConvertAPI client library}
-  spec.description   = %q{Convert various files like MS Word, Excel, PowerPoint, Images to PDF and Images. Create PDF and Images from url and raw HTML. Extract and create PowerPoint presentation from PDF. Merge, Encrypt, Split, Repair and Decrypt PDF files. All supported files conversions and manipulations can be found at https://www.convertapi.com/doc/supported-formats}
-  spec.homepage      = 'https://github.com/ConvertAPI/convertapi-ruby'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|examples)/})
-  end
-
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end