insight_rails 0.1.1

data/README.md

@@ -0,0 +1,43 @@
+# Insight
+
+Rails engine to access support requests and knowledge base articles stored in FatFree CRM. 
+
+## Installation
+
+Add insight to your applications dependencies.
+
+For Rails 2
+
+    gem.config "insight_rails", :lib => "insight"
+    
+For those using bundler
+
+    gem "insight_rails", :require => "insight"
+  
+Make sure your development database exists and run the generator:
+  
+    script/generate insight
+    
+Firstly, run the migration to add the crm_id field to your users table. 
+
+Then update the insight initializer with details of your api_key, fatfree's url and your recaptcha keys.
+
+## Usage
+
+You will now have a knowledge base of articles from your fat free installation available at:
+
+/knowledge
+
+You will also have a support page available at:
+
+/help
+
+Discussions can be viewed at:
+
+/help/browse
+
+This will pull through the issue_categories you setup in Fat Free.
+    
+## Copyright
+
+Copyright (c) 2010 Kieran Johnson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "insight_rails"
+  gem.summary     = "Customer Support and Knowledge Base"
+  gem.description = "Customer Support and Knowledge Base"
+  gem.email       = "support@invisiblelines.com"
+  gem.homepage    = "http://github.com/kieranj/insight"
+  gem.authors     = ["Kieran Johnson"]
+  gem.files       = FileList["[A-Z]*", "{app,config,generators,lib,rails}/**/*"]
+  gem.add_dependency "recaptcha"
+  gem.add_dependency "gravtastic"
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/app/controllers/help/categories_controller.rb

@@ -0,0 +1,11 @@
+class Help::CategoriesController < InsightController
+  
+  skip_before_filter :login_required
+  
+  layout Insight.configuration.layout
+  
+  def index
+    @categories = Category.find(:all)
+  end
+  
+end

data/app/controllers/help/comments_controller.rb

@@ -0,0 +1,22 @@
+class Help::CommentsController < InsightController
+  
+  skip_before_filter :login_required
+    
+  def create
+    @comment = Comment.new(params[:comment].merge(defaults))
+    if verify_recaptcha(:model => @comment, :private_key => Insight.configuration.recaptcha_private_key) && @comment.save
+      redirect_to(help_issue_path(@comment.issue.to_param))
+    else
+      redirect_to(help_issue_path(@comment.issue.to_param))
+    end
+  end
+  
+  protected
+  
+    def defaults
+      { 
+        :issue_id => params[:issue_id]
+      }
+    end
+  
+end

data/app/controllers/help/issues_controller.rb

@@ -0,0 +1,53 @@
+class Help::IssuesController < InsightController
+  
+  layout Insight.configuration.layout
+  
+  skip_before_filter :login_required
+  
+  def my
+    @issues = Issue.get(:my, :crm_id => current_user.crm_id)
+    render :action => "index"
+  end
+  
+  def index
+    if params[:category_id]
+      @category = Category.find(params[:category_id])
+      @issues   = @category.issues
+    else
+      @issues = Issue.find(:all)
+    end
+  end
+  
+  def show
+    @issue = Issue.find(params[:id])
+  end
+  
+  def new
+    @issue = Issue.new
+  end
+  
+  def create
+    @issue            = Issue.new(params[:issue])
+    @issue.contact_id = current_user.crm_id if logged_in? && !current_user.crm_id.nil?
+    
+    if verify_recaptcha(:model => @issue, :private_key => Insight.configuration.recaptcha_private_key) && @issue.save
+      redirect_to(help_issue_path(@issue))
+    else
+      render :action => "new"
+    end
+  end
+  
+  def edit
+    @issue = Issue.find(params[:id])
+  end
+  
+  def update
+    @issue = Issue.find(params[:id])
+    if verify_recaptcha(:model => @issue, :private_key => Insight.configuration.recaptcha_private_key) && @issue.update_attributes(params[:issue].merge(:contact_id => current_user.crm_id))
+      redirect_to(help_issues_path)
+    else
+      render :action => "edit"
+    end
+  end
+  
+end

data/app/controllers/help/sessions_controller.rb

