Version bump 0.2.0

* New Top & Application Menus
* Move quickbooks stats into QBO settings page
* Fixed New vehicle for customer link
* Added issue linking from hashtag numbers in QBO invoice line items
* Cleaned up customer & vehicle lists
* Implemented delete calls from web hook
* Added webhook token verification
* More...

README.md

@@ -20,6 +20,8 @@ The goal of this project is to allow redmine to connect with Quickbooks Online t
 
 * Sign up to become a developer for Intuit https://developer.intuit.com/
 * Create your own aplication to obtain your API keys
+* Set up webhook service to https://redmine.yourdomain.com/qbo/webhook
+  - See https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/webhooks
 
 ##The Install
 
@@ -47,9 +49,7 @@ The goal of this project is to allow redmine to connect with Quickbooks Online t
   
   ![Alt plugin_issue-edit](/Screenshots/plugin_issue_edit.png)
 
-Note: Customers, Employees, and Service Items with automaticly update during normal usage of redmine i.e. a page refresh. You can also manualy force redmine to sync its database with QBO clicking the sync link in the Quickbooks top menu page 
+Note: After the inital synchronization, this plugin will recieve push notifications via Intuit's webhook service.
-
-  ![Alt plugin_top_menu](/Screenshots/plugin_top_menu.png)
 
 ## TODO
   * Abiltiy to add line items to a ticket in a dynamic table so they can be added to the invoice upon closing of the issue

app/controllers/customers_controller.rb

@@ -16,9 +16,16 @@ class CustomersController < ApplicationController
   
   before_filter :require_user
   
+  default_search_scope :names
+  
   # display a list of all customers
   def index
-    @customers = Customer.paginate(:page => params[:page])
+    if params[:search]
+      @customers = Customer.search(params[:search]).paginate(:page => params[:page])
+      if only_one_non_zero?(@customers)
+        redirect_to @customers.first
+      end
+    end
   end
   
   def new
@@ -82,4 +89,17 @@ class CustomersController < ApplicationController
     end
   end
   
+  private
+  
+  def only_one_non_zero?( array )
+    found_non_zero = false
+    array.each do |val|
+      if val!=0
+        return false if found_non_zero
+        found_non_zero = true
+      end
+    end
+    found_non_zero
+  end
+
 end

app/controllers/qbo_controller.rb

@@ -11,6 +11,8 @@
 class QboController < ApplicationController
   unloadable
   
+  require 'openssl'
+  
   include AuthHelper
   
   before_filter :require_user, :except => :qbo_webhook
@@ -34,7 +36,6 @@ class QboController < ApplicationController
   def authenticate
     callback = qbo_oauth_callback_url
     token = Qbo.get_oauth_consumer.get_request_token(:oauth_callback => callback)
-    #session[:qb_request_token] = token
     session[:qb_request_token] = Marshal.dump(token)
     redirect_to("https://appcenter.intuit.com/Connect/Begin?oauth_token=#{token.token}") and return
   end
@@ -43,8 +44,6 @@ class QboController < ApplicationController
   # Called by QBO after authentication has been processed
   #
   def oauth_callback
-    #at = session[:qb_request_token].get_access_token(:oauth_verifier => params[:oauth_verifier])
-    # If Rails >= 4.1 you need to do this =>  
     at = Marshal.load(session[:qb_request_token]).get_access_token(:oauth_verifier => params[:oauth_verifier])
     
     #There can only be one...
@@ -62,42 +61,57 @@ class QboController < ApplicationController
     else
       redirect_to plugin_settings_path(:redmine_qbo), :flash => { :error => "Error" }
     end
-
   end
   
   # Quickbooks Webhook Callback
   def qbo_webhook
     
-    if request.headers['Content-Type'] == 'application/json'
+    # check the payload
-      data = JSON.parse(request.body.read)
+    signature = request.headers['intuit-signature']
+    key = Setting.plugin_redmine_qbo['settingsWebhookToken']
+    data = request.body.read
+    hash = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha256'), key, data)).strip()
+    
+    # proceed if the request is good
+    if hash.eql? signature
+      if request.headers['content-type'] == 'application/json'
+        data = JSON.parse(data)
       else
         # application/x-www-form-urlencoded
         data = params.as_json
       end
