hasura_handler 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f772550a50cbdcfdcebd62cc96813060cd16a10c0bb6196a7405c6fa418c915a
-  data.tar.gz: 85b8df94f285c9fa393dc1d05126af92dfec690f5ff16092a317d6a494355905
+  metadata.gz: 25f72768507a2bb41a57d8496b0a169a81d9f6a23f1b319b0b75070d9fad060d
+  data.tar.gz: a45f22682a707e9387daf8243715f48f6e84ac6d813329e87581b128d6822baa
 SHA512:
-  metadata.gz: b263514fe1d23d90c422a933c14ee3ac0e69c7a681702fdbfc85f7ec65bf66f5f738dbf4ebc2c2a54e032ab84cbba143b7f9a73e39d12ffa532b0e816157024f
-  data.tar.gz: 636455f631df28448915c2a3fa8c2fe79348c453845dc1b30a30bbf879ff15a3e5126da6a31216e1cdb620dc000b936a00bb14f69a620661685fed995ee3192e
+  metadata.gz: 5047bb08871d97abf679305bf0ec75c0de747b2a9ba9b30287b8f946bb7fe28337dbc38011c5d8224dd292b50cf4b7b6df67331b832ba6bd49120dd22207ef0c
+  data.tar.gz: bb3a3b2637e97375ab5a8477e3cf5a13e7e2d06800e8758411620c24e9eb938ffe793a9b90e744cdfa05d03b934bee8b96be2b614a9a125d40e3d097fdc5963f

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,12 @@ 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
     end
   end
 end

data/app/controllers/hasura_handler/auth_hook_controller.rb

@@ -0,0 +1,31 @@
+require_dependency "hasura_handler/application_controller"
+
+module HasuraHandler
+  class AuthHookController < ApplicationController
+    def get_mode
+      @headers = clean_headers.to_h.select{ |k,v| k =~ /\AHTTP_/ }.to_h
+      authenticate
+    end
+
+    def post_mode
+      @headers = raw_params['headers'].
+        to_h.
+        map{ |k,v| ['HTTP_' + k.to_s.gsub('-', '_').upcase, v] }.
+        to_h
+
+      authenticate
+    end
+
+    private
+
+    def authenticate
+      @authenticator = HasuraHandler.authenticator.new(@headers)
+
+      if @authenticator.success?
+        render json: @authenticator.response, status: 200
+      else
+        render json: { error: true, message: @authenticator.error_message }, status: 401
+      end
+    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::EventHandler.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/app/jobs/hasura_handler/event_handler_job.rb

@@ -4,7 +4,7 @@ module HasuraHandler
 
     def perform(handler_class, event)
       klass = handler_class.constantize
-      handler = klass.new(event)
+      handler = klass.new(HasuraHandler::Event.new(event))
       handler.run
     end
   end

data/app/jobs/hasura_handler/event_job.rb

@@ -3,7 +3,7 @@ module HasuraHandler
     queue_as HasuraHandler.event_job_queue
 
     def perform(event)
-      HasuraHandler::EventHandler.new(event).process
+      HasuraHandler::EventProcessor.new(event).process
     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,5 +1,7 @@
 require 'hasura_handler/engine'
+require 'hasura_handler/authenticator'
 require 'hasura_handler/event_handler'
+require 'hasura_handler/event_processor'
 require 'hasura_handler/event'
 require 'hasura_handler/action'
 
@@ -7,6 +9,8 @@ module HasuraHandler
   class << self
     mattr_accessor :auth_header,
                    :auth_key,
+                   :authentication_enabled,
+                   :authenticator,
                    :events_enabled,
                    :actions_enabled,
                    :event_job_queue,
@@ -16,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
@@ -27,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/event.rb

@@ -4,6 +4,7 @@ module HasuraHandler
                 :table,
                 :trigger,
                 :event,
+                :op,
                 :created_at,
                 :raw_event,
                 :errors,
@@ -11,9 +12,10 @@ module HasuraHandler
 
     def initialize(event)
       @id = event['id']
-      @table = event['table']
-      @trigger = event['trigger']
+      @table = event['table']['name']
+      @trigger = event['trigger']['name']
       @event = event['event']
+      @op = event['event']['op']
       @created_at = event['created_at']
       @raw_event = event
       @errors = {}
@@ -42,21 +44,21 @@ module HasuraHandler
     end
 
     def validate_table
-      unless @table.is_a?(Hash)
+      unless @raw_event['table'].is_a?(Hash)
         @errors['table'] = 'not a hash'
         return
       end
 
-      string_fields?(@table, 'table', [:schema, :name])
+      string_fields?(@raw_event['table'], 'table', [:schema, :name])
     end
 
     def validate_trigger
-      unless @trigger.is_a?(Hash)
+      unless @raw_event['trigger'].is_a?(Hash)
         @errors['trigger'] = 'not a hash'
         return
       end
 
-      string_fields?(@trigger, 'trigger', [:name])
+      string_fields?(@raw_event['trigger'], 'trigger', [:name])
     end
 
     def validate_event

data/lib/hasura_handler/event_handler.rb

@@ -16,6 +16,8 @@ module HasuraHandler
       end
     end
 
+    attr_reader :event
+
     def initialize(event)
       @event = event
     end

data/lib/hasura_handler/event_processor.rb

@@ -19,6 +19,10 @@ module HasuraHandler
           handler.run
         end
       end
+
+      if event_handlers.size == 0
+        Rails.logger.debug('[HasuraHandler] Received event with no matching handlers.')
+      end
     end
 
     private
@@ -28,6 +32,7 @@ module HasuraHandler
       descendants.
       map{ |klass| [klass, klass.hasura_matchers] }.
       to_h.
+      select{ |klass, matchers| matchers.present? }.
       map{ |klass,matchers| [klass, check_matchers(matchers)] }.
       to_h.
       select{ |klass,match| match }.
@@ -35,8 +40,8 @@ module HasuraHandler
     end
 
     def check_matchers(matchers)
-      matchers.all? do |matcher|
-        @event.send(matcher.first) == matcher.last
+      matchers.all? do |field,value|
+        @event.send(field) == value
       end
     end
   end

metadata

@@ -1,36 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hasura_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Kaz Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-08-04 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.3'
-end