insight_rails 0.2.0 → 0.3.0

data/README.md

@@ -2,29 +2,25 @@
 
 Rails engine to access support requests and knowledge base articles stored in FatFree CRM. 
 
+**Please Note - Since version 0.3.0 support for Rails 2.x has been dropped.**
+
 ## Installation
 
-Firstly install the insight plugin within you FatFree CRM installation.
+Firstly install the [insight](https://github.com/kieranj/insight "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
+Then add insight_rails to your applications Gemfile.
 
     gem "insight_rails", :require => "insight"
     
-Otherwise add to your environment.rb
-
-    gem.config "insight_rails", :lib => "insight"
-  
-Make sure your development/production database exists and that you have a user model, then run the generator:
+Make sure your development/production database exists and that you have a user and account models, then run the generator:
   
-    script/generate insight
+    rails g insight:install
     
 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.
+A rake file is included to 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
 
@@ -48,7 +44,7 @@ This will pull through the issue_categories you setup in FatFree.
 
 ## Style
 
-The app had a default stylesheet included. This is formatted using Sass so ensure your app has Sass installed.
+The app had a default layout and stylesheet included. This is formatted using Sass and is copied to your applications app/assets/stylesheets folder.
     
 ## Copyright
 

data/Rakefile

@@ -1,4 +1,4 @@
-require 'jeweler'
+require "jeweler"
 
 Jeweler::Tasks.new do |gem|
   gem.name        = "insight_rails"
@@ -7,7 +7,8 @@ Jeweler::Tasks.new do |gem|
   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.files       = FileList["[A-Z]*", "{app,config,lib,rails}/**/*"]
+  gem.add_dependency "rails", ">= 3.1.0.rc4"
   gem.add_dependency "recaptcha"
   gem.add_dependency "gravtastic"
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/app/models/article.rb

@@ -3,6 +3,7 @@ class Article < ActiveResource::Base
   headers["X-ApiKey"] = Insight.configuration.api_key
   
   self.site           = Insight.configuration.fat_free_url
+  self.format         = :xml
   
   def to_param
     slug

data/app/models/article_category.rb

@@ -3,6 +3,7 @@ class ArticleCategory < ActiveResource::Base
   headers["X-ApiKey"] = Insight.configuration.api_key
   
   self.site           = Insight.configuration.fat_free_url
+  self.format         = :xml
   
   def to_param
     slug

data/app/models/category.rb

@@ -3,6 +3,7 @@ class Category < ActiveResource::Base
   headers["X-ApiKey"] = Insight.configuration.api_key
   
   self.site           = Insight.configuration.fat_free_url
+  self.format         = :xml
   
   def to_param
     slug

data/app/models/category_issue.rb

@@ -2,6 +2,7 @@ class CategoryIssue < ActiveResource::Base
   
   self.site         = Insight.configuration.fat_free_url + "/categories/:category_id"
   self.element_name = "issue"
+  self.format       = :xml
   
   def to_param
     slug

data/app/models/comment.rb

@@ -2,8 +2,9 @@ class Comment < ActiveResource::Base
   
   headers["X-ApiKey"] = Insight.configuration.api_key
   
-  self.site = Insight.configuration.fat_free_url + "/issues/:issue_id"
-  
+  self.site           = Insight.configuration.fat_free_url + "/issues/:issue_id"
+  self.format         = :xml
+
   include Gravtastic
   gravtastic :user_email
   

data/app/models/issue.rb

@@ -3,6 +3,7 @@ class Issue < ActiveResource::Base
   headers["X-ApiKey"] = Insight.configuration.api_key
   
   self.site           = Insight.configuration.fat_free_url
+  self.format         = :xml
   
   include Gravtastic
   gravtastic :user_email
@@ -12,15 +13,17 @@ class Issue < ActiveResource::Base
   end
   
   def contact
-    if contact_id
-      super
-    else
-      nil
+    @contact ||= begin
+      if !contact_id.nil?
+        super
+      else
+        nil
+      end
     end
   end
   
   def user_name
-    if contact_id
+    if contact_id.present?
       contact.username
     else
       super
@@ -28,7 +31,7 @@ class Issue < ActiveResource::Base
   end
   
   def user_email
-    if contact_id
+    if contact_id.present?
       contact.email
     else
       super

data/app/models/lead.rb

@@ -3,7 +3,7 @@ class Lead < ActiveResource::Base
   headers["X-ApiKey"] = Insight.configuration.api_key
   
   self.site           = Insight.configuration.fat_free_url
-  
+  self.format         = :xml
   attr_accessor :password, :password_confirmation
   
   def validate

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

@@ -19,8 +19,8 @@
         <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.contact.nil? ? category.issues.first.user_name : category.issues.first.contact.username %>
+                        help_category_issue_path(category, "#{category.issues.first.slug}-#{category.issues.first.id}")) %> 
+            by <%= category.issues.first.contact_id.nil? ? category.issues.first.user_name : category.issues.first.contact.username %>
           <% end -%>
         </td>
       </tr>

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

