support_center 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5e17d22cf4cb911fce90aacc0191e7a822dbce3
+  data.tar.gz: a0d4ad2f3c277389eb14566a415b328560439959
+SHA512:
+  metadata.gz: cf6a9fff66b0b5d7a84b5d2ced0800246b1571bd0d80deb2392755e274384e7bafba147ee5212e997d1c950f6478d8d1b82d4b0ed704c72cbfe15122210502c8
+  data.tar.gz: 61e438dfe61b9ad7be1d68eb4ca02ad84ba4072c2759dd4bfccfe644799f80e7e32b0754bfc9cfcbf6df57d841e2f67e6280963412e44806bd71090fea9a75c7

data/.gitignore

@@ -0,0 +1,14 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# bundler
+.bundle
+
+.DS_Store
+.tags
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fn

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rack-test'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem 'jasmine', '~> 1.3.0'
+end
+
+group :test do
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    support_center (0.1.5)
+      sinatra (>= 1.2.0)
+      slim
+      zendesk_api (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debugger (1.6.8)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.5)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.5)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.3)
+    hashie (3.0.0)
+    inflection (1.0.0)
+    jasmine (1.3.2)
+      jasmine-core (~> 1.3.1)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.3.1)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rubyzip (1.1.4)
+    selenium-webdriver (2.42.0)
+      childprocess (>= 0.5.0)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slim (1.3.9)
+      temple (~> 0.6.3)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.5.0)
+    temple (0.6.7)
+    tilt (1.4.1)
+    websocket (1.0.7)
+    zendesk_api (1.3.7)
+      faraday (~> 0.9)
+      hashie (>= 1.2)
+      inflection
+      mime-types (~> 1.0)
+      multi_json
+      multipart-post (~> 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jasmine (~> 1.3.0)
+  pry
+  pry-debugger
+  rack-test
+  rake
+  rspec
+  simplecov
+  support_center!

data/Procfile

@@ -0,0 +1,3 @@
+src: coffee -cw -o js/support_center js/support_center/src
+spec: coffee -cw -o spec/javascripts spec/coffee
+jasmine: rake jasmine

data/README.md

@@ -0,0 +1,30 @@
+Support Center
+--------------
+
+Rack Middleware for interacting with the Zendesk API
+
+Basic Usage
+-----------
+
+Support Center requires a config block in the following format:
+
+```ruby
+require 'support_center'
+
+SupportCenter.setup do |config|
+  config.environment = ENV['RACK_ENV'] # optional
+  config.config_service_adapter = {username: 'foo@bar.com', password: 'p@ssw0rd12345', url: 'https://foo.zendesk.com/api/v2'}
+end
+```
+
+Then add the following in your config.ru:
+```ruby
+run Rack::URLMap.new('/' => SupportCenter.new)
+```
+
+If need DCMS, mount the app as Rack::Middleware after DCMS is setup:
+```ruby
+# e.g. config/application.rb
+require 'support_center/server'
+use SupportCenter::Server
+```

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/support_center/**/*_spec.rb"
+end
+
+begin
+  require 'yaml'
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+task default: :spec

data/bower.json

@@ -0,0 +1,26 @@
+{
+  "name": "support_center",
+  "version": "0.1.4",
+  "main": "js/support_center/support_center.js",
+  "dependencies": {
+    "jquery": null,
+    "flight": ">=1.0.4 < 1.1.0",
+    "js/support_center/form_component"
+  },
+  "devDependencies": {
+    "requirejs": null
+  },
+  "ignore": [
+    "Gemfile",
+    "Procfile",
+    "Rakefile",
+    "js/support_center/src/",
+    "package.json",
+    "vendor",
+    "Gemfile.lock",
+    "README.md",
+    "lib",
+    "spec",
+    "support_center.gemspec"
+  ]
+}

data/js/support_center/form_component.js

@@ -0,0 +1,161 @@
+// Generated by CoffeeScript 1.7.1
+(function() {
+  define(['jquery', 'flight/lib/component'], function($, defineComponent) {
+    var FormComponent;
+    FormComponent = function() {
+      this.defaultAttrs({
+        ticketSubmitRoute: '/support/tickets/',
+        spinnerClass: '.spinner',
+        questionForm: '#questions_form_element',
+        questionFormThanks: '#thanks_questions_tab',
+        questionButton: '#questions_form',
+        questionFormContainer: '#questions_form_tab',
+        questionBrowserInput: '#question_browser',
+        questioncurrentURL: '#question_current_url',
+        feedbackForm: '#feedback_form_element',
+        feedbackFormThanks: '#thanks_feedback_tab',
+        feedbackButton: '#feedback_form',
+        feedbackFormContainer: '#feedback_form_tab',
+        feedbackBrowserInput: '#feedback_browser',
+        feedbackcurrentURL: '#feedback_current_url'
+      });
+      this.handleFormSubmit = function(ev, formType) {
+        this.disableForm(formType);
+        this.populateMetadata(formType);
+        $.ajax({
+          url: this.attr.ticketSubmitRoute,
+          type: "POST",
+          data: this.select("" + formType + "Form").serialize(),
+          dataType: "json",
+          beforeSend: (function(_this) {
+            return function(xhr, opts) {
+              _this.showSpinner();
+              _this.clearErrors(formType);
+              return _this.checkFormErrors(formType, xhr);
+            };
+          })(this),
+          success: (function(_this) {
+            return function(response, textStatus) {
+              if (response.ticket) {
+                _this.displayThankYou(formType);
+                _this.clearForm(formType);
+                return _this.trigger('supportTicketSubmitted');
+              }
+            };
+          })(this),
+          error: (function(_this) {
+            return function(jqXHR, textStatus) {
+              _this.displayFormError(formType, 'Failed to submit ticket. Please try again later.');
+              _this.disableForm(formType, false);
+              return _this.hideSpinner();
+            };
+          })(this)
+        });
+        if (ev.preventDefault) {
+          return ev.preventDefault();
+        } else {
+          return ev.returnValue = false;
+        }
+      };
+      this.populateMetadata = function(formType) {
+        var browserInfo, currentURL;
+        browserInfo = navigator.userAgent;
+        currentURL = window.location.href;
+        this.select("" + formType + "BrowserInput").val(browserInfo);
+        return this.select("" + formType + "currentURL").val(currentURL);
+      };
+      this.checkFormErrors = function(formType, xhr) {
+        var blank_inputs, email;
+        blank_inputs = this.select("" + formType + "Form").find("input:text[value=''], textarea[value='']");
+        if (blank_inputs.length > 0) {
+          $(blank_inputs).addClass('error_input');
+          this.displayFormError(formType, 'Missing Required Field');
+          this.disableForm(formType, false);
+          this.hideSpinner();
+          xhr.abort();
+          return;
+        }
+        email = this.select("" + formType + "Form").find("input[name='ticket[requester][email]']");
+        if (!this.IsEmail(email.val())) {
+          $(email).addClass('error_input');
+          this.displayFormError(formType, 'Improper Email Format');
+          this.disableForm(formType, false);
+          this.hideSpinner();
+          return xhr.abort();
+        }
+      };
+      this.IsEmail = function(email) {
+        var regex;
+        regex = /^([a-zA-Z0-9_.+-])+\@(([a-zA-Z0-9-])+\.)+([a-zA-Z0-9]{2,4})+$/;
+        return regex.test(email);
+      };
+      this.setTabHeader = function(formType) {
+        var tabHeaderID;
+        tabHeaderID = "" + formType + "Button";
+        $('#feedback_form_holder .ld_tab').removeClass('tab_active');
+        return this.select(tabHeaderID).addClass('tab_active');
+      };
+      this.setTabContent = function(formType) {
+        var tabContentID;
+        tabContentID = "" + formType + "FormContainer";
+        this.displayForm(formType);
+        $('#feedback_form_holder .feedback_popup_tab').removeClass('active_tab');
+        return this.select(tabContentID).addClass('active_tab');
+      };
+      this.displayTab = function(formType) {
+        this.setTabHeader(formType);
+        return this.setTabContent(formType);
+      };
+      this.displayThankYou = function(formType) {
+        this.select("" + formType + "Form").hide();
+        return this.select("" + formType + "FormThanks").show();
+      };
+      this.displayForm = function(formType) {
+        this.select("" + formType + "Form").show();
+        return this.select("" + formType + "FormThanks").hide();
+      };
+      this.displayFormError = function(formType, msg) {
+        return this.select("" + formType + "FormContainer").find('.error_msg').removeClass('hidden').text(msg);
+      };
+      this.disableForm = function(formType, value) {
+        if (value == null) {
+          value = true;
+        }
+        this.select("" + formType + "Form").find("input[type=text], textarea").attr('readonly', value);
+        return this.select("" + formType + "Form").find("input[type=submit]").attr('disabled', value);
+      };
+      this.clearForm = function(formType) {
+        this.select("" + formType + "Form").find("input[type=text], textarea").val('');
+        this.disableForm(formType, false);
+        this.clearErrors(formType);
+        return this.hideSpinner();
+      };
+      this.showSpinner = function() {
+        return this.select('spinnerClass').removeClass('hidden');
+      };
+      this.hideSpinner = function() {
+        return this.select('spinnerClass').addClass('hidden');
+      };
+      this.clearErrors = function(formType) {
+        this.select("" + formType + "Form").find("input[type=text], textarea").removeClass('error_input');
+        return this.select("" + formType + "FormContainer").find('.error_msg').addClass('hidden');
+      };
+      return this.after('initialize', function() {
+        this.on(this.attr.questionForm, 'submit', function(event) {
+          return this.handleFormSubmit(event, 'question');
+        });
+        this.on(this.attr.feedbackForm, 'submit', function(event) {
+          return this.handleFormSubmit(event, 'feedback');
+        });
+        this.on(this.attr.feedbackButton, 'click', function() {
+          return this.displayTab('feedback');
+        });
+        return this.on(this.attr.questionButton, 'click', function() {
+          return this.displayTab('question');
+        });
+      });
+    };
+    return defineComponent(FormComponent);
+  });
+
+}).call(this);

data/js/support_center/src/form_component.coffee

@@ -0,0 +1,133 @@
+define [
+  'jquery',
+  'flight/lib/component'
+], (
+  $,
+  defineComponent,
+) ->
+
+  FormComponent = ->
+    @defaultAttrs
+      ticketSubmitRoute:     '/support/tickets/'
+      spinnerClass:          '.spinner'
+
+      questionForm:          '#questions_form_element'
+      questionFormThanks:    '#thanks_questions_tab'
+      questionButton:        '#questions_form'
+      questionFormContainer: '#questions_form_tab'
+      questionBrowserInput:  '#question_browser'
+      questioncurrentURL:    '#question_current_url'
+
+      feedbackForm:          '#feedback_form_element'
+      feedbackFormThanks:    '#thanks_feedback_tab'
+      feedbackButton:        '#feedback_form'
+      feedbackFormContainer: '#feedback_form_tab'
+      feedbackBrowserInput:  '#feedback_browser'
+      feedbackcurrentURL:    '#feedback_current_url'
+
+    @handleFormSubmit = (ev, formType) ->
+      @disableForm(formType)
+      @populateMetadata(formType)
+      $.ajax
+        url: @attr.ticketSubmitRoute
+        type: "POST"
+        data: @select("#{formType}Form").serialize()
+        dataType: "json"
+        beforeSend: (xhr, opts) =>
+          @showSpinner()
+          @clearErrors(formType)
+          @checkFormErrors(formType, xhr)
+        success: (response, textStatus) =>
+          if response.ticket
+            @displayThankYou(formType)
+            @clearForm(formType)
+            @trigger('supportTicketSubmitted')
+        error: (jqXHR, textStatus) =>
+          @displayFormError(formType, 'Failed to submit ticket. Please try again later.')
+          @disableForm(formType, false)
+          @hideSpinner()
+
+#      IE8 support
+      if ev.preventDefault then ev.preventDefault() else ev.returnValue = false
+
+    @populateMetadata = (formType) ->
+      browserInfo = navigator.userAgent
+      currentURL = window.location.href
+      @select("#{formType}BrowserInput").val(browserInfo)
+      @select("#{formType}currentURL").val(currentURL)
+
+    @checkFormErrors = (formType, xhr) ->
+      blank_inputs = @select("#{formType}Form").find("input:text[value=''], textarea[value='']")
+      if blank_inputs.length > 0
+        $(blank_inputs).addClass('error_input')
+        @displayFormError(formType, 'Missing Required Field')
+        @disableForm(formType, false)
+        @hideSpinner()
+        xhr.abort()
+        return
+      email = @select("#{formType}Form").find("input[name='ticket[requester][email]']")
+      unless @IsEmail(email.val())
+        $(email).addClass('error_input')
+        @displayFormError(formType, 'Improper Email Format')
+        @disableForm(formType, false)
+        @hideSpinner()
+        xhr.abort()
+
+    @IsEmail = (email) ->
+      regex = /^([a-zA-Z0-9_.+-])+\@(([a-zA-Z0-9-])+\.)+([a-zA-Z0-9]{2,4})+$/
+      regex.test email
+
+    @setTabHeader = (formType) ->
+      tabHeaderID = "#{formType}Button"
+      $('#feedback_form_holder .ld_tab').removeClass('tab_active')
+      @select(tabHeaderID).addClass('tab_active')
+
+    @setTabContent = (formType) ->
+      tabContentID = "#{formType}FormContainer"
+      @displayForm(formType)
+      $('#feedback_form_holder .feedback_popup_tab').removeClass('active_tab')
+      @select(tabContentID).addClass('active_tab')
+
+    @displayTab = (formType) ->
+      @setTabHeader(formType)
+      @setTabContent(formType)
+
+    @displayThankYou = (formType) ->
+      @select("#{formType}Form").hide()
+      @select("#{formType}FormThanks").show()
+
+    @displayForm = (formType) ->
+      @select("#{formType}Form").show()
+      @select("#{formType}FormThanks").hide()
+
+    @displayFormError = (formType, msg) ->
+      @select("#{formType}FormContainer").find('.error_msg').removeClass('hidden').text(msg)
+
+    @disableForm = (formType, value=true) ->
+      @select("#{formType}Form").find("input[type=text], textarea").attr('readonly', value)
+      @select("#{formType}Form").find("input[type=submit]").attr('disabled', value)
+
+    @clearForm = (formType) ->
+      @select("#{formType}Form").find("input[type=text], textarea").val('')
+      @disableForm(formType, false)
+      @clearErrors(formType)
+      @hideSpinner()
+
+    @showSpinner = ->
+      @select('spinnerClass').removeClass('hidden')
+
+    @hideSpinner = ->
+      @select('spinnerClass').addClass('hidden')
+
+    @clearErrors = (formType) ->
+      @select("#{formType}Form").find("input[type=text], textarea").removeClass('error_input')
+      @select("#{formType}FormContainer").find('.error_msg').addClass('hidden')
+
+    @after 'initialize', ->
+      @on @attr.questionForm, 'submit', (event)-> @handleFormSubmit(event, 'question')
+      @on @attr.feedbackForm, 'submit', (event)-> @handleFormSubmit(event, 'feedback')
+      @on @attr.feedbackButton, 'click', -> @displayTab('feedback')
+      @on @attr.questionButton, 'click', -> @displayTab('question')
+
+
+  defineComponent FormComponent