-    
+      # Process the information
       entities = data['eventNotifications'][0]['dataChangeEvent']['entities']
-    
       entities.each do |entity|
-      if entity['name'].eql? "Customer"
+        id = entity['id'].to_i
-        Customer.sync_by_id(entity['id'].to_i)
+        name = entity['name']
-      end
         
-      if entity['name'].eql? "Invoice"
+        # TODO rename all other models!
-        QboInvoice.sync_by_id(entity['id'].to_i)
+        name.prepend("Qbo") if not name.eql? "Customer"
-      end
         
-      if entity['name'].eql? "Estimate"
+        # Magicly initialize the correct class
-        QboEstimate.sync_by_id(entity['id'].to_i)
+        obj = name.constantize
-      end
         
-      if entity['name'].eql? "Employee"
+        # for merge events
-        QboEmployee.sync_by_id(entity['id'].to_i)
+        obj.destroy(entity['deletedId']) if entity['deletedId']
+        
+        #Check to see if we are deleting a record
+        if entity['operation'].eql? "Delete"
+            obj.destroy(id)
+        #if not then update!
+        else
+          obj.sync_by_id(id)
         end
       end
       
-    # The webhook doesn't require a response but let's make sure
+      # Record that last time we updated
-    # we don't send anything
+      Qbo.update_time_stamp
+      
+      # The webhook doesn't require a response but let's make sure we don't send anything
       render :nothing => true
+    else
+      render nothing: true, status: 400
+    end
   end
 
   #
@@ -110,7 +124,6 @@ class QboController < ApplicationController
       QboEmployee.sync
       QboEstimate.sync
       QboInvoice.sync
-      #QboPurchase.sync
       
       # Record the last sync time
       Qbo.update_time_stamp

app/controllers/vehicles_controller.rb

@@ -18,13 +18,29 @@ class VehiclesController < ApplicationController
   
   # display a list of all vehicles
   def index
-    @vehicles = Vehicle.paginate(:page => params[:page])
+    if params[:customer_id]
+      begin
+        @vehicles = Customer.find_by_id(params[:customer_id]).vehicles.paginate(:page => params[:page])
+      rescue ActiveRecord::RecordNotFound
+        render_404
+      end
+    end
+    
+    if params[:search]
+      @vehicles = Vehicle.search(params[:search]).paginate(:page => params[:page])
+      if only_one_non_zero?(@vehicles)
+        redirect_to @vehicles.first
+      end
+    end
   end
 
   # return an HTML form for creating a new vehicle
   def new
     @vehicle = Vehicle.new
     @customers = Customer.all.order(:name)
+    if params[:customer]
+      @customer = Customer.find_by_id(params[:customer])
+    end
   end
 
   # create a new vehicle
@@ -87,4 +103,26 @@ class VehiclesController < ApplicationController
     end
   end
   
+  # returns a dynamic list of vehicles owned by a customer
+  def update_vehicles
+    @vehicles = Customer.find_by_id(params[:customer_id].to_i).vehicles
+    respond_to do |format|
+      format.html { render(:text => "not implemented") }
+      format.js
+    end
+  end
+  
+  private
+  
+  def only_one_non_zero?( array )
+    found_non_zero = false
+    array.each do |val|
+      if val!=0
+        return false if found_non_zero
+        found_non_zero = true
+      end
+    end
+    found_non_zero
+  end
+
 end

app/models/customer.rb

@@ -140,6 +140,11 @@ class Customer < ActiveRecord::Base
     end
   end
   
+  # Searchs the database for a customer by name
+  def self.search(search)
+    where("name LIKE ?", "%#{search}%").order(:name)
+  end
+  
   # proforms a bruteforce sync operation
   # This needs to be simplified
   def self.sync_by_id(id) 

