errbit-ng-github-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7bbdc6db9882c0e802e1f26afb96f156180da41b1a2ea2e9c809a41b117ee74
+  data.tar.gz: b6d4cb800782e7409f723acf284f8b975b6fa47c496d99b3a0853155de0840d6
+SHA512:
+  metadata.gz: 37c64da4da97c1295662b653ef2cf49c53c2180647b995b5a77d172632d1ba9c73332296b46bb317d44a99a6681a3c8e87e312445286db207b8294f2c0c3e24f
+  data.tar.gz: c6fb8f65be8c3a3ca9a059b01c478efb07cad42c01749e9b125846e8deeaa49c39b6a29952b221985fce2f5c5e59ca58759353abb586817802c530b32a0b81a0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.1.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## main
+
+* Rename to `errbit-ng-github-plugin`

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Cyril Mougel
+Copyright (c) 2025 Errbit-NG Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Errbit-NG GitHub Plugin
+
+This plugin provides GitHub issue tracker integration for Errbit-NG, and it is the
+only one plugin included by default in Errbit-NG.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/errbit-ng/errbit-ng-github-plugin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/errbit-ng-github-plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "errbit_github_plugin"

data/lib/errbit_github_plugin/error.rb

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

data/lib/errbit_github_plugin/issue_tracker.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "octokit"
+
+module ErrbitGithubPlugin
+  class IssueTracker < ErrbitPlugin::IssueTracker
+    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."
+
+    FIELDS = {
+      username: {
+        placeholder: "Your username on GitHub"
+      },
+      password: {
+        placeholder: "Password for your account"
+      }
+    }
+
+    def self.label
+      LABEL
+    end
+
+    def self.note
+      NOTE
+    end
+
+    def self.fields
+      FIELDS
+    end
+
+    def self.icons
+      @icons ||= {
+        create: [
+          "image/png", ErrbitGithubPlugin.read_static_file("github_create.png")
+        ],
+        goto: [
+          "image/png", ErrbitGithubPlugin.read_static_file("github_goto.png")
+        ],
+        inactive: [
+          "image/png", ErrbitGithubPlugin.read_static_file("github_inactive.png")
+        ]
+      }
+    end
+
+    def configured?
+      errors.empty?
+    end
+
+    def url
+      "https://github.com/#{repo}/issues"
+    end
+
+    def errors
+      errors = []
+      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."]
+      end
+      errors
+    end
+
+    def repo
+      options[:github_repo]
+    end
+
+    def create_issue(title, body, 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
+      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
+
+    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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ErrbitGithubPlugin
+  VERSION = "0.1.0"
+end

data/lib/errbit_github_plugin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "errbit_github_plugin/version"
+require "errbit_github_plugin/error"
+require "errbit_github_plugin/issue_tracker"
+
+module ErrbitGithubPlugin
+  def self.root
+    File.expand_path "../..", __FILE__
+  end
+
+  def self.read_static_file(file)
+    File.read(File.join(root, "static", file))
+  end
+end
+
+ErrbitPlugin::Registry.add_issue_tracker(ErrbitGithubPlugin::IssueTracker)

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: errbit-ng-github-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ihor Zubkov
+bindir: exe
+cert_chain: []
+date: 2025-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: errbit-ng-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: GitHub integration for Errbit-NG
+email:
+- igor.zubkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/errbit-ng-github-plugin.rb
+- lib/errbit_github_plugin.rb
+- lib/errbit_github_plugin/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/errbit-ng/errbit-ng-github-plugin
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/errbit-ng/errbit-ng-github-plugin/issues
+  changelog_uri: https://github.com/errbit-ng/errbit-ng-github-plugin/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/errbit-ng/errbit-ng-github-plugin/blob/main/README.md
+  homepage_uri: https://github.com/errbit-ng/errbit-ng-github-plugin
+  source_code_uri: https://github.com/errbit-ng/errbit-ng-github-plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: GitHub integration for Errbit-NG
+test_files: []