onlyoffice_bugzilla_helper 0.3.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d94c6dba6d91fc40138e56a201ff3c202d9ba50081e3dc30966573815b372da
-  data.tar.gz: 359ec64f4c49c1540a5f54f241cb90ff0878f4a97ad6a508df536fec8643bbcc
+  metadata.gz: aa8f152f01993c75b41a62070b59aaccc39c56d35487cf29aad32834e2aed432
+  data.tar.gz: eef1941b64d912297a1f7c81c1eb4a84d43b93055e347bb221d911f10994a513
 SHA512:
-  metadata.gz: 5305b3d016dad39108d2120b474c87680dc67c314cff7f76f388d22cdb4dbd4d13468f3f866c47b08b44d9818014c50f36a0589813c56276eeb2adbed2edfd38
-  data.tar.gz: 2111a27a55028dcc5290671b3ac24cb229c9dcd7919d49842f2d7c4702ff9d2991e997e0ca2d89af0fbee773cb6a6b6f3134043ddcd4f39bf22d1a54f9b03825
+  metadata.gz: e99a3055e61faa6f0892cd8d370becc72472bdb5a54acc0af29e577a7ad4b2f9185eed2c82ffd874e6d2121f340e174d2e509a39417e35a34b085388735a8560
+  data.tar.gz: 2d85b5860ad6b30d360b9325a5ac0de9b22fbd2abce74b995b579c0616e04e58a8adc868708e6de5d25b45170dc2f8ed991aae5c9afceaf5d1ef07e6106dfa1b

data/lib/onlyoffice_bugzilla_helper.rb

@@ -6,6 +6,7 @@ require 'net/http'
 require 'uri'
 require 'onlyoffice_bugzilla_helper/bug_data'
 require 'onlyoffice_bugzilla_helper/comments'
+require 'onlyoffice_bugzilla_helper/logger_wrapper'
 require 'onlyoffice_bugzilla_helper/networking'
 require 'onlyoffice_bugzilla_helper/update_bug'
 require 'onlyoffice_bugzilla_helper/version'
@@ -16,6 +17,7 @@ module OnlyofficeBugzillaHelper
   class BugzillaHelper
     include BugData
     include Comments
+    include LoggerWrapper
     include Networking
     include UpdateBug
     attr_reader :url
@@ -32,8 +34,6 @@ module OnlyofficeBugzillaHelper
     # @param string [String] string for error
     # @return [Integer, Nil] result of bug id from url
     def bug_id_from_string(string)
-      return nil unless string&.match?(URI::DEFAULT_PARSER.make_regexp)
-
       uri = URI.parse(string)
       return nil unless uri.host == url.host
       return nil unless uri.path == @show_bug_path
@@ -42,14 +42,19 @@ module OnlyofficeBugzillaHelper
       return nil if id.zero?
 
       id
+    rescue URI::InvalidURIError
+      nil
     end
 
     # Read access token from file system
+    # @param force_file_read [True, False] force read api key from file
+    # @param token_path [String] path to file with API Token
     # @return [String] token
-    def self.read_token
-      return ENV['BUGZILLA_API_KEY'] if ENV['BUGZILLA_API_KEY']
+    def self.read_token(force_file_read: false,
+                        token_path: "#{Dir.home}/.bugzilla/api_key")
+      return ENV['BUGZILLA_API_KEY'] if ENV['BUGZILLA_API_KEY'] && !force_file_read
 
-      File.read(Dir.home + '/.bugzilla/api_key').delete("\n")
+      File.read(token_path).delete("\n")
     rescue Errno::ENOENT
       raise Errno::ENOENT,
             "No access token found in #{Dir.home}/.bugzilla/api_key" \
@@ -67,9 +72,8 @@ module OnlyofficeBugzillaHelper
     # @param bug_id [Integer] id of bug
     # @return [Net::HTTPResponse] result of request
     def get_bug_result(bug_id)
-      Net::HTTP.start(@url.host, @url.port, use_ssl: use_ssl?) do |http|
-        http.get(bug_url(bug_id))
-      end
+      req = Net::HTTP::Get.new(bug_url(bug_id))
+      perform_request(req)
     end
   end
 end

data/lib/onlyoffice_bugzilla_helper/bug_data.rb

@@ -24,7 +24,7 @@ module OnlyofficeBugzillaHelper
     def bug_exists?(bug_id)
       bug_status(bug_id)
       true
