the_captain_rails 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 067e4917ab8718f6a09759d82038125d823b7f26c2b89a961930045f9d400426
+  data.tar.gz: 79d157124ef0a1b7709dd73d5503cbfc2e4b7cb140be100c146ed169589703cc
+SHA512:
+  metadata.gz: dd80b45095569decb676aea7afa7e9bdd5e8ef0052774ff95d64d759201d20780b3e41ea127ffb8383d0d87f671f98ebf8cb08a1795272b6de9da4dbed3ec5a1
+  data.tar.gz: e5ae2c72bca3c5a93560bbf1a9e9005bbdacafb9a60ed4fcc290de4a32605024c0a796074362642116584e739d4698b540c59fb6e53867f18b08dc3c67d5a364

data/README.md

@@ -0,0 +1,85 @@
+# TheCaptain Rails
+The gist is that this is housing Rail's specific logic for handling Captain responses and submissions in a Rails project.
+
+Main core feature is the ability to subscribe / explicitly listen for Webhooks that a developer would like to Handel in a specific manner.
+
+I.E. If a Webhook comes back for an IP or Content analysis. A developer may want to allow specific class handlers to manage / analyze these pieces of information differently and directed to other parts of the application. 
+
+(AKA: Single Responsibility Rule)
+
+## Usage
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "the_captain", git: "https://github.com/VianetManagement/the-captain-ruby.git", branch: "3.0.0"
+gem 'the_captain_rails', git: "https://github.com/VianetManagement/the-captain-rails"
+```
+
+
+## Configuration
+
+### Webhook events
+
+#### Configuring The Rails Router Path
+
+Ensure we mount the controller path to handel requests.
+
+`/config/routes.rb`
+```ruby
+Rails.application.routes.draw do
+  mount TheCaptain::Events::Engine => "/captain/events"
+  # ....
+end
+```
+
+Your webhook endpoint will look something like `http://[HOST]/captain/events`
+
+#### Configuring Webhook Listeners
+
+`/config/initializer/the_captain.rb`
+
+```ruby
+TheCaptain::Event.configure do |config|
+  config.subscribe("Account Abuse") { |event| ... }
+  
+  # Alternatively you can also define a class that contains a `call/1` method
+   config.subscribe("Account Abuse", AccountManagment::Abuse.new)
+   
+   # If you wish for all events to pass through a single entry point or you want to log something about any webhook 
+   # passthrough
+   config.all { |event| ... }
+   
+    # [again] Alternatively you can also define a class that contains a `call/1` method
+   config.all WebhookManager.new
+end
+```
+
+Be default the `.subscribe/2` method will listen and attempt to parse which **Kit Name** triggered the given webhook.
+
+You can modify the listening key by configuring the `.event_key_filter/1`
+
+```ruby
+
+TheCaptain::Event.configure do |config|
+  config.event_key_filter = proc { |event| event.[some_key_value_in_response] }
+  config.subscribe([modified_filer_key_result]) { |event| }
+end
+
+```
+
+You can also reject or accept events by modifying the `.event_filter/1`
+
+**Note:** If the filter does not return an event. The `all` listener will not be triggered.
+
+```ruby
+TheCaptain::Event.configure do |config|
+  # If the event's decision id is 1000, then ignore it (i.e.: don't return the event)
+  config.event_filter = proc { |event| event unless event.descition.id == 1000 }
+end
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/the_captain/events/webhook_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Events
+    class WebhookController < ActionController::Base
+      if ::Rails.application.config.action_controller.default_protect_from_forgery
+        skip_before_action :verify_authenticity_token
+      end
+
+      # post
+      def event
+        ::TheCaptain::Events.instrument(process_event)
+        head :ok
+      end
+
+      private
+
+      def process_event
+        request_body = request.body.read
+        request_url  = request.original_url
+        http_version = request.headers["version"] || "HTTP/1.1"
+        response     = construct_response_from(request_body, request_url, http_version)
+        ::TheCaptain::Response::CaptainVessel.new(response)
+      end
+
+      def construct_response_from(payload, uri_destination, http_version)
+        HTTP::Response.new(body: payload, uri: uri_destination, status: 200, version: http_version)
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+TheCaptain::Events::Engine.routes.draw do
+  root to: "webhook#event", via: :post
+end

data/lib/the_captain/events.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Events
+    class << self
+      attr_accessor :adapter, :backend, :namespace, :event_filter, :event_key_filter
+
+      def configure
+        raise ArgumentError, "Must provide a block to configure events" unless block_given?
+        yield self
+      end
+
+      def subscribe(kit_name, callable = Proc.new)
+        backend.subscribe(namespace.to_regexp(kit_name), adapter.call(callable))
+      end
+
+      def all(callable = Proc.new)
+        subscribe(nil, callable)
+      end
+
+      def instrument(event)
+        event = event_filter.call(event)
+        return unless event
+        event_key = event_key_filter.call(event)
+        backend.instrument(namespace.call(event_key), event)
+      end
+
+      def listening?(kit_name)
+        namespaced_name = namespace.call(kit_name)
+        backend.notifier.listening?(namespaced_name)
+      end
+    end
+
+    Namespace = Struct.new(:value, :delimiter) do
+      def call(name = nil)
+        "#{value}#{delimiter}#{name&.to_s&.tr(' ', delimiter)&.downcase}"
+      end
+
+      def to_regexp(name = nil)
+        /^#{Regexp.escape(call(name))}/
+      end
+    end
+
+    NotificationAdapter = Struct.new(:subscriber) do
+      def self.call(callable)
+        new(callable)
+      end
+
+      def call(*args)
+        payload = args.last
+        subscriber.call(payload)
+      end
+    end
+
+    self.adapter          = NotificationAdapter
+    self.backend          = ActiveSupport::Notifications
+    self.namespace        = Namespace.new("captain_event", ".")
+    self.event_filter     = lambda { |event| event }
+    self.event_key_filter = lambda { |event| event.dig(:action) }
+  end
+end

data/lib/the_captain/rails/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module TheCaptain
+  module Events
+    class Engine < ::Rails::Engine
+      isolate_namespace TheCaptain::Events
+
+      initializer "the_captain_rails.initialize" do
+        require "the_captain_rails"
+      end
+    end
+  end
+end

data/lib/the_captain_rails.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+require "the_captain"
+require "the_captain/events"
+require "the_captain/rails/engine" if defined?(Rails)

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: the_captain_rails
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- George J Protacio-Karaszi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: the_captain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: The Captain will tell, talk, and taddle on those pesky fraudulent scalliwags.
+email:
+- george@elevatorup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/controllers/the_captain/events/webhook_controller.rb
+- config/routes.rb
+- lib/the_captain/events.rb
+- lib/the_captain/rails/engine.rb
+- lib/the_captain_rails.rb
+homepage: https://github.com/VianetManagement/the-captain-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- app
+- config
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails bindings for the The Captain API
+test_files: []