ghub 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70374819e231535495ea7691e634aef56616e2065bd6a65bec82a33f4f8af7ee
-  data.tar.gz: 0657d78763952299f611047d9c8f640189478037ce770a75dcab5c9a1e14a199
+  metadata.gz: ce5b37f7c61c21eeeff22b06117bee8ec9cf0c80bc119f82d92f8b8c7d2475c6
+  data.tar.gz: 62cfd658f42a0b836869b212c13c9f5f6e6e2c9e86bc5d06da43367268f668c6
 SHA512:
-  metadata.gz: c0df55e7dd487a9b9d62302f6f4403ad5b11cab6e5fcd869d7a4e147c3e40d8e6b984926d5bb24f363c15087090013d0a1db674848e1056eef1d02081df05a45
-  data.tar.gz: 851294544b56028aa1bf060a8cd0d745c7501885ed798e6d699a5590ddf9c5264f5ce1e6a0c643905adbd27b4aaa171ddf6e4c463b2c5da20590b4c58172cd84
+  metadata.gz: 8f5c9a045f4abfab759860eeefc8169f402fce8906f9471b4542880da9caae712816996be863f392723dbee49e6e2a2d59fd3373a0cef120ea852054a8043e0c
+  data.tar.gz: b589f93696d26551cca0db2629c0551911b29dba3e4bcc59dc5e3c6857f29638bbde5758687a28be658876526b570b6adde3e1af14f775f3c565721aab06846a

data/README.adoc

@@ -4,7 +4,7 @@
 
 = 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://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.
+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://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 which provides a nicer Object API instead of link:https://lostisland.github.io/faraday[Faraday] which is what the link:https://github.com/octokit/octokit.rb[Octokit] gem uses.
 
 toc::[]
 
@@ -151,6 +151,15 @@ client.repositories.destroy "acme", "ghub-test"
 
 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.
 
+==== Search
+
+The following is how to search link:https://docs.github.com/en/rest/search/search#search-users[users]:
+
+[source,ruby]
+----
+client.search_users.index q: "test@example.com"
+----
+
 ==== 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:

data/ghub.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ghub"
-  spec.version = "0.5.1"
+  spec.version = "0.7.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/ghub"

data/lib/ghub/client.rb

@@ -11,6 +11,7 @@ module Ghub
       organization_members_endpoint: :organization_members,
       pulls_endpoint: :pulls,
       repositories_endpoint: :repositories,
+      search_users_endpoint: :search_users,
       users_endpoint: :users
     ]
 
@@ -29,6 +30,8 @@ module Ghub
 
     def repositories = repositories_endpoint
 
+    def search_users = search_users_endpoint
+
     def users = users_endpoint
   end
 end

data/lib/ghub/endpoints/container.rb

@@ -13,6 +13,7 @@ module Ghub
       register(:organization_members) { Endpoints::Organizations::Members::Root.new }
       register(:pulls) { Endpoints::Pulls::Root.new }
       register(:repositories) { Endpoints::Repositories::Root.new }
+      register(:search_users) { Endpoints::Search::Users::Root.new }
       register(:users) { Endpoints::Users::Root.new }
     end
   end

data/lib/ghub/endpoints/search/users/actions/index.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "transactable"
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        module Actions
+          # Handles a user index action.
+          class Index
+            include Import[:client, response: "responses.index", model: "models.index"]
+            include Transactable
+
+            def call **parameters
+              pipe(
+                client.get("search/users", **parameters),
+                try(:parse, catch: JSON::ParserError),
+                validate(response),
+                as(:fetch, :items),
+                map { |item| model.new item.to_h }
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/search/users/container.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "dry/container"
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        # Defines user dependencies.
+        module Container
+          extend Dry::Container::Mixin
+
+          merge Ghub::Container
+
+          namespace :responses do
+            register(:index) { Responses::Index }
+          end
+
+          namespace :models do
+            register(:index) { Models::Index }
+          end
+
+          namespace :actions do
+            register(:index) { Actions::Index.new }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/search/users/import.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "infusible"
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        Import = Infusible.with Container
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/search/users/models/index.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        module Models
+          # Defines a user within a collection.
+          Index = Struct.new(
+            :avatar_url,
+            :events_url,
+            :followers_url,
+            :following_url,
+            :gists_url,
+            :gravatar_id,
+            :html_url,
+            :id,
+            :login,
+            :node_id,
+            :organizations_url,
+            :received_events_url,
+            :repos_url,
+            :score,
+            :site_admin,
+            :starred_url,
+            :subscriptions_url,
+            :type,
+            :url,
+            keyword_init: true
+          ) do
+            include Resultable
+
+            def initialize *arguments
+              super
+              freeze
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/search/users/responses/index.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        module Responses
+          # Defines a user within a collection.
+          Index = Dry::Schema.Params do
+            required(:total_count).filled :integer
+            required(:incomplete_results).filled :bool
+            required(:items).array(:hash) do
+              required(:avatar_url).filled :string
+              required(:events_url).filled :string
+              required(:followers_url).filled :string
+              required(:following_url).filled :string
+              required(:gists_url).filled :string
+              required(:gravatar_id).maybe :string
+              required(:html_url).filled :string
+              required(:id).filled :integer
+              required(:login).filled :string
+              required(:node_id).filled :string
+              required(:organizations_url).filled :string
+              required(:received_events_url).filled :string
+              required(:repos_url).filled :string
+              required(:score).filled :float
+              required(:site_admin).filled :bool
+              required(:starred_url).filled :string
+              required(:subscriptions_url).filled :string
+              required(:type).filled :string
+              required(:url).filled :string
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ghub/endpoints/search/users/root.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ghub
+  module Endpoints
+    module Search
+      module Users
+        # Provides access to the search API endpoint for users.
+        class Root
+          include Users::Import[index_action: "actions.index"]
+
+          def index(...) = index_action.call(...)
+        end
+      end
+    end
+  end
+end

data/lib/ghub/resultable.rb

@@ -5,9 +5,9 @@ module Ghub
   module Resultable
     include Dry::Monads[:result]
 
-    def self.included object
+    def self.included descendant
       super
-      object.extend ClassMethods
+      descendant.extend ClassMethods
     end
 
     # Allows an object to be callable via a class method.

data/lib/ghub.rb

@@ -6,11 +6,14 @@ require "zeitwerk"
 
 Dry::Schema.load_extensions :monads
 
-Zeitwerk::Loader.for_gem.then do |loader|
+Zeitwerk::Loader.new.then do |loader|
   loader.inflector.inflect "api" => "API"
+  loader.tag = File.basename __FILE__, ".rb"
+  loader.push_dir __dir__
   loader.setup
 end
 
 # Main namespace.
 module Ghub
+  def self.loader(registry = Zeitwerk::Registry) = registry.loader_for __FILE__
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghub
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -206,6 +206,12 @@ files:
 - lib/ghub/endpoints/repositories/responses/index.rb
 - lib/ghub/endpoints/repositories/responses/show.rb
 - lib/ghub/endpoints/repositories/root.rb
+- lib/ghub/endpoints/search/users/actions/index.rb
+- lib/ghub/endpoints/search/users/container.rb
+- lib/ghub/endpoints/search/users/import.rb
+- lib/ghub/endpoints/search/users/models/index.rb
+- lib/ghub/endpoints/search/users/responses/index.rb
+- lib/ghub/endpoints/search/users/root.rb
 - lib/ghub/endpoints/users/actions/index.rb
 - lib/ghub/endpoints/users/actions/show.rb
 - lib/ghub/endpoints/users/container.rb
@@ -276,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A monadic GitHub API client.