pager_tree-integrations 1.0.0

data/db/migrate/20220208195853_create_active_storage_tables.active_storage.rb

@@ -0,0 +1,58 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :active_storage_blobs, id: primary_key_type do |t|
+      t.string :key, null: false
+      t.string :filename, null: false
+      t.string :content_type
+      t.text :metadata
+      t.string :service_name, null: false
+      t.bigint :byte_size, null: false
+      t.string :checksum
+
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
+
+      t.index [:key], unique: true
+    end
+
+    create_table :active_storage_attachments, id: primary_key_type do |t|
+      t.string :name, null: false
+      t.references :record, null: false, polymorphic: true, index: false, type: foreign_key_type
+      t.references :blob, null: false, type: foreign_key_type
+
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
+
+      t.index [:record_type, :record_id, :name, :blob_id], name: :index_active_storage_attachments_uniqueness, unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+
+    create_table :active_storage_variant_records, id: primary_key_type do |t|
+      t.belongs_to :blob, null: false, index: false, type: foreign_key_type
+      t.string :variation_digest, null: false
+
+      t.index [:blob_id, :variation_digest], name: :index_active_storage_variant_records_uniqueness, unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
+end

data/db/migrate/20220208195854_create_deferred_request_deferred_requests.deferred_request.rb

@@ -0,0 +1,13 @@
+# This migration comes from deferred_request (originally 20220204152629)
+class CreateDeferredRequestDeferredRequests < ActiveRecord::Migration[7.0]
+  def change
+    create_table :deferred_request_deferred_requests do |t|
+      t.text :request
+      t.text :routing
+      t.text :result
+      t.integer :status, default: 0, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220208195855_create_pager_tree_integrations_integrations.rb

@@ -0,0 +1,10 @@
+class CreatePagerTreeIntegrationsIntegrations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :pager_tree_integrations_integrations do |t|
+      t.string :type, null: false
+      t.text :options
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220215200426_create_pager_tree_integrations_outgoing_webhook_deliveries.rb

@@ -0,0 +1,12 @@
+class CreatePagerTreeIntegrationsOutgoingWebhookDeliveries < ActiveRecord::Migration[7.0]
+  def change
+    create_table :pager_tree_integrations_outgoing_webhook_deliveries do |t|
+      t.references :resource, polymorphic: true, index: {name: "idx_outgoing_webhook_deliveries_resource"}
+      t.string :type, null: false
+      t.string :thirdparty_id
+      t.integer :status, null: false, default: 0
+      t.text :data
+      t.timestamps
+    end
+  end
+end

data/lib/generators/integration/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generate a PagerTree integration
+
+Example:
+    bin/rails generate integration #{vendor}/#{version}
+
+    This will create:
+        create  app/models/pager_tree/integrations/#{vendor}/#{version}.rb
+        create  app/views/pager_tree/integrations/#{vendor}/#{version}/_form_options.html.erb
+        create  app/views/pager_tree/integrations/#{vendor}/#{version}/_show_options.html.erb
+        create  test/models/pager_tree/integrations/#{vendor}/#{version}_test.rb

data/lib/generators/integration/integration_generator.rb

@@ -0,0 +1,14 @@
+class IntegrationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_templates
+    template "model.rb.tt", "app/models/#{file_path}.rb"
+    template "_form_options.html.erb.tt", "app/views/#{file_path}/_form_options.html.erb"
+    template "_show_options.html.erb.tt", "app/views/#{file_path}/_show_options.html.erb"
+    template "test.rb.tt", "test/models/#{file_path}_test.rb"
+  end
+
+  def inject_locales
+    puts "IMPORTANT: Ensure you add your translations to config/locales/en.yml"
+  end
+end

data/lib/generators/integration/templates/_form_options.html.erb.tt

@@ -0,0 +1,8 @@
+<div class="grid grid-cols-1 md:grid-cols-3 gap-4">
+  <div class="form-group">
+    <%%= form.label :option_api_key %>
+    <%%= form.text_field :option_api_key, class: "form-control" %>
+    <p class="form-hint"><%%== t(".option_api_key_hint_html") %></p>
+  </div>
+  <!-- TODO ADD/EDIT YOUR INTEGRATION OPTIONS HERE. SEE CREATING_AN_INTEGRATION.md for different form fields -->
+</div>