app/models/qbo.rb

@@ -51,4 +51,8 @@ class Qbo < ActiveRecord::Base
     qbo.last_sync = DateTime.now
     qbo.save
   end
+  
+  def self.last_sync
+    format_time(Qbo.first.last_sync)
+  end
 end

app/models/qbo_employee.rb

@@ -34,7 +34,6 @@ class QboEmployee < ActiveRecord::Base
 
   def self.sync_by_id(id)
     employee = get_base.service.fetch_by_id(id)
-    
     qbo_employee = find_or_create_by(id: employee.id)
     qbo_employee.name = employee.display_name
     qbo_employee.id = employee.id

app/models/qbo_invoice.rb

@@ -46,11 +46,23 @@ class QboInvoice < ActiveRecord::Base
   end
   
   def self.sync_by_id(id)
+    #update the information in the database
     invoice = get_base.service.fetch_by_id(id) 
     qbo_invoice = find_or_create_by(id: invoice.id) 
     qbo_invoice.doc_number = invoice.doc_number 
     qbo_invoice.id = invoice.id
     qbo_invoice.save! 
+    
+    # Scan the line items for hashtags and attach to the applicable issues
+    invoice.line_items.each { |line|
+      if line.description
+        line.description.scan(/#(\w+)/).flatten.each { |issue|
+          i = Issue.find_by_id(issue.to_i)
+          i.qbo_invoice = QboInvoice.find_by_id(invoice.id.to_i)
+          i.save!
+        }
+      end
+    }
   end
   
   def self.update(id)

app/models/vehicle.rb

@@ -21,7 +21,7 @@ class Vehicle < ActiveRecord::Base
   
   validates_presence_of :customer
   validates :vin, uniqueness: true
-  validates :year, numericality: { only_integer: true }
+  #validates :year, numericality: { only_integer: true }
   
   before_save :decode_vin
   after_initialize :get_details
@@ -75,6 +75,11 @@ class Vehicle < ActiveRecord::Base
     write_attribute(:vin, val.to_s.upcase)
   end
   
+  # search for a vin
+  def self.search(search)
+    where("vin LIKE ?", "%#{search}%")
+  end
+  
   private
   
   # init method to pull JSON details from Edmunds
@@ -121,4 +126,5 @@ class Vehicle < ActiveRecord::Base
     v = self.vin[0,11]
     return v.slice(0,8) + v.slice(9,11)
   end
+  
 end

app/views/customers/_details.html.erb

@@ -31,7 +31,6 @@
     </tr>
     
     <tr>
-      <td/>
       <td>
         <%= button_to "Edit Customer", edit_customer_path(customer), method: :get%> 
       </td>

app/views/customers/index.html.erb

@@ -1,19 +1,30 @@
 <h1>Customers</h1> 
+<br/> 
+<%= form_tag(customers_path, :method => "get", id: "search-form") do %>
+<%= text_field_tag :search, params[:search], placeholder: "Search Customers" %>
+<%= submit_tag "Search" %>
+<%= button_to "New Customer", new_customer_path, method: :get %>       
+<% end %>
+<br/>
+<% if @customers.present? %>
+  
 <br/>
 <% @customers.each do |c| %>
   <div class="row">
     <div class="span6 columns">
-      <fieldset>
+      <%= link_to c, customer_path(c.id) %>
-        <%= c.name %>
-        <%= button_to "Show", customer_path(c.id), method: :get %>
-      </fieldset>
     </div>
   </div>
 <% end %>
 
-<br/>
-
 <div class="actions">
   <%= will_paginate @customers %>
-  <%= button_to "New", new_customer_path, method: :get %>       
+</div>
+
+<% else %>
+  <p>There are no customers containing the term(s) <%= params[:search] %>.</p>
+<% end %>
+
+<div>
+  <b>Last Sync: </b> <%= Qbo.last_sync %>
 </div>

app/views/customers/show.html.erb

