onlyoffice_documentserver_conversion_helper 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cddd11a1a80052f9232c9d8f1e6a2eb3fc066ed94dc1c407ec437869126abd49
+  data.tar.gz: da14479675d910bca3de929b55d4e9633f5f5a149438bccf52ce47b57e2793d7
+SHA512:
+  metadata.gz: a4e053b7993029e73996d969771891fc201add85ccb1e20c7a2de55bdbf77415488196c64de9dd777c66ff97eb01bd9d2e635f2ed4e87f8027dfe806962db02c
+  data.tar.gz: 364db58bb120d6688738a4ecd77dfd47a4bdbca0d58ce597edff31a21f3619e9e466bf7413a99cf2c46cd24b1ced9bd05eb74d2fa3c350f967316ed6c803a55f

data/README.md

@@ -0,0 +1 @@
+# onlyoffice_documentserver_conversion_helper

data/lib/onlyoffice_documentserver_conversion_helper.rb

@@ -0,0 +1,120 @@
+require 'jwt'
+require 'net/http'
+require 'securerandom'
+require 'timeout'
+require_relative 'onlyoffice_documentserver_conversion_helper/version'
+
+# Stuff for working with conversion service
+# See: https://api.onlyoffice.com/editors/conversionapi
+module OnlyofficeDocumentserverConversionHelper
+  # ==== Examples
+  # ConvertFileData.new('https://doc-linux.teamlab.info').perform_convert('http://testrail-nct.tk/files/convertation_select/googerd.docx')
+  # ConvertFileData.new('https://doc-linux.teamlab.info').perform_convert({:url=>'http://testrail-nct.tk/files/convertation_select/googerd.docx'})
+  # ConvertFileData.new('https://doc-linux.teamlab.info').perform_convert({:url=>'http://testrail-nct.tk/files/convertation_select/googerd.docx', :outputtype => 'pdf'})
+  class ConvertFileData
+    attr_accessor :file_url
+    attr_accessor :key
+    attr_writer :input_filetype
+    attr_accessor :output_file_type
+
+    DOCUMENT_EXTENSIONS = %w[TXT HTML HTM ODT DOCT DOCX RTF DOC PDF].freeze
+    SPREADSHEET_EXTENSIONS = %w[XLS XLSX ODS XLST].freeze
+    PRESENTATION_EXTENSIONS = %w[PPT PPTX PPTT ODP].freeze
+
+    def initialize(server_path,
+                   jwt_key: 'jwt_key',
+                   jwt_header: 'AuthorizationJwt',
+                   jwt_prefix: 'Bearer',
+                   timeout: 300)
+      @server_path = server_path
+      @jwt_key = jwt_key
+      @jwt_header = jwt_header
+      @jwt_prefix = jwt_prefix
+      @timeout = timeout
+    end
+
+    def output_file_type_auto
+      return 'docx' if DOCUMENT_EXTENSIONS.include?(@input_filetype.upcase)
+      return 'xlsx' if SPREADSHEET_EXTENSIONS.include?(@input_filetype.upcase)
+      return 'pptx' if PRESENTATION_EXTENSIONS.include?(@input_filetype.upcase)
+    end
+
+    def key_auto
+      SecureRandom.uuid
+    end
+
+    def input_filetype
+      File.extname(@file_url).delete('.')
+    end
+
+    def convert_url
+      "#{@server_path}/ConvertService.ashx"
+    end
+
+    def autocomplete_missing_params(params)
+      params[:key] = key_auto unless params.key?(:key)
+      params[:outputtype] = output_file_type_auto unless params.key?(:outputtype)
+      params[:filetype] = input_filetype unless params.key?(:filetype)
+      params
+    end
+
+    # @return [String] with url to result file
+    # @param [String] data is a response body
+    # @param [String] file_format is a format of result file
+    # Method will get link from response body. Link start from 'https', and end from result file format
+    def get_url_from_responce(data, file_format)
+      res_result = /(http|https).*(#{file_format})/.match(data)
+      CGI.unescapeHTML(res_result.to_s)
+    end
+
+    def add_jwt_data(request)
+      payload_to_encode = { 'payload' => '{}' }
+      jwt_encoded = JWT.encode payload_to_encode, @jwt_key
+      request[@jwt_header] = "#{@jwt_prefix} #{jwt_encoded}"
+    end
+
+    def request(convert_url, params)
+      uri = URI(convert_url)
+      req = Net::HTTP::Post.new(uri)
+      req.body = params.to_json
+      add_jwt_data(req)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = @timeout
+      http.use_ssl = true if uri.scheme == 'https'
+      send_request(http, req)
+    end
+
+    # sending request every 5 second within @timeout
+    # responce will contain 504 if
+    # return responce body
+    def send_request(http, req)
+      Timeout.timeout(@timeout) do
+        (@timeout / 5).times do
+          responce = http.request(req)
+          return responce.body unless responce.code == '504'
+          sleep 5
+        end
+      end
+    end
+
+    # @return [Hash] with usl for download file after conversion and response data
+    # @param [Hash] args collect all parameters of request OR [String] if you not need to use advensed params and want to set all etc params automaticly.
+    # All args, except of :url and if it is [Hash], will be attache in end of request
+    # ==== Examples
+    # perform_convert('https://google.com/filename.docx')
+    # perform_convert({:url => 'https://google.com/filename.docx'})
+    # perform_convert({:url => 'https://google.com/filename.docx',
+    #                 :key=>'askjdhaskdasdasdi',
+    #                 :outputtype => 'pdf'})
+    def perform_convert(args = {})
+      args = { url: args } if args.is_a?(String)
+      raise 'Parameter :url with link on file is necessary!!' if args[:url].nil? || args.nil?
+      @file_url = args[:url]
+      @input_filetype = File.extname(@file_url).delete('.')
+      advanced_params = autocomplete_missing_params(args)
+      data = request(convert_url, advanced_params)
+      url = get_url_from_responce(data, advanced_params[:outputtype])
+      { url: url, data: data }
+    end
+  end
+end

data/lib/onlyoffice_documentserver_conversion_helper/version.rb

@@ -0,0 +1,6 @@
+module OnlyofficeDocumentserverConversionHelper
+  # This module holds the OnlyofficeDocumentserverConversionHelper gem version
+  module Version
+    STRING = '0.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_documentserver_conversion_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Pavel Lobashov
+- Dmitry Rotaty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Helper method for using ONLYOFFICE DocumentServer conversion api
+email:
+- shockwavenn@gmail.com
+- flaminestone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/onlyoffice_documentserver_conversion_helper.rb
+- lib/onlyoffice_documentserver_conversion_helper/version.rb
+homepage: http://rubygems.org/gems/onlyoffice_documentserver_conversion_helper
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: onlyoffice_documentserver_conversion_helper Gem
+test_files: []