workarea-zendesk 1.0.0

data/app/lib/workarea/zendesk/gateway.rb

@@ -0,0 +1,53 @@
+module Workarea
+  module Zendesk
+    class Gateway
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def create_request(request)
+        resp = connection.post('api/v2/requests.json') do |req|
+          req.body = request.to_json
+        end
+
+        Response.new(resp)
+      end
+
+      private
+
+      def encoded_basic_auth
+        "Basic #{Base64.encode64(auth_string)}"
+      end
+
+      def connection
+        headers = { 'Content-Type' => 'application/json', 'Authorization' => encoded_basic_auth }
+
+        request_timeouts = {
+          timeout: Workarea.config.zendesk[:api_timeout],
+          open_timeout: Workarea.config.zendesk[:open_timeout]
+        }
+
+        conn = Faraday.new(url: rest_endpoint, headers: headers, request: request_timeouts)
+        conn
+      end
+
+      def api_user_name
+        options[:api_user_name]
+      end
+
+      def api_token
+        options[:api_token]
+      end
+
+      def auth_string
+        "#{api_user_name}/token:#{api_token}"
+      end
+
+      def rest_endpoint
+        options[:rest_endpoint]
+      end
+    end
+  end
+end

data/app/lib/workarea/zendesk/response.rb

@@ -0,0 +1,27 @@
+module Workarea
+  module Zendesk
+    class Response
+      attr_reader :response
+
+      def initialize(response = {})
+        @response = response
+      end
+
+      def success?
+        @response.status.to_s =~ /^2/
+      end
+
+      def body
+        return {} unless @response.body.present?
+        JSON.parse(@response.body)
+      end
+
+      def error_details
+        return unless body.present?
+        return unless body["error"].present?
+
+        body["details"].to_s
+      end
+    end
+  end
+end

data/app/views/workarea/storefront/_zendesk_web_widget.html.haml

@@ -0,0 +1,2 @@
+- if Workarea::Zendesk.config.public_key.present?
+  %script#ze-snippet{src: "https://static.zdassets.com/ekr/snippet.js?key=#{Workarea::Zendesk.config.public_key}"}

data/app/workers/zendesk/create_inquiry_request.rb

@@ -0,0 +1,46 @@
+module Workarea
+  module Zendesk
+    class CreateInquiryRequest
+      class ZendeskTicketError < StandardError; end
+
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::Inquiry => [:create] }
+      )
+
+      def perform(id)
+        inquiry = Workarea::Inquiry.find(id)
+        response = Workarea::Zendesk.gateway.create_request(zendesk_request(inquiry))
+
+        raise ZendeskTicketError, response.error_details  unless response.success?
+      end
+
+      private
+
+      def test_prefix
+        !Rails.env.production? ? "** IGNORE * TEST * IGNORE ** " : ""
+      end
+
+      def zendesk_request(inquiry)
+        {
+          request: {
+            requester: {
+              name: inquiry.name,
+              email: inquiry.email
+            },
+            subject: test_prefix + inquiry.full_subject,
+            comment: {
+              body: comment_body(inquiry)
+            }
+          }
+        }
+      end
+
+      def comment_body(inquiry)
+        "Name: #{inquiry.name}\nEmail: #{inquiry.email}\nSubject: #{inquiry.full_subject}\nOrder Id: #{inquiry.order_id || ""}\nMessage: #{inquiry.message}"
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/workarea/zendesk/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/initializers/append_points.rb

@@ -0,0 +1,4 @@
+Workarea::Plugin.append_partials(
+  'storefront.document_head',
+  'workarea/storefront/zendesk_web_widget'
+)

data/config/initializers/workarea.rb

@@ -0,0 +1,8 @@
+Workarea.configure do |config|
+  config.zendesk = ActiveSupport::Configurable::Configuration.new
+  config.zendesk.public_key = ""
+
+  config.zendesk.rest_endpoint = ""
+  config.zendesk.api_timeout = 2
+  config.zendesk.open_timeout = 2
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/workarea/zendesk.rb

@@ -0,0 +1,38 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/zendesk/engine'
+require 'workarea/zendesk/version'
+
+module Workarea
+  module Zendesk
+    def self.config
+      Workarea.config.zendesk
+    end
+
+    def self.credentials
+      (Rails.application.secrets.zendesk || '')
+    end
+
+    def self.rest_endpoint
+      config.rest_endpoint
+    end
+
+    def self.api_user_name
+      credentials[:api_user_name]
+    end
+
+    def self.api_token
+      credentials[:api_token]
+    end
+
+    def self.gateway
+      if credentials.present?
+        Zendesk::Gateway.new(rest_endpoint: rest_endpoint, api_user_name: api_user_name, api_token: api_token)
+      else
+        Zendesk::BogusGateway.new
+      end
+    end
+  end
+end

data/lib/workarea/zendesk/engine.rb

@@ -0,0 +1,10 @@
+require 'workarea/zendesk'
+
+module Workarea
+  module Zendesk
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::Zendesk
+    end
+  end
+end

data/lib/workarea/zendesk/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Zendesk
+    VERSION = "1.0.0".freeze
+  end
+end

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,34 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+# Workarea must be required before other gems to ensure control over Rails.env
+# for running tests
+require 'workarea/core'
+require 'workarea/admin'
+require 'workarea/storefront'
+Bundler.require(*Rails.groups)
+require "workarea/zendesk"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end