@@ -1,7 +1,12 @@
-<h1>Customer Detail</h1> 
+<h1>Customer #<%= @customer.id %></h1> 
 <br/> 
+<h2>Details:</h2>
 <%= render :partial => 'customers/details', locals: {customer: @customer} %>
 <br/>
+<h2>Vehicles:</h2>
 <%= render :partial => 'vehicles/list' %>
+<%= button_to "New Vehicle", new_customer_vehicle_path(@customer), method: :get %>
 <br/>
+<br/>
+<h2>Issues:</h2>
 <%= render :partial => 'issues/list_simple', locals: {issues: @issues} %>

app/views/qbo/_settings.html.erb

@@ -47,6 +47,15 @@ intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_au
       </td>
     </tr>
     
+    <tr>
+      <th>Intuit QBO Webhook Token</th>
+      <td>
+        <input type="text" style="width:350px" id="settingsWebhookToken"
+                           value="<%= settings['settingsWebhookToken'] %>"
+                           name="settings[settingsWebhookToken]" >
+      </td>
+    </tr>
+
      <tr>
        <th>Token Expires At</th>
        <td><%= if Qbo.exists? then Qbo.first.token_expires_at end %>
@@ -63,6 +72,36 @@ intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_au
 <br/>
 Note: You need to authenticate after saving your key and secret above
 <br/>
+<br/>
 
 <!-- this will display a button that the user clicks to start the flow -->
 <ipp:connectToIntuit></ipp:connectToIntuit>
+
+<br/>
+<br/>
+
+<div>
+    <b>Customer Count:</b> <%= Customer.count%>
+    </div>
+      
+    <div>
+        <b>Item Count:</b> <%= QboItem.count %>
+    </div>
+      
+    <div>
+        <b>Employee Count:</b> <%= QboEmployee.count %>
+    </div>
+    
+    <div>
+        <b>Invoice Count:</b> <%= QboInvoice.count %>
+    </div>
+    
+    <div>
+        <b>Estimate Count:</b> <%= QboEstimate.count %>
+    </div>
+      
+    <br/>
+    
+    <div>
+        <b>Last Sync: </b> <%= Qbo.last_sync %> <%= link_to " Sync Now", qbo_sync_path %>
+</div>

app/views/qbo/index.html.erb

@@ -12,44 +12,31 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 <body>
     <h1> Redmine Quickbooks</h1>
-    <%= form_for @qbo do |f|%>   
+    
     <div>
-        <%= f.label "Customer Count:"+@customer_count.to_s%>
+        <b>Customer Count:</b> <%= @customer_count.to_s%>
-        <br/>
+    </div>
-        <%= f.select :customer_id, Customer.all.pluck(:name, :id).sort, :selected => @selected_customer, include_blank: true %>
+      
+    <div>
+        <b>Item Count:</b> <%= @qbo_item_count.to_s %>
+    </div>
+      
+    <div>
+        <b>Employee Count:</b> <%= @qbo_employee_count.to_s %>
+    </div>
+    
+    <div>
+        <b>Invoice Count:</b> <%= @qbo_invoice_count.to_s %>
+    </div>
+    
+    <div>
+        <b>Estimate Count:</b> <%= @qbo_estimate_count.to_s %>
     </div>
       
     <br/>
     
     <div>
-        <%= f.label "Item Count: "+@qbo_item_count.to_s %>
+        <b>Last Sync: </b> <%= Qbo.last_sync %>
-        <br/>
-        <%= f.select :qbo_item_id, QboItem.all.pluck(:name, :id).sort.reverse, :selected => @selected_item, include_blank: true %>
     </div>
     