@@ -0,0 +1,40 @@
+class Help::SessionsController < ApplicationController
+  
+  layout Insight.configuration.layout
+  
+  skip_before_filter :login_required
+  
+  before_filter :check_existing_login, :only => [ :new ]
+  
+  # def new    
+  # end
+  # 
+  # def create
+  #   json         = { :username => params[:username], :password => params[:password] }.to_json
+  #   auth_details = MultiPass.encode64(json)
+  #   
+  #   session = InsightSession.new(:auth => auth_details)
+  #   if session.save
+  #     self.current_user = session.multipass
+  #   else
+  #     render :action => "new"
+  #   end
+  # end
+  
+  def destroy
+    session[:multipass] = nil
+    redirect_to("/help")
+  end
+  
+  protected
+  
+    def check_existing_login
+      if logged_in?
+        session[:multipass] = current_user.multipass
+        redirect_to("/help")
+      else
+        redirect_to(login_path(:to => "/help"))
+      end
+    end
+  
+end

data/app/controllers/help_controller.rb

@@ -0,0 +1,10 @@
+class HelpController < InsightController
+  
+  skip_before_filter :login_required
+  
+  layout Insight.configuration.layout
+  
+  def index
+  end
+  
+end

data/app/controllers/insight_controller.rb

@@ -0,0 +1,32 @@
+class InsightController < ApplicationController
+  
+  before_filter :login_required
+  
+  def current_user
+    @insight_user ||= login_from_multipass
+  end
+  
+  def current_user=(multipass)
+    session[:multipass] = multipass
+    @insight_user       = login_from_multipass
+  end
+  
+  def authorized?
+    logged_in?
+  end
+  
+  def logged_in?
+    !!current_user
+  end
+  
+  protected
+  
+    def login_required
+      authorized?
+    end
+    
+    def login_from_multipass
+      session[:multipass].nil? ? nil : InsightUser.new(session[:multipass])
+    end
+  
+end

data/app/controllers/knowledge/article_categories_controller.rb

@@ -0,0 +1,13 @@
+class Knowledge::ArticleCategoriesController < ApplicationController
+  
+  skip_before_filter :login_required
+  
+  layout Insight.configuration.layout
+
+  def index
+    @categories      = ArticleCategory.find(:all)
+    @latest_articles = Article.get(:latest)
+    @latest_issues   = Issue.get(:latest)
+  end
+  
+end

data/app/controllers/knowledge/articles_controller.rb

@@ -0,0 +1,11 @@
+class Knowledge::ArticlesController < ApplicationController
+  
+  skip_before_filter :login_required
+  
+  layout Insight.configuration.layout
+  
+  def show
+    @article = Article.find(params[:id])
+  end
+  
+end

data/app/helpers/help/issues_helper.rb

@@ -0,0 +1,15 @@
+module Help::IssuesHelper
+  
+  def posted_on_long(date)
+    date.strftime("%B #{date.day.ordinalize} %Y") + " at " + date.strftime("%H:%M%p").downcase
+  end
+  
+  def posted_on_short(date)
+    date.strftime("%B #{date.day.ordinalize}, %Y %H:%M") + date.strftime("%p").downcase
+  end
+  
+  def comment_by(comment)
+    "staff" if comment.commenter_type == "User"
+  end
+  
+end

data/app/models/article.rb

@@ -0,0 +1,11 @@
+class Article < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site           = Insight.configuration.fat_free_url
+  
+  def to_param
+    slug
+  end
+  
+end

data/app/models/article_category.rb

@@ -0,0 +1,11 @@
+class ArticleCategory < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site           = Insight.configuration.fat_free_url
+  
+  def to_param
+    slug
+  end
+  
+end

data/app/models/category.rb

@@ -0,0 +1,11 @@
+class Category < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site           = Insight.configuration.fat_free_url
+  
+  def to_param
+    slug
+  end
+  
+end

data/app/models/category_issue.rb

@@ -0,0 +1,10 @@
+class CategoryIssue < ActiveResource::Base
+  
+  self.site         = Insight.configuration.fat_free_url + "/categories/:category_id"
+  self.element_name = "issue"
+  
+  def to_param
+    slug
+  end
+
+end

data/app/models/comment.rb

@@ -0,0 +1,26 @@
+class Comment < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site = Insight.configuration.fat_free_url + "/issues/:issue_id"
+  
+  include Gravtastic
+  gravtastic :user_email
+  
+  def user_name
+    if commenter_id
+      commenter.username
+    else
+      super
+    end
+  end
+  
+  def user_email
+    if commenter_id
+      commenter.email
+    else
+      super
+    end
+  end
+  
+end

data/app/models/insight_user.rb

@@ -0,0 +1,19 @@
+class InsightUser
+  
+  def initialize(multipass)
+    @multipass_attributes = self.class.multipass.decode(multipass)
+  end
+
+  def method_missing(method, *args, &block)
+    if @multipass_attributes.keys.include?(method)
+      @multipass_attributes[method]
+    else
+      super
+    end
+  end
+  
+  def self.multipass
+    @multipass ||= MultiPass.new('fatfree', 'abc')
+  end
+  
+end

