issue-db 1.1.0 → 1.2.0

data/lib/issue_db/utils/init.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
-module Init
-  # A helper method for initializing the IssueDB library when .new is called
-  # Everything in this method should be idempotent and safe to call multiple times
-  def init!
-    begin
-      @client.add_label(
-        @repo.full_name,
-        @label,
-        "000000",
-        { description: "This issue is managed by the issue-db Ruby library. Please do not remove this label." },
-        disable_retry: true
-      )
-    rescue StandardError => e
-      if e.message.include?("already_exists")
-        @log.debug("label #{@label} already exists")
-      else
-        @log.error("error creating label: #{e.message}") unless ENV.fetch("ENV", nil) == "acceptance"
+module IssueDB
+  module Init
+    # A helper method for initializing the IssueDB library when .new is called
+    # Everything in this method should be idempotent and safe to call multiple times
+    def init!
+      begin
+        @client.add_label(
+          @repo.full_name,
+          @label,
+          "000000",
+          { description: "This issue is managed by the issue-db Ruby library. Please do not remove this label." },
+          disable_retry: true
+        )
+      rescue StandardError => e
+        if e.message.include?("already_exists")
+          @log.debug("label #{@label} already exists")
+        else
+          @log.error("error creating label: #{e.message}") unless ENV.fetch("ENV", nil) == "acceptance"
+        end
       end
     end
   end

data/lib/issue_db/utils/parse.rb

@@ -1,40 +1,42 @@
 # frozen_string_literal: true
 
-class ParseError < StandardError; end
+module IssueDB
+  class ParseError < StandardError; end
 
-module Parse
-  # Parses the issue body
-  # This method returns a hash that contains the following fields:
-  # - body_before: the body of the issue before the data
-  # - data: the parsed data as a hash
-  # - body_after: the body of the issue after the data
-  # :param body [String] the body of the issue to parse data from
-  # :param guard_start [String] the guard start string which is used to identify the start of the data
-  # :param guard_end [String] the guard end string which is used to identify the end of the data
-  # :return [Hash] the parsed issue body
-  def parse(body, guard_start: "<!--- issue-db-start -->", guard_end: "<!--- issue-db-end -->")
-    body_array = body.split("\n")
-    start_index = body_array.index(guard_start)
-    end_index = body_array.index(guard_end)
+  module Parse
+    # Parses the issue body
+    # This method returns a hash that contains the following fields:
+    # - body_before: the body of the issue before the data
+    # - data: the parsed data as a hash
+    # - body_after: the body of the issue after the data
+    # :param body [String] the body of the issue to parse data from
+    # :param guard_start [String] the guard start string which is used to identify the start of the data
+    # :param guard_end [String] the guard end string which is used to identify the end of the data
+    # :return [Hash] the parsed issue body
+    def parse(body, guard_start: "<!--- issue-db-start -->", guard_end: "<!--- issue-db-end -->")
+      body_array = body.split("\n")
+      start_index = body_array.index(guard_start)
+      end_index = body_array.index(guard_end)
 
-    if start_index.nil? || end_index.nil?
-      raise ParseError, "issue body is missing a guard start or guard end"
-    end
+      if start_index.nil? || end_index.nil?
+        raise ParseError, "issue body is missing a guard start or guard end"
+      end
 
-    # remove the first and last line if they contain triple backticks (codeblock)
-    data = body_array[start_index + 1...end_index]
-    data.shift if data.first.include?("```")
-    data.pop if data.last.include?("```")
+      # remove the first and last line if they contain triple backticks (codeblock)
+      data = body_array[start_index + 1...end_index]
+      data.shift if data.first.include?("```")
+      data.pop if data.last.include?("```")
 
-    # rejoins the data into a string
-    data = data.join("\n")
-    # parse the data
-    data = JSON.parse(data)
+      # rejoins the data into a string
+      data = data.join("\n")
+      # parse the data
+      data = JSON.parse(data)
 
-    return {
-      body_before: body_array[0...start_index].join("\n"),
-      data: data,
-      body_after: body_array[end_index + 1..-1].join("\n"),
-    }
+      return {
+        body_before: body_array[0...start_index].join("\n"),
+        data: data,
+        body_after: body_array[end_index + 1..-1].join("\n"),
+      }
+    end
   end
 end

data/lib/issue_db.rb

@@ -8,63 +8,75 @@ require_relative "issue_db/authentication"
 require_relative "issue_db/models/repository"
 require_relative "issue_db/database"
 
-class IssueDB
-  include Version
-  include Authentication
-  include Init
+module IssueDB
+  # Module-level constructor that delegates to Client.new for convenience
+  # This allows users to call IssueDB.new instead of IssueDB::Client.new
+  def self.new(*args, **kwargs, &block)
+    Client.new(*args, **kwargs, &block)
+  end
 
-  attr_reader :log
-  attr_reader :version
+  class Client
+    include Version
+    include Authentication
+    include Init
 
-  # Create a new IssueDB object
-  # :param repo: The GitHub repository to use as the datastore (org/repo format) [required]
-  # :param log: An optional logger - created for you by default
-  # :param octokit_client: An optional pre-hydrated Octokit::Client object
-  # :param label: The label to use for issues managed in the datastore by this library
-  # :param cache_expiry: The number of seconds to cache issues in memory (default: 60)
-  # :param init: Whether or not to initialize the database on object creation (default: true) - idempotent
-  # :return: A new IssueDB object
-  def initialize(repo, log: nil, octokit_client: nil, label: nil, cache_expiry: nil, init: true)
-    @log = log || RedactingLogger.new($stdout, level: ENV.fetch("LOG_LEVEL", "INFO").upcase)
-    @version = VERSION
-    @client = Authentication.login(octokit_client, @log)
-    @repo = Repository.new(repo)
-    @label = label || ENV.fetch("ISSUE_DB_LABEL", "issue-db")
-    @cache_expiry = cache_expiry || ENV.fetch("ISSUE_DB_CACHE_EXPIRY", 60).to_i
-    init! if init
-  end
+    attr_reader :log
+    attr_reader :version
 
-  def create(key, data, options = {})
-    db.create(key, data, options)
-  end
+    # Create a new IssueDB::Client object
+    # :param repo: The GitHub repository to use as the datastore (org/repo format) [required]
+    # :param log: An optional logger - created for you by default
+    # :param octokit_client: An optional pre-hydrated Octokit::Client object
+    # :param label: The label to use for issues managed in the datastore by this library
+    # :param cache_expiry: The number of seconds to cache issues in memory (default: 60)
+    # :param init: Whether or not to initialize the database on object creation (default: true) - idempotent
+    # :param app_id: GitHub App ID (for GitHub App authentication)
+    # :param installation_id: GitHub App Installation ID (for GitHub App authentication)
+    # :param app_key: GitHub App private key (for GitHub App authentication)
+    # :param app_algo: GitHub App algorithm (for GitHub App authentication, defaults to RS256)
+    # :return: A new IssueDB::Client object
+    def initialize(repo, log: nil, octokit_client: nil, label: nil, cache_expiry: nil, init: true, app_id: nil, installation_id: nil, app_key: nil, app_algo: nil)
+      @log = log || RedactingLogger.new($stdout, level: ENV.fetch("LOG_LEVEL", "INFO").upcase)
+      @version = VERSION
+      @client = Authentication.login(octokit_client, @log, app_id:, installation_id:, app_key:, app_algo:)
+      @repo = Repository.new(repo)
+      @label = label || ENV.fetch("ISSUE_DB_LABEL", "issue-db")
+      @cache_expiry = cache_expiry || ENV.fetch("ISSUE_DB_CACHE_EXPIRY", 60).to_i
+      init! if init
+    end
 
-  def read(key, options = {})
-    db.read(key, options)
-  end
+    def create(key, data, options = {})
+      db.create(key, data, options)
+    end
 
-  def update(key, data, options = {})
-    db.update(key, data, options)
-  end
+    def read(key, options = {})
+      db.read(key, options)
+    end
 
-  def delete(key, options = {})
-    db.delete(key, options)
-  end
+    def update(key, data, options = {})
+      db.update(key, data, options)
+    end
 
-  def list(options = {})
-    db.list(options)
-  end
+    def delete(key, options = {})
+      db.delete(key, options)
+    end
 
-  def list_keys(options = {})
-    db.list_keys(options)
-  end
+    def list(options = {})
+      db.list(options)
+    end
 
-  def refresh!
-    db.refresh!
-  end
+    def list_keys(options = {})
+      db.list_keys(options)
+    end
+
+    def refresh!
+      db.refresh!
+    end
 
-  protected
+    protected
 
-  def db
-    @db ||= Database.new(@log, @client, @repo, @label, @cache_expiry)
+    def db
+      @db ||= Database.new(@log, @client, @repo, @label, @cache_expiry)
+    end
   end
 end

data/lib/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-module Version
-  VERSION = "1.1.0"
+module IssueDB
+  module Version
+    VERSION = "1.2.0"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: issue-db
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - runwaylab