hasura_handler 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391dc0c3183a5a8ac53709ee48c14a0ee5fae6c085a21d200972556b732fcd1a
-  data.tar.gz: 32122de81ca8c930934383944f0387bdeb9e566a026aea488be203f0610d7137
+  metadata.gz: b476da389358677671ebee56a1d014dc90779a73ade92eaf6d17f894192d0f4c
+  data.tar.gz: 1aef41672a1832e2abe57e78b260fdef87a0e0147c470898ccb17dfb3b05c791
 SHA512:
-  metadata.gz: 687179bd480090e6a46e06f63aff4901f3b609f3321f91aba92b6a238a140bbb7220723261a25ce44cf30ce3dddbc023eded6e9e98c16c25a19bda3448b2928d
-  data.tar.gz: e7b506c5cd0904a626390b9ed76e02d0da34729b9299264b5457fb248dcc398d134a198364fdca36768111b1a5cd3ceabcd69042cd1505e9f5b956ccc7fdc354
+  metadata.gz: 466c57748a94c57040c9d963af6982f4796370c30c582c0c3a306b5d4bc0573f3d3989d6a4e3702f7c162c8e5ad659ee50b032aecc7ac606003dddafca9ffe1a
+  data.tar.gz: 921d0f38484c4d6f127660e7a999ef5af1a0bce82013aeccace3abf1ca6d4468c567d11355dc35691c97480056ad88829cba2dd0984ba9b6208679f62ff2b02b

data/README.md

@@ -1,28 +1,9 @@
-# HasuraHandler![tests](https://github.com/KazW/HasuraHandler/workflows/tests/badge.svg)
-Short description and motivation.
+# HasuraHandler ![Gem Version](https://badge.fury.io/rb/hasura_handler.svg) [![tests](https://github.com/KazW/HasuraHandler/workflows/tests/badge.svg)](https://github.com/KazW/HasuraHandler/actions?query=workflow%3Atests) [![Maintainability](https://api.codeclimate.com/v1/badges/38864d7565ab11729b6b/maintainability)](https://codeclimate.com/github/KazW/HasuraHandler/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/38864d7565ab11729b6b/test_coverage)](https://codeclimate.com/github/KazW/HasuraHandler/test_coverage)
+HasuraHandler is a Rails framework that makes building microservices for Hasura easy.
+HasuraHandler also simplifies adding Hasura to an existing Rails app.
 
 ## Usage
