hub_kernel-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f88a656280e3947879dd6de7324478d0e25a728445ce3f1b4cd90d65bf7e7815
+  data.tar.gz: a87e442f929a84ed92f128d25824f8e6154a4db93356187a8e29185b02a4541a
+SHA512:
+  metadata.gz: 2ad7cd9a06e4fc669dd54ea6288731b2e07d23aef30be8c8170bff74d8f1517428658a2feabea7ca12bb5d8e4b9b6d8ec4481c10b11b36ca5bbc11487cf29bc0
+  data.tar.gz: d78ea1612b08e6f4fe694617148ca50a32a1d8d6061066c79fd0dcd5a8ccd2711bd3fc85ad5f1c54693d489bdb872577fc2950ab052c50f1c781d0effac869e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# hub_kernel-api
+
+Serves a hub_kernel hub's exposed methods as a JSON API. The host lists the hubs it
+serves, and every call goes through the host's own sign-in, then hub_kernel's permission
+check and account scope.
+
+## Usage
+
+Add the gem, then in an initializer name the controller the API inherits from, the two
+methods on it that give the person and the account a call is made for, and the hubs it
+serves:
+
+```ruby
+HubKernel::Api.base_controller = "Api::HubBaseController"
+HubKernel::Api.person_method = :current_person
+HubKernel::Api.account_method = :current_account
+
+Rails.application.config.to_prepare do
+  HubKernel::Api.hubs = [ Supplies ]
+end
+```
+
+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:
+
+```ruby
+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
+return value under `answer`.
+
+| 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 record the call names does not exist | 404 | `{"error": "No <record> has the id <id>"}` |
+
+## Installation
+
+```ruby
+gem "hub_kernel-api"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

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

@@ -0,0 +1,35 @@
+module HubKernel
+  module Api
+    class HubCallsController < HubKernel::Api.base_controller.constantize
+      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?
+
+        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 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)
+        render json: { error: "No #{missing.model.demodulize.underscore.humanize(capitalize: false)} has the id #{missing.id}" }, status: :not_found
+      end
+    end
+  end
+end

data/config/routes.rb

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

data/lib/hub_kernel/api/engine.rb

@@ -0,0 +1,7 @@
+module HubKernel
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace HubKernel::Api
+    end
+  end
+end

data/lib/hub_kernel/api/version.rb

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

data/lib/hub_kernel/api.rb

@@ -0,0 +1,14 @@
+require "hub_kernel"
+require "hub_kernel/api/version"
+require "hub_kernel/api/engine"
+
+module HubKernel
+  module Api
+    mattr_accessor :hubs, default: []
+    mattr_accessor :base_controller, default: "ActionController::API"
+    mattr_accessor :person_method
+    mattr_accessor :account_method
+
+    def self.find(name) = hubs.find { |hub| hub.name.demodulize.underscore == name }
+  end
+end

data/lib/hub_kernel-api.rb

@@ -0,0 +1 @@
+require "hub_kernel/api"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: hub_kernel-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tylercschneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+- !ruby/object:Gem::Dependency
+  name: hub_kernel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+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.'
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/hub_kernel/api/hub_calls_controller.rb
+- config/routes.rb
+- lib/hub_kernel-api.rb
+- lib/hub_kernel/api.rb
+- lib/hub_kernel/api/engine.rb
+- lib/hub_kernel/api/version.rb
+homepage: https://github.com/DYB-Development/hub_kernel-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/DYB-Development/hub_kernel-api
+  source_code_uri: https://github.com/DYB-Development/hub_kernel-api
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Serves a hub_kernel hub's exposed methods as a JSON API.
+test_files: []