zendesk_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7789387d91473a18513bc9a722fc13e3cf3531d6
+  data.tar.gz: 3955edcc59139c0dabd07f33051bca4025b01bc3
+SHA512:
+  metadata.gz: 1d4e34daf8e477af6e6afb20694130e871c20fd52d1087ec9584fdb4b359741dcc3db853a2a73058bf28329f78c4c95980d20489267c2f11d8ab761fc5533889
+  data.tar.gz: c95159cf2599910322ca2dbe44c44e27822eb7664ee78b54f67f2082e7fdfc1c4d0655376e81f64098cb27af70934e142daf9be488e307464b8d5066dc5c2e0d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# Zendesk Rails
+
+Zendesk Rails is a mountable engine for end-users to create, track, and comment on tickets. It uses the [Zendesk API Client](https://github.com/zendesk/zendesk_api_client_rb).
+
+## Installation
+
+Add `zendesk_rails` to your Gemfile.
+
+```ruby
+gem 'zendesk_rails'
+```
+
+## Setup
+
+Mount the engine within your Rails application by adding this line to `config/routes.rb`.
+
+```ruby
+mount ZendeskRails::Engine, at: '/help'
+```
+
+Then you'll need to configure a few settings by creating an initializer.
+
+```ruby
+ZendeskRails.configure do
+  config.url = 'https://example.zendesk.com/api/v2'
+
+  # Basic / Token authentication
+  config.username = 'user@example.com'
+
+  # Choose one of the following depending on your authentication choice
+  config.token = 'your zendesk token'
+  config.password = 'your zendesk password'
+end
+```
+
+You should be ready to go! Fire up your server and visit '/help'.
+
+## Additional Configuration
+
+#### Zendesk API Settings
+
+The `configure` block accepts all settings from the [Zendesk API Client](https://github.com/zendesk/zendesk_api_client_rb). Take a look at their documentation for some additional configuration options.
+
+#### Customization
+
+##### config.app_name
+
+Sets the name of the app in the navbar.
+
+```ruby
+config.app_name = 'My Application'
+```
+
+##### config.layout
+
+Sets the path to a custom layout.
+
+```ruby
+config.layout = 'layouts/application'
+```
+
+##### config.devise_scope
+
+By default, Zendesk Rails assumes your controller has a `current_user` method. If `config.devise_scope` were set to `:admin`, Zendesk Rails would use `current_admin`.
+
+##### config.user_attributes
+
+Your user model is expected to have `:name` and `:email` methods. Otherwise, you'll need to provide a hash with the values being the actual names of your methods.
+
+```ruby
+config.user_attributes = { name: :full_name, email: :email_address }
+```
+
+##### config.time_formatter
+
+Times are displayed using `time_ago_in_words`. You can set this to either a string to be passed to `strftime`, or a proc that accepts a Time. Passing a proc allows you to use view helper methods.
+
+```ruby
+config.time_formatter = ->(time){ time.to_formatted_s }
+```
+
+##### config.ticket_list_options
+
+Ticket list options are passed to the Zendesk API's search endpoint. By default, tickets are sorted by the created_at time in descending order.
+
+```ruby
+config.ticket_list_options = {
+  sort_by: :created_at,
+  sort_order: :desc
+}
+```
+
+See http://developer.zendesk.com/documentation/rest_api/search.html
+
+##### config.comment_list_options
+
+Comment list options are passed to the Zendesk API's request comments. By default, comments are sorted by the created_at time in descending order.
+
+```ruby
+config.comment_list_options = {
+  sort_by: :created_at,
+  sort_order: :desc
+}
+```
+
+See http://developer.zendesk.com/documentation/rest_api/requests.html#listing-comments
+
+##### config.test_mode
+
+When `config.test_mode` is true, a fake API will be used. All created tickets will be stored in memory. This setting is particularly useful for testing out Zendesk Rails. Do not use this setting in production.
+
+### Overriding Controller Behavior
+
+Zendesk Rails offers hooks that allow you to control what happens after a ticket is created/invalid. You can override the following methods in your `ApplicationController`.
+
+```ruby
+# The user will be redirected to this URL when a
+# ticket is successfully created
+def after_zendesk_ticket_created_path_for(ticket)
+  if user_signed_in?
+    ticket_path(ticket.id)
+  else
+    main_app.root_path
+  end
+end
+
+# Render will be called with these arguments when a ticket is invalid
+def after_zendesk_ticket_invalid_template
+  return 'new' if user_signed_in?
+  ['welcome/index', { layout: false }]
+end
+```
+
+### Overriding Content
+
+Zendesk Rails allows you to easily override content using I18n. Override keys from [config/locales/zendesk_rails.yml](config/locales/zendesk_rails.yml) in a file located in your `config/locales` directory.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ZendeskRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/zendesk_rails/application.js

@@ -0,0 +1,3 @@
+//= require_tree .
+//= require jquery
+//= require jquery_ujs

data/app/assets/stylesheets/zendesk_rails/application.css

@@ -0,0 +1,29 @@
+/*
+ *= require_tree .
+ *= require_self
+*/
+
+body {
+  padding-top: 70px;
+}
+
+.comment {
+  font-size: 17.5px;
+}
+
+.comment-body p:last-child,
+.comment-body ul:last-child,
+.comment-body ol:last-child {
+  margin-bottom: 0;
+}
+
+.comment-details {
+  display: block;
+  font-size: 80%;
+  line-height: 1.42857143;
+  color: #777;
+}
+
+.comment-details:before {
+  content: '\2014 \00A0';
+}

data/app/controllers/zendesk_rails/tickets_controller.rb

@@ -0,0 +1,59 @@
+module ZendeskRails
+  class TicketsController < ApplicationController
+    layout :zendesk_layout
+
+    def index
+      @tickets = TicketHandler.search(query: {
+        requester: zendesk_user_attribute(:email)
+      })
+    end
+
+    def show
+      @ticket  = TicketHandler.find_request(params[:id])
+      @handler = CommentHandler.new(@ticket)
+    end
+
+    def new
+      @handler = TicketHandler.new
+    end
+
+    def create
+      @handler = TicketHandler.new(ticket_params)
+
+      if @ticket = @handler.create
+        flash_key = zendesk_user_signed_in? ? :authenticated : :unauthenticated
+        redirect_to after_zendesk_ticket_created_path_for(@ticket), flash: {
+          success: t("zendesk.tickets.create.#{flash_key}.message")
+        }
+      else
+        render *Array(after_zendesk_ticket_invalid_template)
+      end
+    end
+
+    def update
+      @ticket  = TicketHandler.find_ticket(params[:id])
+      @handler = CommentHandler.new(@ticket, comment_params)
+
+      if @handler.save
+        redirect_to ticket_path(@ticket.id), flash: {
+          success: t('zendesk.comments.added')
+        }
+      else
+        render 'show'
+      end
+    end
+
+    private
+
+    def comment_params
+      params.require(:ticket).permit(:comment)
+    end
+
+    def ticket_params
+      params.require(:ticket).permit(:subject, :body).merge(requester: {
+        name: (params[:ticket][:name].presence || zendesk_user_attribute(:name)),
+        email: (params[:ticket][:email].presence || zendesk_user_attribute(:email))
+      })
+    end
+  end
+end

data/app/helpers/zendesk_rails/tickets_helper.rb

@@ -0,0 +1,30 @@
+module ZendeskRails
+  module TicketsHelper
+    def format_time(time)
+      formatter = zendesk_config.time_formatter
+      if formatter.respond_to?(:call)
+        instance_exec time, &formatter
+      else
+        time.strftime(formatter)
+      end
+    end
+
+    def status_label_class(status)
+      t('zendesk.tickets.status')[status.try(:to_sym)] || 'default'
+    end
+
+    def form_group_with_errors(object, field, &block)
+      errors = object.errors.full_messages_for(field)
+      group_classes, help = 'form-group', ''
+
+      if errors.any?
+        group_classes << ' has-error has-feedback'
+        help = content_tag(:span, errors.first, class: 'help-block')
+      end
+
+      content_tag :div, class: group_classes do
+        capture(errors, &block).concat(help)
+      end
+    end
+  end
+end

data/app/models/zendesk_rails/comment_handler.rb

@@ -0,0 +1,40 @@
+module ZendeskRails
+  class CommentHandler
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    attr_reader :ticket
+    attr_accessor :comment, :requester_id
+
+    validates_presence_of :comment, :requester_id
+
+    def initialize(ticket, attributes = {})
+      @ticket = ticket
+      @requester_id = ticket.requester_id
+
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def save
+      return false unless valid?
+
+      ticket.comment = {
+        body: comment,
+        author_id: ticket.requester_id
+      }
+
+      ticket.save
+    end
+
+    def comments
+      @comments ||= ticket.comments(ZendeskRails.config.comment_list_options)
+    end
+
+    def persisted?
+      false
+    end
+  end
+end

data/app/models/zendesk_rails/ticket_handler.rb

@@ -0,0 +1,74 @@
+require 'active_model'
+
+module ZendeskRails
+  class TicketHandler
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    attr_reader :ticket
+    attr_accessor :name, :email, :subject, :body, :requester, :comment
+
+    validates :subject, :body, :requester, presence: true
+    validate :requester_email_presence, :requester_name_presence
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def create
+      @ticket = self.class.client.tickets.create(create_params) if valid?
+    end
+
+    def create_params
+      {
+        subject: subject,
+        comment: { value: body },
+        requester: requester
+      }.merge(ZendeskRails.config.ticket_create_params)
+    end
+
+    def persisted?
+      false
+    end
+
+    def requester_email_presence
+      if requester && requester[:email].blank?
+        errors.add(:email, "can't be blank")
+      end
+    end
+
+    def requester_name_presence
+      if requester && requester[:name].blank?
+        errors.add(:name, "can't be blank")
+      end
+    end
+
+    class << self
+      delegate :client, to: ZendeskRails
+
+      def search(conditions = {})
+        conditions[:query] = to_query(conditions[:query])
+        conditions.merge!(ZendeskRails.config.ticket_list_options)
+        client.search(conditions)
+      end
+
+      def find_request(id)
+        client.requests.find(id: id)
+      end
+
+      def find_ticket(id)
+        client.tickets.find(id: id)
+      end
+
+      private
+
+      def to_query(query)
+        return query unless query.respond_to?(:keys)
+        query.to_a.map { |a| a.join(':') }.join('+')
+      end
+    end
+  end
+end

data/app/views/layouts/zendesk_rails/tickets.html.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Help | <%= zendesk_config.app_name %></title>
+  <%= stylesheet_link_tag    "http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" %>
+  <%= stylesheet_link_tag    "zendesk_rails/application", media: "all" %>
+  <%= javascript_include_tag "zendesk_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+    <div class="container">
+      <div class="navbar-header">
+        <%= link_to zendesk_config.app_name, main_app.root_path, class: 'navbar-brand' %>
+      </div>
+    </div>
+  </div>
+
+  <div class="container" role="main">
+    <% flash.each do |type, message| %>
+      <div class="alert alert-<%= type %> fade in">
+        <button class="close" data-dismiss="alert">×</button>
+        <%= message %>
+      </div>
+    <% end %>
+
+    <%= yield %>
+  </div>
+
+  <%= javascript_include_tag "http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js" %>
+</body>
+</html>

data/app/views/zendesk_rails/tickets/index.html.erb

@@ -0,0 +1,37 @@
+<div class="jumbotron">
+  <h1><%= t 'zendesk.tickets.jumbotron.callout' %></h1>
+  <p><%= t 'zendesk.tickets.jumbotron.body' %></p>
+  <p>
+    <%= link_to t('zendesk.tickets.jumbotron.new'), new_ticket_path, class: "btn btn-primary btn-lg" %>
+  </p>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <h1><%= t 'zendesk.tickets.list.heading' %></h1>
+    <div class="table-responsive">
+      <table class="table table-hover table-striped">
+        <thead>
+          <th><%= t 'zendesk.tickets.list.columns.id' %></th>
+          <th><%= t 'zendesk.tickets.list.columns.subject' %></th>
+          <th><%= t 'zendesk.tickets.list.columns.status' %></th>
+          <th><%= t 'zendesk.tickets.list.columns.last_updated' %></th>
+        </thead>
+        <tbody>
+          <% @tickets.each do |ticket| %>
+            <tr>
+              <td><%= link_to ticket.id, zendesk_rails.ticket_path(ticket.id) %></td>
+              <td><%= truncate ticket.subject, length: 300 %></td>
+              <td>
+                <span class="label label-<%= status_label_class(ticket.status) %>">
+                  <%= ticket.status.try(:titleize) || 'New' %>
+                </span>
+              </td>
+              <td><%= format_time(ticket.updated_at || ticket.created_at) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/views/zendesk_rails/tickets/new.html.erb

@@ -0,0 +1,38 @@
+<div class="page-header">
+  <h1>New ticket</h1>
+</div>
+
+<div class="row">
+  <div class="col-md-8">
+    <%= form_for(@handler, as: :ticket, url: tickets_path) do |f| %>
+      <% unless zendesk_user_signed_in? %>
+        <%= form_group_with_errors f.object, :name do %>
+          <%= f.label :name, t('zendesk.tickets.new.name.label') %>
+          <%= f.text_field :name, class: "form-control", placeholder: t('zendesk.tickets.new.name.placeholder') %>
+        <% end %>
+
+        <%= form_group_with_errors f.object, :email do %>
+          <%= f.label :email, t('zendesk.tickets.new.email.label') %>
+          <%= f.text_field :email, class: "form-control", placeholder: t('zendesk.tickets.new.email.placeholder') %>
+        <% end %>
+      <% end %>
+
+      <%= form_group_with_errors f.object, :subject do %>
+        <%= f.label :subject, t('zendesk.tickets.new.subject.label') %>
+        <%= f.text_field :subject, class: "form-control", placeholder: t('zendesk.tickets.new.subject.placeholder') %>
+      <% end %>
+
+      <%= form_group_with_errors f.object, :body do %>
+        <%= f.label :body, t('zendesk.tickets.new.body.label') %>
+        <%= f.text_area :body, rows: 10, class: "form-control", placeholder: t('zendesk.tickets.new.body.placeholder') %>
+      <% end %>
+
+      <p><%= f.submit t('zendesk.tickets.new.submit'), class: "btn btn-large btn-primary" %></p>
+
+    <% end %>
+  </div>
+
+  <div class="col-md-4">
+    <div class="well"><%= t 'zendesk.tickets.new.sidebar' %></div>
+  </div>
+</div>

data/app/views/zendesk_rails/tickets/show.html.erb

@@ -0,0 +1,43 @@
+<div class='page-header'>
+  <h2>
+    <div class="label label-<%= status_label_class(@ticket.status) %>">#<%= @ticket.id -%></div>
+    <%= truncate @ticket.subject, length: 200 -%>
+  </h2>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="well">
+      <%= form_for(@handler, as: :ticket, method: :put, url: ticket_path(@ticket.id)) do |f| %>
+
+        <%= form_group_with_errors f.object, :comment do %>
+          <%= f.text_area :comment, rows: 5, class: "form-control", placeholder: t('zendesk.comments.new.placeholder') %>
+        <% end %>
+
+        <p><%= submit_tag t('zendesk.comments.new.submit'), class: "btn btn-large btn-primary" %></p>
+      <% end %>
+    </div>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <% @handler.comments.each do |comment| %>
+      <div class="well comment">
+        <div class="row">
+          <% if photo = comment.author.photo %>
+            <div class="col-xs-2 col-md-1">
+              <%= image_tag photo.content_url, class: 'img-circle img-responsive' %>
+            </div>
+          <% end %>
+          <div class="<%= photo ? 'col-xs-10 col-md-11' : 'col-md-12' %>">
+            <div class="comment-body"><%= raw comment.html_body %></div>
+            <small class="comment-details">
+              <%= t 'zendesk.comments.details', time: format_time(comment.created_at), user: comment.author.name %>
+            </small>
+          </div>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>

data/config/locales/zendesk_rails.yml

@@ -0,0 +1,48 @@
+en:
+  zendesk:
+    app_name: Help
+    tickets:
+      status:
+        new: warning
+        open: danger
+        pending: info
+        hold: primary
+        solved: default
+        closed: default
+      jumbotron:
+        callout: Having trouble?
+        body: Our help desk is ready to answer any questions you might have. Create a new ticket to get help.
+        new: New Ticket »
+      list:
+        heading: My Tickets
+        columns:
+          id: '#'
+          subject: Subject
+          status: Status
+          last_updated: Last Updated
+      new:
+        sidebar: Just fill out the form, and we'll get back to you as soon as possible.
+        name:
+          label: Name
+          placeholder: Name
+        email:
+          label: Email
+          placeholder: Email
+        subject:
+          label: Subject
+          placeholder: Subject
+        body:
+          label: Describe your issue
+          placeholder: Please describe the issue you're experiencing...
+        submit: Send Your Question
+      create:
+        authenticated:
+          message: Thank you for your submission! You can track the status of your ticket from this page.
+        unauthenticated:
+          message: Thank you for your submission! You will receive an email at the provided address shortly.
+    comments:
+      details: '%{time} by %{user}'
+      added: Comment successfully submitted.
+      new:
+        placeholder: Enter your reply...
+        submit: Add Comment

data/config/routes.rb

@@ -0,0 +1,4 @@
+ZendeskRails::Engine.routes.draw do
+  resources :tickets
+  root to: 'tickets#index'
+end

data/lib/tasks/zendesk_rails_tasks.rake

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

data/lib/zendesk_rails.rb

@@ -0,0 +1,11 @@
+require 'zendesk_rails/engine'
+
+module ZendeskRails
+  mattr_reader :config, :client
+
+  def self.configure
+    @@config = ZendeskRails::Configuration.new
+    yield config
+    @@client = config.build_client
+  end
+end

data/lib/zendesk_rails/configuration.rb

@@ -0,0 +1,91 @@
+module ZendeskRails
+  class Configuration
+    CLIENT_OPTIONS = [
+      :username,
+      :password,
+      :token,
+      :url,
+      :retry,
+      :logger,
+      :client_options,
+      :adapter,
+      :allow_http,
+      :access_token,
+      :url_based_access_token
+    ]
+
+    DEFAULT_SORTING = {
+      sort_by: :created_at,
+      sort_order: :desc
+    }
+
+    DEFAULT_USER_ATTRIBUTES = {
+      name: :name,
+      email: :email
+    }
+
+    attr_accessor *CLIENT_OPTIONS
+    attr_accessor :layout
+    attr_writer :devise_scope
+    attr_writer :app_name
+    attr_writer :time_formatter
+    attr_writer :test_mode
+    attr_writer :user_attributes
+    attr_writer :ticket_list_options
+    attr_writer :comment_list_options
+    attr_writer :ticket_create_params
+
+    def devise_scope
+      @current_user_method || :user
+    end
+
+    def app_name
+      @app_name || I18n.translate('zendesk.app_name')
+    end
+
+    def time_formatter
+      @time_formatter || ->(time) { "#{time_ago_in_words(time)} ago" }
+    end
+
+    def test_mode?
+      @test_mode
+    end
+
+    def user_attributes
+      (@user_attributes || {}).reverse_merge(DEFAULT_USER_ATTRIBUTES)
+    end
+
+    def ticket_create_params
+      @ticket_create_params || {}
+    end
+
+    def ticket_list_options
+      (@ticket_list_options || {}).reverse_merge(DEFAULT_SORTING)
+    end
+
+    def comment_list_options
+      (@comment_list_options || {}).reverse_merge(DEFAULT_SORTING)
+    end
+
+    def build_client
+      client_class.new do |client_config|
+        CLIENT_OPTIONS.each do |opt|
+          if value = send(opt)
+            client_config.send("#{opt}=", value)
+          end
+        end
+      end
+    end
+
+    private
+
+    def client_class
+      if test_mode?
+        require 'zendesk_rails/testing'
+        ZendeskRails::Testing::Client
+      else
+        ::ZendeskAPI::Client
+      end
+    end
+  end
+end

data/lib/zendesk_rails/controller_helpers.rb

@@ -0,0 +1,41 @@
+module ZendeskRails
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :config, to: :ZendeskRails, prefix: :zendesk
+      delegate :layout, to: :zendesk_config, prefix: :zendesk
+
+      helper_method :zendesk_config,
+                    :zendesk_current_user,
+                    :zendesk_user_signed_in?,
+                    :zendesk_user_attribute
+    end
+
+    def zendesk_current_user
+      send "current_#{zendesk_config.devise_scope}"
+    end
+
+    def zendesk_user_signed_in?
+      send "#{zendesk_config.devise_scope}_signed_in?"
+    end
+
+    # Gets the value of a user's name/emails based on
+    # configurable attribute names
+    def zendesk_user_attribute(attribute)
+      attr_name = zendesk_config.user_attributes[attribute]
+      zendesk_current_user.try(attr_name)
+    end
+
+    # The user will be redirected to this URL when a
+    # ticket is successfully created
+    def after_zendesk_ticket_created_path_for(ticket)
+      ticket_path(ticket.id)
+    end
+
+    # Render will be called with these arguments when a ticket is invalid
+    def after_zendesk_ticket_invalid_template
+      'new'
+    end
+  end
+end

data/lib/zendesk_rails/engine.rb

@@ -0,0 +1,15 @@
+require 'zendesk_api'
+require 'zendesk_rails/configuration'
+require 'zendesk_rails/controller_helpers'
+
+module ZendeskRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ZendeskRails
+
+    initializer "zendesk_rails.helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        include ZendeskRails::ControllerHelpers
+      end
+    end
+  end
+end

data/lib/zendesk_rails/testing.rb

@@ -0,0 +1,102 @@
+module ZendeskRails
+  module Testing
+    class Resource
+      def initialize(attributes)
+        @attributes = attributes.symbolize_keys
+      end
+
+      def method_missing(method, *args, &block)
+        if attribute = @attributes[method]
+          attribute.respond_to?(:keys) ? OpenStruct.new(attribute) : attribute
+        else
+          super
+        end
+      end
+
+      class << self
+        def all
+          (@all ||= []).sort { |a, b| b.created_at <=> a.created_at }
+        end
+
+        delegate *Array.instance_methods(false), to: :all
+      end
+    end
+
+    class Comment < Resource
+      def initialize(attributes)
+        attributes.reverse_merge!(
+          created_at: Time.now,
+          updated_at: Time.now
+        )
+        super(attributes)
+      end
+    end
+
+    class Ticket < Resource
+      def initialize(attributes)
+        attributes.reverse_merge!(
+          created_at: Time.now,
+          updated_at: Time.now,
+          priority: 'low',
+          status: 'new',
+          comments: []
+        )
+        super(attributes)
+      end
+
+      def save
+        true
+      end
+
+      def requester_id
+        @requester_id ||= rand(1..1000)
+      end
+
+      def as_comment
+        @attributes.slice(:created_at, :updated_at).merge(
+          html_body: description,
+          author: { name: requester[:name] }
+        )
+      end
+
+      def comments(_opts = {})
+        list = (@attributes[:comments] + [as_comment]).map { |c| Comment.new(c) }
+        list.sort { |a, b| b.created_at <=> a.created_at }
+      end
+
+      def comment=(opts)
+        @attributes[:comments].unshift(
+          html_body: opts[:body],
+          author: requester
+        )
+      end
+
+      class << self
+        def create(client_or_opts = {}, opts = nil)
+          opts ||= client_or_opts
+          id = (all.map(&:id).max || 0) + 1
+          opts.merge!(id: id, description: opts[:comment][:value])
+          ticket = new opts.slice(:subject, :requester, :description, :id)
+          @all.unshift ticket
+          ticket
+        end
+
+        def find(opts = {})
+          all.find do |ticket|
+            opts.map do |key, value|
+              ticket.send(key) == value || ticket.send(key).to_s == value
+            end.all?
+          end
+        end
+      end
+    end
+
+    class Client
+      def tickets(_opts = {})
+        Ticket
+      end
+      alias_method :requests, :tickets
+      alias_method :search, :tickets
+    end
+  end
+end

data/lib/zendesk_rails/version.rb

@@ -0,0 +1,3 @@
+module ZendeskRails
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: simplecov
+  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: capybara
+  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: poltergeist
+  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: A Rails engine to add help desk ticketing using the Zendesk API.
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/zendesk_rails/application.js
+- app/assets/stylesheets/zendesk_rails/application.css
+- app/controllers/zendesk_rails/tickets_controller.rb
+- app/helpers/zendesk_rails/tickets_helper.rb
+- app/models/zendesk_rails/comment_handler.rb
+- app/models/zendesk_rails/ticket_handler.rb
+- app/views/layouts/zendesk_rails/tickets.html.erb
+- app/views/zendesk_rails/tickets/index.html.erb
+- app/views/zendesk_rails/tickets/new.html.erb
+- app/views/zendesk_rails/tickets/show.html.erb
+- config/locales/zendesk_rails.yml
+- config/routes.rb
+- lib/tasks/zendesk_rails_tasks.rake
+- lib/zendesk_rails.rb
+- lib/zendesk_rails/configuration.rb
+- lib/zendesk_rails/controller_helpers.rb
+- lib/zendesk_rails/engine.rb
+- lib/zendesk_rails/testing.rb
+- lib/zendesk_rails/version.rb
+homepage: https://github.com/rzane/zendesk_rails
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails Help Desk Ticketing using the Zendesk API
+test_files: []