onlyoffice_bugzilla_helper 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbaa61a748e1d1b3e298fe2f9efde9777563108d19c5d23cc673d4dfa23b228
-  data.tar.gz: af6d86186bf9ab27adf4e748f5d7f5918dd45b2cc3a7d27a046423010fd6c790
+  metadata.gz: c2c0df09ea18bbe7bd0b3e564c373bd2d489bc46aa782905b8bacf6664126add
+  data.tar.gz: e178efeb2a1fd38b49db763eeb41292dfccbf8836b206779c48bac485f0c5c4d
 SHA512:
-  metadata.gz: b8dbff38b2430541cced2acb312a20f651bc2e07bbb59b48a782b6119b7936876a76060992bedea6942323965c415850035686f31d6ff23dd2acbd3bd4dedf95
-  data.tar.gz: ebb566a1a4590baa7df29062c654fe73653404bfa5e92d21c86a7a099f263e5baf7fa0f8698724752107e2c11a692407c53c12e520b0cd734e82db8cfa01c5a0
+  metadata.gz: 700fc2d2050f00db7f1bacc9524067bcaf9225eef0de1ca81345fc4c4d11cbd8ff63ef5cad5cb9efba1faf2ea56e599ac50f08f29f65ba31dbf71459841c6af4
+  data.tar.gz: 333a43b5c73e213162e21460b9acedbc1e8d38b72a1c904701bd28de578394bfc0d5c9a731451df4dfd68dd2eaa891c2d9818886b9f976752a4bead969dc614e

data/lib/onlyoffice_bugzilla_helper.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'json'
 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'
 
 # Helper for bugzilla, used in QA
@@ -10,11 +16,15 @@ module OnlyofficeBugzillaHelper
   # Class to check bugzilla via http
   class BugzillaHelper
     include BugData
+    include Comments
+    include LoggerWrapper
+    include Networking
+    include UpdateBug
     attr_reader :url
 
-    def initialize(bugzilla_url: 'bugzilla.onlyoffice.com',
+    def initialize(bugzilla_url: 'https://bugzilla.onlyoffice.com',
                    api_key: BugzillaHelper.read_token)
-      @url = bugzilla_url
+      @url = URI.parse(bugzilla_url)
       @key = api_key
       @show_bug_path = '/show_bug.cgi'
       @show_bug_param = 'id'
@@ -24,46 +34,46 @@ 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 =~ URI::DEFAULT_PARSER.make_regexp
+      return nil unless string&.match?(URI::DEFAULT_PARSER.make_regexp)
+
       uri = URI.parse(string)
-      return nil unless uri.host == url
+      return nil unless uri.host == url.host
       return nil unless uri.path == @show_bug_path
+
       id = CGI.parse(uri.query)[@show_bug_param].first.to_i
       return nil if id.zero?
+
       id
     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']
-      File.read(Dir.home + '/.bugzilla/api_key').delete("\n")
+    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(token_path).delete("\n")
     rescue Errno::ENOENT
-      raise Errno::ENOENT, "No access token found in #{Dir.home}/.bugzilla/api_key" \
-      "Please create files #{Dir.home}/.bugzilla/api_key"
+      raise Errno::ENOENT,
+            "No access token found in #{Dir.home}/.bugzilla/api_key" \
+            "Please create files #{Dir.home}/.bugzilla/api_key"
     end
 
     private
 
     # @param id [Integer] id of bug
     # @return [String] url of bug on server with api key
-    def bug_url(id)
-      "/rest/bug/#{id}?api_key=#{@key}"
+    def bug_url(id, suffix = '')
+      "/rest/bug/#{id}#{suffix}?api_key=#{@key}"
     end
 
     # @param bug_id [Integer] id of bug
-    # @param port [Integer] port of server
     # @return [Net::HTTPResponse] result of request
-    def get_bug_result(bug_id, port)
-      Net::HTTP.start(url, port, use_ssl: (port == 443)) do |http|
-        http.get(bug_url(bug_id))
-      end
-    end
-
-    # @param response [Net::HTTPResponse] to check
-    # @return [Boolean] is response - redirect
-    def response_redirect?(response)
-      response.header['location']
+    def get_bug_result(bug_id)
+      req = Net::HTTP::Get.new(bug_url(bug_id))
+      perform_request(req)
     end
   end
 end

data/lib/onlyoffice_bugzilla_helper/bug_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OnlyofficeBugzillaHelper
   # Method to work with bug data
   module BugData
@@ -5,8 +7,7 @@ module OnlyofficeBugzillaHelper
     # @param bug_id [String, Integer] id of bug
     # @return [JSON] data
     def bug_data(bug_id)
-      res = get_bug_result(bug_id, 80)
-      res = get_bug_result(bug_id, 443) if response_redirect?(res)
+      res = get_bug_result(bug_id)
       JSON.parse(res.body)['bugs'].first
     end
 
@@ -23,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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OnlyofficeBugzillaHelper
+  # Working with comments
+  module Comments
+    # @return [Hash] list of bug comments
+    def comments(bug_id)
+      res = Net::HTTP.start(@url.host, @url.port, use_ssl: use_ssl?) do |http|
+        http.get(bug_url(bug_id, '/comment'))
+      end
+      JSON.parse(res.body)['bugs'][bug_id.to_s]['comments']
+    end
+
+    # Add comment to bug
+    # @param bug_id [Integer] id of bug
+    # @param comment [String] comment to add
+    def add_comment(bug_id, comment)
+      req = Net::HTTP::Post.new(bug_url(bug_id, '/comment'))
+      req.body = { comment: comment }.to_json
+      req.add_field('Content-Type', 'text/plain')
+      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

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

data/lib/onlyoffice_bugzilla_helper/networking.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OnlyofficeBugzillaHelper
+  # Code for networking
+  module Networking
+    private
+
+    # @return [True, False] is ssl shold be used
+    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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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')
+      perform_request(req)
+    end
+  end
+end

data/lib/onlyoffice_bugzilla_helper/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module OnlyofficeBugzillaHelper
-  VERSION = '0.2.0'.freeze
+  # [String] version of Gem
+  VERSION = '0.6.0'
 end

metadata

@@ -1,58 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_bugzilla_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
-- Pavel Lobashov
 - ONLYOFFICE
+- Pavel Lobashov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  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: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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: '3.0'
+        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
@@ -60,26 +158,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".overcommit.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- Changelog.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - 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
-- onlyoffice_bugzilla_helper.gemspec
-homepage: http://rubygems.org/gems/onlyoffice_bugzilla_helper
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  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-QA/onlyoffice_bugzilla_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_bugzilla_helper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -88,15 +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: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.14
 signing_key: 
 specification_version: 4
 summary: Helper for bugzilla