riaction 1.0.0 → 1.1.0

data/lib/riaction/version.rb

@@ -1,3 +1,3 @@
 module Riaction
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/tasks/riaction.rake

@@ -7,7 +7,7 @@ namespace 'riaction' do
           require rbfile
         end
       
-        Riaction::Riaction::EVENT_LOGGING_CLASSES.each do |class_name|
+        Riaction::Riaction::EVENT_CLASSES.each do |class_name|
           klass = class_name.constantize
           puts "#{klass} defines the following events:"
           klass.riaction_events.each_pair do |name, deets|
@@ -17,6 +17,7 @@ namespace 'riaction' do
             else
               puts "    Trigger: By calling :trigger_#{deets[:trigger]}!"
             end
+            
             case deets[:profile]
             when Symbol
               if deets[:profile] == :self
@@ -27,6 +28,14 @@ namespace 'riaction' do
             when Proc
               puts "    Profile: Returned via Proc"
             end
+            
+            case deets[:profile_type]
+            when Symbol
+              puts "    Profile Type: #{deets[:profile_type]}"
+            when NilClass
+              puts "    Profile Type: uses default"
+            end
+            
             case deets[:params]
             when NilClass
               puts "    Event Params: None"
@@ -37,6 +46,7 @@ namespace 'riaction' do
             when Hash
               puts "    Event Params: #{deets[:params]}"
             end
+            
             case deets[:guard]
             when NilClass
               puts "    Guard: None"
@@ -78,20 +88,12 @@ namespace 'riaction' do
       
         Riaction::Riaction::PROFILE_CLASSES.each do |class_name|
           klass = class_name.constantize
-          begin
-            klass.all.each do |obj|
-              declaration = klass.riaction_profiles.first
-              puts "Addressing #{klass} record #{obj.id}; creating profile under type '#{declaration[0]}'"
-              obj.riaction_create_profile
-              default_keys = obj.riaction_profile_keys(declaration[0])
-              declaration[1].each_pair do |id_type, id|
-                value = obj.send(id)
-                puts "...updating profile with id type #{id_type} and value #{value}"
-                obj.riaction_update_profile(id_type)
-              end
+          if (klass.riactionary? && klass.riaction_profile? && klass.riaction_profile_types_defined > 0)
+            puts "Addressing #{class_name}: defines the profile(s) #{klass.riaction_profile_keys.keys.map(&:to_s).join(', ')}"
+            klass.select(:id).all.each do |obj|
+              puts "  Addressing record ##{obj.id};"
+              ::Riaction::ProfileCreator.perform(class_name, obj.id)
             end
-          rescue Riaction::NoProfileDefined => e
-            puts "ERROR: #{klass} does not properly define a profile; skipping"
           end
         end
       end

data/riaction.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |s|
 
   
   s.add_development_dependency "rspec", ">= 2.6"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "ruby-debug19"
   
   s.add_runtime_dependency "rake"
-  s.add_runtime_dependency "faraday"
-  s.add_runtime_dependency "faraday-stack"
   s.add_runtime_dependency "activerecord", ">= 3.0.0"
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "resque"
+  s.add_runtime_dependency "ruby-iactionable", ">= 0.0.2"
 end

data/spec/event_performer_spec.rb

