errbit_github_plugin 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: afa68dc7f2ff60cfa5bca4d26fd9889a36bca7ad
-  data.tar.gz: f80c19060d3f571fe4882b3c62efbe6bc585ad42
+SHA256:
+  metadata.gz: 297a2628ce82518179d2e1c49e6e3fa74d5196e0477989441ef642e59a9d53fc
+  data.tar.gz: e77faf9c3f5de3af16b4a05d9e684c5fe0ec6697f3135aae2a8fefd97647075b
 SHA512:
-  metadata.gz: e6101c37634049d1a0cdba1fad9c4f272f70ce64fa4e925265272974ad21d4fed6b61f91c4c133b957215931d40dc600ab81d4dccb715879a6a671023c0e1ef1
-  data.tar.gz: f3af3a3f80dda0814de880fd94b40a0497ecc7960f98df2c8bfb9063a078acd4c2ae73d91ba137130d2368c1432c0bcc4d9d0c1de836ae0b60153a3fb5e874cd
+  metadata.gz: 8f47ea7b0efa36f9224db491ebee2cc1f147a6ae0ad66cc59fb45dc470b82a4ba97b308d6a060002a45dbdd72c262a41ac08cc22380e0055ff5cf9e71728ec83
+  data.tar.gz: 58040aeb2ae35411303e871e279cb5dea26499d58cad30e070174edefbc707c27bf281c5c86960537173d133b08a8d9e1be2ed342935838260bce9e069821025

data/.envrc

@@ -0,0 +1 @@
+export JRUBY_OPTS="--debug"

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,367 @@
+require:
+  - rubocop-disable_syntax
+
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+# We use standard as a linter and formatter instead Rubocop.
+# Also, we are explicitly disable all rubocop rules what
+# already enabled in standard. And standard-performance.
+
+# Standard rules. Style:
+
+# Enforced by standard. Disable.
+Style/StringLiterals:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/HashSyntax:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantRegexpArgument:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantBegin:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SuperWithArgsParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/Encoding:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/EmptyMethod:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SingleLineMethods:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SafeNavigation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RescueStandardError:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantSelf:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/TernaryParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantLineContinuation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SlicingWithRange:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/MultilineIfModifier:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantCondition:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantInterpolation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/OrAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/ItAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/EachWithObject:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/GlobalStdStream:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Disabled as in standard.
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/Alias:
+  Enabled: false
+
+# Standard rules. Layout:
+
+# Enforced by standard. Disable.
+Layout/HashAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/DotPosition:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ExtraSpacing:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ArgumentAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/IndentationWidth:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ElseAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EndAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineArrayBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ArrayAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/AssignmentIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/LineLength:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/CaseIndentation:
+  Enabled: false
+
+# Standard rules. Lint:
+
+# Enforced by standard. Disable.
+Lint/ImplicitStringConcatenation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/TripleQuotes:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/SymbolConversion:
+  Enabled: false
+
+# Enforced by rubocop and standard
+Lint/CopDirectiveSyntax:
+  Enabled: true
+
+# Enforced by standard. Disable.
+Lint/DuplicateMethods:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/UselessTimes:
+  Enabled: false
+
+# Standard-performance rules.
+
+# Enforced by standard-performance. Disable.
+Performance/Detect:
+  Enabled: false
+
+# Enforced by standard-performance. Disable.
+Performance/StringIdentifierArgument:
+  Enabled: false
+
+# Enforced by standard-performance. Disable.
+Performance/RegexpMatch:
+  Enabled: false
+
+# Always enable rubocop Security:
+
+# Enforced by rubocop and standard
+Security/JSONLoad:
+  Enabled: true
+
+# Our rubocop rules
+
+# Bundler rules.
+
+Bundler/OrderedGems:
+  Enabled: false
+
+# Gemspec rules
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+# Style rules
+
+# Don't allow %i[foo bar baz]
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Don't allow %w[foo bar baz]
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Disable warnings like "Missing top-level documentation comment for"
+Style/Documentation:
+  Enabled: false
+
+# Disable as in standard.
+Style/ArgumentsForwarding:
+  Enabled: false
+
+# RSpec rules
+
+# Prefer eq over be.
+RSpec/BeEq:
+  Enabled: false
+
+# Prefer eq over eql.
+RSpec/BeEql:
+  Enabled: false
+
+# We prefer to use `expect` over `allow`.
+RSpec/StubbedMock:
+  Enabled: false
+
+# We prefer multiple before blocks in tests.
+RSpec/ScatteredSetup:
+  Enabled: false
+
+# We use `expect` in before hooks.
+RSpec/ExpectInHook:
+  Enabled: false
+
+# We use item_1, item_2, etc. Disable.
+RSpec/IndexedLet:
+  Enabled: false
+
+# We don't use named subject's
+RSpec/NamedSubject:
+  Enabled: false
+
+# Naming rules:
+
+# Disable anonymous block forwarding.
+Naming/BlockForwarding:
+  Enabled: true
+  EnforcedStyle: explicit
+
+# Enable and exclude specific files.
+Naming/FileName:
+  Enabled: true
+
+# Disabled syntax:
+
+# Disable shorthand hash syntax like: ({ x:, y: })
+# Disable % style literals
+Style/DisableSyntax:
+  DisableSyntax:
+    - shorthand_hash_syntax
+    - percent_literals

data/.ruby-version

@@ -0,0 +1 @@
+3.1.7

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.1

data/README.md

@@ -1,29 +1,8 @@
-# ErrbitGithubPlugin
+# Errbit GitHub Plugin
 
-TODO: Write a gem description
+[![RSpec](https://github.com/errbit/errbit_github_plugin/actions/workflows/rspec.yml/badge.svg)](https://github.com/errbit/errbit_github_plugin/actions/workflows/rspec.yml)
+[![RSpec on JRuby](https://github.com/errbit/errbit_github_plugin/actions/workflows/jruby.yml/badge.svg)](https://github.com/errbit/errbit_github_plugin/actions/workflows/jruby.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'errbit_github_plugin'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install errbit_github_plugin
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+This plugin provides GitHub issue tracker integration for Errbit, and it is the
+only plugin included by default in Errbit.

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/lib/errbit_github_plugin/{error.rb → authentication_error.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ErrbitGithubPlugin
   class AuthenticationError < Exception; end
 end

data/lib/errbit_github_plugin/issue_tracker.rb

@@ -1,15 +1,17 @@
-require 'octokit'
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+require "octokit"
 
 module ErrbitGithubPlugin
   class IssueTracker < ErrbitPlugin::IssueTracker
+    LABEL = "github"
 
-    LABEL = 'github'
-
-    NOTE = 'Please configure your github repository in the <strong>GITHUB ' <<
-           'REPO</strong> field above.<br/> Instead of providing your ' <<
-           'username & password, you can link your Github account to your ' <<
-           'user profile, and allow Errbit to create issues using your ' <<
-           'OAuth token.'
+    NOTE = "Please configure your GitHub repository in the <strong>GITHUB " \
+           "REPO</strong> field above.<br> Instead of providing your " \
+           "username & password, you can link your GitHub account to your " \
+           "user profile, and allow Errbit to create issues using your " \
+           "OAuth token."
 
     FIELDS = {
       username: {
@@ -35,13 +37,13 @@ module ErrbitGithubPlugin
     def self.icons
       @icons ||= {
         create: [
-          'image/png', ErrbitGithubPlugin.read_static_file('github_create.png')
+          "image/png", ErrbitGithubPlugin.read_static_file("github_create.png")
         ],
         goto: [
-          'image/png', ErrbitGithubPlugin.read_static_file('github_goto.png'),
+          "image/png", ErrbitGithubPlugin.read_static_file("github_goto.png")
         ],
         inactive: [
-          'image/png', ErrbitGithubPlugin.read_static_file('github_inactive.png'),
+          "image/png", ErrbitGithubPlugin.read_static_file("github_inactive.png")
         ]
       }
     end
@@ -56,12 +58,15 @@ module ErrbitGithubPlugin
 
     def errors
       errors = []
-      if self.class.fields.detect {|f| options[f[0]].blank? }
-        errors << [:base, 'You must specify your GitHub username and password']
+
+      if self.class.fields.detect { |f| options[f[0]].blank? }
+        errors << [:base, "You must specify your GitHub username and password"]
       end
+
       if repo.blank?
-        errors << [:base, 'You must specify your GitHub repository url.']
+        errors << [:base, "You must specify your GitHub repository url."]
       end
+
       errors
     end
 
@@ -70,17 +75,42 @@ module ErrbitGithubPlugin
     end
 
     def create_issue(title, body, user: {})
-      if user['github_login'] && user['github_oauth_token']
-        github_client = Octokit::Client.new(
-          login: user['github_login'], access_token: user['github_oauth_token'])
+      github_client = if user["github_login"] && user["github_oauth_token"]
+        Octokit::Client.new(
+          login: user["github_login"], access_token: user["github_oauth_token"]
+        )
       else
-        github_client = Octokit::Client.new(
-          login: options['username'], password: options['password'])
+        Octokit::Client.new(
+          login: options["username"], password: options["password"]
+        )
       end
       issue = github_client.create_issue(repo, title, body)
       issue.html_url
     rescue Octokit::Unauthorized
       raise ErrbitGithubPlugin::AuthenticationError, "Could not authenticate with GitHub. Please check your username and password."
     end
+
+    # @param url [String]
+    # @param user [Hash]
+    # @return [String] The URL of the closed issue
+    def close_issue(url, user: {})
+      github_client = if user["github_login"] && user["github_oauth_token"]
+        Octokit::Client.new(
+          login: user["github_login"], access_token: user["github_oauth_token"]
+        )
+      else
+        Octokit::Client.new(
+          login: options["username"], password: options["password"]
+        )
+      end
+      # It would be better to get the number from issue.number when we create the issue,
+      # however, since we only have the url, get the number from it.
+      # ex: "https://github.com/octocat/Hello-World/issues/1347"
+      issue_number = url.split("/").last
+      issue = github_client.close_issue(repo, issue_number)
+      issue.html_url
+    rescue Octokit::Unauthorized
+      raise ErrbitGithubPlugin::AuthenticationError, "Could not authenticate with GitHub. Please check your username and password."
+    end
   end
 end

data/lib/errbit_github_plugin/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ErrbitGithubPlugin
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/errbit_github_plugin.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require "errbit_github_plugin/version"
-require 'errbit_github_plugin/error'
-require 'errbit_github_plugin/issue_tracker'
+require "errbit_github_plugin/authentication_error"
+require "errbit_github_plugin/issue_tracker"
 
 module ErrbitGithubPlugin
   def self.root
-    File.expand_path '../..', __FILE__
+    File.expand_path "../..", __FILE__
   end
 
   def self.read_static_file(file)
-    File.read(File.join(self.root, 'static', file))
+    File.read(File.join(root, "static", file))
   end
 end
 

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: errbit_github_plugin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Crosby
-- Cyril Mougel
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: errbit_plugin
@@ -26,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,27 +38,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -70,31 +68,33 @@ dependencies:
 description: GitHub integration for Errbit
 email:
 - stevecrozz@gmail.com
-- cyril.mougel@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
+- ".envrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".standard.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
-- errbit_github_plugin.gemspec
 - lib/errbit_github_plugin.rb
-- lib/errbit_github_plugin/error.rb
+- lib/errbit_github_plugin/authentication_error.rb
 - lib/errbit_github_plugin/issue_tracker.rb
 - lib/errbit_github_plugin/version.rb
 - static/github_create.png
 - static/github_goto.png
 - static/github_inactive.png
-- vendor/assets/images/github_create.png
-- vendor/assets/images/github_inactive.png
-homepage: https://github.com/brandedcrate/errbit_github_plugin
+homepage: https://github.com/errbit/errbit_github_plugin
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/errbit/errbit_github_plugin
+  source_code_uri: https://github.com/errbit/errbit_github_plugin
+  bug_tracker_uri: https://github.com/errbit/errbit_github_plugin/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -102,17 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: GitHub integration for Errbit
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in errbit_github_plugin.gemspec
-gemspec
-
-gem 'errbit_plugin', :git => 'https://github.com/errbit/errbit_plugin.git'
-gem 'rspec'
-gem 'guard'
-gem 'guard-rspec'
-gem 'coveralls', :require => false

data/errbit_github_plugin.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'errbit_github_plugin/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "errbit_github_plugin"
-  spec.version       = ErrbitGithubPlugin::VERSION
-  spec.authors       = ["Stephen Crosby", "Cyril Mougel"]
-  spec.email         = ["stevecrozz@gmail.com", "cyril.mougel@gmail.com"]
-
-  spec.description   = %q{GitHub integration for Errbit}
-  spec.summary       = %q{GitHub integration for Errbit}
-  spec.homepage      = "https://github.com/brandedcrate/errbit_github_plugin"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "errbit_plugin"
-  spec.add_dependency "octokit"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end