@@ -1,4 +1,4 @@
-<% form_tag(help_issue_comments_path(@issue), :class => "formtastic") do %>
+<%= form_tag(help_issue_comments_path(@issue), :class => "formtastic") do %>
   <fieldset class="inputs">
     <ol>
       <% if !logged_in? -%>

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

@@ -1,4 +1,4 @@
-<% form_tag(help_issues_path, :class => "formtastic") do %>
+<%= form_tag(help_issues_path, :class => "formtastic") do %>
   <fieldset class="inputs">
     <ol>
       <% if !logged_in? -%>

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

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

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

@@ -8,7 +8,7 @@
         <ul>
           <% category.articles[0..5].each do |article| %>
             <li>
-              <%= link_to(article.title, knowledge_article_path(article)) %>
+              <%= link_to(article.title, knowledge_article_path(article.slug)) %>
             </li>
           <% end %>
         </ul>

data/config/routes.rb

@@ -1,31 +1,25 @@
-ActionController::Routing::Routes.draw do |map|
+Rails.application.routes.draw do
   
-  map.knowledge "/knowledge",
-    :controller => "knowledge/article_categories",
-    :action     => "index"
-    
-  map.namespace :knowledge do |kb|
-    kb.resources :categories, :controller => "article_categories"
-    kb.resources :articles,   :only       => [ :index, :show ]
-  end
-    
-  map.help "/help",
-    :controller => "help",
-    :action     => "index"
-    
-  map.namespace :help do |help|
-    help.browse "/browse",
-      :controller => "categories",
-      :action     => "index"
+  match "/knowledge" => "knowledge/article_categories#index", :as => "knowledge"
+  
+  namespace :knowledge do
+    resources :categories, :controller => "article_categories"
+    resources :articles,   :only       => [ :index, :show ]
+  end  
+  
+  match "/help"  => "help#index", :as => "help"
+  
+  namespace :help do |help|
+
+    match "/browse" => "categories#index", :as => "browse"
   
-    help.resources :categories do |category|
-      category.resources :issues
+    resources :categories do
+      resources :issues
     end
   
-    help.resources :issues, 
-      :collection => { :my => :get },
-      :except     => [ :destroy ] do |issue|
-      issue.resources :comments, :except => [ :destroy ]
+    resources :issues, :except => [ :destroy ] do
+      get :my, :on => :collection
+      resources :comments, :except => [ :destroy ]
     end
   end
   

data/lib/generators/insight/install/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generates the necessary config file, migration and a simple layout with stylesheet.
+
+Example:
+    rails generate insight:install
+
+    This will create:
+        config/initializers/insight.rb
+        app/views/layouts/insight.html.erb
+        app/views/layouts/_insight_footer.html.erb
+        app/assets/stylesheets/insight.sass.css

data/lib/generators/insight/install/install_generator.rb

@@ -0,0 +1,38 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Insight
+    
+    class InstallGenerator < Rails::Generators::Base
+    
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), "templates")
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def install
+        copy_file "insight.rb",               "config/initializers/insight.rb"
+        copy_file "insight.html.erb",         "app/views/layouts/insight_layout.rb"
+        copy_file "_insight_footer.html.erb", "app/views/layouts/_insight_footer.html.erb"    
+        copy_file "insight.sass",             "app/assets/stylesheets/insight.css.sass"
+  
+        migration_template "migrations/link_users_to_crm_contacts.rb", "db/migrate/link_users_to_crm_contacts.rb"
+  
+        inject_into_class "app/models/user.rb",    User,    "  include Insight::CRM::Callbacks::User\n"
+        inject_into_class "app/models/account.rb", Account, "  include Insight::CRM::Callbacks::Account\n"
+  
+        readme "README"
+      end
+    
+    end
+    
+end

data/lib/insight/crm/callbacks/account.rb

@@ -9,7 +9,6 @@ module Insight
         def self.included(base)
           base.class_eval do
             after_create :create_crm_account
-            # after_update :update_crm_account
           end
         
           protected
@@ -21,12 +20,6 @@ module Insight
               account.save
               self.update_attribute(:crm_id, account.id)
             end
-          
-            # def update_crm_account
-            #   account      = CRM::Models::Account.find(crm_id)
-            #   account.name = name
-            #   account.save
-            # end
                     
         end
       

data/lib/insight/crm/callbacks/user.rb

@@ -9,7 +9,6 @@ module Insight
         def self.included(base)
           base.class_eval do
             after_create :create_crm_contact
-            # after_update :update_crm_contact, :unless => :recording_last_activity?
           end
         
           protected
@@ -22,12 +21,6 @@ module Insight
               self.update_attribute(:crm_id, contact.id)
             end
           
-            # def update_crm_contact
-            #   contact            = CRM::Models::Contact.find(crm_id)
-            #   contact.attributes = crm_attributes
-            #   contact.save
-            # end
-          
             def crm_attributes
               a = {}
               a[:title]      = title      if respond_to?(:title)
