hub_kernel-api 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e1e73789993ac38e72f3707d5ff990ad680a180ea5c9b49afb8dbccc4ad2e0
-  data.tar.gz: '02937a7e3d0b5eb5979c316a32cb7dede99749b0d559b5846ff090a5c700fc64'
+  metadata.gz: 005a2ef443ca851aa60b1e07bbf00d20f36ad682a7dcba572fcb2c5847181831
+  data.tar.gz: 3da76e3b5993936cc999d4641e2d4b70476a8fb7d86451294a7a5f583b85fb0c
 SHA512:
-  metadata.gz: b8c5ba3ed71d2dbb8690ac63f7bded2b1cc9a3d9ef7e3592f65fe533402a6cbf8da8a7193e93e184bea3b6fa2bfa304e421ea16c9601bbbe8382c3524801fd29
-  data.tar.gz: 1ff6097cfa70e00947054dc7b3c788923f94ef5e11ec731869f42f30c08f315d2ba498b3452808f5cba9a021cb3336b07aae9849b930f57c8a43293226391430
+  metadata.gz: 36883d22bb606c36eca8c7e80620d1a8c07105254f41152a87e28c4317f91ff23ec58f5a6aa17971d106577695f25f2e8c5e3aa8b329108303a0ca8f341326fb
+  data.tar.gz: 78348ad9a3c18cffff53beadc24f99a15a5d0b4524a592da883e807966648bef9f550945bd059cacc60e03d60084bed3c0d8a8ead26c7d702baaca0c43eabaeb

data/README.md

@@ -17,9 +17,15 @@ HubKernel::Api.account_method = :current_account
 
 Rails.application.config.to_prepare do
   HubKernel::Api.hubs = [ Supplies ]