@@ -0,0 +1,233 @@
+require 'spec_helper.rb'
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+ActiveRecord::Base.connection.create_table(:users) do |t|
+  t.string :name
+  t.string :email
+  t.timestamps
+end
+
+class User < ActiveRecord::Base
+  extend Riaction::Riaction::ClassMethods
+  
+  has_many :comments, :dependent => :destroy
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'comments'")
+ActiveRecord::Base.connection.create_table(:comments) do |t|
+  t.belongs_to :user
+  t.string :content
+end
+
+class Comment < ActiveRecord::Base
+  extend Riaction::Riaction::ClassMethods
+  
+  belongs_to :user
+end
+
+describe "sending an event to IActionable from the name of a riaction class and an ID to locate the instance" do
+  before do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+    
+    @api = mock("mocked IActionable API")
+    IActionable::Api.stub!(:new).and_return(@api)
+    Resque.stub(:enqueue).and_return true
+    
+    User.reset_riaction if User.riactionary?
+    Comment.reset_riaction if Comment.riactionary?
+
+    # multiple test runs are building up the callbacks
+    Comment.class_eval do
+      reset_callbacks :create
+      reset_callbacks :update
+      reset_callbacks :destroy
+    end
+  end
+
+  describe ::Riaction::EventPerformer do
+    before do
+      User.class_eval do
+        riaction :profile, :type => :player, :custom => :id
+        riaction :profile, :type => :npc, :username => :name, :custom => :id
+      end
+      @user = User.riactionless{ User.create(:name => 'zortnac') }
+    end
+    
+    describe "and where an event is defined with parameters" do
+      before do
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :npc, :params => {:foo => 'bar'}
+        end
+        
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+      end
+      
+      it "should create the event through the API wrapper with the correct parameters" do
+        @api.should_receive(:log_event).once.with(@comment.riaction_event_params[:make_a_comment][:profile][:type], 
+                                                  @comment.riaction_event_params[:make_a_comment][:profile][:id_type],
+                                                  @comment.riaction_event_params[:make_a_comment][:profile][:id],
+                                                  :make_a_comment, 
+                                                  @comment.riaction_event_params[:make_a_comment][:params])
+        ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+      end
+    end
+    
+    describe "and where an event is defined without parameters" do
+      before do
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :player
+        end
+        
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+      end
+      
+      it "should create the event through the API wrapper with no parameters" do
+        @api.should_receive(:log_event).once.with(@comment.riaction_event_params[:make_a_comment][:profile][:type], 
+                                                  @comment.riaction_event_params[:make_a_comment][:profile][:id_type],
+                                                  @comment.riaction_event_params[:make_a_comment][:profile][:id],
+                                                  :make_a_comment, 
+                                                  {})
+        ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+      end
+    end
+    
+    describe "when fetching the event params raises a" do
+      before do
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :npc, :params => {:foo => 'bar'}
+        end
+        
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+      end
+      
+      describe "RuntimeError" do
+        before do
+          @comment.stub!(:riaction_event_params).and_raise(::Riaction::RuntimeError)
+          Comment.stub!(:find_by_id!).and_return(@comment)
+        end
+        
+        it "should not try to create the event" do
+          @api.should_not_receive(:log_event)
+          begin
+            ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+          rescue Exception => e
+          end
+        end
+        
+        it "should raise a RuntimeError" do
+          lambda { ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id) }.should raise_error(::Riaction::RuntimeError)
+        end
+      end
+      
+      describe "ConfigurationError" do
+        before do
+          @comment.stub!(:riaction_event_params).and_raise(::Riaction::ConfigurationError)
+          Comment.stub!(:find_by_id!).and_return(@comment)
+        end
+        
+        it "should not try to create the event" do
+          @api.should_not_receive(:log_event)
+          begin
+            ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+          rescue Exception => e
+          end
+        end
+        
+        it "should raise a ConfigurationError" do
+          lambda { ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id) }.should raise_error(::Riaction::ConfigurationError)
+        end
+      end
+    end
+    
+    describe "when the class does not actually define any riaction events" do
+      before do
+        Comment.reset_riaction if Comment.riactionary?
+        # multiple test runs are building up the callbacks
+        Comment.class_eval do
+          reset_callbacks :create
+          reset_callbacks :update
+          reset_callbacks :destroy
+        end
+        @comment = Comment.create(:user_id => @user.id, :content => 'this is a comment')
+      end
+      
+      it "should not try to create the event" do
+        @api.should_not_receive(:log_event)
+        begin
+          ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+        rescue Exception => e
+        end
+      end
+      
+      it "should raise a ConfigurationError" do
+        lambda { ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id) }.should raise_error(::Riaction::ConfigurationError)
+      end
+    end
+    
+    describe "when the class does not actually define the event specified" do
+      before do
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :npc, :params => {:foo => 'bar'}
+        end
+        
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+      end
+      
+      it "should not try to create the event" do
+        @api.should_not_receive(:log_event)
+        begin
+          ::Riaction::EventPerformer.perform(:bogus, 'Comment', @comment.id)
+        rescue Exception => e
+        end
+      end
+      
+      it "should raise a ConfigurationError" do
+        lambda { ::Riaction::EventPerformer.perform(:bogus, 'Comment', @comment.id) }.should raise_error(::Riaction::ConfigurationError)
+      end
+    end
+    
+    describe "when the object specified is missing" do
+      before do
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :npc, :params => {:foo => 'bar'}
+        end
+        
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+        @comment.destroy
+      end
+      
+      it "should not try to create the event" do
+        @api.should_not_receive(:log_event)
+        begin
+          ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+        rescue Exception => e
+        end
+      end
+      
+      it "should not raise an error" do
+        lambda { ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id) }.should_not raise_error
+      end
+    end
+    
+    describe "when the call to IActionable, through API wrapper, fails" do
+      before do
+        @api.stub!(:log_event).and_raise(IActionable::Error::Internal.new(""))
+        Comment.class_eval do
+          riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :profile_type => :npc, :params => {:foo => 'bar'}
+        end
+        @comment = Comment.riactionless{ Comment.create(:user_id => @user.id, :content => 'this is a comment') }
+      end
+      
+      it "should re-enqueue the job with an attempt count" do
+        Resque.should_receive(:enqueue).once.with(Riaction::EventPerformer, :make_a_comment, 'Comment', @comment.id, 1)
+        ::Riaction::EventPerformer.perform(:make_a_comment, 'Comment', @comment.id)
+      end
+    end
+  end
+  
+  after do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+end

