hub_kernel-interface 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9385ca6b5908cfc7854200c351dd6f6cbe30a90c850d14a7519c4e73a5d2eeeb
-  data.tar.gz: 199574b3bc71a071a97670a97dd8ab08747945b45216d1eac24d21f22ffa965a
+  metadata.gz: 46efe9234db5355c30fb8e4860fb8183028c7d41fb5e4ca4172d5f939bf0aee8
+  data.tar.gz: a0108815b76bd611f424978603340d9c1901d8e5d0632e78f1482dc9109a0747
 SHA512:
-  metadata.gz: 96ef67da95a65e5fd1f26c3fc6ef25e9ad0a9fb28a742b03ce2399aefb5360ccddcb4c764c04a2255b685b542a1d612937163b252b47ee7c2eb7cc2888688618
-  data.tar.gz: e36173e0a4b7f957323969718216df7c7c0ca5083ba1852ac094c77d75579b9da986e64c8c11c996e4efb139379d77a08862b773f557820f0b1f13532df09fc3
+  metadata.gz: 4366f0048a51612e55228f972bc76311ca69283b7e04ea22c463bcd3ae6a049d943f989b559ea25c9d69070f3afaaf2cfc5986afb46cd0e6c4094f5ee42b4d19
+  data.tar.gz: 7ad825094966140dccefbc112ace422d68986a6d6707ac7116fede8a215e3bf4bfce0250335c5efd773a4d39d9472b33ae27a15eb835ff8097828c236d015789

data/README.md

@@ -60,6 +60,22 @@ An interface gem's boot check runs `HubKernel::Interface.check!`, which raises
 an entry that exposes no methods, two entries that answer at the same name, and each
 problem in a served hub's exposed list.
 
+An interface gem checks a call's values before calling, and describes a record the call
+named that does not exist, so every interface gives the same reasons:
+
+```ruby
+HubKernel::Interface::CallReasons.refuse_unlisted_values(Supplies, "price_of", values: values, person: person, account: account)
+HubKernel::Interface::CallReasons.missing_record(error) # => "No consumable has the id 7"
+```
+
+`refuse_unlisted_values` does nothing for a call that sends only listed values, and asks the
+permission check nothing. For a call that sends any other value, it asks the permission check
+once about the called method, raises `HubKernel::NotAllowed` when it refuses, and otherwise
+raises `HubKernel::Refused` naming the method and every value it is not listed with.
+
+`Supplies.allows?("price_of", person: person, account: account)` asks the permission check
+about that one method. `missing_record` reads the error's `model` and `id`.
+
 `Supplies.exposure_problems` names each exposed method the hub has no method for, or lists
 with values it does not take. `HubKernel::Interface::ExposingHubs.list` holds every hub that
 declares an exposed method.

data/lib/hub_kernel/exposes.rb

@@ -29,6 +29,12 @@ module HubKernel
       exposures.select { |exposure| allowed?(exposure, person, account) }
     end
 
+    def allows?(name, person:, account:)
+      refuse_without_caller(person, account)
+
+      allowed?(exposed(name), person, account)
+    end
+
     def call_exposed(name, values:, person:, account:)
       refuse_without_caller(person, account)
 

data/lib/hub_kernel/interface/call_reasons.rb

@@ -0,0 +1,17 @@
+require "hub_kernel/exposes"
+
+module HubKernel
+  module Interface
+    module CallReasons
+      def self.refuse_unlisted_values(hub, name, values:, person:, account:)
+        unlisted = values.keys - hub.exposed(name).takes
+        return if unlisted.none?
+
+        raise HubKernel::NotAllowed, "#{hub.name.demodulize} #{name}" unless hub.allows?(name, person: person, account: account)
+        raise HubKernel::Refused, "#{name} does not take #{unlisted.join(", ")}" if unlisted.any?
+      end
+
+      def self.missing_record(missing) = "No #{missing.model.demodulize.underscore.humanize(capitalize: false)} has the id #{missing.id}"
+    end
+  end
+end

data/lib/hub_kernel/interface/version.rb

@@ -1,5 +1,5 @@
 module HubKernel
   module Interface
-    VERSION = "0.4.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/hub_kernel/interface.rb

@@ -1,5 +1,6 @@
 require "hub_kernel/interface/version"
 require "hub_kernel/exposes"
+require "hub_kernel/interface/call_reasons"
 
 module HubKernel
   module Interface

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-interface
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - tylercschneider
@@ -40,6 +40,7 @@ files:
 - lib/hub_kernel/context.rb
 - lib/hub_kernel/exposes.rb
 - lib/hub_kernel/interface.rb
+- lib/hub_kernel/interface/call_reasons.rb
 - lib/hub_kernel/interface/exposing_hubs.rb
 - lib/hub_kernel/interface/version.rb
 homepage: https://github.com/DYB-Development/hub_kernel-interface