onlyoffice_bugzilla_helper 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8546f46503248d965497169d720b46bb608883a248a22338fc9d56a82082c857
-  data.tar.gz: 9ac958331df297a80cfcb709a3539f0ff6d744d800d9c1ef3a9416296d7527c8
+  metadata.gz: 7ff70cf1f92d58b5ee3fde49f516e53be60ad0f1589cae8624c5c8dc80efeb7c
+  data.tar.gz: ae5a6db51a4e414a0c23e997084763c47052b2494ad4ba6fb8848a6494133bd4
 SHA512:
-  metadata.gz: 20534e8b08c71fbb9d2e4beb8ec3bdde5404508d32b08510d010663af2f195547f79bb1c72d847a67a1c1274b2546621a99978a3cca383b8a66c512f87b22a72
-  data.tar.gz: '0369bca03402e01e59a0ad7a423ea02952c5baaba5b7164ab47f0bb5fcfdd433c5cd9118fc25d291368b07386ce46705922514d97bb2f386d8b20ff00432c776'
+  metadata.gz: a959f75ef11abab71e6f82bc15e9307ceb46c7bbdc6befd18ef12b2869d4000adcb100577bf9b36c514fb683d6e06533d2cb5addad015955063cef16fa56a8c5
+  data.tar.gz: '018bd6c8e66fc1b4930f001a32d024adad5dc4e16c38bef9197bd27098caba20b2707dbcbc7d549f82f466338b099a58ce124e9dba9090bcbdc5784b8ea499b0'

data/lib/onlyoffice_bugzilla_helper.rb

@@ -1,77 +1,78 @@
+# 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/networking'
+require 'onlyoffice_bugzilla_helper/update_bug'
 require 'onlyoffice_bugzilla_helper/version'
 
 # Helper for bugzilla, used in QA
 module OnlyofficeBugzillaHelper
   # Class to check bugzilla via http
   class BugzillaHelper
+    include BugData
+    include Comments
+    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'
     end
 
-    # Get status of bug
-    # @param bug_id [String, Integer] id of bug
-    # @return [String] status of bug
-    def bug_status(bug_id)
-      res = get_bug_result(bug_id, 80)
-      res = get_bug_result(bug_id, 443) if response_redirect?(res)
-      parsed_json = JSON.parse(res.body)
-      parsed_json['bugs'].first['status']
-    end
-
     # Get bug id from url
     # @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|
+    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
     end
-
-    # @param response [Net::HTTPResponse] to check
-    # @return [Boolean] is response - redirect
-    def response_redirect?(response)
-      response.header['location']
-    end
   end
 end

data/lib/onlyoffice_bugzilla_helper/bug_data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OnlyofficeBugzillaHelper
+  # Method to work with bug data
+  module BugData
+    # Get bug data of bug
+    # @param bug_id [String, Integer] id of bug
+    # @return [JSON] data
+    def bug_data(bug_id)
+      res = get_bug_result(bug_id)
+      JSON.parse(res.body)['bugs'].first
+    end
+
+    # Get status of bug
+    # @param bug_id [String, Integer] id of bug
+    # @return [String] status of bug
+    def bug_status(bug_id)
+      parsed_json = bug_data(bug_id)
+      parsed_json['status']
+    end
+
+    # @param bug_id [Integer] is bug exists
+    # @return [Boolean]
+    def bug_exists?(bug_id)
+      bug_status(bug_id)
+      true
+    rescue JSON::ParserError, NoMethodError
+      false
+    end
+  end
+end

data/lib/onlyoffice_bugzilla_helper/comments.rb

@@ -0,0 +1,26 @@
+# 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')
+      connection = Net::HTTP.new(@url.host, @url.port)
+      connection.use_ssl = use_ssl?
+      connection.start { |http| http.request(req) }
+    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,13 @@
+# 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
+  end
+end

data/lib/onlyoffice_bugzilla_helper/update_bug.rb

@@ -0,0 +1,19 @@
+# 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')
+      connection = Net::HTTP.new(@url.host, @url.port)
+      connection.use_ssl = use_ssl?
+      connection.start { |http| http.request(req) }
+    end
+  end
+end

data/lib/onlyoffice_bugzilla_helper/version.rb

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

metadata

@@ -1,58 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_bugzilla_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
-- Pavel Lobashov
 - ONLYOFFICE
+- Pavel Lobashov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2020-12-18 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,25 +158,22 @@ 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/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:
@@ -87,15 +182,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.1.4
 signing_key: 
 specification_version: 4
 summary: Helper for bugzilla