data/app/models/issue.rb

@@ -0,0 +1,30 @@
+class Issue < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site           = Insight.configuration.fat_free_url
+  
+  include Gravtastic
+  gravtastic :user_email
+  
+  def to_param
+    "#{slug}-#{id}"
+  end
+  
+  def user_name
+    if contact_id
+      contact.username
+    else
+      super
+    end
+  end
+  
+  def user_email
+    if contact_id
+      contact.email
+    else
+      super
+    end
+  end
+  
+end

data/app/models/lead.rb

@@ -0,0 +1,15 @@
+class Lead < ActiveResource::Base
+  
+  headers["X-ApiKey"] = Insight.configuration.api_key
+  
+  self.site           = Insight.configuration.fat_free_url
+  
+  attr_accessor :password, :password_confirmation
+  
+  def validate
+    self.errors.add(:email, "Is required")                         if email.nil?
+    self.errors.add(:password, "Is required")                      if password.nil?
+    self.errors.add(:password_confirmation, "Must match password") if password != password_confirmation
+  end
+  
+end

data/app/views/help/categories/index.html.erb

@@ -0,0 +1,29 @@
+<h1>Public Discussions</h1>
+
+<h2>Welcome to the discussion area. You can browse public discussions or start your own discussion in a category of your choosing.</h2>
+
+<table>
+  <thead>
+    <tr>
+      <th width="790">Category</th>
+      <th width="150">Latest Post</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @categories.each do |category| -%>
+      <tr class="<%= cycle(:odd, :even) %>">
+        <td>
+          <h2><%= link_to(category.name, help_category_issues_path(category)) %></h2>
+          <%= simple_format(category.description) %>
+        </td>
+        <td>
+          <% if !category.issues.empty? -%>
+            <%= link_to(category.issues.first.updated_at.strftime("%b %d, %Y %H:%M"),
+                        help_category_issue_path(category, category.issues.first)) %> 
+            by <%= category.issues.first.user_name %>
+          <% end -%>
+        </td>
+      </tr>
+    <% end -%>
+  </tbody>
+</table>

data/app/views/help/comments/_form.html.erb

@@ -0,0 +1,25 @@
+<% form_tag(help_issue_comments_path(@issue), :class => "formtastic") do %>
+  <fieldset class="inputs">
+    <ol>
+      <% if !logged_in? -%>
+        <li class="string">
+          <%= label_tag      "comment[user_name]", "Name" %>
+          <%= text_field_tag "comment[user_name]" %>
+        </li>
+        <li class="string">
+          <%= label_tag      "comment[user_email]", "Email" %>
+          <%= text_field_tag "comment[user_email]" %>
+        </li>
+      <% end -%>
+      <li class="text">
+        <%= text_area_tag "comment[comment]" %>
+      </li>
+    </ol>
+  </fieldset>
+  
+  <%= recaptcha_tags :public_key => Insight.configuration.recaptcha_public_key %>
+  
+  <fieldset class="buttons">
+    <%= submit_tag("Post Comment") %>
+  </fieldset>
+<% end %>

data/app/views/help/issues/_form.html.erb

@@ -0,0 +1,43 @@
+<% form_tag(help_issues_path, :class => "formtastic") do %>
+  <fieldset class="inputs">
+    <ol>
+      <% if !logged_in? -%>
+        <li class="string">
+          <%= label_tag "issue[user_name]", "Name" %>
+          <%= text_field_tag "issue[user_name]" %>
+        </li>
+        <li class="string">
+          <%= label_tag "issue[user_email]", "Email" %>
+          <%= text_field_tag "issue[user_email]" %>
+        </li>
+      <% end -%>
+      <li class="select">
+        <%= label_tag "issue[category_id]", "Category" %>
+        <%= select_tag "issue[category_id]", 
+                       options_from_collection_for_select(Category.find(:all), :id, :name),
+                       :prompt => "Please select" %>
+      </li>
+      <li class="string">
+        <%= label_tag "issue[subject]", "Subject" %>
+        <%= text_field_tag "issue[subject]" %>
+      </li>
+      <li class="text">
+        <%= text_area_tag "issue[body]" %>
+      </li>
+      <% if logged_in? -%>
+        <li class="boolean">
+          <label>
+            <%= check_box_tag "issue[private]" %>
+            Mark this issue as private. Only allow support representatives to see it.
+          </label>
+        </li>
+      <% end -%>
+    </ol>
+  </fieldset>
+  
+  <%= recaptcha_tags :public_key => Insight.configuration.recaptcha_public_key %>
+  
+  <fieldset class="buttons">
+    <%= submit_tag("Post Issue") %>
+  </fieldset>
+<% end %>