-How to use my plugin.
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'hasura_handler'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install hasura_handler
-```
-
-## Contributing
-Contribution directions go here.
+Please see the [documentation site](https://kazw.github.io/HasuraHandler).
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/hasura_handler/actions_controller.rb

@@ -2,29 +2,27 @@ require_dependency 'hasura_handler/application_controller'
 
 module HasuraHandler
   class ActionsController < ApplicationController
+    before_action :check_header
+
     def index
-      unless HasuraHandler::Action.hasura_actions.keys.include?(action_params['action']['name'])
+      unless HasuraHandler::Action.hasura_actions.keys.include?(raw_params['action']['name'])
         render json: { error: true, message: 'action name not registered' }, status: 404
         return
       end
 
-      klass = HasuraHandler::Action.hasura_actions[action_params['action']['name']]
-      action = klass.new(action_params['session_variables'].to_h, action_params['input'].to_h)
-      action.run
+      klass = HasuraHandler::Action.hasura_actions[raw_params['action']['name']]
+      action = klass.new(
+        clean_headers,
+        raw_params['session_variables'].to_h,
+        raw_params['input'].to_h
+      )
 
+      action.run
       if action.error_message.present?
         render json: { error: true, message: action.error_message }, status: 400
       else
         render json: action.output
       end
     end
-
-    def action_params
-      full_params.permit(
-        action: [:name],
-        input: {},
-        session_variables: {}
-      )
-    end
   end
 end

data/app/controllers/hasura_handler/application_controller.rb

@@ -1,6 +1,8 @@
 module HasuraHandler
   class ApplicationController < ActionController::API
-    before_action :check_header
+    def protect_against_forgery?
+      false
+    end
 
     private
 
@@ -10,8 +12,17 @@ module HasuraHandler
       end
     end
 
-    def full_params
-      ActionController::Parameters.new(JSON.parse(request.body.read))
+    def raw_params
+      @raw_params ||= JSON.parse(request.raw_post)
+    end
+
+    def clean_headers
+      request.
+      headers.
+      reject{ |k,v| k.include?('.') }.
+      to_h.
+      select{ |k,v| k =~ /\AHTTP_/ }.
+      to_h
     end
   end
 end

data/app/controllers/hasura_handler/auth_hook_controller.rb

@@ -0,0 +1,39 @@
+require_dependency "hasura_handler/application_controller"
+
+module HasuraHandler
+  class AuthHookController < ApplicationController
+    def get_mode
+      @headers = clean_headers
+      authenticate
+    end
+
+    def post_mode
+      @headers = raw_params['headers'].
+        to_h.
+        map{ |k,v| [standardize_header(k), v] }.
+        to_h
+
+      authenticate
+    end
+
+    private
+
+    def authenticate
+      @authenticator = HasuraHandler.
+        authenticator.
+        to_s.
+        constantize.
+        new(@headers)
+
+      if @authenticator.success?
+        render json: @authenticator.response, status: 200
+      else
+        render json: { error: true, message: @authenticator.error_message }, status: 401
+      end
+    end
+
+    def standardize_header(header)
+      "HTTP_#{header.to_s.gsub('-', '_').upcase}"
+    end
+  end
+end

data/app/controllers/hasura_handler/events_controller.rb

@@ -2,8 +2,10 @@ require_dependency 'hasura_handler/application_controller'
 
 module HasuraHandler
   class EventsController < ApplicationController
+    before_action :check_header
+
     def index
-      processor = HasuraHandler::EventProcessor.new(event_params.to_h)
+      processor = HasuraHandler::EventProcessor.new(raw_params)
 
       unless processor.event.valid?
         error_response(processor.event.errors)
@@ -30,29 +32,5 @@ module HasuraHandler
       response.set_header('Retry-After', HasuraHandler.retry_after)
       render json: { success: false, errors: errors }, status: 400
     end
-
-    def event_params
-      full_params.permit(
-        :id,
-        :created_at,
-        table: [
-          :schema,
-          :name
-        ],
-        trigger: [
-          :name
-        ],
-        event: [
-          :op,
-          {
-            session_variables: {},
-            data: {
-              new: {},
-              old: {}
-            }
-          }
-        ]
-      )
-    end
   end
 end

data/config/routes.rb

@@ -1,4 +1,9 @@
 HasuraHandler::Engine.routes.draw do
+  if HasuraHandler.authentication_enabled
+    get '/auth', to: 'auth_hook#get_mode'
+    post '/auth', to: 'auth_hook#post_mode'
+  end
+
   if HasuraHandler.events_enabled
     post '/events', to: 'events#index'
   end

data/lib/hasura_handler.rb

@@ -1,4 +1,5 @@
 require 'hasura_handler/engine'
+require 'hasura_handler/authenticator'
 require 'hasura_handler/event_handler'
 require 'hasura_handler/event_processor'
 require 'hasura_handler/event'
@@ -8,6 +9,8 @@ module HasuraHandler
   class << self
     mattr_accessor :auth_header,
                    :auth_key,
+                   :authentication_enabled,
+                   :authenticator,
                    :events_enabled,
                    :actions_enabled,
                    :event_job_queue,
@@ -17,6 +20,8 @@ module HasuraHandler
                    :retry_after
 
     self.auth_header = 'HTTP_X_HASURA_SERVICE_KEY'
+    self.authentication_enabled = false
+    self.authenticator = nil
     self.events_enabled = true
     self.async_events = true
     self.fanout_events = true
@@ -28,8 +33,13 @@ module HasuraHandler
 
   def self.setup(&block)
     yield self
-    [:auth_key].each do |key|
-      raise "HasuraHandler requires the #{key} to be configured." if self.send(key).blank?
+
+    if (self.events_enabled || self.actions_enabled) && self.auth_key.blank?
+      raise 'HasuraHandler requires the auth_key to be configured if actions or events are enabled.'
+    end
+
+    if self.authentication_enabled && self.authenticator.blank?
+      raise 'HasuraHandler requires the authenticator to be configured if authentication hook is enabled.'
     end
   end
 end

data/lib/hasura_handler/action.rb

@@ -17,11 +17,13 @@ module HasuraHandler
     end
 
     attr_reader :session_variables,
+                :headers,
                 :input,
                 :output,
                 :error_message
 
-    def initialize(session_variables, input)
+    def initialize(headers, session_variables, input)
+      @headers = headers
       @session_variables = session_variables
       @input = input
       @output = {}

data/lib/hasura_handler/authenticator.rb

@@ -0,0 +1,22 @@
+module HasuraHandler
+  class Authenticator
+    attr_reader :headers
+    attr_accessor :response,
+                  :error_message
+
+    def initialize(headers)
+      @headers = headers
+      @response = {}
+    end
+
+    def success?
+      begin
+        authenticate
+      ensure
+        return false if @response.blank?
+      end
+
+      @response.present? || @error_message.blank?
+    end
+  end
+end

data/lib/hasura_handler/engine.rb

@@ -2,5 +2,13 @@ module HasuraHandler
   class Engine < ::Rails::Engine
     isolate_namespace HasuraHandler
     config.generators.api_only = true
+
+    if Rails.version.to_f < 6
+      config.eager_load_paths += Dir[Rails.root.join('app', '{actions,reactions}', '*.rb')]
+    end
+
+    config.to_prepare do
+      Dir[Rails.root.join('app', '{actions,reactions}', '*.rb')].each{ |file| require_dependency file }
+    end
   end
 end

data/lib/hasura_handler/event_handler.rb

@@ -1,5 +1,7 @@
 module HasuraHandler
   class EventHandler
+    extend ActiveSupport::DescendantsTracker
+
     class << self
       attr_reader :hasura_matchers
 
@@ -8,8 +10,8 @@ module HasuraHandler
         allowed_matchers = [:table, :trigger, :op]
 
         matchers.keys.each do |matcher|
-          raise 'invalid matcher' unless allowed_matchers.include?(matcher)
-          raise 'invalid matcher value' unless matchers[matcher].is_a?(String)
+          raise "invalid matcher: #{matcher}" unless allowed_matchers.include?(matcher)
+          raise "invalid matcher value for: #{matcher}" unless matchers[matcher].is_a?(String)
         end
 
         @hasura_matchers = matchers

metadata

@@ -1,36 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hasura_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Kaz Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
-description: Provides an easy way to build custom backends for Hasura.
+        version: '5.0'
+description: HasuraHandler is a Rails framework that makes building microservices
+  for Hasura easy.
 email:
 - me@kaz.codes
 executables: []
@@ -42,6 +37,7 @@ files:
 - Rakefile
 - app/controllers/hasura_handler/actions_controller.rb
 - app/controllers/hasura_handler/application_controller.rb
+- app/controllers/hasura_handler/auth_hook_controller.rb
 - app/controllers/hasura_handler/events_controller.rb
 - app/jobs/hasura_handler/application_job.rb
 - app/jobs/hasura_handler/event_handler_job.rb
@@ -49,16 +45,20 @@ files:
 - config/routes.rb
 - lib/hasura_handler.rb
 - lib/hasura_handler/action.rb
+- lib/hasura_handler/authenticator.rb
 - lib/hasura_handler/engine.rb
 - lib/hasura_handler/event.rb
 - lib/hasura_handler/event_handler.rb
 - lib/hasura_handler/event_processor.rb
-- lib/hasura_handler/version.rb
 - lib/tasks/hasura_handler_tasks.rake
-homepage: https://github.com/KazW/HasuraHandler
+homepage: https://kazw.github.io/HasuraHandler
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/KazW/HasuraHandler/issues
+  documentation_uri: https://kazw.github.io/HasuraHandler
+  homepage_uri: https://kazw.github.io/HasuraHandler
+  source_code_uri: https://github.com/KazW/HasuraHandler
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Integrates Hasura with Rails

data/lib/hasura_handler/version.rb

@@ -1,3 +0,0 @@
-module HasuraHandler
-  VERSION = '0.1.4'
-end