data/lib/generators/integration/templates/_show_options.html.erb.tt

@@ -0,0 +1,14 @@
+<div class="sm:col-span-2">
+  <dt class="text-sm font-medium text-gray-500">
+    <%%= t("activerecord.attributes.<%= file_path %>.option_account_sid") %>
+  </dt>
+  <dd class="mt-1 text-sm text-gray-900">
+    <div class="flex items-center gap-2">
+      <p class="text-sm truncate">
+        <%%= integration.option_api_key %>
+      </p>
+    </div>
+  </dd>
+</div>
+
+<!-- TODO: add/edit your integration options here. See CREATING_AN_INTEGRATION.md for different form fields. You should only show "very important" options -->

data/lib/generators/integration/templates/model.rb.tt

@@ -0,0 +1,64 @@
+module PagerTree::Integrations
+  class <%= class_name %> < Integration
+    # TODO: Add options that are relevant to your integration
+    OPTIONS = [
+      {key: :api_key, type: :string, default: nil},
+    ]
+    store_accessor :options, *OPTIONS.map { |x| x[:key] }.map(&:to_s), prefix: "option"
+    
+    # TODO - add some validations for your options
+    validates :option_api_key, presence: true
+
+    # TODO - add defaults for your options
+    after_initialize do
+      self.option_api_key ||= nil
+    end
+
+    # TODO: Does this integration support incoming requests?
+    def adapter_supports_incoming?
+      true
+    end
+
+    # TODO: Does this integration support outgoing events?
+    def adapter_supports_outgoing?
+      true
+    end
+
+    # TODO: can requests from this integration be deferred? most integrations should be 'true'
+    # unless a realtime response is needed by the posting service
+    def adapter_incoming_can_defer?
+      true
+    end
+
+    # TODO: A unique identifier for this integration/alert
+    def adapter_thirdparty_id
+      adapter_incoming_request_params.dig("id")
+    end
+
+    # TODO: Returns :create, :acknowledge, :resolve, or :other
+    def adapter_action
+      :other
+    end
+
+    # TODO: Implement your transform
+    def adapter_process_create
+      Alert.new(
+        title: adapter_incoming_request_params.dig("title"),
+        urgency: adapter_incoming_request_params.dig("urgency"),
+        thirdparty_id: adapter_thirdparty_id,
+        dedup_keys: [adapter_thirdparty_id],
+        additional_data: _additional_datums
+      )
+    end
+
+    private
+
+    # TODO: Implement any additional data that should be shown in the alert with high priority (be picky as to 'very important' information)
+    def _additional_datums
+      [
+        # AdditionalDatum.new(format: "text", label: "Method", value: adapter_incoming_request_params.dig("check", "method")),
+        # AdditionalDatum.new(format: "datetime", label: "Triggered At", value: adapter_incoming_request_params.dig("triggered_at"))
+      ]
+    end
+  end
+end

data/lib/generators/integration/templates/test.rb.tt

