ifd_tools 0.1.4 → 0.1.5

data/README.md

@@ -26,4 +26,23 @@ To install:
 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".
-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.
+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.
+
+## Customer Creation
+
+A special helper method is provided on the `ApiController` class to facilitate easy Customer creation.  There is plenty of inline documentation on usage there, but here's an example:
+
+	class ApiController < ApplicationController
+
+	  before_filter :authenticate_customer!, :except => [:software_updates, :emergency_messages, :notifier_updates]
+	  respond_to :json, :xml
+
+	  include IfdTools::ApiControllerExtensions
+
+	  create_customer do |customer|
+		  # customer = Customer.new(params[:customer]) already passed in to us, just handle special use cases for data transformations
+		  customer.account_level = CustomerAccountLevel.find_by_abbreviation(params[:account_level])
+		  customer
+	  end
+
+	end

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

@@ -1,6 +1,6 @@
 class ApiController < ApplicationController
 
-  before_filter :authenticate_customer!, :except => [:software_updates, :emergency_messages, :notifier_updates]
+  before_filter :authenticate_customer!, :except => [:create_customer, :software_updates, :emergency_messages, :notifier_updates]
   respond_to :json, :xml
   
   include IfdTools::ApiControllerExtensions

data/lib/ifd_tools/version.rb

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

data/lib/ifd_tools.rb

@@ -10,6 +10,7 @@ require 'stringex'
 require 'daemons'
 require 'haml'
 require 'swfobject-rails'
+require 'active_admin_relationship_filters'
 
 require "ifd_tools/engine"
 require 'ifd_tools/date_time_additions'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ifd_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -235,6 +235,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_admin_relationship_filters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement