ghub 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67209270e2d198aaa7f26601f2acd4c4fb5cc859b5a37f88ef395dbda34d5efa
+  data.tar.gz: fc1b61af0858733c161dc11d586d1fb001434a763475a311448427152e016705
+SHA512:
+  metadata.gz: a60bfc949f6987c33752838ddeb74897ffb08546e6306c50d921f607d1bf68dcbcc3bef036817ac0dd8d195573a298d5f0881216efcd30f178a2f7c2ed74a800
+  data.tar.gz: 7ea4fc6a7141a317fc5d8c2ae2b593bb31533a47209ee8141523eadd97a6fdf60077fe6397663efb363a4245974453234d9f13aec087e92c4183a580dd9ba87e

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,198 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Ghub
+
+Ghub is portmanteau (i.e. [g]it + hub = ghub) that provides a GitHub link:https://docs.github.com/en/rest[API] client using a design which leverages link:https://www.alchemists.io/articles/ruby_function_composition[function composition] and link:https://dry-rb.org/gems/dry-monads[monads]. This gem is built upon the link:https://github.com/httprb/http[HTTP] gem instead of link:https://lostisland.github.io/faraday[Faraday] which is what the link:https://github.com/octokit/octokit.rb[Octokit] gem uses.
+
+toc::[]
+
+== Features
+
+* Provides an API client which is a partial implementation of GitHub's link:https://docs.github.com/en/rest[API].
+* Provides HTTP request and response verification using link:https://dry-rb.org/gems/dry-schema[Dry Schema].
+* Uses link:https://www.alchemists.io/articles/ruby_function_composition[Function Composition] -- coupled with link:https://www.alchemists.io/projects/transactable[Transactable] -- to process each HTTP request and response.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+. link:https://github.com[GitHub].
+
+== Setup
+
+To set up the project, run:
+
+[source,bash]
+----
+bin/setup
+----
+
+== Usage
+
+All usage is via the `Ghub::Client` class.
+
+=== Initialization
+
+You can initialize an API client -- using the defaults as described in the _Environment_ section below -- as follows:
+
+[source,ruby]
+----
+client = Ghub::Client.new
+----
+
+Further customization can be done via a block:
+
+[source,ruby]
+----
+client = Ghub::Client.new do |config|
+  config.accept = "application/json"     # Uses a custom HTTP Accept header.
+  config.paginate = true                 # Enabled automatic pagination.
+  config.token = "ghp_abc"               # Provides a Personal Access Token (PAT).
+  config.url = "https://alt.github.com"  # Uses a custom API root.
+end
+----
+
+=== Environment
+
+Environment variable support can be managed using link:https://direnv.net[direnv]. These are the defaults:
+
+[source,bash]
+----
+GITHUB_API_ACCEPT=application/vnd.github+json
+GITHUB_API_PAGINATE=false
+GITHUB_API_TOKEN=
+GITHUB_API_URL=https://api.github.com
+----
+
+_You must provide a value for `GITHUB_API_TOKEN` in order to make authenticated API requests._ This can be done by creating a link:https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[Personal Access Token (PAT)] for the value.
+
+=== Endpoints
+
+Only partial support of the various API endpoints are supported. Each section below documents usage with additional documentation, usage, parameters, responses, etc. provided by the official GitHub API documentation links.
+
+==== Branch Protection
+
+The following is an example of how to link:https://docs.github.com/en/rest/branches/branch-protection#get-branch-protection[show], link:https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection[update], and link:https://docs.github.com/en/rest/branches/branch-protection#delete-branch-protection[destroy] branch protection:
+
+[source,ruby]
+----
+client.branch_protection.show "<owner>", "<repository>", "<branch>"
+client.branch_protection.update "<owner>", "<repository>", "<branch>", {}
+client.branch_protection.destroy "<owner>", "<repository>", "<branch>"
+----
+
+==== Branch Signature
+
+The following is an example of how to link:https://docs.github.com/en/rest/branches/branch-protection#get-commit-signature-protection[show], link:https://docs.github.com/en/rest/branches/branch-protection#create-commit-signature-protection[create], and link:https://docs.github.com/en/rest/branches/branch-protection#delete-commit-signature-protection[destroy] branch signature protection:
+
+[source,ruby]
+----
+client.branch_signature.show "<owner>", "<repository>", "<branch>"
+client.branch_signature.create "<owner>", "<repository>", "<branch>"
+client.branch_signature.destroy "<owner>", "<repository>", "<branch>"
+----
+
+==== Organization Members
+
+The following is how to link:https://docs.github.com/en/rest/orgs/members#list-organization-members[index] organization members.
+
+[source,ruby]
+----
+client.organization_members.index "<owner>"
+----
+
+==== Pulls
+
+The following is how to link:https://docs.github.com/en/rest/pulls/pulls#list-pull-requests[index] and link:https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request[show] pull requests:
+
+[source,ruby]
+----
+client.pulls.index "<owner>", "<repository>"
+client.pulls.show "<owner>", "<repository>", <id>
+----
+
+==== Repositories
+
+The following documents how to interact with repositories:
+
+* link:https://docs.github.com/en/rest/repos/repos#list-repositories-for-a-user[Index] (users)
+* link:https://docs.github.com/en/rest/repos/repos#list-organization-repositories[Index] (organizations)
+* link:https://docs.github.com/en/rest/repos/repos#get-a-repository[Show]
+* link:https://docs.github.com/en/rest/repos/repos#create-a-repository-for-the-authenticated-user[Create] (user)
+* link:https://docs.github.com/en/rest/repos/repos#create-an-organization-repository[Create] (organization)
+* link:https://docs.github.com/en/rest/repos/repos#update-a-repository[Update]
+* link:https://docs.github.com/en/rest/repos/repos#delete-a-repository[Destroy]
+
+[source,ruby]
+----
+client.repositories.index "<owner>", "<repository>"
+client.repositories.show "<owner>", "<repository>"
+
+# For a user.
+# Example: client.repositories.create :users, {name: "ghub-test", private: true}
+client.repositories.create :users, <attributes>
+
+# For an organization.
+# Example: client.repositories.create :orgs, {name: "ghub-test", private: true}, owner: "acme"
+client.repositories.create :orgs, <attributes>, owner: "<organization>"
+
+client.repositories.patch "<owner>", {description: "For test only."}
+client.repositories.destroy "<owner>", <id>
+----
+
+GitHub's API design for repositories is awkward and you can see this infect the Object API, especially when creating a repository. Use `:users` or `:orgs` (can be strings) to distinguish between the two types of repository creation. The only stipulation for organization creation is that you must supply the organization name. This was done so you could use the same Object API for both.
+
+==== Users
+
+The following is how to link:https://docs.github.com/en/rest/users/users#list-users[index] and link:https://docs.github.com/en/rest/users/users#get-a-user[show] users:
+
+[source,ruby]
+----
+client.users.index
+client.users.show "<user>"
+----
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/ghub
+cd ghub
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== link:https://www.alchemists.io/policies/license[License]
+
+== link:https://www.alchemists.io/policies/security[Security]
+
+== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://www.alchemists.io/policies/contributions[Contributions]
+
+== link:https://www.alchemists.io/projects/ghub/versions[Versions]
+
+== link:https://www.alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/ghub.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "ghub"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://www.alchemists.io/projects/ghub"
+  spec.summary = "A monadic GitHub API client."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/ghub/issues",
+    "changelog_uri" => "https://www.alchemists.io/projects/ghub/versions",
+    "documentation_uri" => "https://www.alchemists.io/projects/ghub",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Ghub",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/ghub"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.1"
+  spec.add_dependency "dry-container", "~> 0.11"
+  spec.add_dependency "dry-monads", "~> 1.5"
+  spec.add_dependency "dry-schema", "~> 1.11"
+  spec.add_dependency "http", "~> 5.1"
+  spec.add_dependency "infusible", "~> 0.1"
+  spec.add_dependency "refinements", "~> 9.6"
+  spec.add_dependency "transactable", "~> 0.1"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/ghub/api/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Ghub
+  module API
+    # A low-level API client.
+    class Client
+      include Import[:configuration, :http]
+      include Dry::Monads[:result]
+
+      def initialize page: Page, **dependencies
+        super(**dependencies)
+        @page = page
+      end
+
+      def get path, **parameters
+        return call :get, path, params: parameters unless configuration.paginate
+
+        page.of { |index| call :get, path, params: parameters.merge(page: index) }
+      end
+
+      def post path, body = nil, **parameters
+        call __method__, path, json: body, params: parameters
+      end
+
+      def put path, body = nil, **parameters
+        call __method__, path, json: body, params: parameters
+      end
+
+      def patch path, body = nil, **parameters
+        call __method__, path, json: body, params: parameters
+      end
+
+      def delete(path, **parameters) = call __method__, path, params: parameters
+
+      private
+
+      attr_reader :page
+
+      def call method, path, **options
+        http.auth("Bearer #{configuration.token}")
+            .headers(accept: configuration.accept)
+            .public_send(method, "#{configuration.url}/#{path}", options)
+            .then { |response| response.status.success? ? Success(response) : Failure(response) }
+      end
+    end
+  end
+end

data/lib/ghub/api/page.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "json"
+require "refinements/arrays"
+
+module Ghub
+  module API
+    # Represents a page of an API response.
+    class Page
+      extend Dry::Monads[:result]
+
+      using Refinements::Arrays
+
+      def self.of index = 1, bodies: [], &request
+        yield(index).fmap { |response| new response }
+                    .fmap { |page| [page, bodies.including(page.body)] }
+                    .bind do |page, amalgam|
+                      if page.last?
+                        Success page.to_response(amalgam)
+                      else
+                        of page.next, bodies: amalgam, &request
+                      end
+                    end
+      end
+
+      def initialize response
+        @response = response
+      end
+
+      def next = navigation __method__
+
+      def last? = navigation(:last).zero?
+
+      def body = response.parse
+
+      def to_response content = []
+        return response if content.empty?
+
+        response.class.new request: response.request,
+                           headers: response.headers,
+                           body: content.to_json,
+                           status: response.status,
+                           version: response.version
+      end
+
+      private
+
+      attr_reader :response
+
+      def navigation target
+        links.find { |link| link.include? target.to_s }
+             .then { |link| String(link)[/page=(?<page>\d+)/, :page].to_i }
+      end
+
+      def links = String(response.headers["Link"]).split ", "
+    end
+  end
+end

