RubyGems - onlyoffice_documentserver_conversion_helper - Versions diffs - 0.1.1 → 0.4.0 - Mend

onlyoffice_documentserver_conversion_helper 0.1.1 → 0.4.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.

Files changed (7) hide show

checksums.yaml +4 -4
data/lib/onlyoffice_documentserver_conversion_helper/name.rb +9 -0
data/lib/onlyoffice_documentserver_conversion_helper/version.rb +4 -1
data/lib/onlyoffice_documentserver_conversion_helper/xml_responce_parser.rb +17 -0
data/lib/onlyoffice_documentserver_conversion_helper.rb +48 -13
metadata +147 -9
data/README.md +0 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddd11a1a80052f9232c9d8f1e6a2eb3fc066ed94dc1c407ec437869126abd49
-  data.tar.gz: da14479675d910bca3de929b55d4e9633f5f5a149438bccf52ce47b57e2793d7
+  metadata.gz: 2052d02f45954ff45a8a5d222d3387e2492b6f81b7790d27a0a270d1ebde0700
+  data.tar.gz: 112a1889a8471d5fcc1d90dd726a5fce1d4b68c976b2e72c3d97638b9a2aade9
 SHA512:
-  metadata.gz: a4e053b7993029e73996d969771891fc201add85ccb1e20c7a2de55bdbf77415488196c64de9dd777c66ff97eb01bd9d2e635f2ed4e87f8027dfe806962db02c
-  data.tar.gz: 364db58bb120d6688738a4ecd77dfd47a4bdbca0d58ce597edff31a21f3619e9e466bf7413a99cf2c46cd24b1ced9bd05eb74d2fa3c350f967316ed6c803a55f
+  metadata.gz: 6f06371b23c50fc660a9aa4ee76b82cfa7e6513d62d61491320115fa566ba20950f7bdd388fa956fdf52de1c8c6b4917b060569d03ea91079c3779177341722f
+  data.tar.gz: 0eeee137a054d173b5fa083990e5a06aa1db09e33684353f4e050557db5d50722a7c1047c523ac82e3baeaa29475c5d8448df07b3809b25f3838a0b7085020d4

data/lib/onlyoffice_documentserver_conversion_helper/name.rb ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module OnlyofficeDocumentserverConversionHelper
+  # This module holds the OnlyofficeDocumentserverConversionHelper gem name
+  module Name
+    # @return [String] name of gem
+    STRING = 'onlyoffice_documentserver_conversion_helper'
+  end
+end

data/lib/onlyoffice_documentserver_conversion_helper/version.rb CHANGED Viewed

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 module OnlyofficeDocumentserverConversionHelper
   # This module holds the OnlyofficeDocumentserverConversionHelper gem version
   module Version
-    STRING = '0.1.1'.freeze
+    # @return [String] version of gem
+    STRING = '0.4.0'
   end
 end