data/app/views/help/issues/index.html.erb

@@ -0,0 +1,42 @@
+<h1><%= @category.name %></h1>
+<h2><%= @category.description %></h2>
+
+<%= link_to("Create New Issue", new_help_issue_path, :class => "button") %>
+
+<table>
+  <thead>
+    <tr>
+      <th width="590">Topic</th>
+      <th width="60">State</th>
+      <th width="60">Replies</th>
+      <th width="180">Latest Post</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @issues.each do |issue| %>
+      <tr class="<%= cycle(:odd, :even) %>">
+        <td>
+          <h2><%= link_to(issue.subject, help_issue_path(issue)) %></h2>
+          <p>Started by <%= issue.user_name %></p>
+        </td>
+        <td>
+          <%= issue.state %>
+        </td>
+        <td>
+          <%= issue.comments.count %>
+        </td>
+        <td>
+          <% if issue.comments.empty? %>
+            <%= link_to(posted_on_short(issue.created_at), help_issue_path(issue)) %>
+            <br />
+            <%= issue.user_name %>
+          <% else %>
+            <%= link_to(posted_on_short(issue.comments.last.updated_at), help_issue_path(issue)) %>
+            <br />
+            <%= issue.comments.last.user_name %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/help/issues/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New Issue</h1>
+
+<%= render :partial => "help/issues/form" %>

data/app/views/help/issues/show.html.erb

@@ -0,0 +1,39 @@
+<div class="issue">
+  <h2><strong>Subject</strong> : <%= @issue.subject %></h2>
+
+  <div class="author">
+    <%= image_tag(@issue.gravatar_url(:size => 30)) %>
+    <p>Posted by <cite><%= @issue.user_name %></cite> on <%= posted_on_long(@issue.updated_at) %></p>
+  </div>
+
+  <div class="body">
+    <%= simple_format(@issue.body) %>
+  </div>
+
+  <% if !@issue.comments.empty? %>
+    <h3 class="comment_count"><%= @issue.comments.count %> Comments</h3>
+
+    <ol class="comments">
+      <% @issue.comments.each_with_index do |comment, index| %>
+        <li class="<%= cycle(:odd, :even) %>">
+          <div class="<%= comment_by(comment) %>">
+            <p><strong><%= index + 1 %></strong> Posted by <cite><%= comment.user_name %></cite> on <%= posted_on_long(comment.updated_at) %></p>
+          </div>
+          <div class="gravatar">
+            <%= image_tag(comment.gravatar_url(:size => 30)) %>
+          </div>
+          <div class="said">
+            <%= simple_format(comment.comment) %>
+          </div>
+        </li>
+      <% end %>
+    </ol>
+  <% end %>
+
+  <h3 class="reply">Reply to this discussion</h3>
+  <%= render :partial => "help/comments/form" %>
+</div>
+
+<div class="issue-status">
+  <p><strong><%= @issue.state %></strong></p>
+</div>

data/app/views/help/sessions/new.html.erb

@@ -0,0 +1,20 @@
+<h1>Login</h1>
+
+<% form_tag(help_session_path, :class => "formtastic") do %>
+  <fieldset class="inputs">
+    <ol>
+      <li class="string">
+        <%= label_tag      "user[email]", "Email" %>
+        <%= text_field_tag "user[email]" %>
+      </li>
+      <li class="password">
+        <%= label_tag          "user[password]", "Password" %>
+        <%= password_field_tag "user[password]" %>
+      </li>
+    </ol>
+  </fieldset>
+  
+  <fieldset class="buttons">
+    <%= submit_tag("Login") %>
+  </fieldset>
+<% end %>

data/app/views/knowledge/article_categories/index.html.erb

@@ -0,0 +1,16 @@
+<h1>Knowledge Base</h1>
+
+<div class="articles">
+  <% @categories.each do |category| %>
+    <div class="category">
+      <h2><%= category.name %></h2>
+      <ul>
+        <% category.articles[0..5].each do |article| %>
+          <li>
+            <%= link_to(article.title, knowledge_article_path(article)) %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+</div>

data/app/views/knowledge/articles/show.html.erb

@@ -0,0 +1,3 @@
+<h1><%= @article.title %></h1>
+
+<%= simple_format(@article.body) %>