convert_api 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9000b9daea1645e115548fbbb17edcdbcb52cdd179fda838ea40f17df85f4adc
-  data.tar.gz: 8d43ea9df0273824b2f90489e0c3f6a74403045f627161dfdc11958dbea14800
+  metadata.gz: a03a5db74661e761e600143a2156eb8b123cbd24a7b2a1f965f04cc78df567c5
+  data.tar.gz: da3d99dcba730103b6545ac4700a1e4d0d859be7c3c47fc92032e49274bcf94f
 SHA512:
-  metadata.gz: cff4a0ba9aa76cfaf50c03403b8c8376665d4bcb3c5490ab0fbf5fbbac9f88523241d383e834b9e01246be5e0a05b4cf473b8c6bcbd2196e5afdd5fd4780625c
-  data.tar.gz: 0430d681bd169f0765166b4009697488c5ba585023f64c6f83ec8bfc84177519b52319230aba6f13a8cfe52ac954cfd9ac2e17c1105a88a5009f19f355b11ece
+  metadata.gz: 1196c45816646b1f2b58acb79598c69cf9706a333f92c0d47e0bdd94f1b336a813963b8c7e84db2c3d7e0cfb39f8016626ed35eac8c144d8ab88397e0b7fadad
+  data.tar.gz: 434915e2525a5b3cf5fadd8ed2af3177844ca9aca29160efefb17d5ae2dd45485ee45075fc0f1b7a052e09513dd168a8ef94aacec7612f40068b54d7f3c25418

data/.github/workflows/main.yml

@@ -11,6 +11,7 @@ jobs:
           - 2.7
           - 3.1
           - 3.2
+          - 3.3
           - jruby-9.1
           - jruby-head
     name: Ruby ${{ matrix.ruby-version }} sample

data/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+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/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.3.4

data/README.md

@@ -23,17 +23,17 @@ gem 'convert_api'
 
 ### Configuration
 
-You can get your secret at https://www.convertapi.com/a
+You can get your credentials at https://www.convertapi.com/a/auth
 
 ```ruby
 ConvertApi.configure do |config|
-  config.api_secret = 'your-api-secret'
+  config.api_credentials = 'your-api-secret-or-token'
 end
 ```
 
 ### File conversion
 
-Example to convert file to PDF. All supported formats and options can be found 
+Example to convert file to PDF. All supported formats and options can be found
 [here](https://www.convertapi.com/doc/supported-formats).
 
 ```ruby
@@ -99,12 +99,12 @@ 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
 
-puts user_info['SecondsLeft']
+puts user_info['ConversionsConsumed']
 ```
 
 ### Alternative domain

data/lib/convert_api/client.rb

@@ -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(SecretError, 'API secret not configured') if config.api_secret.nil?
-
-      params_with_secret = params.merge(Secret: config.api_secret)
-      query = URI.encode_www_form(params_with_secret)
-
-      base_uri.path + path + '?' + query
+      base_uri.path + path + '?' + URI.encode_www_form(params)
     end
 
     def build_form_data(params)
@@ -123,6 +118,18 @@ module ConvertApi
       data
     end
 
+    def headers_with_auth
+      DEFAULT_HEADERS.merge(auth_headers)
+    end
+
+    def auth_headers
+      { 'Authorization' => "Bearer #{api_credentials}" }
+    end
+
+    def api_credentials
+      config.api_credentials || raise(AuthenticationError, 'API credentials not configured')
+    end
+
     def base_uri
       config.base_uri
     end

data/lib/convert_api/configuration.rb

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

data/lib/convert_api/errors.rb

@@ -1,6 +1,6 @@
 module ConvertApi
   class Error < StandardError; end
-  class SecretError < Error; end
+  class AuthenticationError < Error; end
   class FileNameError < Error; end
   class TimeoutError < Error; end
   class ConnectionFailed < Error; end

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 = '1.4.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convert_api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tomas Rutkauskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2024-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: ConvertAPI client library