ifd_tools 0.1.3 → 0.1.4

data/README.md

@@ -25,4 +25,5 @@ To install:
 1. There are several configuration options for color choices in the `ifd_tools.rb` initializer.
 2. To track specific events, create subclasses of `IfdTools::Tracking::Event` in your application, in `app/models/ifd_tools/tracking` folder.
 3. Be sure to override the `assign_trackable_item_by_id` method per subclass (default implement is to raise an exception)
-4. Tracking requests can be initiated via the API at `/api/track.xml?type=product_event&id=14`. The `type` parameter is the class name without the module prefixes, underscored -> "IfdTools::Tracking::ProductEvent" should be sent as "product_event".
+4. Tracking requests can be initiated via the API at `/api/track.xml?type=product_event&id=14`. The `type` parameter is the class name without the module prefixes, underscored -> "IfdTools::Tracking::ProductEvent" should be sent as "product_event".
+5. Also have "batch tracking" functionality available, which will accept JSON or XML in a request to process multiple entries.  Each "event" is id, type and optionally timestamp (UNIX) or platform.

data/app/views/api/batch_track.builder

@@ -0,0 +1,8 @@
+xml.instruct!
+xml.response do
+  if @error.present?
+    xml.error { xml.cdata! @error }
+  else
+    xml.track @events.count
+  end
+end

data/app/views/api/create_customer.builder

@@ -0,0 +1,18 @@
+xml.instruct!
+xml.response do
+  xml.error { "validations failed" }
+  xml.failures do
+    @failures.each do |attribute, messages|
+      xml.attribute(key: attribute) do
+        messages.each do |error|
+          xml.message { xml.cdata! error }
+        end
+      end
+    end
+  end
+  xml.validations do
+    @customer.errors.full_messages.uniq.each do |message|
+      xml.message { xml.cdata! message }
+    end
+  end
+end

data/lib/generators/ifd_tools/install/templates/controllers/api_controller.rb

@@ -4,5 +4,30 @@ class ApiController < ApplicationController
   respond_to :json, :xml
   
   include IfdTools::ApiControllerExtensions
+  
+  # Use this block to initialize the given Customer instance
+  # The return value of this block will be assigned back to the 
+  # @customer ivar, which is used to generate the HTTP response (validations failed, etc)
+  #
+  # The request must be to "/api/create_customer" and the params namespaced under "params[:customer]"
+  # If you have special params that will throw exception if passed to Customer.new(params[:customer]), for example params[:customer][:account_level]
+  # then you should move that special attribute outside of the :customer hash & process it separately
+  #
+  create_customer do |customer|
+    
+    # Notes on parameter
+    #
+    # "customer" is initially set to this before it is passed into this block
+    # "customer" is also available as @customer
+    # customer = Customer.new params[:customer]
+    
+    # Example request
+    # To make use of some parameter that's not directly an attribute, for example :account_level
+    # Just make sure that :account_level is outside of the params[:customer] hash
+    #
+    # customer.account_level = CustomerAccountLevel.find_by_abbreviation(params[:account_level]) 
+    
+    customer
+  end
 
 end

data/lib/ifd_tools/api_controller/customers.rb

@@ -0,0 +1,44 @@
+module IfdTools
+  module ApiController
+    module Customers
+      
+      extend ActiveSupport::Concern
+              
+      def create_customer
+        if params[:customer]
+          @customer = Customer.new params[:customer]
+          @customer = instance_exec @customer, &self.class.create_customer_block
+          if @customer.valid?
+            @customer.save
+            respond_to do |format|
+              format.json { render json: { success: "Registered" }, status: :ok }
+              format.xml { render xml: { success: "Registered" }, status: :ok }
+            end
+          else
+            respond_to do |format|
+              @failures = @customer.errors.keys.inject({}) { |failures, key| failures[key] = @customer.errors[key].uniq; failures }
+              format.json { render json: { error: "validations failed", validations: @customer.errors.full_messages.uniq, failures: @failures }, status: :unprocessable_entity }
+              format.xml { render status: :unprocessable_entity }
+            end
+          end
+        else
+          respond_to do |format|
+            format.json { render json: { error: "Missing parameters" }, status: :unprocessable_entity }
+            format.xml { render xml: { error: "Missing parameters" }, status: :unprocessable_entity }
+          end
+        end
+      end
+      
+      included do
+        cattr_accessor :create_customer_block
+      end
+      
+      module ClassMethods
+        def create_customer(&block)
+          self.create_customer_block = block
+        end
+      end
+      
+    end
+  end
+end

data/lib/ifd_tools/api_controller/tracking.rb

@@ -38,6 +38,49 @@ module IfdTools
           render status: :unprocessable_entity
         end
       end
+      
+      # Used to record events from the application, more than one at a time, by submitting a request via JSON or XML
+      # 
+      # Example request stucture:
+      #   events
+      #     event
+      #       type product_event
+      #       id 14
+      #       timestamp 1233452 (optional)
+      #       platform mac (optional)
+      #
+      def batch_track
+        
+        begin
+        
+          @events = params[:events] || []
+          @events.map(&:symbolize_keys!)
+          @events.each do |event|
+          
+            case event[:type]
+            when "application_event"
+              @event = IfdTools::Tracking::ApplicationEvent.new
+
+            else
+              @event = "ifd_tools/tracking/#{event[:type]}".camelize.constantize.new
+              @event.assign_trackable_item_by_id(event[:id])
+              
+            end
+            
+            @event.ip_address = request.remote_ip
+            @event.customer = current_customer
+            @event.platform = event[:platform] || IfdTools::Tracking::Event.platform_for_request(request)
+            @event.timestamp = Time.at(event[:timestamp]) || Time.now
+            @event.save!
+            
+          end
+          
+        rescue Exception => e
+          @error = e.message
+          render status: :unprocessable_entity
+        end
+                    
+      end
 
     end
   end

data/lib/ifd_tools/api_controller_extensions.rb

@@ -1,6 +1,7 @@
 require 'ifd_tools/api_controller/emergency_messages'
 require 'ifd_tools/api_controller/software_updates'
 require 'ifd_tools/api_controller/notifier_updates'
+require 'ifd_tools/api_controller/customers'
 require 'ifd_tools/api_controller/contact_requests'
 require 'ifd_tools/api_controller/tracking'
 
@@ -14,6 +15,7 @@ module IfdTools
       include IfdTools::ApiController::NotifierUpdates
       include IfdTools::ApiController::Tracking
       include IfdTools::ApiController::ContactRequests
+      include IfdTools::ApiController::Customers
     end
     
   end

data/lib/ifd_tools/version.rb

@@ -1,3 +1,3 @@
 module IfdTools
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ifd_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2012-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -298,7 +298,9 @@ files:
 - app/views/admin/shared/_footer.html.haml
 - app/views/admin/software_updates/_form.html.haml
 - app/views/admin/users/_form.html.haml
+- app/views/api/batch_track.builder
 - app/views/api/contact.builder
+- app/views/api/create_customer.builder
 - app/views/api/emergency_messages.builder
 - app/views/api/notifier_updates.builder
 - app/views/api/software_updates.builder
@@ -344,6 +346,7 @@ files:
 - lib/ifd_tools/active_admin/base.rb
 - lib/ifd_tools/active_admin/can_can/action_items.rb
 - lib/ifd_tools/api_controller/contact_requests.rb
+- lib/ifd_tools/api_controller/customers.rb
 - lib/ifd_tools/api_controller/emergency_messages.rb
 - lib/ifd_tools/api_controller/notifier_updates.rb
 - lib/ifd_tools/api_controller/software_updates.rb