-      <br/>
-      
-      <div>
-        <%= f.label "Employee Count: "+@qbo_employee_count.to_s %>
-        <br/>
-        <%= f.select :qbo_employee_id, QboEmployee.all.pluck(:name, :id).sort, :selected => @selected_employee, include_blank: true %>
-      </div>
-    
-    
-      <p>
-        <%= f.label "Invoice Count: "+@qbo_invoice_count.to_s %>
-        <br/>
-        <%=f.select :qbo_invoice_id, QboInvoice.all.pluck(:doc_number, :id).sort! {|x, y| y <=> x}, :selected => @selected_invoice, include_blank: true%>
-      </p> 
-      <p>
-        <%= f.label "Estimate Count: "+@qbo_estimate_count.to_s %>
-        <br/>
-        <%=f.select :qbo_estimate_id, QboEstimate.all.pluck(:doc_number, :id).sort! {|x, y| y <=> x}, :selected => @selected_estimate, include_blank: true%>
-       </p>
-    
-      
-    <% end %>    
-    <br/>
-    <br/>
-    <%= link_to "Sync", qbo_sync_path %>
 </body>

app/views/vehicles/_details.html.erb

@@ -3,7 +3,7 @@
   
     <tr>
       <th>Customer</th>
-      <td><%= vehicle.customer.name %></td>
+      <td><%= link_to vehicle.customer.name, customer_path(vehicle.customer) %></td>
     </tr>
   
     <tr>

app/views/vehicles/_form.html.erb

@@ -6,7 +6,7 @@
         <div class="clearfix">
           Customer: 
           <div class="input">
-            <%= f.collection_select :customer_id, @customers, :id, :name, include_blank: true, :selected => @customer, :required => true%>
+            <%= f.collection_select :customer_id, @customers, :id, :name, include_blank: true, :selected => params[:customer_id], :required => true%>
             </div>
         </div>
         

app/views/vehicles/_list.html.erb

@@ -1,20 +1,26 @@
+<% if @vehicles.present? %>
+
   <% @vehicles.each do |vehicle| %>
     <div class="row">
-    <div class="span6 columns">
+      <div>
-      <fieldset>
+        <b><%= link_to "##{vehicle.id}", vehicle_path(vehicle) %> </b>
+      </div>
+      
+      <div>
         <%= vehicle.to_s %>
         <br/>
-        <div style="float: right;" >
+        <%= vehicle.customer %>
-          <%= button_to "More", vehicle_path(vehicle), method: :get %>
-        </div>
-      </fieldset>
-    </div>
-  </div>
-<% end %>
-
         <br/>
+        <%= vehicle.vin %>
+      </div>
+    </div>
+    <br/>
+  <% end %>
 
   <div class="actions">
     <%= will_paginate @vehicles %>
-  <%= button_to "New Vehicle", new_vehicle_path, method: :get %>       
   </div>
+
+<% else %>
+  <p>There are no vehicles containing the term(s) <%= params[:search] %>.</p>
+<% end %>

app/views/vehicles/_vehicle.html.erb

@@ -0,0 +1 @@
+<option value="<%= vehicle.id %>"><%= vehicle.to_s.titleize %></option>

app/views/vehicles/index.html.erb

@@ -1,3 +1,10 @@
 <h1>Customer Vehicles</h1> 
 <br/> 
+
+<%= form_tag(vehicles_path, :method => "get", id: "search-form") do %>
+<%= text_field_tag :search, params[:search], placeholder: "Search Vehicles by VIN" %>
+<%= submit_tag "Search" %>
+<%= button_to "New Vehicle", new_vehicle_path, method: :get %>
+<% end %>
+
 <%= render :partial => 'vehicles/list' %>

app/views/vehicles/show.html.erb

@@ -1,4 +1,4 @@
-<h1>Customer Vehicle</h1> 
+<h1>Vehicle #<%=@vehicle.id%> </h1> 
 <br/> 
 
 <div style="text-align: left; width:90%;">

app/views/vehicles/update_vehicles.js.erb

@@ -0,0 +1 @@
+$("#issue_vehicles_id").empty().append("<%= escape_javascript(render(:partial => @vehicles)) %>")

assets/javascripts/vehicles.js