data/lib/onlyoffice_documentserver_conversion_helper/xml_responce_parser.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Class for parse Xml responce
+class XmlResponceParser
+  def initialize(string_with_xml, file_format)
+    @string_with_xml = string_with_xml
+    @file_format = file_format
+  end
+  # Method parses server response
+  # returning url with unescape HTML
+  # @return [String] URL
+  def result_url
+    res_result = /(http|https).*\.(#{@file_format})/.match(@string_with_xml)
+    CGI.unescapeHTML(res_result.to_s)
+  end
+end

data/lib/onlyoffice_documentserver_conversion_helper.rb CHANGED Viewed

@@ -1,24 +1,36 @@
+# frozen_string_literal: true
 require 'jwt'
 require 'net/http'
 require 'securerandom'
 require 'timeout'
+require_relative 'onlyoffice_documentserver_conversion_helper/xml_responce_parser'
 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'})
+  # converter = ConvertFileData.new('https://server')
+  # converter.perform_convert('http://files/googerd.docx')
+  # converter.perform_convert({:url=>'http://files/googerd.docx'})
+  # converter.perform_convert({:url=>'http://files/googerd.docx',
+  #                            :outputtype => 'pdf'})
   class ConvertFileData
+    # @return [String] file_url to convert
     attr_accessor :file_url
+    # @return [String] key for convert operation
     attr_accessor :key
+    # @return [String] input_filetype format
     attr_writer :input_filetype
+    # @return [String] output_file_type format
     attr_accessor :output_file_type
+    # @return [Array<String>] list of text formats
     DOCUMENT_EXTENSIONS = %w[TXT HTML HTM ODT DOCT DOCX RTF DOC PDF].freeze
+    # @return [Array<String>] list of spreadsheet formats
     SPREADSHEET_EXTENSIONS = %w[XLS XLSX ODS XLST].freeze
+    # @return [Array<String>] list of presentation formats
     PRESENTATION_EXTENSIONS = %w[PPT PPTX PPTT ODP].freeze
     def initialize(server_path,
@@ -33,24 +45,33 @@ module OnlyofficeDocumentserverConversionHelper
       @timeout = timeout
     end
+    # Auto detect output file format
+    # @return [String] result format
     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
+    # @return [String] random generated key
     def key_auto
       SecureRandom.uuid
     end
+    # Get input file name from url
+    # @return [String] result file name
     def input_filetype
       File.extname(@file_url).delete('.')
     end
+    # @return [String] convert service url
     def convert_url
       "#{@server_path}/ConvertService.ashx"
     end
+    # Complete missing params
+    # @param [Hash] params manually defined
+    # @return [Hash] filled params hash
     def autocomplete_missing_params(params)
       params[:key] = key_auto unless params.key?(:key)
       params[:outputtype] = output_file_type_auto unless params.key?(:outputtype)
@@ -61,18 +82,26 @@ module OnlyofficeDocumentserverConversionHelper
     # @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
+    # 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
+    # Add jwt data to request
+    # @param [Net::HTTP::Post] request to add data
+    # @return [Net::HTTP::Post] request with JWT
     def add_jwt_data(request)
-      payload_to_encode = { 'payload' => '{}' }
+      payload_to_encode = { 'payload' => JSON.parse(request.body) }
       jwt_encoded = JWT.encode payload_to_encode, @jwt_key
       request[@jwt_header] = "#{@jwt_prefix} #{jwt_encoded}"
     end
+    # Make request
+    # @param [String] convert_url to call
+    # @param [Hash] params with options
+    # @return [String] body of responce
     def request(convert_url, params)
       uri = URI(convert_url)
       req = Net::HTTP::Post.new(uri)
@@ -92,28 +121,34 @@ module OnlyofficeDocumentserverConversionHelper
         (@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
+    # @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 advenced 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('https://example.com/filename.docx')
+    # perform_convert({:url => 'https://example.com/filename.docx'})
     # perform_convert({:url => 'https://google.com/filename.docx',
-    #                 :key=>'askjdhaskdasdasdi',
-    #                 :outputtype => 'pdf'})
+    #                  :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 = XmlResponceParser.new(data, advanced_params[:outputtype]).result_url
       { url: url, data: data }
     end
   end

metadata CHANGED Viewed

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_documentserver_conversion_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
+- ONLYOFFICE
 - Pavel Lobashov
 - Dmitry Rotaty
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -25,21 +26,159 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
 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/name.rb
 - lib/onlyoffice_documentserver_conversion_helper/version.rb
-homepage: http://rubygems.org/gems/onlyoffice_documentserver_conversion_helper
+- lib/onlyoffice_documentserver_conversion_helper/xml_responce_parser.rb
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_documentserver_conversion_helper
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_documentserver_conversion_helper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_documentserver_conversion_helper/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_documentserver_conversion_helper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_documentserver_conversion_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_documentserver_conversion_helper
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -48,15 +187,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: onlyoffice_documentserver_conversion_helper Gem

data/README.md DELETED Viewed

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