convert_api 1.4.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9000b9daea1645e115548fbbb17edcdbcb52cdd179fda838ea40f17df85f4adc
4
- data.tar.gz: 8d43ea9df0273824b2f90489e0c3f6a74403045f627161dfdc11958dbea14800
3
+ metadata.gz: e87ee021afbce241b24e28e70245ec318a6c6ae799c1ff769cd6437a4065536f
4
+ data.tar.gz: b385c3030e308d7dde8d711f3b2f30d48303f5af6bc5208437b09ae329b50519
5
5
  SHA512:
6
- metadata.gz: cff4a0ba9aa76cfaf50c03403b8c8376665d4bcb3c5490ab0fbf5fbbac9f88523241d383e834b9e01246be5e0a05b4cf473b8c6bcbd2196e5afdd5fd4780625c
7
- data.tar.gz: 0430d681bd169f0765166b4009697488c5ba585023f64c6f83ec8bfc84177519b52319230aba6f13a8cfe52ac954cfd9ac2e17c1105a88a5009f19f355b11ece
6
+ metadata.gz: 0447ac667edc5df34913612ff81003dfbcdea39a345b1fc111ecfd28dd123651d0fa2218b4942258e4aecd32266438ae2768e593ceb5c0ff7573fbb4f389d26e
7
+ data.tar.gz: 57a409748204a607373d4b1d2a6db8b8d7ad68a02f4da5a6aab1bf023358e6d727972f29113c606d940686c854b3a261f2e690921a3345785c394f321364a32c
@@ -11,6 +11,7 @@ jobs:
11
11
  - 2.7
12
12
  - 3.1
13
13
  - 3.2
14
+ - 3.3
14
15
  - jruby-9.1
15
16
  - jruby-head
16
17
  name: Ruby ${{ matrix.ruby-version }} sample
@@ -23,4 +24,5 @@ jobs:
23
24
  - run: bundle install
24
25
  - env:
25
26
  CONVERT_API_SECRET: ${{ secrets.CONVERTAPI_SECRET }}
27
+ CONVERT_API_TOKEN: ${{ secrets.CONVERTAPI_TOKEN }}
26
28
  run: bundle exec rake spec
@@ -0,0 +1,21 @@
1
+ name: Publish gem to rubygems
2
+ on:
3
+ release:
4
+ types: [published]
5
+ jobs:
6
+ build:
7
+ runs-on: ubuntu-latest
8
+ steps:
9
+ - uses: actions/checkout@v4
10
+ - uses: ruby/setup-ruby@v1
11
+
12
+ # setup .gem/credentials
13
+ - run: mkdir -p ~/.gem
14
+ - env:
15
+ RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
16
+ run: >-
17
+ echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
18
+ - run: chmod 0600 ~/.gem/credentials
19
+
20
+ - run: gem build convert_api.gemspec --output=release.gem
21
+ - run: gem push release.gem
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- 2.6.3
1
+ 3.3.4
data/README.md CHANGED
@@ -23,7 +23,7 @@ gem 'convert_api'
23
23
 
24
24
  ### Configuration
25
25
 
26
- You can get your secret at https://www.convertapi.com/a
26
+ You can get your secret at https://www.convertapi.com/a/auth
27
27
 
28
28
  ```ruby
29
29
  ConvertApi.configure do |config|
@@ -31,9 +31,18 @@ ConvertApi.configure do |config|
31
31
  end
32
32
  ```
33
33
 
34
+ Or
35
+
36
+ You can get your token at https://www.convertapi.com/a/access-tokens
37
+ ```ruby
38
+ ConvertApi.configure do |config|
39
+ config.token = 'your-token'
40
+ end
41
+ ```
42
+
34
43
  ### File conversion
35
44
 
36
- Example to convert file to PDF. All supported formats and options can be found
45
+ Example to convert file to PDF. All supported formats and options can be found
37
46
  [here](https://www.convertapi.com/doc/supported-formats).
38
47
 
39
48
  ```ruby
@@ -104,7 +113,7 @@ You can always check your remaining seconds programmatically by fetching [user i
104
113
  ```ruby
105
114
  user_info = ConvertApi.user
106
115
 
107
- puts user_info['SecondsLeft']
116
+ puts user_info['ConversionsConsumed']
108
117
  ```
109
118
 
110
119
  ### Alternative domain
@@ -127,6 +136,10 @@ Find more advanced examples in the [examples/](https://github.com/ConvertAPI/con
127
136
 
128
137
  Run `CONVERT_API_SECRET=your_secret rake spec` to run the tests.
129
138
 
139
+ Or
140
+
141
+ Run `CONVERT_API_TOKEN=your_token rake spec` to run the tests.
142
+
130
143
  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).
131
144
 
132
145
  ## Contributing
@@ -101,10 +101,10 @@ module ConvertApi
101
101
  end
102
102
 
103
103
  def request_uri(path, params = {})
104
- raise(SecretError, 'API secret not configured') if config.api_secret.nil?
104
+ raise(AuthenticationError, 'API secret or Token not configured') if authentication.nil?
105
105
 
106
- params_with_secret = params.merge(Secret: config.api_secret)
107
- query = URI.encode_www_form(params_with_secret)
106
+ params_with_authentication = params.merge(authentication)
107
+ query = URI.encode_www_form(params_with_authentication)
108
108
 
109
109
  base_uri.path + path + '?' + query
110
110
  end
@@ -123,6 +123,13 @@ module ConvertApi
123
123
  data
124
124
  end
125
125
 
126
+ def authentication
127
+ return { Secret: config.api_secret } unless config.api_secret.nil?
128
+ return { Token: config.token } unless config.token.nil?
129
+
130
+ nil
131
+ end
132
+
126
133
  def base_uri
127
134
  config.base_uri
128
135
  end
@@ -1,6 +1,7 @@
1
1
  module ConvertApi
2
2
  class Configuration
3
3
  attr_accessor :api_secret
4
+ attr_accessor :token
4
5
  attr_accessor :base_uri
5
6
  attr_accessor :connect_timeout
6
7
  attr_accessor :read_timeout
@@ -1,6 +1,6 @@
1
1
  module ConvertApi
2
2
  class Error < StandardError; end
3
- class SecretError < Error; end
3
+ class AuthenticationError < Error; end
4
4
  class FileNameError < Error; end
5
5
  class TimeoutError < Error; end
6
6
  class ConnectionFailed < Error; end
@@ -1,3 +1,3 @@
1
1
  module ConvertApi
2
- VERSION = '1.4.0'
2
+ VERSION = '2.0.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: convert_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tomas Rutkauskas
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-07-19 00:00:00.000000000 Z
11
+ date: 2024-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -63,6 +63,7 @@ extensions: []
63
63
  extra_rdoc_files: []
64
64
  files:
65
65
  - ".github/workflows/main.yml"
66
+ - ".github/workflows/publish.yml"
66
67
  - ".gitignore"
67
68
  - ".rspec"
68
69
  - ".ruby-version"
@@ -86,7 +87,7 @@ homepage: https://github.com/ConvertAPI/convertapi-ruby
86
87
  licenses:
87
88
  - MIT
88
89
  metadata: {}
89
- post_install_message:
90
+ post_install_message:
90
91
  rdoc_options: []
91
92
  require_paths:
92
93
  - lib
@@ -101,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
101
102
  - !ruby/object:Gem::Version
102
103
  version: '0'
103
104
  requirements: []
104
- rubygems_version: 3.0.3
105
- signing_key:
105
+ rubygems_version: 3.5.11
106
+ signing_key:
106
107
  specification_version: 4
107
108
  summary: ConvertAPI client library
108
109
  test_files: []