Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)
MIT License

Copyright (c) 2018 Tomas Rutkauskas
Copyright (c) 2012-2026 ConvertAPI

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ end
### File conversion

Example to convert file to PDF. All supported formats and options can be found
[here](https://www.convertapi.com/doc/supported-formats).
[here](https://www.convertapi.com/api).

```ruby
result = ConvertApi.convert('pdf', { File: '/path/to/my_file.docx' })
Expand Down Expand Up @@ -67,22 +67,22 @@ 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'
)
```

#### 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/doc/supported-formats).
parameters and explanations can be found [here](https://www.convertapi.com/api).

```ruby
result = ConvertApi.convert(
'pdf',
{File: /path/to/my_file.docx',
PageRange: '1-10',
PdfResolution: '150'}
'pdf',
{ File: '/path/to/my_file.docx',
PageRange: '1-10',
Pdfa: true }
)
```

Expand All @@ -99,7 +99,7 @@ puts result.files[0].size

### User information

You can always check your usage by fetching [user information](https://www.convertapi.com/doc/user).
You can always check your usage by fetching [user information](https://www.convertapi.com/docs/user-information).

```ruby
user_info = ConvertApi.user
Expand All @@ -109,7 +109,7 @@ 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).
Set config `base_uri` attribute to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/docs/servers-location).

```ruby
ConvertApi.configure do |config|
Expand Down Expand Up @@ -142,7 +142,7 @@ GitHub Releases only; see [RELEASING.md](RELEASING.md) and [CHANGELOG.md](CHANGE

## Contributing

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.
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](https://www.contributor-covenant.org) code of conduct.

## License

Expand Down
21 changes: 21 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security policy

## Reporting a vulnerability

Please do not report security vulnerabilities in public GitHub issues, discussions or pull requests.

Report them privately on GitHub instead: open the [Security tab](https://github.com/ConvertAPI/convertapi-library-ruby/security) of this repository and click "Report a vulnerability", or go straight to [the report form](https://github.com/ConvertAPI/convertapi-library-ruby/security/advisories/new). Only you and the maintainers can see the report.

Please include:

- the version of the convert_api gem and of Ruby you use;
- the steps to reproduce the issue, or a proof of concept;
- what an attacker could do with it.

We will confirm that we received your report and keep you updated until it is fixed. Please give us reasonable time to release a fix before you disclose the issue publicly.

You can use the same private route if you are not sure whether the issue is in this SDK or in the ConvertAPI service itself.

## Supported versions

Security fixes are released in the latest version of the [convert_api gem on RubyGems](https://rubygems.org/gems/convert_api). Please check that the issue still occurs with the latest version before you report it.
Loading