hasura_handler 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95be3b9811df02080b282112b53e0b0a6aacd4520cd98de9de851af3349028a8
-  data.tar.gz: 41a54a270f42447b21ae308b79e23bd1ad24851cbc00d1c5101d8ca478342ef5
+  metadata.gz: d39e768059737605f096e2fb1ebc03b97a30ff3c05a55a580bc4f99b96e0e60e
+  data.tar.gz: 9322488f0d8cd4934509279e28b824926cb1f7a14a982700c323f5c11dab5d81
 SHA512:
-  metadata.gz: f03c0e96d4c8f4e06de84c7ed087fb79a3c86d0fe8be6a29fd8d465d581c1a0735e81bf7cb3015eb1c7ac4bc2e25416ceef712716aa805a9163c6940d83aaa59
-  data.tar.gz: b3c696453cd65e2c16b9d0e2888d0681456d7bba76d1e78d93b5cbcf510096c5618ecd58e5d81c5c7bdbfdffe8d68a651963e8737e293b93476fd9d6d7c8c720
+  metadata.gz: 021c7736f7148d728ea3b09562051e5b3679a6b9370a127304f988274a81cf2959b012dc2b2561fb257f43c10a2e396d753ce01101d19d1c1cc300337df9da69
+  data.tar.gz: ddda66c93f15b46b003f063b878fc00c59adba67bc0d6ec500d1b514ad1dfd0ecedf6f761db967a146678fb442060e8dbcb4cbea0306688ef0490ac31293118f

data/README.md

@@ -1,28 +1,9 @@
-# HasuraHandler
-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,16 +2,22 @@ require_dependency 'hasura_handler/application_controller'
 
 module HasuraHandler
   class ActionsController < ApplicationController
-    def process
-      unless HasuraHandler::Action.hasura_actions.keys.include?(action_params[:action][:name])
+    before_action :check_header
+
+    def index
+      unless HasuraHandler::Action.hasura_actions.keys.include?(action_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], action_params[:input])
-      action.run
+      klass = HasuraHandler::Action.hasura_actions[action_params['action']['name']]
+      action = klass.new(
+        clean_headers,
+        action_params['session_variables'].to_h,
+        action_params['input'].to_h
+      )
 
+      action.run
       if action.error_message.present?
         render json: { error: true, message: action.error_message }, status: 400
       else
@@ -20,7 +26,7 @@ module HasuraHandler
     end
 
     def action_params
-      params.permit(
+      full_params.permit(
         action: [:name],
         input: {},
         session_variables: {}

data/app/controllers/hasura_handler/application_controller.rb

@@ -1,7 +1,5 @@
 module HasuraHandler
   class ApplicationController < ActionController::API
-    before_action :check_header
-
     private
 
     def check_header
@@ -9,5 +7,13 @@ module HasuraHandler
         render json: { error: true, message: 'unable to authenticate request' }, status: 401
       end
     end
+
+    def full_params
+      ActionController::Parameters.new(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,35 @@
+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 = post_params['auth_hook']['headers'].
+        to_h.
+        map{ |k,v| ['HTTP_' + k.to_s.gsub('-', '_').upcase, v] }.
+        to_h
+
+      authenticate
+    end
+
+    private
+
+    def post_params
+      params.permit(auth_hook: {}, headers: {})
+    end
+
+    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
-    def process
-      processor = HasuraHandler::EventHandler.new(event_params)
+    before_action :check_header
+
+    def index
+      processor = HasuraHandler::EventProcessor.new(event_params.to_h)
 
       unless processor.event.valid?
         error_response(processor.event.errors)
@@ -32,9 +34,10 @@ module HasuraHandler
     end
 
     def event_params
-      params.permit(
+      full_params.permit(
         :id,
         :created_at,
+        delivery_info: {},
         table: [
           :schema,
           :name
@@ -46,10 +49,7 @@ module HasuraHandler
           :op,
           {
             session_variables: {},
-            data: {
-              new: {},
-              old: {}
-            }
+            data: {}
           }
         ]
       )

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,9 +1,14 @@
 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#process'
+    post '/events', to: 'events#index'
   end
 
   if HasuraHandler.actions_enabled
-    post '/actions', to: 'actions#process'
+    post '/actions', to: 'actions#index'
   end
 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,
@@ -15,7 +19,9 @@ module HasuraHandler
                    :fanout_events,
                    :retry_after
 
-    self.auth_header = 'X-Hasura-Service-Key'
+    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

@@ -5,9 +5,7 @@ module HasuraHandler
       attr_reader :hasura_action_name
 
       def action_name(action_name)
-        raise 'run method not defined' unless new(nil, nil).respond_to?(:run)
         raise 'action_name must be a symbol or string' unless action_name.is_a?(Symbol) || action_name.is_a?(String)
-        raise 'action_name already used' if @@hasura_actions.keys.include?(action_name.to_s)
 
         @@hasura_actions[action_name.to_s] = self
         @hasura_action_name = action_name.to_s
@@ -19,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,21 @@
+module HasuraHandler
+  class Authenticator
+    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,17 +4,19 @@ module HasuraHandler
                 :table,
                 :trigger,
                 :event,
+                :op,
                 :created_at,
                 :raw_event,
                 :errors,
                 :valid
 
     def initialize(event)
-      @id = event[:id]
-      @table = event[:table]
-      @trigger = event[:trigger]
-      @event = event[:event]
-      @created_at = event[:created_at]
+      @id = event['id']
+      @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
@@ -65,7 +67,7 @@ module HasuraHandler
         return
       end
 
-      @errors['event.session_variables'] = 'not a hash' unless @event[:session_variables].is_a?(Hash)
+      @errors['event.session_variables'] = 'not a hash' unless @event['session_variables'].is_a?(Hash)
       string_fields?(@event, 'event', [:op])
 
       [:new, :old].each do |field|

data/lib/hasura_handler/event_handler.rb

@@ -12,12 +12,12 @@ module HasuraHandler
           raise 'invalid matcher value' unless matchers[matcher].is_a?(String)
         end
 
-        raise 'run method not defined' unless new(nil).respond_to?(:run)
-
         @hasura_matchers = matchers
       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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hasura_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Kaz Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,21 +30,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3.2
-- !ruby/object:Gem::Dependency
-  name: graphql-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-description: Provides an easy way to build custom backends for Hasura.
+description: HasuraHandler is a Rails framework that makes building microservices
+  for Hasura easy.
 email:
 - me@kaz.codes
 executables: []
@@ -56,6 +43,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
@@ -63,16 +51,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:
@@ -88,7 +80,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.0'
-end