convertapi/convertapi-ruby

A Ruby Gem for the ConvertAPI

convertapi-ruby's Issues

Gem incompatible with ruby-2.7.0 and upwards

Previously, in one of the project, I had been using this gem with ruby-2.6.5. After upgrading the ruby version to 2.7.2 I started getting some errors. Specifically when I tried to save the converted file using the save method on the ConvertApi::ResultFile module.

when I try to save the converted file like so: converted.file.save('/path/to/file')

I'm getting this error: ArgumentError (extra arguments)

Introduce alternative converter parameter in conversion method

Some formats have several converters, for example, docx to pdf has three of them listed below.
It should be a possibility to set up an alternative converter from the library in the Convert method.

https://v2.convertapi.com/convert/docx/to/pdf
https://v2.convertapi.com/convert/docx/to/pdf/converter/openoffice
https://v2.convertapi.com/convert/docx/to/pdf/converter/printer

This is only an example of a convert method on how it could implement alternative converters.

Default method

ConvertApi.convert('pdf', File: '/path/to/my_file.docx')

with alternative converter

ConvertApi.convert('pdf', File: '/path/to/my_file.docx', converter: 'openoffice')

ConvertApi::ConnectionFailed end of file reached

We are experiencing an issue while trying to convert and merge a pdf.

The error we get is
ConvertApi::ConnectionFailed end of file reached

AFAIK, we haven't touched our side of the code.

Do you have any idea what the source of this problem might be?
I went through the docs and couldn't find anything.

Also our dashboard shows 0 failures and your status page shows that everything is operational.

Change HTTP request Agent header format

Change HTTP request Agent header format from old format

convertapi-ruby-version

to

ConvertAPI-Ruby/version

Such format is more native to HTTP agent specification http://www.bizcoder.com/the-much-maligned-user-agent-header

Incorrect parameter name in URL example

In this example the parameter name is Url, but actually this generates a blank PDF (presumably there is some error that isn't reported)

convertapi-ruby/examples/convert_url_to_pdf.rb

Line 14 in 1117620

Url: 'https://en.wikipedia.org/wiki/Data_conversion',

Using File as the parameter works correctly, which is odd as this contradicts the API documentation, but matches the CLI command.

URI.encode deprecated in Ruby 3

When running with the Ruby 3 getting this error:
...lib/convert_api/client.rb:51:in 'block in upload': undefined method 'encode' for URI:Module (NoMethodError)

Change default Timeout from 600 to 180

The maximum timeout for Web to PDF API is 180 and the library default timeout is 600 which throw validation exception when used. Please change default Timeout from 600 to 180.

StoreFile not honored

The following code:

    result = ConvertApi.convert('txt', { File: document.url, StoreFile: false, RemoveHeadersFooters: true }, from_format: 'pdf')

makes a call to the url with &StoreFile=true.

I think the problem is here:

convertapi-ruby/lib/convert_api/task.rb

Line 11 in 88ed026

params = normalize_params(@params).merge(

I think you merge default parameters over top user parameters when you should be doing the merge the other way.

This seems like kind of a security risk having it this way especially since your documentation at: https://www.convertapi.com/pdf-to-txt#snippet=ruby clearly states that the default is false not true.

ConvertApiUser.SecondsLeft property is depreciated

ConvertAPI/convertapi-dotnet#50

Documentation improvement

A comment from the user:

It would be really helpful if you provided better documentation on how to access elements of the response objects your API returns. It took me forever to figure out how to actually get the files that were converted, and I did it on my own, not with your documentation. For example, it was not obvious that the response object was returning an array of files that I could access like this:

rtf_file = ConvertApi.convert('rtf', File: 'new.pdf')

rtf_url = rtf_file.files[0].url
open('rtf_file.rtf', 'wb') do |file|
file << open(rtf_url).read
end

Add Token authentication

Add Token authentication to Ruby library.

Description ConvertAPI/convertapi-dotnet#29

Can this thing convert FROM pdf

I'm trying to get text out .pdf files. Can this module do that?

Increase default TimeOut to 1000

ConvertAPI/convertapi-dotnet#23

Support thread-safe async conversions

We have a use case where some of our conversion requests will be synchronous and some will be asynchronous in the same application.

Async requests are specified by a URI path prefix instead of a request param and I don't see a way to add that prefix to the request builder in a ConvertApi::Task as it is hard-coded to start with /convert

I could modify the base_uri in ConvertApi::Configuration but that would change it for all calls to ConvertApi#convert in the current thread instead of for a single request.

Am I missing something?