@@ -39,11 +32,7 @@ module Insight
               a[:username]   = username   if respond_to?(:username)
               a
             end
-            
-            # def recording_last_activity?
-            #   respond_to?(:last_activity) && last_activity_changed?
-            # end
-          
+                      
         end
       
       end

data/lib/insight/engine.rb

@@ -0,0 +1,16 @@
+require "insight"
+require "rails"
+
+module Insight
+  
+  class Engine < ::Rails::Engine
+    
+    engine_name :insight
+    
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "railties", "tasks.rake")
+    end
+    
+  end
+  
+end

data/lib/insight.rb

@@ -1,3 +1,5 @@
+require "insight/engine" if defined?(Rails)
+
 require "recaptcha/rails"
 require "insight/configuration"
 require "gravtastic"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: insight_rails
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kieran Johnson
@@ -15,25 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +03:00
+date: 2011-07-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: recaptcha
+  name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 977940597
         segments: 
+        - 3
+        - 1
         - 0
-        version: "0"
+        - rc4
+        version: 3.1.0.rc4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: gravtastic
+  name: recaptcha
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,6 +49,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gravtastic
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Customer Support and Knowledge Base
 email: support@invisiblelines.com
 executables: []
@@ -88,21 +105,22 @@ files:
 - app/views/layouts/_insight_footer.html.erb
 - app/views/layouts/insight_layout.html.erb
 - config/routes.rb
-- generators/insight/insight_generator.rb
-- generators/insight/lib/insert_commands.rb
-- generators/insight/templates/README
-- generators/insight/templates/_insight_footer.html.erb
-- generators/insight/templates/insight.html.erb
-- generators/insight/templates/insight.rake
-- generators/insight/templates/insight.rb
-- generators/insight/templates/insight.sass
-- generators/insight/templates/migrations/link_users_to_crm_contacts.rb
+- lib/generators/insight/install/USAGE
+- lib/generators/insight/install/install_generator.rb
+- lib/generators/insight/install/templates/README
+- lib/generators/insight/install/templates/_insight_footer.html.erb
+- lib/generators/insight/install/templates/insight.html.erb
+- lib/generators/insight/install/templates/insight.rb
+- lib/generators/insight/install/templates/insight.sass
+- lib/generators/insight/install/templates/migrations/link_users_to_crm_contacts.rb
 - lib/insight.rb
 - lib/insight/configuration.rb
 - lib/insight/crm/callbacks/account.rb
 - lib/insight/crm/callbacks/user.rb
 - lib/insight/crm/models/account.rb
 - lib/insight/crm/models/contact.rb
+- lib/insight/engine.rb
+- lib/insight/railties/tasks.rake
 has_rdoc: true
 homepage: http://github.com/kieranj/insight
 licenses: []

data/generators/insight/insight_generator.rb

@@ -1,29 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
-
-class InsightGenerator < Rails::Generator::Base
-  
-  def manifest
-    record do |m|
-      m.directory          File.join("config", "initializers")
-      m.file               "insight.rb", "config/initializers/insight.rb"
-      
-      m.migration_template "migrations/link_users_to_crm_contacts.rb",
-                           "db/migrate",
-                           :migration_file_name => "link_users_to_crm_contacts"
-                           
-      m.file               "insight.html.erb", "app/views/layouts/insight.html.erb"
-      m.file               "_insight_footer.html.erb", "app/views/layouts/_insight_footer.html.erb"
-                           
-      m.insert_into        "app/models/user.rb",    "include Insight::CRM::Callbacks::User"
-      m.insert_into        "app/models/account.rb", "include Insight::CRM::Callbacks::Account"
-      
-      m.file               "insight.rake", "lib/tasks/insight.rake"
-      
-      m.directory          File.join("public", "stylesheets", "sass")
-      m.file               "insight.sass", "public/stylesheets/sass/insight.sass"
-      
-      m.readme             "README"
-    end
-  end
-  
-end

data/generators/insight/lib/insert_commands.rb

@@ -1,33 +0,0 @@
-# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
-
-Rails::Generator::Commands::Base.class_eval do
-  def file_contains?(relative_destination, line)
-    File.read(destination_path(relative_destination)).include?(line)
-  end
-end
-
-Rails::Generator::Commands::Create.class_eval do
-  def insert_into(file, line)
-    logger.insert "#{line} into #{file}"
-    unless options[:pretend] || file_contains?(file, line)
-      gsub_file file, /^(class|module|.*Routes).*$/ do |match|
-        "#{match}\n  #{line}"
-      end
-    end
-  end
-end
-
-Rails::Generator::Commands::Destroy.class_eval do
-  def insert_into(file, line)
-    logger.remove "#{line} from #{file}"
-    unless options[:pretend]
-      gsub_file file, "\n  #{line}", ''
-    end
-  end
-end
-
-Rails::Generator::Commands::List.class_eval do
-  def insert_into(file, line)
-    logger.insert "#{line} into #{file}"
-  end
-end