errbit-ng-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a71eb449292cc07bf9a78044ca8b24e2eb9f4db9e1f67efef131712106a10ef3
+  data.tar.gz: 2adfcf8f85aeff119d76f63b969559d64729b054e687ff4786a47d6c55248eae
+SHA512:
+  metadata.gz: 923ee8e3edf7bd66037568fe9532734b320142bb41908e5f2d0daf4552fa84049888b7ea1672fcb907f136e493e46b914b3c45d28d85c0997f33d89b2c871ccc
+  data.tar.gz: 30eded126d9a71985383cb8df0abe5268ce1aef57928dbd2bf5ae4931de1ee796b94acf37d69d2dfb489d7417d87831684ae0f6fc4cc7fda90875f0e23c398d8

data/.rspec

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

data/.ruby-version

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

data/.standard.yml

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

data/CHANGELOG.md

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Errbit
+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,134 @@
+# ErrbitPlugin [![Build Status](https://travis-ci.org/errbit/errbit_plugin.svg?branch=master)](https://travis-ci.org/errbit/errbit_plugin)
+
+ErrbitPlugin provides a set of base classes that you can extend to create
+Errbit plugins.
+
+## Creating plugins
+
+ErrbitPlugins are Ruby gems that extend the functionality of Errbit. To get
+started, create a Ruby gem and add 'errbit_plugin' as a dependency in your
+gem's gemspec.
+
+Now you can start adding plugins. At the moment, there is only one kind of
+plugin you can create, and that is the issue tracker.
+
+### Issue Trackers
+
+An issue tracker plugin is a Ruby class that enables you to link errors within
+errbit to an issue in an external issue tracker like Github. An app within
+errbit can be associated an issue tracker or not. When there is an association,
+errbit users can choose 'create issue' from an error page which will both
+create an issue on the external issue tracker out of the given error and link
+that issue to the errbit error. Likewise, a user can also choose 'close issue'
+to close the issue on the external issue tracker, if your plugin provides a 
+method to do so.
+
+Your issue tracker plugin is responsible for providing the interface defined by
+ErrbitPlugin::IssueTracker. All of the required methods must be implemented and
+the class must extend ErrbitPlugin::IssueTracker. Here's an example:
+
+```ruby
+class MyIssueTracker < ErrbitPlugin::IssueTracker
+  # A unique label for your tracker plugin used internally by errbit
+  def self.label
+    "my-tracker"
+  end
+
+  def self.note
+    "a note about this tracker that users will see"
+  end
+
+  # Form fields that will be presented to the administrator when setting up
+  # or editing the errbit app. The values we collect will be availble for use
+  # later when we have an instance of this class.
+  def self.fields
+    {
+      username: {
+        placeholder: "Some placeholder text"
+      },
+      password: {
+        placeholder: "Some more placeholder text",
+        label: "Passphrase" # a label to use in the UI instead of 'password'
+      }
+    }
+  end
+
+  # Icons to display during user interactions with this issue tracker. This
+  # method should return a hash of two-tuples, the key names being 'create',
+  # 'goto', and 'inactive'. The two-tuples should contain the icon media type
+  # and the binary icon data.
+  def self.icons
+    @icons ||= {
+      create: ["image/png", File.read("./path/to/create.png")],
+      goto: ["image/png", File.read("./path/to/goto.png")],
+      inactive: ["image/png", File.read("./path/to/inactive.png")]
+    }
+  end
+
+  # If this tracker can be in a configured or non-configured state, you can let
+  # errbit know by returning a Boolean here
+  def configured?
+    # In this case, we'll say this issue tracker is configured when username
+    # and password are set
+    options[:username].present? && options[:password].present?
+  end
+
+  # Called to validate user input. Just return a hash of errors if there are
+  # any
+  def errors
+    if options[:username]
+      {}
+    else
+      {field_one: "username must be present"}
+    end
+  end
+
+  # This is where you actually go create the issue on the external issue
+  # tracker. You get access to everything in options, an issue title, body and
+  # a user record representing the user who's creating the issue.
+  #
+  # Return a string with a link to the issue
+  def create_issue(title, body, user: {})
+    # Create an issue! Then update the problem to link it.
+
+    "https://sometracker.com/my/issue/123"
+  end
+
+  # This method is optional. Errbit will create body text for your issue by
+  # calling render_to_string with some arguments. If you want control over
+  # those arguments, you can specify them here. You can control which file is
+  # rendered and anything else Rails allows you to specify as arguments in
+  # render_to_string.
+  #
+  # If you don't implement this method, Errbit will render a body using a
+  # default template
+  #
+  # @see http://apidock.com/rails/ActionController/Base/render_to_string
+  def render_body_args
+    # In this example, we want to render a special file
+    ["/path/to/some/template", formats: [:rdoc]]
+  end
+
+  # This method is optional, and is where you actually go close the issue on
+  # the external issue tracker. You get access to everything in options, a
+  # string with a link to the issue # and a user resource.
+  #
+  # return true if successful, false otherwise
+  def close_issue(issue_link, user = {})
+    # Close the issue! (Perhaps using the passed in issue_link url to identify it.)
+  end
+
+  # The URL for your remote issue tracker
+  def url
+    "https://some-remote-tracker.com"
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/errbit-ng/errbit-ng-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-plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "errbit_plugin"

data/lib/errbit_plugin/issue_tracker.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErrbitPlugin
+  # abstract class for issue trackers
+  class IssueTracker
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+  end
+end

data/lib/errbit_plugin/none_issue_tracker.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ErrbitPlugin
+  class NoneIssueTracker < IssueTracker
+    def self.label
+      "none"
+    end
+
+    def self.note
+      "When no issue tracker has been configured, you will be able to leave comments on errors."
+    end
+
+    def self.fields
+      {}
+    end
+
+    def self.icons
+      @icons ||= {
+        create: ["image/png", read_static_file("none_create.png")],
+        goto: ["image/png", read_static_file("none_create.png")],
+        inactive: ["image/png", read_static_file("none_inactive.png")]
+      }
+    end
+
+    def self.read_static_file(file)
+      File.read(File.expand_path(File.join(
+        File.dirname(__FILE__), "..", "..", "..", "static", file
+      )))
+    end
+
+    ##
+    # The NoneIssueTracker is mark like configured? false because it not valid
+    # like a real IssueTracker
+    def configured?
+      false
+    end
+
+    def errors
+      {}
+    end
+
+    def url
+      ""
+    end
+
+    def create_issue(*)
+      false
+    end
+
+    def close_issue(*)
+      false
+    end
+  end
+end
+
+ErrbitPlugin::Registry.add_issue_tracker(ErrbitPlugin::NoneIssueTracker)

data/lib/errbit_plugin/registry.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ErrbitPlugin
+  class IncompatibilityError < StandardError
+  end
+
+  class AlreadyRegisteredError < StandardError
+  end
+
+  class Registry
+    def self.add_issue_tracker(klass)
+      key = klass.label
+
+      if issue_trackers.has_key?(key)
+        raise AlreadyRegisteredError, "issue_tracker '#{key}' already registered"
+      end
+
+      validate = ValidateIssueTracker.new(klass)
+
+      if validate.valid?
+        @issue_trackers[key] = klass
+      else
+        raise IncompatibilityError.new(validate.errors.join("; "))
+      end
+    end
+
+    def self.clear_issue_trackers
+      @issue_trackers = {}
+    end
+
+    def self.issue_trackers
+      @issue_trackers ||= {}
+    end
+  end
+end

data/lib/errbit_plugin/validate_issue_tracker.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ErrbitPlugin
+  class ValidateIssueTracker
+    attr_reader :errors
+
+    def initialize(klass)
+      @klass = klass
+      @errors = []
+    end
+
+    def valid?
+      valid_inherit = good_inherit?
+      valid_instance_methods = implements_instance_methods?
+      valid_class_methods = implements_class_methods?
+
+      valid_inherit && valid_instance_methods && valid_class_methods
+    end
+
+    private
+
+    def good_inherit?
+      if @klass.ancestors.include?(ErrbitPlugin::IssueTracker)
+        true
+      else
+        add_errors(:not_inherited)
+
+        false
+      end
+    end
+
+    def implements_instance_methods?
+      impl = [:configured?, :errors, :create_issue, :url].map do |method|
+        if instance.respond_to?(method)
+          true
+        else
+          add_errors(:instance_method_missing, method)
+
+          false
+        end
+      end
+
+      impl.all? { |value| value == true }
+    end
+
+    def implements_class_methods?
+      impl = [:label, :fields, :note, :icons].map do |method|
+        if @klass.respond_to?(method)
+          true
+        else
+          add_errors(:class_method_missing, method)
+
+          false
+        end
+      end
+
+      impl.all? { |value| value == true }
+    end
+
+    def instance
+      @instance ||= @klass.new({})
+    end
+
+    def add_errors(key, value = nil)
+      @errors << [key, value].compact
+    end
+  end
+end

data/lib/errbit_plugin/version.rb

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

data/lib/errbit_plugin.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "errbit_plugin/version"
+require "errbit_plugin/registry"
+require "errbit_plugin/issue_tracker"
+require "errbit_plugin/validate_issue_tracker"
+require "errbit_plugin/none_issue_tracker"

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: errbit-ng-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: []
+description: Base to create an Errbit-NG plugins
+email:
+- igor.zubkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/errbit-ng-plugin.rb
+- lib/errbit_plugin.rb
+- lib/errbit_plugin/issue_tracker.rb
+- lib/errbit_plugin/none_issue_tracker.rb
+- lib/errbit_plugin/registry.rb
+- lib/errbit_plugin/validate_issue_tracker.rb
+- lib/errbit_plugin/version.rb
+- static/fake_create.png
+- static/fake_inactive.png
+- static/none_create.png
+- static/none_inactive.png
+homepage: https://github.com/errbit-ng/errbit-ng-plugin
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/errbit-ng/errbit-ng-plugin/issues
+  changelog_uri: https://github.com/errbit-ng/errbit-ng-plugin/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/errbit-ng/errbit-ng-plugin/blob/main/README.md
+  homepage_uri: https://github.com/errbit-ng/errbit-ng-plugin
+  source_code_uri: https://github.com/errbit-ng/errbit-ng-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: Base to create an Errbit-NG plugins
+test_files: []