@@ -0,0 +1,87 @@
+require "test_helper"
+
+module PagerTree::Integrations
+  class <%= class_name %>Test < ActiveSupport::TestCase
+    include Integrateable
+
+    setup do
+      @integration = pager_tree_integrations_integrations(:<%= class_name.underscore.gsub("/", "_") %>)
+
+      # TODO: Write some requests to test the integration
+      @create_request = {
+        "triggered_at": "2016-05-24T20:10:57.657259407Z",
+        "state": "triggered",
+        "alert": {
+          "id": 9,
+          "type": "time_total",
+          "stat": "avg",
+          "window_duration": 5,
+          "value": 2500,
+          "op": "gt"
+        },
+        "check": {
+          "id": 80,
+          "name": "Axe Search",
+          "method": "GET",
+          "protocol": "http",
+          "url": "www.axemusic.com/catalogsearch/result/?cat=0&q=sm58",
+          "apdex_threshold": 700
+        },
+        "value": 2724
+      }.with_indifferent_access
+
+      @resolve_request = @create_request.deep_dup
+      @resolve_request[:state] = "resolved"
+
+      @other_request = @create_request.deep_dup
+      @other_request[:state] = "baaad"
+    end
+
+    test "sanity" do
+      # TODO: Check some sane defaults your integration should have
+      assert @integration.adapter_supports_incoming?
+      assert @integration.adapter_incoming_can_defer?
+      assert_not @integration.adapter_supports_outgoing?
+      assert @integration.adapter_show_alerts?
+      assert @integration.adapter_show_logs?
+      assert_not @integration.adapter_show_outgoing_webhook_delivery?
+    end
+
+    test "adapter_actions" do
+      # TODO: Check that the adapter_actions returns expected results based on the inputs
+      @integration.adapter_incoming_request_params = @create_request
+      assert_equal :create, @integration.adapter_action
+
+      @integration.adapter_incoming_request_params = @resolve_request
+      assert_equal :resolve, @integration.adapter_action
+
+      @integration.adapter_incoming_request_params = @other_request
+      assert_equal :other, @integration.adapter_action
+    end
+
+    test "adapter_thirdparty_id" do
+      # TODO: Check that the third party id comes back as expected
+      @integration.adapter_incoming_request_params = @create_request
+      assert_equal 9, @integration.adapter_thirdparty_id
+    end
+
+    test "adapter_process_create" do
+      # TODO: Check tthe entire transform
+      @integration.adapter_incoming_request_params = @create_request
+
+      true_alert = Alert.new(
+        title: "Axe Search triggered",
+        urgency: nil,
+        thirdparty_id: 9,
+        dedup_keys: [9],
+        additional_data: [
+          AdditionalDatum.new(format: "link", label: "URL", value: "http://www.axemusic.com/catalogsearch/result/?cat=0&q=sm58"),
+          AdditionalDatum.new(format: "text", label: "Method", value: "GET"),
+          AdditionalDatum.new(format: "datetime", label: "Triggered At", value: "2016-05-24T20:10:57.657259407Z")
+        ]
+      )
+
+      assert_equal true_alert.to_json, @integration.adapter_process_create.to_json
+    end
+  end
+end

data/lib/pager_tree/integrations/engine.rb

@@ -0,0 +1,11 @@
+module PagerTree
+  module Integrations
+    class Engine < ::Rails::Engine
+      isolate_namespace PagerTree::Integrations
+
+      config.before_initialize do
+        config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
+      end
+    end
+  end
+end

data/lib/pager_tree/integrations/env.rb

@@ -0,0 +1,36 @@
+module PagerTree
+  module Integrations
+    module Env
+      private
+
+      # Search for environment variables
+      #
+      # We must handle a lot of different cases, including the new Rails 6
+      # environment separated credentials files which have no nesting for
+      # the current environment.
+      #
+      # 1. Check environment variable
+      # 2. Check environment scoped credentials, then secrets
+      # 3. Check unscoped credentials, then secrets
+      def find_value_by_name(scope, name)
+        ENV["#{scope.upcase}_#{name.upcase}"] ||
+          credentials&.dig(env, scope, name) ||
+          secrets&.dig(env, scope, name) ||
+          credentials&.dig(scope, name) ||
+          secrets&.dig(scope, name)
+      end
+
+      def env
+        Rails.env.to_sym
+      end
+
+      def secrets
+        Rails.application.secrets
+      end
+
+      def credentials
+        Rails.application.credentials if Rails.application.respond_to?(:credentials)
+      end
+    end
+  end
+end

data/lib/pager_tree/integrations/version.rb

@@ -0,0 +1,5 @@
+module PagerTree
+  module Integrations
+    VERSION = "1.0.0"
+  end
+end

data/lib/pager_tree/integrations.rb

@@ -0,0 +1,29 @@
+require "pager_tree/integrations/version"
+require "pager_tree/integrations/engine"
+
+module PagerTree
+  module Integrations
+    autoload :Env, "pager_tree/integrations/env"
+
+    mattr_accessor :deferred_request_class
+    @@deferred_request_class = "DeferredRequest::DeferredRequest"
+
+    mattr_accessor :integration_parent_class
+    @@integration_parent_class = "ApplicationRecord"
+
+    mattr_accessor :outgoing_webhook_delivery_parent_class
+    @@outgoing_webhook_delivery_parent_class = "ApplicationRecord"
+
+    mattr_accessor :outgoing_webhook_delivery_factory_class
+    @@outgoing_webhook_delivery_factory_class = "PagerTree::Integrations::OutgoingWebhookDelivery::HookRelay"
+
+    mattr_accessor :outgoing_webhook_delivery_table_name
+    @@outgoing_webhook_delivery_table_name = "pager_tree_integrations_outgoing_webhook_deliveries"
+
+    mattr_accessor :integration_email_v3_domain
+    @@integration_email_v3_domain = "alerts.pagertree.com"
+
+    mattr_accessor :integration_email_v3_inbox
+    @@integration_email_v3_inbox = "a"
+  end
+end

data/lib/tasks/pager_tree/integrations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pager_tree_integrations do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: pager_tree-integrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Austin Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PagerTree Open Source Integration Adapters. Contribute to a growing library
+  of PagerTree integrations!
+email:
+- amiller@pagertree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/pager_tree_integrations_manifest.js
+- app/assets/stylesheets/pager_tree/integrations/application.css
+- app/controllers/pager_tree/integrations/application_controller.rb
+- app/controllers/pager_tree/integrations/live_call_routing/twilio/v3_controller.rb
+- app/helpers/pager_tree/integrations/application_helper.rb
+- app/jobs/pager_tree/integrations/application_job.rb
+- app/jobs/pager_tree/integrations/outgoing_webhook_job.rb
+- app/mailers/pager_tree/integrations/application_mailer.rb
+- app/models/pager_tree/integrations/additional_datum.rb
+- app/models/pager_tree/integrations/alert.rb
+- app/models/pager_tree/integrations/apex_ping/v3.rb
+- app/models/pager_tree/integrations/application_record.rb
+- app/models/pager_tree/integrations/email/v3.rb
+- app/models/pager_tree/integrations/integration.rb
+- app/models/pager_tree/integrations/live_call_routing/twilio/v3.rb
+- app/models/pager_tree/integrations/outgoing_event.rb
+- app/models/pager_tree/integrations/outgoing_webhook/v3.rb
+- app/models/pager_tree/integrations/outgoing_webhook_delivery.rb
+- app/models/pager_tree/integrations/outgoing_webhook_delivery/hook_relay.rb
+- app/views/layouts/pager_tree/integrations/application.html.erb
+- app/views/pager_tree/integrations/apex_ping/v3/_form_options.html.erb
+- app/views/pager_tree/integrations/apex_ping/v3/_show_options.html.erb
+- app/views/pager_tree/integrations/email/v3/_form_options.html.erb
+- app/views/pager_tree/integrations/email/v3/_show_options.html.erb
+- app/views/pager_tree/integrations/live_call_routing/twilio/v3/_form_options.html.erb
+- app/views/pager_tree/integrations/live_call_routing/twilio/v3/_show_options.html.erb
+- app/views/pager_tree/integrations/outgoing_webhook/v3/_form_options.html.erb
+- app/views/pager_tree/integrations/outgoing_webhook/v3/_show_options.html.erb
+- app/views/shared/_password_visibility_button.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20220208195853_create_active_storage_tables.active_storage.rb
+- db/migrate/20220208195854_create_deferred_request_deferred_requests.deferred_request.rb
+- db/migrate/20220208195855_create_pager_tree_integrations_integrations.rb
+- db/migrate/20220215200426_create_pager_tree_integrations_outgoing_webhook_deliveries.rb
+- lib/generators/integration/USAGE
+- lib/generators/integration/integration_generator.rb
+- lib/generators/integration/templates/_form_options.html.erb.tt
+- lib/generators/integration/templates/_show_options.html.erb.tt
+- lib/generators/integration/templates/model.rb.tt
+- lib/generators/integration/templates/test.rb.tt
+- lib/pager_tree/integrations.rb
+- lib/pager_tree/integrations/engine.rb
+- lib/pager_tree/integrations/env.rb
+- lib/pager_tree/integrations/version.rb
+- lib/tasks/pager_tree/integrations_tasks.rake
+homepage: https://pagertree.com
+licenses:
+- Apache License v2.0
+metadata:
+  homepage_uri: https://pagertree.com
+  source_code_uri: https://github.com/PagerTree/pager_tree-integrations
+  changelog_uri: https://github.com/PagerTree/pager_tree-integrations/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: PagerTree Integration Adapters
+test_files: []