+  HubKernel::Api.check!
 end
 ```
 
+`HubKernel::Api.check!` raises `HubKernel::Api::UnservableHubError` when a served entry
+exposes no methods, when two served hubs answer at the same address, or when a served
+hub's exposed list has a problem, naming each. Inside `to_prepare` it runs again after
+every code reload.
+
 The base controller's own sign-in runs before every call. hub_kernel's permission check
 and account scope must also be set, as hub_kernel's readme describes. Mount the engine:
 
@@ -38,6 +44,16 @@ A hub listed this way answers only at the name given, and the permission check i
 asked about it by its own name, such as `ledger:record_spend`. A read answers GET and a write answers POST, and the answer is the method's
 return value under `answer`.
 
+A GET at a served hub's own address, `/<hub>`, lists the methods the caller may call on
+the account the host names, each with its name, the values it takes and its verb:
+
+```json
+[{ "name": "price_of", "takes": ["item"], "verb": "GET" }]
+```
+
+A hub that is not served is answered as not found, and a caller the host's sign-in refuses
+is shown nothing.
+
 | Case | Status | Body |
 | --- | --- | --- |
 | The method answers | 200 | `{"answer": ...}` |

data/app/controllers/hub_kernel/api/hub_calls_controller.rb

@@ -1,9 +1,8 @@
 module HubKernel
   module Api
-    class HubCallsController < HubKernel::Api.base_controller.constantize
+    class HubCallsController < HubController
       wrap_parameters false
 
-      rescue_from ActionController::RoutingError, HubKernel::NotAllowed, with: :not_found
       rescue_from HubKernel::Refused, HubKernel::MissingArgumentError, with: :refused
       rescue_from ActiveRecord::RecordNotFound, with: :missing_record
 
@@ -16,8 +15,6 @@ module HubKernel
 
       private
 
-      def hub = @hub ||= HubKernel::Api.find(params[:hub]) || raise(ActionController::RoutingError, "Not found")
-
       def asked_with_the_right_verb? = hub.exposed(params[:name])&.writes == request.post?
 
       def refuse_unlisted_values
@@ -32,12 +29,6 @@ module HubKernel
 
       def values = request.query_parameters.merge(request.request_parameters).deep_symbolize_keys
 
-      def caller_person = send(HubKernel::Api.person_method)
-
-      def caller_account = send(HubKernel::Api.account_method)
-
-      def not_found = render(json: { error: "Not found" }, status: :not_found)
-
       def refused(refusal) = render(json: { error: refusal.message }, status: :unprocessable_content)
 
       def missing_record(missing)

data/app/controllers/hub_kernel/api/hub_controller.rb

@@ -0,0 +1,17 @@
+module HubKernel
+  module Api
+    class HubController < HubKernel::Api.base_controller.constantize
+      rescue_from ActionController::RoutingError, HubKernel::NotAllowed, with: :not_found
+
+      private
+
+      def hub = @hub ||= HubKernel::Api.find(params[:hub]) || raise(ActionController::RoutingError, "Not found")
+
+      def caller_person = send(HubKernel::Api.person_method)
+
+      def caller_account = send(HubKernel::Api.account_method)
+
+      def not_found = render(json: { error: "Not found" }, status: :not_found)
+    end
+  end
+end

data/app/controllers/hub_kernel/api/hubs_controller.rb

@@ -0,0 +1,13 @@
+module HubKernel
+  module Api
+    class HubsController < HubController
+      def show
+        render json: hub.exposures_for(person: caller_person, account: caller_account).map { |exposure| listed(exposure) }
+      end
+
+      private
+
+      def listed(exposure) = { name: exposure.name, takes: exposure.takes, verb: exposure.writes ? "POST" : "GET" }
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,4 @@
 HubKernel::Api::Engine.routes.draw do
+  get ":hub", to: "hubs#show"
   match ":hub/:name", to: "hub_calls#answer", via: [ :get, :post ]
 end

data/lib/hub_kernel/api/version.rb

@@ -1,5 +1,5 @@
 module HubKernel
   module Api
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/hub_kernel/api.rb

@@ -4,6 +4,8 @@ require "hub_kernel/api/engine"
 
 module HubKernel
   module Api
+    class UnservableHubError < StandardError; end
+
     mattr_accessor :hubs, default: []
     mattr_accessor :base_controller, default: "ActionController::API"
     mattr_accessor :person_method
@@ -11,6 +13,24 @@ module HubKernel
 
     def self.find(name) = addresses[name]
 
-    def self.addresses = hubs.reduce({}) { |found, entry| found.merge(entry.is_a?(Hash) ? entry : { entry.name.demodulize.underscore => entry }) }
+    def self.check!
+      problems = unexposed_hubs + shared_addresses + exposure_problems
+      raise UnservableHubError, problems.join("\n") if problems.any?
+    end
+
+    def self.addresses = served.to_h
+
+    def self.served = hubs.flat_map { |entry| entry.is_a?(Hash) ? entry.to_a : [ [ entry.name.demodulize.underscore, entry ] ] }
+
+    def self.unexposed_hubs = served.map(&:last).reject { |hub| hub.respond_to?(:exposures) }.map { |hub| "#{hub.name} exposes no methods to serve" }
+
+    def self.shared_addresses
+      served.group_by(&:first).select { |_address, entries| entries.size > 1 }.map do |address, entries|
+        "#{entries.map { |_address, hub| hub.name }.join(" and ")} both answer at #{address}"
+      end
+    end
+
+    def self.exposure_problems = served.map(&:last).select { |hub| hub.respond_to?(:exposure_problems) }.flat_map(&:exposure_problems)
+    private_class_method :served, :unexposed_hubs, :shared_addresses, :exposure_problems
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - tylercschneider
@@ -50,6 +50,8 @@ files:
 - README.md
 - Rakefile
 - app/controllers/hub_kernel/api/hub_calls_controller.rb
+- app/controllers/hub_kernel/api/hub_controller.rb
+- app/controllers/hub_kernel/api/hubs_controller.rb
 - config/routes.rb
 - lib/hub_kernel-api.rb
 - lib/hub_kernel/api.rb