data/spec/profile_creation_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper.rb"
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+ActiveRecord::Base.connection.create_table(:users) do |t|
+  t.string :name
+  t.string :email
+  t.timestamps
+end
+
+class User < ActiveRecord::Base
+  extend Riaction::Riaction::ClassMethods
+  
+  has_many :comments, :dependent => :destroy
+end
+
+describe "automatic profile creation from riaction definitions:" do
+  before do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+    
+    @api = mock("mocked IActionable API")
+    IActionable::Api.stub!(:new).and_return(@api)
+    Resque.stub(:enqueue).and_return true
+    
+    User.reset_riaction if User.riactionary?
+  end
+
+  describe ::Riaction::ProfileCreator do
+    describe "when a class declares a single profile type with a single identifer" do
+      before do
+        User.class_eval do
+          riaction :profile, :type => :player, :custom => :id
+        end
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+      end
+      
+      it "should use the API wraper to create the profile with that identifer" do
+        @api.should_receive(:create_profile).once.with('player', 'custom', @user.id.to_s, nil)
+        ::Riaction::ProfileCreator.perform('User', @user.id)
+      end
+    end
+    
+    describe "when a class declares a single profile type with multiple identifers" do
+      before do
+        User.class_eval do
+          riaction :profile, :type => :player, :custom => :id, :username => :name
+        end
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+      end
+      
+      it "should use the API wrapper to create the profile with the first identifer given, then make additional calls to the API to add the extra identifiers" do
+        @api.should_receive(:create_profile).once.ordered.with('player', 'custom', @user.id.to_s, nil)
+        @api.should_receive(:add_profile_identifier).once.ordered.with('player', 'custom', @user.id.to_s, 'username', @user.name)
+        ::Riaction::ProfileCreator.perform('User', @user.id)
+      end
+    end
+    
+    describe "when a class declares multiple profile types, each with a different number of identifers" do
+      before do
+        User.class_eval do
+          riaction :profile, :type => :player, :custom => :id
+          riaction :profile, :type => :npc, :custom => :id, :username => :name
+        end
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+      end
+      
+      it "should use the API wrapper to create a profile for each type defined, each followed by the correct API calls for the extra identifiers" do
+        @api.should_receive(:create_profile).once.ordered.with('player', 'custom', @user.id.to_s, nil)
+        @api.should_receive(:create_profile).once.ordered.with('npc', 'custom', @user.id.to_s, nil)
+        @api.should_receive(:add_profile_identifier).once.ordered.with('npc', 'custom', @user.id.to_s, 'username', @user.name)
+        ::Riaction::ProfileCreator.perform('User', @user.id)
+      end
+    end
+    
+    describe "when a class declares an optional display name" do
+      describe "as a method" do
+        before do
+          User.class_eval do
+            riaction :profile, :type => :player, :custom => :id, :display_name => :name
+          end
+          @user = User.riactionless{ User.create(:name => 'zortnac') }
+        end
+        
+        it "should use the API wraper to create the profile with that display name" do
+          @api.should_receive(:create_profile).once.with('player', 'custom', @user.id.to_s, @user.name)
+          ::Riaction::ProfileCreator.perform('User', @user.id)
+        end
+      end
+      
+      describe "as a proc" do
+        before do
+          User.class_eval do
+            riaction :profile, :type => :player, :custom => :id, :display_name => Proc.new{|record| record.name}
+          end
+          @user = User.riactionless{ User.create(:name => 'zortnac') }
+        end
+        
+        it "should use the API wraper to create the profile with that display name" do
+          @api.should_receive(:create_profile).once.with('player', 'custom', @user.id.to_s, @user.name)
+          ::Riaction::ProfileCreator.perform('User', @user.id)
+        end
+      end
+    end
+    
+    describe "when the class does not actually define itself as a riaction profile" do
+      before do
+        @user = User.create(:name => 'zortnac')
+      end
+      
+      it "should raise a Riaction runtime error" do
+        lambda {::Riaction::ProfileCreator.perform('User', @user.id)}.should raise_error(::Riaction::RuntimeError)
+      end
+    end
+    
+    describe "when the call to IActionable, through API wrapper, fails" do
+      before do
+        @api.stub!(:create_profile).and_raise(IActionable::Error::Internal.new(""))
+        User.class_eval do
+          riaction :profile, :type => :player, :custom => :id, :username => :name
+        end
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+      end
+      
+      it "should re-enqueue the job with an attempt count" do
+        Resque.should_receive(:enqueue).once.with(Riaction::ProfileCreator, "User", @user.id, 1)
+        ::Riaction::ProfileCreator.perform('User', @user.id, 0)
+      end
+    end
+  end
+  
+  after do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+end