hub_kernel-api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff8bff7f1990c004e388aac6bbfe08f93f6007263653962a93ee7589d185a24
-  data.tar.gz: f79790b1f3a26080b561ce6968142c39aa584742b0a5e037a231165ed00fd0d2
+  metadata.gz: e54d19b67798c82119ecff94f0f294353cd927da83a55282b2f61ffbf111061d
+  data.tar.gz: 1d48fc7eb9520cb6300315462a74159b68a0e236c797f87d97964c4455eefce1
 SHA512:
-  metadata.gz: 3d9ee144416f2ab53a5f66aa0e590ab7a784cec6519a49d89336c3dfe0df53bf6ce9ace1cda27644e9e5616ccf08f33bde8e5b04a30b8bc356153ccbffbc716f
-  data.tar.gz: fe2a86a74e9e47f6b78b3093d6ac29bd766d706b3b3024762a89f3e80d2936be896d90633b2860f78700cce2f25674035fd8e939d94472e5bd7967850e81993b
+  metadata.gz: fa3f514ecb094b92a30e80fc390414abf616e68c8b479485462d5f7298d77cab57f3d813ced143fbafc58330f8685a7cac2d94aad14693a006730ff0c0ba6060
+  data.tar.gz: 07c3ae8786feb3ad091474071d2dc7699ee8cc0b7ebb798f95cd53c7afaac53096e7df8d261bbd5c1e01ba4f13a613998b40cea868c4afccabcc12a0789c0fe9

data/README.md

@@ -38,11 +38,22 @@ 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": ...}` |
 | The hub is not served, the method is not exposed, the verb is wrong, or the host's permission check refuses | 404 | `{"error": "Not found"}` |
 | The hub refuses, or a required value is missing | 422 | `{"error": "<reason>"}` |
+| A permitted call sends a value the method is not listed with | 422 | `{"error": "<method> does not take <values>"}` |
 | A record the call names does not exist | 404 | `{"error": "No <record> has the id <id>"}` |
 
 ## Installation

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

@@ -1,29 +1,33 @@
 module HubKernel
   module Api
-    class HubCallsController < HubKernel::Api.base_controller.constantize
-      rescue_from ActionController::RoutingError, HubKernel::NotAllowed, with: :not_found
+    class HubCallsController < HubController
+      wrap_parameters false
+
       rescue_from HubKernel::Refused, HubKernel::MissingArgumentError, with: :refused
       rescue_from ActiveRecord::RecordNotFound, with: :missing_record
 
       def answer
         raise ActionController::RoutingError, "Not found" unless asked_with_the_right_verb?
+        return refuse_unlisted_values if unlisted_values.any?
 
         render json: { answer: hub.call_exposed(params[:name], values: values, person: caller_person, account: caller_account) }
       end
 
       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 values = request.query_parameters.merge(request.request_parameters).deep_symbolize_keys
+      def refuse_unlisted_values
+        raise HubKernel::NotAllowed unless permitted?
 
-      def caller_person = send(HubKernel::Api.person_method)
+        refused(HubKernel::Refused.new("#{params[:name]} does not take #{unlisted_values.join(", ")}"))
+      end
+
+      def permitted? = hub.exposures_for(person: caller_person, account: caller_account).any? { |exposure| exposure.name.to_s == params[:name] }
 
-      def caller_account = send(HubKernel::Api.account_method)
+      def unlisted_values = values.keys - hub.exposed(params[:name]).takes
 
-      def not_found = render(json: { error: "Not found" }, status: :not_found)
+      def values = request.query_parameters.merge(request.request_parameters).deep_symbolize_keys
 
       def refused(refusal) = render(json: { error: refusal.message }, status: :unprocessable_content)
 

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.2.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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
 description: 'hub_kernel-api gives any hub built on hub_kernel a JSON API: the host
   lists the hubs it serves, and every call goes through the host''s sign-in, permission
   check and account scope.'
@@ -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