hub_kernel-api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88a656280e3947879dd6de7324478d0e25a728445ce3f1b4cd90d65bf7e7815
-  data.tar.gz: a87e442f929a84ed92f128d25824f8e6154a4db93356187a8e29185b02a4541a
+  metadata.gz: 86e1e73789993ac38e72f3707d5ff990ad680a180ea5c9b49afb8dbccc4ad2e0
+  data.tar.gz: '02937a7e3d0b5eb5979c316a32cb7dede99749b0d559b5846ff090a5c700fc64'
 SHA512:
-  metadata.gz: 2ad7cd9a06e4fc669dd54ea6288731b2e07d23aef30be8c8170bff74d8f1517428658a2feabea7ca12bb5d8e4b9b6d8ec4481c10b11b36ca5bbc11487cf29bc0
-  data.tar.gz: d78ea1612b08e6f4fe694617148ca50a32a1d8d6061066c79fd0dcd5a8ccd2711bd3fc85ad5f1c54693d489bdb872577fc2950ab052c50f1c781d0effac869e8
+  metadata.gz: b8c5ba3ed71d2dbb8690ac63f7bded2b1cc9a3d9ef7e3592f65fe533402a6cbf8da8a7193e93e184bea3b6fa2bfa304e421ea16c9601bbbe8382c3524801fd29
+  data.tar.gz: 1ff6097cfa70e00947054dc7b3c788923f94ef5e11ec731869f42f30c08f315d2ba498b3452808f5cba9a021cb3336b07aae9849b930f57c8a43293226391430

data/README.md

@@ -28,7 +28,14 @@ mount HubKernel::Api::Engine => "/api/v1/hubs"
 ```
 
 Each exposed method answers at `/<hub>/<method>`, where `<hub>` is the hub's module name
-underscored. A read answers GET and a write answers POST, and the answer is the method's
+underscored. To answer at a name of the host's choosing, list the hub as a one-pair hash:
+
+```ruby
+HubKernel::Api.hubs = [ Supplies, { "money" => Billing::Ledger } ]
+```
+
+A hub listed this way answers only at the name given, and the permission check is still
+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`.
 
 | Case | Status | Body |
@@ -36,6 +43,7 @@ return value under `answer`.
 | 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,12 +1,15 @@
 module HubKernel
   module Api
     class HubCallsController < HubKernel::Api.base_controller.constantize
+      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
 
       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
@@ -17,6 +20,16 @@ module HubKernel
 
       def asked_with_the_right_verb? = hub.exposed(params[:name])&.writes == request.post?
 
+      def refuse_unlisted_values
+        raise HubKernel::NotAllowed unless permitted?
+
+        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 unlisted_values = values.keys - hub.exposed(params[:name]).takes
+
       def values = request.query_parameters.merge(request.request_parameters).deep_symbolize_keys
 
       def caller_person = send(HubKernel::Api.person_method)

data/lib/hub_kernel/api/version.rb

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

data/lib/hub_kernel/api.rb

@@ -9,6 +9,8 @@ module HubKernel
     mattr_accessor :person_method
     mattr_accessor :account_method
 
-    def self.find(name) = hubs.find { |hub| hub.name.demodulize.underscore == name }
+    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 }) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.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.'