@@ -0,0 +1,16 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/
+
+$ ->
+  $(document).on 'change', '#issue_customer_id', (evt) ->
+    $.ajax 'update_vehicles',
+      type: 'GET'
+      dataType: 'script'
+      data: {
+        customer_id: $("#issue_customer_id option:selected").val()
+      }
+      error: (jqXHR, textStatus, errorThrown) ->
+        console.log("AJAX Error: #{textStatus}")
+      success: (data, textStatus, jqXHR) ->
+console.log("Dynamic vehicle select OK!")

config/routes.rb

@@ -20,5 +20,11 @@ get 'qbo/invoice/:id', :to => 'invoice#show', as: :invoice
 
 post 'qbo/webhook', :to => 'qbo#qbo_webhook'
 
+#ajax
+get "update_vehicles" => 'vehicles#update_vehicles', as: 'update_vehicles'
+
+resources :customers do
+  resources :vehicles
+end
+
 resources :vehicles
-resources :customers

init.rb

@@ -25,7 +25,7 @@ Redmine::Plugin.register :redmine_qbo do
     name 'Redmine Quickbooks Online plugin'
     author 'Rick Barrette'
     description 'This is a plugin for Redmine to intergrate with Quickbooks Online to allow for seamless intergration CRM and invoicing of completed issues'
-    version '0.0.7'
+    version '0.2.0'
     url 'https://github.com/rickbarrette/redmine_qbo'
     author_url 'http://rickbarrette.org'
     settings :default => {'empty' => true}, :partial => 'qbo/settings'
@@ -46,7 +46,12 @@ Redmine::Plugin.register :redmine_qbo do
     WillPaginate.per_page = 10
 
     # Register QBO top menu item
-    menu :top_menu, :qbo, { :controller => :qbo, :action => :index }, :caption => 'Quickbooks', :if => Proc.new { User.current.admin? }
+    #menu :top_menu, :qbo, { :controller => :qbo, :action => :index }, :caption => 'Quickbooks', :if => Proc.new { User.current.admin? }
-    menu :top_menu, :vehicles, { :controller => :vehicles, :action => :index }, :caption => 'Vehicles', :if => Proc.new { User.current.logged? }
     menu :top_menu, :customers, { :controller => :customers, :action => :index }, :caption => 'Customers', :if => Proc.new { User.current.logged? }
+    menu :top_menu, :vehicles, { :controller => :vehicles, :action => :index }, :caption => 'Vehicles', :if => Proc.new { User.current.logged? }
+    
+    menu :application_menu, :new_customer, { :controller => :customers, :action => :new }, :caption => 'New Customer', :if => Proc.new { User.current.logged? }
+    
+    permission :customers, { :customers => [:index, :new] }, :public => false
+    menu :project_menu, :customers, { :controller => 'customers', :action => 'new' }, :caption => 'New Customer', :after => :activity, :param => :project_id
 end

lib/issues_form_hook_listener.rb

@@ -10,6 +10,11 @@
 
 class IssuesFormHookListener < Redmine::Hook::ViewListener
   
+  # Load the javascript
+  def view_layouts_base_html_head(context = {})
+    javascript_include_tag 'vehicles', :plugin => 'redmine_qbo'
+  end
+  
   # Edit Issue Form
   # Show a dropdown for quickbooks contacts
   def view_issues_form_details_bottom(context={})

lib/issues_show_hook_listener.rb

@@ -50,6 +50,8 @@ class IssuesShowHookListener < Redmine::Hook::ViewListener
       #do nothing
     end
     
+    split_vin = vin.scan(/.{1,9}/) if vin
+    
     return "
     <div class=\"attributes\">
     
@@ -82,7 +84,7 @@ class IssuesShowHookListener < Redmine::Hook::ViewListener
         
       <div class=\"vehicle_vin attribute\">
         <div class=\"label\"><span>VIN</span>:</div>
-        <div class=\"value\">#{vin.gsub(/(.{9})/, '\1 ') if vin}</div>
+        <div class=\"value\">#{split_vin[0] if split_vin}<b>#{split_vin[1] if split_vin}</b></div>
       </div>
       
       <div class=\"vehicle_notes attribute\">