-    rescue JSON::ParserError
+    rescue JSON::ParserError, NoMethodError
       false
     end
   end

data/lib/onlyoffice_bugzilla_helper/comments.rb

@@ -18,9 +18,7 @@ module OnlyofficeBugzillaHelper
       req = Net::HTTP::Post.new(bug_url(bug_id, '/comment'))
       req.body = { comment: comment }.to_json
       req.add_field('Content-Type', 'text/plain')
-      connection = Net::HTTP.new(@url.host, @url.port)
-      connection.use_ssl = use_ssl?
-      connection.start { |http| http.request(req) }
+      perform_request(req)
     end
   end
 end

data/lib/onlyoffice_bugzilla_helper/logger_wrapper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module OnlyofficeBugzillaHelper
+  # Logger module for logging stuff
+  module LoggerWrapper
+    # @return [Logger] default logger
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+
+    # Log info about request
+    # @param [Net:HTTP] request to make
+    # @param [Net:HTTP] response in result
+    # @return [nil]
+    def log_request(request, response)
+      logger.info('Made request. '\
+                  "Type: #{request.method}. "\
+                  "Path: #{hide_keys(request.path)}. "\
+                  "Body: #{hide_keys(request.body)}. "\
+                  "Response: #{hide_keys(response.body)}")
+    end
+
+    # Hide sensitive info
+    # @param [String] string to hide
+    # @return [String] result
+    def hide_keys(string)
+      string&.gsub(@key, '[REMOVED]')
+    end
+  end
+end

data/lib/onlyoffice_bugzilla_helper/name.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module OnlyofficeBugzillaHelper
+  # [String] name of gem
   NAME = 'onlyoffice_bugzilla_helper'
 end

data/lib/onlyoffice_bugzilla_helper/networking.rb

@@ -9,5 +9,16 @@ module OnlyofficeBugzillaHelper
     def use_ssl?
       @url.scheme == 'https'
     end
+
+    # Perform request for current bugzilla
+    # @param [Net:HTTP] request to make
+    # @return [Net:HTTPResponse] result of request
+    def perform_request(request)
+      connection = Net::HTTP.new(@url.host, @url.port)
+      connection.use_ssl = use_ssl?
+      result = connection.start { |http| http.request(request) }
+      log_request(request, result)
+      result
+    end
   end
 end

data/lib/onlyoffice_bugzilla_helper/update_bug.rb

@@ -3,13 +3,15 @@
 module OnlyofficeBugzillaHelper
   # Method to updating bug data
   module UpdateBug
+    # Update bug info
+    # @param bug_id [Integer] id of bug
+    # @param params [Hash] params to update
+    # @return [Net::HTTPResponse] result of update
     def update_bug(bug_id, params = {})
       req = Net::HTTP::Put.new(bug_url(bug_id))
       req.body = params.to_json
       req.add_field('Content-Type', 'text/plain')
-      connection = Net::HTTP.new(@url.host, @url.port)
-      connection.use_ssl = use_ssl?
-      connection.start { |http| http.request(req) }
+      perform_request(req)
     end
   end
 end

data/lib/onlyoffice_bugzilla_helper/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module OnlyofficeBugzillaHelper
-  VERSION = '0.3.0'
+  # [String] version of Gem
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_bugzilla_helper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,22 +9,148 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: 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.0'
+        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: '13.0'
+        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
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.9.20
 description: Helper for bugzilla, used in QA
 email:
 - shockwavenn@gmail.com
@@ -35,19 +161,20 @@ files:
 - lib/onlyoffice_bugzilla_helper.rb
 - lib/onlyoffice_bugzilla_helper/bug_data.rb
 - lib/onlyoffice_bugzilla_helper/comments.rb
+- lib/onlyoffice_bugzilla_helper/logger_wrapper.rb
 - lib/onlyoffice_bugzilla_helper/name.rb
 - lib/onlyoffice_bugzilla_helper/networking.rb
 - lib/onlyoffice_bugzilla_helper/update_bug.rb
 - lib/onlyoffice_bugzilla_helper/version.rb
-homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_bugzilla_helper
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper
 licenses:
 - AGPL-3.0
 metadata:
-  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_bugzilla_helper/issues
-  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_bugzilla_helper/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_bugzilla_helper
-  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_bugzilla_helper
-  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_bugzilla_helper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -56,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.14
 signing_key: 
 specification_version: 4
 summary: Helper for bugzilla