convert_api 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c19d784a48c22fedfcb2f00b4d150cc638b99b4688bae2d6f5bb13e28af08d
-  data.tar.gz: 775a9a90934f9447acde26c05a004f9106541603b6a2fb3fcb458dbb426cca98
+  metadata.gz: e87ee021afbce241b24e28e70245ec318a6c6ae799c1ff769cd6437a4065536f
+  data.tar.gz: b385c3030e308d7dde8d711f3b2f30d48303f5af6bc5208437b09ae329b50519
 SHA512:
-  metadata.gz: c15b8d712d8ce29cb11ad915d11676b1ff13f064c3df3655611f085f958c8ca9502352300b940bffea2ce2ccfc5f64bfc177f6b7a70262e5c43236b3f02a3b10
-  data.tar.gz: 24ad1374796432ed6a3e332676b3421e183a9224b70bea09fe2bd1c2dfa0eea86fc6c9f1ca496a0ec2a134fcb5b6fed9ead4a2edf10b1b5aee2e1342c19110ee
+  metadata.gz: 0447ac667edc5df34913612ff81003dfbcdea39a345b1fc111ecfd28dd123651d0fa2218b4942258e4aecd32266438ae2768e593ceb5c0ff7573fbb4f389d26e
+  data.tar.gz: 57a409748204a607373d4b1d2a6db8b8d7ad68a02f4da5a6aab1bf023358e6d727972f29113c606d940686c854b3a261f2e690921a3345785c394f321364a32c

data/.github/workflows/main.yml

@@ -9,8 +9,9 @@ jobs:
           - 2.0
           - 2.6
           - 2.7
-          - 3.0
-          - ruby-head
+          - 3.1
+          - 3.2
+          - 3.3
           - jruby-9.1
           - jruby-head
     name: Ruby ${{ matrix.ruby-version }} sample
@@ -23,4 +24,5 @@ jobs:
       - 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

@@ -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,7 +23,7 @@ gem 'convert_api'
 
 ### Configuration
 
-You can get your secret at https://www.convertapi.com/a
+You can get your secret at https://www.convertapi.com/a/auth
 
 ```ruby
 ConvertApi.configure do |config|
@@ -31,13 +31,22 @@ ConvertApi.configure do |config|
 end
 ```
 
+Or
+
+You can get your token at https://www.convertapi.com/a/access-tokens
+```ruby
+ConvertApi.configure do |config|
+  config.token = 'your-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
-result = ConvertApi.convert('pdf', File: '/path/to/my_file.docx')
+result = ConvertApi.convert('pdf', { File: '/path/to/my_file.docx' })
 
 # save to file
 result.file.save('/path/to/save/file.pdf')
@@ -59,7 +68,7 @@ conversion_cost = result.conversion_cost
 #### Convert file url
 
 ```ruby
-result = ConvertApi.convert('pdf', File: 'https://website/my_file.docx')
+result = ConvertApi.convert('pdf', { File: 'https://website/my_file.docx' })
 ```
 
 #### Specifying from format
@@ -67,7 +76,7 @@ result = ConvertApi.convert('pdf', File: 'https://website/my_file.docx')
 ```ruby
 result = ConvertApi.convert(
   'pdf', 
-  { File: /path/to/my_file' }, 
+  {File: /path/to/my_file'}, 
   from_format: 'docx'
 )
 ```
@@ -75,14 +84,14 @@ result = ConvertApi.convert(
 #### Additional conversion parameters
 
 ConvertAPI accepts extra conversion parameters depending on converted formats. All conversion 
-parameters and explanations can be found [here](https://www.convertapi.com).
+parameters and explanations can be found [here](https://www.convertapi.com/doc/supported-formats).
 
 ```ruby
 result = ConvertApi.convert(
   'pdf', 
-  File: /path/to/my_file.docx',
+  {File: /path/to/my_file.docx',
   PageRange: '1-10',
-  PdfResolution: '150',
+  PdfResolution: '150'}
 )
 ```
 
@@ -91,7 +100,7 @@ result = ConvertApi.convert(
 You can access result file collection like this:
 
 ```ruby
-result = ConvertApi.convert('pdf', File: 'https://website/my_file.docx')
+result = ConvertApi.convert('pdf', { File: 'https://website/my_file.docx' })
 
 puts result.files[0].url
 puts result.files[0].size
@@ -104,9 +113,20 @@ You can always check your remaining seconds programmatically by fetching [user i
 ```ruby
 user_info = ConvertApi.user
 
-puts user_info['SecondsLeft']
+puts user_info['ConversionsConsumed']
+```
+
+### Alternative domain
+
+Set config `base_uri` attribute to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/doc/servers-location).
+
+```ruby
+ConvertApi.configure do |config|
+  config.base_uri = URI('https://eu-v2.convertapi.com/')
+end
 ```
 
+
 ### More examples
 
 Find more advanced examples in the [examples/](https://github.com/ConvertAPI/convertapi-ruby/tree/master/examples) folder.
@@ -116,6 +136,10 @@ Find more advanced examples in the [examples/](https://github.com/ConvertAPI/con
 
 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.
+
 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).
 
 ## Contributing

data/lib/convert_api/client.rb

@@ -101,10 +101,10 @@ module ConvertApi
     end
 
     def request_uri(path, params = {})
-      raise(SecretError, 'API secret not configured') if config.api_secret.nil?
+      raise(AuthenticationError, 'API secret or Token not configured') if authentication.nil?
 
-      params_with_secret = params.merge(Secret: config.api_secret)
-      query = URI.encode_www_form(params_with_secret)
+      params_with_authentication = params.merge(authentication)
+      query = URI.encode_www_form(params_with_authentication)
 
       base_uri.path + path + '?' + query
     end
@@ -123,6 +123,13 @@ module ConvertApi
       data
     end
 
+    def authentication
+      return { Secret: config.api_secret } unless config.api_secret.nil?
+      return { Token: config.token } unless config.token.nil?
+
+      nil
+    end
+
     def base_uri
       config.base_uri
     end

data/lib/convert_api/configuration.rb

@@ -1,6 +1,7 @@
 module ConvertApi
   class Configuration
     attr_accessor :api_secret
+    attr_accessor :token
     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,10 +15,11 @@ module ConvertApi
 
       from_format = @from_format || detect_format(params)
       read_timeout = @conversion_timeout + config.conversion_timeout_delta if @conversion_timeout
-      converter = params[:converter] ? "/converter/#{params[:converter]}" : ''
+      converter = detect_converter(params)
+      converter_path = converter ? "/converter/#{converter}" : ''
 
       response = ConvertApi.client.post(
-        "convert/#{from_format}/to/#{@to_format}#{converter}",
+        "convert/#{from_format}/to/#{@to_format}#{converter_path}",
         params,
         read_timeout: read_timeout,
       )
@@ -32,10 +33,10 @@ module ConvertApi
       result = {}
 
       symbolize_keys(params).each do |key, value|
-        case key
-        when :File
-          result[:File] = FileParam.build(value)
-        when :Files
+        case
+        when key != :StoreFile && key.to_s.end_with?('File')
+          result[key] = FileParam.build(value)
+        when key == :Files
           result[:Files] = files_batch(value)
         else
           result[key] = value
@@ -69,6 +70,14 @@ 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.3.2'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convert_api
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Tomas Rutkauskas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2024-08-04 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"
@@ -86,7 +87,7 @@ homepage: https://github.com/ConvertAPI/convertapi-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: ConvertAPI client library
 test_files: []