insight_rails 0.1.4 → 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kieran Johnson
+ 
+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

@@ -4,27 +4,35 @@ Rails engine to access support requests and knowledge base articles stored in Fa
 
 ## Installation
 
-Add insight to your applications dependencies. Currently the generators only support Rails 2.
+Firstly install the insight plugin within you FatFree CRM installation.
+
+Then add insight to your applications dependencies. Currently the generators only support Rails 2.
     
 For those using bundler
 
     gem "insight_rails", :require => "insight"
     
-Other wise add to your environment.rb
+Otherwise add to your environment.rb
 
     gem.config "insight_rails", :lib => "insight"
   
-Make sure your development database exists and that you have user and account models, then run the generator:
+Make sure your development/production database exists and that you have a user model, then run the generator:
   
     script/generate insight
     
-Now run the migration to add the crm_id field to your users table. 
+Now run the generated migration to add the crm_id field to your users table. 
+
+An initializer is added, and in this file you need to update the details of your product api_key (from FatFree), FatFree's api url and your recaptcha keys.
+
+Finally a rake file is added to lib/tasks. This will help migrate an existing users you have in your application to contacts within FatFree. Depending on the fields your user model has you may need to edit this to suit.
+
+To run the rake task
 
-Then update the insight initializer with details of your api_key, fatfree's url and your recaptcha keys.
+    rake insight:generate_crm_contacts
 
 ## Usage
 
-You will now have a knowledge base of articles from your fat free installation available at:
+You will now have a knowledge base of articles from your FatFree installation available at:
 
 /knowledge
 
@@ -36,7 +44,7 @@ Discussions can be viewed at:
 
 /help/browse
 
-This will pull through the issue_categories you setup in Fat Free.
+This will pull through the issue_categories you setup in FatFree.
 
 ## Style
 

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/app/controllers/help_controller.rb

@@ -7,4 +7,4 @@ class HelpController < InsightController
   def index
   end
   
-end
+end

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

@@ -0,0 +1,35 @@
+<div class="yui-gc">
+	<div class="yui-u first">
+	
+	<h1>Welcome to the <%= Insight.configuration.product_name %> support area</h1>
+
+	<h2>This is where we handle all support for <%= Insight.configuration.product_name %>.</h2>
+
+	<p>You can search our knowledge base or public discussions for answers to your questions. Alternatively
+	you can create a new issue and we'll help you as soon as we can.</p>
+
+	<p>Please take the time to create an account it will help you better track and follow your issues.</p>
+
+	<p>From the helpdesk you can raise public issues (everyone can see and reply to them) or private issues
+	which are viewable only by our support staff.</p> 
+
+	</div>
+
+	<div class="yui-u support-staff">
+	<h3>Support Staff</h3>
+	<p>The following support representatives are available to discuss your requests.</p>
+  </div>
+</div>
+
+<div class="yui-gb big-menu">
+	<div class="yui-u first">
+		<p><a href="/help/issues/new">Start a discussion</a></p>
+	</div>
+	<div class="yui-u">
+		<p><a href="/knowledge/">Knowledge base</a></p>
+	</div>
+	<div class="yui-u">
+		<p><a href="/help/browse/">Browse discussions</a></p>
+	</div>
+</div>
+

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

@@ -35,9 +35,9 @@
     </ol>
   </fieldset>
   
-  <%= recaptcha_tags :public_key => Insight.configuration.recaptcha_public_key %>
+  <%= recaptcha_tags :display => { :theme => 'clean' }, :public_key => Insight.configuration.recaptcha_public_key %>
   
   <fieldset class="buttons">
-    <%= submit_tag("Post Issue") %>
+    <%= submit_tag("Post Issue / Topic") %>
   </fieldset>
-<% end %>
+<% end %>

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

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

data/app/views/layouts/insight_layout.html.erb

@@ -21,11 +21,11 @@
             </li>
             <% if logged_in? %>
               <li>
-                <%= link_to("Logout", help_logout_path) %>
+                <%= link_to("Logout", logout_path) %>
               </li>
             <% else %>
               <li>
-                <%= link_to("Login", help_login_path) %>
+                <%= link_to("Login", login_path) %>
               </li>
             <% end %>
           </ul>

data/config/routes.rb

@@ -8,7 +8,7 @@ ActionController::Routing::Routes.draw do |map|
     kb.resources :categories, :controller => "article_categories"
     kb.resources :articles,   :only       => [ :index, :show ]
   end
-  
+    
   map.help "/help",
     :controller => "help",
     :action     => "index"
@@ -17,16 +17,6 @@ ActionController::Routing::Routes.draw do |map|
     help.browse "/browse",
       :controller => "categories",
       :action     => "index"
-      
-    help.login "/login",
-      :controller => "sessions",
-      :action     => "new"
-      
-    help.logout "/logout",
-      :controller => "sessions",
-      :action     => "destroy"
-      
-    help.resource :sessions
   
     help.resources :categories do |category|
       category.resources :issues

data/generators/insight/templates/insight.rake

@@ -1,7 +1,7 @@
 namespace :insight do
   
-  desc "Generate CRM Accounts"
-  task :generate_crm_accounts => :environment do
+  desc "Generate CRM Contacts"
+  task :generate_crm_contacts => :environment do
     Account.find_each do |account|
       name = (account.respond_to?(:name) ? account.name + " " + account.id.to_s : account.site_name + " " + account.id.to_s)
       crm_account = Insight::CRM::Models::Account.new(:name => name)

data/lib/insight/configuration.rb

@@ -2,12 +2,13 @@ module Insight
   
   class Configuration
     
-    attr_accessor :fat_free_url, :api_key, :layout, :recaptcha_public_key, :recaptcha_private_key
+    attr_accessor :fat_free_url, :api_key, :layout, :recaptcha_public_key, :recaptcha_private_key, :product_name
     
     def initialize
       @fat_free_url          = "http://localhost"
       @api_key               = nil
       @layout                = "support_layout"
+      @product_name          = "PRODUCT_NAME"
       @recaptcha_public_key  = nil
       @recaptcha_private_key = nil
     end
@@ -25,4 +26,4 @@ module Insight
     
   end
   
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: insight_rails
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kieran Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +00:00
+date: 2011-02-17 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,15 +53,16 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.md
 files: 
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
 - app/controllers/help/categories_controller.rb
 - app/controllers/help/comments_controller.rb
 - app/controllers/help/issues_controller.rb
-- app/controllers/help/sessions_controller.rb
 - app/controllers/help_controller.rb
 - app/controllers/insight_controller.rb
 - app/controllers/knowledge/article_categories_controller.rb
@@ -82,7 +83,6 @@ files:
 - app/views/help/issues/index.html.erb
 - app/views/help/issues/new.html.erb
 - app/views/help/issues/show.html.erb
-- app/views/help/sessions/new.html.erb
 - app/views/knowledge/article_categories/index.html.erb
 - app/views/knowledge/articles/show.html.erb
 - app/views/layouts/_insight_footer.html.erb

data/app/controllers/help/sessions_controller.rb

@@ -1,18 +0,0 @@
-class Help::SessionsController < ApplicationController
-  
-  layout Insight.configuration.layout
-  
-  skip_before_filter :login_required
-      
-  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/views/help/sessions/new.html.erb

@@ -1,20 +0,0 @@
-<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 %>