data/lib/ghub/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Ghub
+  # The primary interface for making API requests.
+  class Client
+    include Import[:configuration]
+
+    include Endpoints::Import[
+      branch_protection_endpoint: :branch_protection,
+      branch_signature_endpoint: :branch_signature,
+      organization_members_endpoint: :organization_members,
+      pulls_endpoint: :pulls,
+      repositories_endpoint: :repositories,
+      users_endpoint: :users
+    ]
+
+    def initialize **dependencies
+      super(**dependencies)
+      yield configuration if block_given?
+    end
+
+    def branch_protection = branch_protection_endpoint
+
+    def branch_signature = branch_signature_endpoint
+
+    def organization_members = organization_members_endpoint
+
+    def pulls = pulls_endpoint
+
+    def repositories = repositories_endpoint
+
+    def users = users_endpoint
+  end
+end

data/lib/ghub/configuration/content.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Ghub
+  module Configuration
+    # Defines the client configuration content for API requests.
+    Content = Struct.new :accept, :paginate, :token, :url, keyword_init: true
+  end
+end

data/lib/ghub/configuration/loader.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Ghub
+  module Configuration
+    # Handles loading of configuration with environment defaults.
+    class Loader
+      using Refinements::Strings
+
+      def initialize model = Content, environment: ENV
+        @model = model
+        @environment = environment
+      end
+
+      def call
+        model[
+          accept: environment.fetch("GITHUB_API_ACCEPT", "application/vnd.github+json"),
+          paginate: environment.fetch("GITHUB_API_PAGINATE", "false").to_bool,
+          token: environment["GITHUB_API_TOKEN"],
+          url: environment.fetch("GITHUB_API_URL", "https://api.github.com")
+        ]
+      end
+
+      private
+
+      attr_reader :model, :environment
+    end
+  end
+end

data/lib/ghub/container.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "http"
+
+module Ghub
+  # Defines application dependencies.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration, memoize: true) { Configuration::Loader.new.call }
+    register(:http) { HTTP }
+    register(:client) { API::Client.new }
+  end
+end

data/lib/ghub/endpoints/branches/protection/actions/show.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "transactable"
+
+module Ghub
+  module Endpoints
+    module Branches
+      module Protection
+        module Actions
+          # Handles a branch projection show action.
+          class Show
+            include Protection::Import[:client, response: "responses.show", model: "models.show"]
+            include Transactable
+
+            def call owner, repository, branch, **parameters
+              pipe(
+                client.get(
+                  "repos/#{owner}/#{repository}/branches/#{branch}/protection",
+                  **parameters
+                ),
+                try(:parse, catch: JSON::ParserError),
+                validate(response),
+                to(model, :for)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/branches/protection/actions/update.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "transactable"
+
+module Ghub
+  module Endpoints
+    module Branches
+      module Protection
+        module Actions
+          # Handles a branch projection update action.
+          class Update
+            include Protection::Import[
+              :client,
+              request: "requests.update",
+              response: "responses.show",
+              model: "models.show"
+            ]
+
+            include Transactable
+
+            def call owner, repository, branch, body, **parameters
+              pipe(
+                body,
+                validate(request),
+                insert("repos/#{owner}/#{repository}/branches/#{branch}/protection", at: 0),
+                insert(parameters),
+                to(client, :put),
+                try(:parse, catch: JSON::ParserError),
+                validate(response),
+                to(model, :for)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end