Project

conserva

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
conservamosk1995/conserva_gemDocumentationSource CodeWiki
Gem for work with conversion service - conserva.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,935
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.2.3
Total releases
1
First release
2016-06-09
Latest release
2016-06-09
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-07-21
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
json
>= 0
pry
>= 0
rake
>= 0
rspec
>= 0
sinatra
>= 0
sinatra-contrib
>= 0
webmock
>= 0

Runtime

net-ping
>= 0
rest-client
>= 0
 Project Readme

Conserva

Ruby gem for Convert Service AWESOME" Gem for work with convert service - conserva."

Before working get personal API key. Оnly user who create task can get information, remove and download task.

Base functions

Before work gem must initialized. By default proxy initialized as nil. Example:

Conserva.initialize('123.123.123.123:1234', '2195038e-c3f4-48bb-94a5-65c7739c10e8')

Conserva.initialize('123.123.123.123:1234', '2195038e-c3f4-48bb-94a5-65c7739c10e8', proxy: '1.1.1.1:3000')

For getting all possible combinations for conversion should use:

Conserva.valid_file_convertations
➔ [[doc, pdf], [txt, pdf], [bmp, jpg]]

For creating task on server:

Conserva.create_task(File.new('/home/evan/test_file.txt'),'txt', 'pdf')
➔ 1034

Getting information about created task:

Conserva.task_info(1034)
➔ {"source_file"=>"1466583406242_test_file.txt", "converted_file"=>nil, "input_extension"=>"txt", "output_extension"=>"pdf", "state"=>"rec", "created_at"=>"2016-06-22 11:16:46 +0300", "updated_at"=>nil, "finished_at"=>nil, "source_file_sha256"=>"5cd3aca2394b25e57526c0ebb6934710e426e403db1974d7dff785cf8bcdea25", "result_file_sha256"=>nil}

Checking task readness:

Conserva.task_ready?(identifier_task)

Downloading file. By default, gem verify downloaded file by comparsion checksum. For disabling validation, should add to options, check_sum: false. Two examples:

# downloading file with verification
file_data = Conserva.download_file(1234)
File.open('local_file.pdf', "w") do |file|
   file.write(file_data)
end

# downloading file without verification
file_data = Conserva.download_file(1235, check_sum: false)

Removing task. If task in progress, will be thrown exception Conserva::TaskLocked.

Conserva.remove_task(identifier_task)

Exceptions

All exceptions inherited from base class Conserva::ConvertError.

Example usage

require 'conserva'
require 'digest'

begin
    conserva_address = '123.123.123.123:1234'
    api_key = '2195038e-c3f4-48bb-94a5-65c7739c10e8'
    proxy = '1.1.1.1:3000'

    Conserva.initialize(conserva_address, api_key, proxy: proxy)

    identifier_task = Conserva.create_task(File.new('/home/evan/test_file.txt'),'txt', 'pdf')
    ➔ 1234

    if Conserva.task_ready?(identifier_task)
        file_data = Conserva.download_file(identifier_task)
        File.open('local_file.pdf', "w") do |file|
           file.write(file_data)
        end
    end

    Conserva.task_info(indentifier_task)
    ➔ { "source_file" => "1466583406242_test_file.txt",
        "converted_file" => "1466583406242_test_file.pdf",
        "input_extension" => "txt",
        "output_extension" => "pdf",
        "state" => "succ",
        "created_at" => "2016-06-22 11:16:46 +0300",
        "updated_at" => 2016-06-22 11:16:47 +0300,
        "finished_at" => 2016-06-22 11:16:47 +0300,
        "source_file_sha256" => "5cd3aca2394b25e57526c0ebb6934710e426e403db1974d7dff785cf8bcdea25",
        "result_file_sha256" => "3c9ba016f68cee0e5124467ba2d15ad8c2e94e72941f7ac1dc40564e80b7e9ad"
      }

    Conserva.remove_task(identifier_task)
rescue Conserva::ConvertError => exception
    # handling Conserva exceptions
end