hub_kernel-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e1e73789993ac38e72f3707d5ff990ad680a180ea5c9b49afb8dbccc4ad2e0
-  data.tar.gz: '02937a7e3d0b5eb5979c316a32cb7dede99749b0d559b5846ff090a5c700fc64'
+  metadata.gz: e54d19b67798c82119ecff94f0f294353cd927da83a55282b2f61ffbf111061d
+  data.tar.gz: 1d48fc7eb9520cb6300315462a74159b68a0e236c797f87d97964c4455eefce1
 SHA512:
-  metadata.gz: b8c5ba3ed71d2dbb8690ac63f7bded2b1cc9a3d9ef7e3592f65fe533402a6cbf8da8a7193e93e184bea3b6fa2bfa304e421ea16c9601bbbe8382c3524801fd29
-  data.tar.gz: 1ff6097cfa70e00947054dc7b3c788923f94ef5e11ec731869f42f30c08f315d2ba498b3452808f5cba9a021cb3336b07aae9849b930f57c8a43293226391430
+  metadata.gz: fa3f514ecb094b92a30e80fc390414abf616e68c8b479485462d5f7298d77cab57f3d813ced143fbafc58330f8685a7cac2d94aad14693a006730ff0c0ba6060
+  data.tar.gz: 07c3ae8786feb3ad091474071d2dc7699ee8cc0b7ebb798f95cd53c7afaac53096e7df8d261bbd5c1e01ba4f13a613998b40cea868c4afccabcc12a0789c0fe9

data/README.md

@@ -38,6 +38,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.4.0"
   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.4.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