riaction 0.0.3 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Overview #
 
-riaction provides both a ruby wrapper for IActionable's restful API and an "acts-as" style interface for a Rails application's ActiveRecord models to associate them with IActionable profiles and have them drive the logging of game events.
+riaction provides both a ruby wrapper for IActionable's restful API and an "acts-as" style interface for the models in your Rails application.  This document assumes knowledge of IActionable's API.
 
 # How To Use #
 
@@ -17,7 +17,7 @@ The wrapper for IActionable's API is used internally by the rest of the gem, but
                                     :version => 3 )
     @api = IActionable::Api.new
 
-IActionable's API speaks in JSON, and here those responses are wrapped in simple objects where nesting and variable names are determined by [IActionable's documentation](http://www.http://iactionable.com/api/).  For example, here the wrapper is making a call to load a profile summary:
+IActionable's API speaks in JSON, and here those responses are wrapped in simple objects where nesting and variable names are determined by [IActionable's documentation](http://www.iactionable.com/api/).  For example, here the wrapper is making a call to load a profile summary:
 
     profile_summary = @api.get_profile_summary("user", "username", "zortnac", 10)
     profile_summary.display_name # => "Chris Eberz"
@@ -51,11 +51,11 @@ Models in your application may declare themselves as profiles that exist on IAct
     #  id                           :integer(4)
     #  nickname                     :string(255)
   
-Here, the class User declares itself as a profile of type "player", identifiable by two of IActionable's supported ID types, username and custom, the values of which are the fields (or any symbol that an instance of the class responds to) nickname and id, respectively.  When a class declares itself as an riaction profile, an after_create callback will be added to register that model on IActionable as a profile as the type, and with the identifiers, described in the class.
+Here, the class User declares itself as a profile of type "player", identifiable by two of IActionable's supported identifier types, username and custom.  The values of these identifiers are the fields nickname and id, respectively, and can be any method that an instance of the class responds to.  When a class declares itself as a riaction profile, an after_create callback will be added to create the profile on IActionable with the identifiers declared in the class.
 
 #### Profile Instance Methods ####
 
-Classes that declare themselves as IActionable profiles are given instance methods that tie in to the IActionable API, as many uses of the API take a profile as an argument.
+Classes that declare themselves as IActionable profiles are given instance methods that tie in to the IActionable API, as many uses of the API treat the profile as a top-level resource.
 
     @api.get_profile_summary("player", "username", "zortnac", 10)
     # is equivalent to the following...
@@ -71,14 +71,14 @@ Classes that declare themselves as IActionable profiles are given instance metho
 
 ### Declaring Events ###
 
-Models in your application may declare any number of events that they log through IActionable.  For each event that is declared the important elements are:
+Models in your application may declare any number of events that they wish to log through IActionable.  For each event that is declared the important elements are:
 
-1. The event's name (or key)
-2. The type of trigger that causes the event to be logged
-3. The profile under which the event is logged
-4. Any optional parameters (key-value pairs) that you want to pass
+* The event's name (or key).
+* The type of trigger that causes the event to be logged.
+* The profile under which the event is logged.
+* Any optional parameters (key-value pairs) that you want to pass.
 
-` `
+<!-- end list --> 
 
     class Comment
       belongs_to :user
@@ -99,17 +99,17 @@ Here, the name of the event is `make_a_comment`.  The trigger for the event, in
 
 _Note: If the trigger is one of :create, :update, or :destroy, then the appropriate ActiveRecord callback will log the event.  If the trigger is anything else, then an instance method is provided to log the event by hand.  For example, an argument of `:trigger => :foo` will provide an instance method `trigger_foo!`_
 
-The profile that this event will be logged under can be any object whose class declares itself as a profile.  Here, the profile is the object returned by the ActiveRecord association `:user`, and we assume is an instance of the User class from above.  Lastly, the optional params passed along with the event is the key-value pair `{:post => :post_id}`, where `:post_id` is an ActiveRecord table column.
+The profile that this event will be logged under can be any object whose class declares itself as a profile.  Here, the profile is the object returned by the ActiveRecord association `:user` (for this example we assume this is an instance of the User class from above).  Lastly, the optional params passed along with the event is the key-value pair `{:post => :post_id}`, where `:post_id` is an ActiveRecord table column.
 
 Putting this all together, whenever an instance of the Comment class is created, an event is logged for which the equivalent call to the API might look like this:
 
     @api.log_event("player", "username", "zortnac", "make_a_comment", {:post => 33})
 
-_Note: If a class both declares itself as a profile and declares one or more events, and wants to refer to itself as the profile for any of those events, use `:profile => :self`_
+_Note: If a class declares itself as a profile and also declares one or more events, but wants to refer to itself as the profile for any of those events, use `:profile => :self` in the event's declaration_
 
 ### Rails Rake Tasks ###
 
-There are 3 rakes tasks included for summarizing all of your models' declarations as well as a way to initialize profiles on IActionable.  To see a report of all the events declared across your application, run the following:
+There are 3 rake tasks included for summarizing all of your models' declarations as well as a way to initialize profiles on IActionable.  To see a report of all the events declared across your application, run the following:
 
     rake riaction:rails:list:events
 

data/lib/riaction/riaction.rb

@@ -19,10 +19,14 @@ module Riaction
     Set.new [:create, :update, :destroy]
   end
   
+  def self.retry_attempts_for_internal_error
+    3
+  end
+  
   class ProfileCreator
     @queue = :riaction_profile_creator
     
-    def self.perform(klass_name, id)
+    def self.perform(klass_name, id, attempt=0)
       if klass_name.constantize.riaction_profile?      
         iactionable_api = IActionable::Api.new
         profile_object = klass_name.constantize.find_by_id!(id)
@@ -36,13 +40,21 @@ module Riaction
     rescue IActionable::Error::BadRequest => e
       # This should only be thrown if the profile type names specified in the model don't match what's on IActionable's dashboard 
       raise e
+    rescue IActionable::Error::Internal => e
+      # upon an intenal error from IActionable, retry some set number of times by requeueing the task through Resque 
+      # after the max number of attempts, re-raise
+      if attempt < Riaction.retry_attempts_for_internal_error
+        Resque.enqueue(Riaction::ProfileCreator, klass_name, id, attempt+1)
+      else
+        raise e
+      end
     end
   end
   
   class EventPerformer
     @queue = :riaction_event_logger
     
-    def self.perform(event_name, klass_name, id)
+    def self.perform(event_name, klass_name, id, attempt=0)
       iactionable_api = IActionable::Api.new
       
       event_object = klass_name.constantize.find_by_id!(id)
@@ -66,6 +78,14 @@ module Riaction
       # Log event should never throw this as of IActionable API v3
     rescue NoMethodError => e
       raise NoEventDefined.new
+    rescue IActionable::Error::Internal => e
+      # upon an intenal error from IActionable, retry some set number of times by requeueing the task through Resque 
+      # after the max number of attempts, re-raise
+      if attempt < Riaction.retry_attempts_for_internal_error
+        Resque.enqueue(Riaction::EventPerformer, event_name, klass_name, id, attempt+1)
+      else
+        raise e
+      end
     end
   end
   

data/lib/riaction/version.rb

@@ -1,3 +1,3 @@
 module Riaction
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/riaction_spec.rb

@@ -86,6 +86,24 @@ describe Riaction do
         lambda { Riaction::EventPerformer.perform(:create_profile, "BadClass", @bad_instance.id) }.should raise_error(Riaction::NoEventDefined)
       end
     end
+    
+    describe "when the API raises an IActionable internal error" do
+      before do
+        @api.stub!(:get_profile_summary)
+        @api.stub!(:create_profile)
+        @api.stub!(:log_event).and_raise(IActionable::Error::Internal.new(nil))
+        Resque.stub!(:enqueue)
+      end
+      
+      it "should re-schedule the task some defined number of times before re-raising again on the last attempt" do
+        Resque.should_receive(:enqueue).exactly(Riaction.retry_attempts_for_internal_error).times.with(Riaction::EventPerformer, :create_profile, "MyClass", @instance.id, instance_of(Fixnum))
+        
+        (Riaction.retry_attempts_for_internal_error).times do |i|
+          lambda { Riaction::EventPerformer.perform(:create_profile, "MyClass", @bad_instance.id, i) }.should_not raise_error
+        end
+        lambda { Riaction::EventPerformer.perform(:create_profile, "MyClass", @bad_instance.id, Riaction.retry_attempts_for_internal_error) }.should raise_error(IActionable::Error::Internal)
+      end
+    end
   end
   
   describe "profile generation" do
@@ -119,6 +137,24 @@ describe Riaction do
         lambda { Riaction::ProfileCreator.perform("BadClass", @instance.id) }.should raise_error(Riaction::NoProfileDefined)
       end
     end
+    
+    describe "when the API raises an IActionable internal error" do
+      before do
+        @instance = MyClass.new
+        MyClass.stub!(:find_by_id!).and_return(@instance)
+        @api.stub!(:create_profile).and_raise(IActionable::Error::Internal.new(nil))
+        Resque.stub!(:enqueue)
+      end
+      
+      it "should re-schedule the task some defined number of times before re-raising again on the last attempt" do
+        Resque.should_receive(:enqueue).exactly(Riaction.retry_attempts_for_internal_error).times.with(Riaction::ProfileCreator, "MyClass", @instance.id, instance_of(Fixnum))
+        
+        (Riaction.retry_attempts_for_internal_error).times do |i|
+          lambda { Riaction::ProfileCreator.perform("MyClass", @instance.id, i) }.should_not raise_error
+        end
+        lambda { Riaction::ProfileCreator.perform("MyClass", @instance.id, Riaction.retry_attempts_for_internal_error) }.should raise_error(IActionable::Error::Internal)
+      end
+    end
   end
   
   describe "event triggering" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riaction
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-02 00:00:00.000000000Z
+date: 2011-11-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153398980 !ruby/object:Gem::Requirement
+  requirement: &2156451960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2153398980
+  version_requirements: *2156451960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153398280 !ruby/object:Gem::Requirement
+  requirement: &2156451540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153398280
+  version_requirements: *2156451540
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2153397820 !ruby/object:Gem::Requirement
+  requirement: &2156447860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153397820
+  version_requirements: *2156447860
 - !ruby/object:Gem::Dependency
   name: faraday-stack
-  requirement: &2153397260 !ruby/object:Gem::Requirement
+  requirement: &2156447440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153397260
+  version_requirements: *2156447440
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2153396640 !ruby/object:Gem::Requirement
+  requirement: &2156447000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153396640
+  version_requirements: *2156447000
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153386700 !ruby/object:Gem::Requirement
+  requirement: &2156446380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153386700
+  version_requirements: *2156446380
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &2153386200 !ruby/object:Gem::Requirement
+  requirement: &2156445720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153386200
+  version_requirements: *2156445720
 description: Wrapper for IActionable's restful API and an "acts-as" style interface
   for models to behave as profiles and drive game events.
 email: