Freshservice (#40)

Author: armiiller

CREATING_AN_INTEGRATION.md

@@ -167,3 +167,8 @@ Don't forget to add `English (en)` translations for your integration. You need t
 
 ### Tests
 Please make sure to add appropriate tests for your addition (model tests, and if applicable, controller tests). **These should be quality tests.**
+
+You can test locally like so:
+`RAILS_ENV=test dotenv -f ".env.test.local" rails db:test:prepare test`
+
+In the `.env.test.local` file, you will want to set your `DATABASE_URL` variable

Gemfile

@@ -20,7 +20,7 @@ gem "pg", "~> 1.3"
 
 # integration dependencies
 gem "aws-sdk-sns", "~> 1.53"
-gem "deferred_request", "~> 1.0"
+gem "deferred_request", "~> 1.0.4"
 gem "httparty", "~> 0.20.0"
 gem "sanitize", "~> 6.0"
 gem "twilio-ruby", "~> 5.64"

Gemfile.lock

@@ -99,7 +99,7 @@ GEM
     debug (1.4.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
-    deferred_request (1.0.2)
+    deferred_request (1.0.4)
       rails (>= 6.0.0)
     digest (3.1.0)
     dotenv (2.7.6)
@@ -277,7 +277,7 @@ DEPENDENCIES
   appraisal (~> 2.4)
   aws-sdk-sns (~> 1.53)
   debug (>= 1.0.0)
-  deferred_request (~> 1.0)
+  deferred_request (~> 1.0.4)
   dotenv-rails (~> 2.7)
   httparty (~> 0.20.0)
   pager_tree-integrations!

app/models/pager_tree/integrations/freshservice/v3.rb

@@ -0,0 +1,103 @@
+module PagerTree::Integrations
+  class Freshservice::V3 < Integration
+    FS_TICKET_STATUS = {
+      open: 2,
+      pending: 3,
+      resolved: 4,
+      closed: 5
+    }
+
+    FS_TICKET_PRIORITY = {
+      low: 1,
+      medium: 2,
+      high: 3,
+      urgent: 4
+    }
+
+    OPTIONS = []
+    store_accessor :options, *OPTIONS.map { |x| x[:key] }.map(&:to_s), prefix: "option"
+
+    after_initialize do
+    end
+
+    def adapter_supports_incoming?
+      true
+    end
+
+    def adapter_supports_outgoing?
+      false
+    end
+
+    def adapter_incoming_can_defer?
+      true
+    end
+
+    def adapter_thirdparty_id
+      _freshservice_webhook.dig("ticket_public_url")
+    end
+
+    def adapter_action
+      status = _freshservice_webhook.dig("ticket_status")
+      status_i = status&.to_i
+
+      if status_i == FS_TICKET_STATUS[:open] || status == "Open" || status_i == FS_TICKET_STATUS[:pending] || status == "Pending"
+        :create
+      elsif status_i == FS_TICKET_STATUS[:resolved] || status == "Resolved" || status_i == FS_TICKET_STATUS[:closed] || status == "Closed"
+        :resolve
+      else
+        :other
+      end
+    end
+
+    def adapter_process_create
+      Alert.new(
+        title: _title,
+        description: _description,
+        urgency: _urgency,
+        thirdparty_id: adapter_thirdparty_id,
+        dedup_keys: [adapter_thirdparty_id],
+        additional_data: _additional_datums
+      )
+    end
+
+    private
+
+    def _freshservice_webhook
+      # this is not a mistake, the webhook says fresh**desk**, not fresh**service**
+      adapter_incoming_request_params.dig("freshdesk_webhook")
+    end
+
+    def _title
+      _freshservice_webhook.dig("ticket_subject")
+    end
+
+    def _description
+      _freshservice_webhook.dig("ticket_description")
+    end
+
+    def _urgency
+      priority = _freshservice_webhook.dig("ticket_priority")
+      priority_i = priority&.to_i
+
+      if priority_i == FS_TICKET_PRIORITY[:low] || priority == "Low"
+        :low
+      elsif priority_i == FS_TICKET_PRIORITY[:medium] || priority == "Normal" || priority == "Medium"
+        :medium
+      elsif priority_i == FS_TICKET_PRIORITY[:high] || priority == "High"
+        :high
+      elsif priority_i == FS_TICKET_PRIORITY[:urgent] || priority == "Urgent"
+        :critical
+      end
+    end
+
+    def _additional_datums
+      [
+        AdditionalDatum.new(format: "text", label: "Ticket ID", value: _freshservice_webhook.dig("ticket_id")),
+        AdditionalDatum.new(format: "link", label: "Ticket URL", value: _freshservice_webhook.dig("ticket_url")),
+        AdditionalDatum.new(format: "text", label: "Requester Email", value: _freshservice_webhook.dig("ticket_email")),
+        AdditionalDatum.new(format: "text", label: "To Email", value: _freshservice_webhook.dig("ticket_to_email")),
+        AdditionalDatum.new(format: "text", label: "CC Email", value: _freshservice_webhook.dig("ticket_cc_email"))
+      ]
+    end
+  end
+end

app/views/pager_tree/integrations/freshservice/v3/_form_options.html.erb

@@ -36,6 +36,9 @@ en:
       freshdesk:
         v3:
           form_options:
+      freshservice:
+        v3:
+          form_options:
       live_call_routing:
         twilio:
           v3:

app/views/pager_tree/integrations/freshservice/v3/_show_options.html.erb

@@ -0,0 +1 @@
+grep nameserver /etc/resolv.conf | awk '{print $2}' | xargs

config/locales/en.yml

@@ -0,0 +1,7 @@
+# See the following for details on why we need this for the deferred request library
+# https://stackoverflow.com/questions/71191685/visit-psych-nodes-alias-unknown-alias-default-psychbadalias
+# https://discuss.rubyonrails.org/t/cve-2022-32224-possible-rce-escalation-bug-with-serialized-columns-in-active-record/81017
+
+if Gem::Version.new(Rails.version) >= Gem::Version.new("7.0.3.1")
+  ActiveRecord.yaml_column_permitted_classes = [ActiveSupport::HashWithIndifferentAccess]
+end

scripts/wsl-ip.sh

@@ -40,6 +40,10 @@ freshdesk_v3:
   type: "PagerTree::Integrations::Freshdesk::V3"
   # options: no_options
 
+freshservice_v3:
+  type: "PagerTree::Integrations::Freshservice::V3"
+  # options: no_options
+
 live_call_routing_twilio_v3:
   type: "PagerTree::Integrations::LiveCallRouting::Twilio::V3"
   options:

test/dummy/config/initializers/activerecord_yaml.rb

@@ -0,0 +1,82 @@
+require "test_helper"
+
+module PagerTree::Integrations
+  class Freshservice::V3Test < ActiveSupport::TestCase
+    include Integrateable
+
+    setup do
+      @integration = pager_tree_integrations_integrations(:freshservice_v3)
+
+      @create_request = {
+        # not a mistake, freshservice uses the "freshdesk" key, not "freshservice"
+        freshdesk_webhook: {
+          ticket_id: "123",
+          ticket_subject: "Ticket Subject",
+          ticket_description: "Ticket Description",
+          ticket_priority: 1,
+          ticket_status: 2,
+          ticket_url: "https://desk.freshservice.com/ticket/123",
+          ticket_public_url: "https://public.freshservice.com/ticket/123",
+          ticket_due_by_time: "2022-05-23T08:18:26-05:00",
+          ticket_source: "Customer",
+          ticket_requester_name: "Joe Bob",
+          ticket_requester_email: "[email protected]",
+          ticket_requester_phone: nil,
+          ticket_company_name: "Acme Corp"
+        }
+      }.with_indifferent_access
+
+      @resolve_request = @create_request.deep_dup
+      @resolve_request[:freshdesk_webhook][:ticket_status] = "Resolved"
+
+      @other_request = @create_request.deep_dup
+      @other_request[:freshdesk_webhook][:ticket_status] = "baaad"
+    end
+
+    test "sanity" do
+      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
+      @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
+      @integration.adapter_incoming_request_params = @create_request
+      assert_equal @create_request[:freshdesk_webhook][:ticket_public_url], @integration.adapter_thirdparty_id
+    end
+
+    test "adapter_process_create" do
+      @integration.adapter_incoming_request_params = @create_request
+
+      true_alert = Alert.new(
+        title: @create_request[:freshdesk_webhook][:ticket_subject],
+        description: @create_request[:freshdesk_webhook][:ticket_description],
+        urgency: :low,
+        thirdparty_id: @create_request[:freshdesk_webhook][:ticket_public_url],
+        dedup_keys: [@create_request[:freshdesk_webhook][:ticket_public_url]],
+        additional_data: [
+          AdditionalDatum.new(format: "text", label: "Ticket ID", value: @create_request[:freshdesk_webhook].dig("ticket_id")),
+          AdditionalDatum.new(format: "link", label: "Ticket URL", value: @create_request[:freshdesk_webhook].dig("ticket_url")),
+          AdditionalDatum.new(format: "text", label: "Requester Email", value: @create_request[:freshdesk_webhook].dig("ticket_email")),
+          AdditionalDatum.new(format: "text", label: "To Email", value: @create_request[:freshdesk_webhook].dig("ticket_to_email")),
+          AdditionalDatum.new(format: "text", label: "CC Email", value: @create_request[:freshdesk_webhook].dig("ticket_cc_email"))
+        ]
+      )
+
+      assert_equal true_alert.to_json, @integration.adapter_process_create.to_json
+    end
+  end
+end