riaction 0.0.1

data/spec/riaction_spec.rb

@@ -0,0 +1,253 @@
+require 'spec_helper.rb'
+
+describe Riaction do
+  class RiactionTestBase
+    include ActiveSupport::Callbacks
+    include Riaction
+    define_callbacks :after_create, :after_update, :after_destroy
+    
+    def self.base_class
+      self
+    end
+    
+    def initialize
+      run_callbacks(:after_create)
+    end
+    
+    def update
+      run_callbacks(:after_update)
+    end
+    
+    def destroy
+      run_callbacks(:after_destroy)
+    end
+    
+    def id
+      42
+    end
+  end
+  
+  before do
+    @api = mock("mocked IActionable API")
+    IActionable::Api.stub!(:new).and_return(@api)
+    Resque.stub!(:enqueue)
+  end
+  
+  describe "logging events" do
+    class MyClass < RiactionTestBase
+      riaction :profile, :type => :user, :custom => :id
+      riaction :event, :name => :create_profile, :trigger => :create, :profile => :self, :params => {:foo => "bar"}
+    end
+    
+    class BadClass < RiactionTestBase
+    end
+    
+    before do
+      @instance = MyClass.new
+      MyClass.stub!(:find_by_id!).and_return(@instance)
+      @bad_instance = BadClass.new
+      BadClass.stub!(:find_by_id!).and_return(@bad_instance)
+    end
+    
+    describe "when the profile generating the event exists" do
+      before do
+        @api.stub!(:get_profile_summary).and_return(true)
+      end
+      
+      it "should send the event with parameters based on the details provided in the class" do
+        @api.should_receive(:log_event).once.with("user", "custom", @instance.id.to_s, :create_profile, {:foo => "bar"})
+        Riaction::EventPerformer.perform(:create_profile, "MyClass", @instance.id)
+      end
+    end
+    
+    describe "when the profile generating the event does not exist" do
+      before do
+        @api.stub!(:get_profile_summary).and_raise(IActionable::Error::BadRequest.new(nil))
+      end
+      
+      it "should create the profile and then send the event with parameters based on the details provided in the class" do
+        @api.should_receive(:create_profile).once.ordered.with("user", "custom", @instance.id.to_s)
+        @api.should_receive(:log_event).once.ordered.with("user", "custom", @instance.id.to_s, :create_profile, {:foo => "bar"})
+        Riaction::EventPerformer.perform(:create_profile, "MyClass", @instance.id)
+      end
+    end
+    
+    describe "when the class does not define the named event" do
+      it "should not attempt to log the event, and raise an error" do
+        @api.should_not_receive(:log_event)
+        lambda { Riaction::EventPerformer.perform(:bad_event_name, "MyClass", @instance.id) }.should raise_error(Riaction::NoEventDefined)
+      end
+    end
+    
+    describe "when the class does not define the named event or any other riaction property" do
+      it "should not attempt to log the event, and raise an error" do
+        @api.should_not_receive(:log_event)
+        lambda { Riaction::EventPerformer.perform(:create_profile, "BadClass", @bad_instance.id) }.should raise_error(Riaction::NoEventDefined)
+      end
+    end
+  end
+  
+  describe "profile generation" do
+    class MyClass < RiactionTestBase
+      riaction :profile, :type => :user, :custom => :id
+    end
+    
+    class BadClass < RiactionTestBase
+    end
+    
+    describe "with a class that defines itself as an iactionable profile" do
+      before do
+        @instance = MyClass.new
+        MyClass.stub!(:find_by_id!).and_return(@instance)
+      end
+      
+      it "should create the profile with parameters based on the details provided in the class" do
+        @api.should_receive(:create_profile).once.ordered.with("user", "custom", @instance.id.to_s)
+        Riaction::ProfileCreator.perform("MyClass", @instance.id)
+      end
+    end
+    
+    describe "with a class that does not define itself as an iactionable profile" do
+      before do
+        @instance = BadClass.new
+        BadClass.stub!(:find_by_id!).and_return(@instance)
+      end
+      
+      it "should not attempt to create the profile, and raise an error" do
+        @api.should_not_receive(:create_profile)
+        lambda { Riaction::ProfileCreator.perform("BadClass", @instance.id) }.should raise_error(Riaction::NoProfileDefined)
+      end
+    end
+  end
+  
+  describe "event triggering" do
+    class EventDrivingClass < RiactionTestBase
+      def initialize
+        super
+      end
+      
+      riaction :event, :name => :creation_event, :trigger => :create, :profile => :self
+      riaction :event, :name => :updating_event, :trigger => :update, :profile => :self
+      riaction :event, :name => :destruction_event, :trigger => :destroy, :profile => :self
+      riaction :event, :name => :custom_event, :trigger => :custom, :profile => :self
+      
+      def id
+        42
+      end
+    end
+    
+    before do
+      @event_driver_instance = EventDrivingClass.new
+    end
+    
+    describe "from an after-create callback" do
+      it "should log the event using the profile and paramters specified in the class" do
+        Resque.should_receive(:enqueue).once.with(Riaction::EventPerformer, :creation_event, "EventDrivingClass", @event_driver_instance.id)
+        EventDrivingClass.new
+      end
+    end
+    
+    describe "from an after-update callback" do
+      it "should log the event using the profile and paramters specified in the class" do
+        Resque.should_receive(:enqueue).once.with(Riaction::EventPerformer, :updating_event, "EventDrivingClass", @event_driver_instance.id)
+        @event_driver_instance.update
+      end
+    end
+    
+    describe "from an after-destroy callback" do
+      it "should log the event using the profile and paramters specified in the class" do
+        Resque.should_receive(:enqueue).once.with(Riaction::EventPerformer, :destruction_event, "EventDrivingClass", @event_driver_instance.id)
+        @event_driver_instance.destroy
+      end
+    end
+    
+    describe "from a custom trigger" do
+      it "should log the event using the profile and paramters specified in the class" do
+        Resque.should_receive(:enqueue).once.with(Riaction::EventPerformer, :custom_event, "EventDrivingClass", @event_driver_instance.id)
+        @event_driver_instance.trigger_custom!
+      end
+    end
+  end
+  
+  describe "profile" do
+    class ProfileClass < RiactionTestBase
+      def initialize
+        super
+      end
+      
+      riaction :profile, :type => :user, :custom => :id, :username => :name
+      
+      def id
+        42
+      end
+      
+      def name
+        "zortnac"
+      end
+    end
+    
+    describe "creation triggering" do
+      it "should create the profile based on the parameters given in the class, when an instance of that class is created" do
+        Resque.should_receive(:enqueue).once.with(Riaction::ProfileCreator, "ProfileClass", 42)
+        ProfileClass.new
+      end
+    end
+    
+    describe "instance methods" do
+      before do
+        @instance = ProfileClass.new
+        @mock_response = mock("mock response")
+      end
+      
+      describe "for loading a profile summary" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:get_profile_summary).once.with("user", "custom", @instance.id.to_s, 10).and_return(@mock_response)
+          @instance.riaction_profile_summary(10).should == @mock_response
+        end
+      end
+      
+      describe "for creating a profile" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.stub!(:get_profile_summary).and_return(nil)
+          @api.should_receive(:create_profile).once.with("user", "custom", @instance.id.to_s).and_return(@mock_response)
+          @instance.riaction_create_profile.should == @mock_response
+        end
+      end
+      
+      describe "for adding new identifiers to a profile" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:add_profile_identifier).once.with("user", "custom", @instance.id.to_s, "username", @instance.name).and_return(@mock_response)
+          @instance.riaction_update_profile(:username).should == @mock_response
+        end
+      end
+      
+      describe "for loading profile achievments" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:get_profile_achievements).once.with("user", "custom", @instance.id.to_s, nil).and_return(@mock_response)
+          @instance.riaction_profile_achievements.should == @mock_response
+        end
+      end
+      
+      describe "for loading profile challenges" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:get_profile_challenges).once.with("user", "custom", @instance.id.to_s, nil).and_return(@mock_response)
+          @instance.riaction_profile_challenges.should == @mock_response
+        end
+      end
+      
+      describe "for loading profile goals" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:get_profile_goals).once.with("user", "custom", @instance.id.to_s, nil).and_return(@mock_response)
+          @instance.riaction_profile_goals.should == @mock_response
+        end
+      end
+      
+      describe "for loading profile notifications" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+          @api.should_receive(:get_profile_notifications).once.with("user", "custom", @instance.id.to_s).and_return(@mock_response)
+          @instance.riaction_profile_notifications.should == @mock_response
+        end
+      end
+    end
+  end
+end

data/spec/settings_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper.rb'
+
+describe IActionable::Settings do
+  before do
+    @settings_hash = {
+      :app_key => "12345",
+      :api_key => "abcde",
+      :version => "3"
+    }
+  end
+  
+  describe "with a valid input hash" do
+    it "should initialize" do
+      lambda { IActionable::Settings.new(@settings_hash) }.should_not raise_error
+    end
+  end
+  
+  describe "with an invalid input hash" do
+    it "should not initialize from missing app key" do
+      @settings_hash.delete(:app_key)
+      lambda { IActionable::Settings.new(@settings_hash) }.should raise_error(IActionable::ConfigError)
+    end
+    
+    it "should not initialize from missing api key" do
+      @settings_hash.delete(:api_key)
+      lambda { IActionable::Settings.new(@settings_hash) }.should raise_error(IActionable::ConfigError)
+    end
+    
+    it "should not initialize from missing version" do
+      @settings_hash.delete(:version)
+      lambda { IActionable::Settings.new(@settings_hash) }.should raise_error(IActionable::ConfigError)
+    end
+  end
+  
+  describe "once initialized" do
+    before do
+      @settings = IActionable::Settings.new(@settings_hash)
+    end
+    
+    it "should return the app key" do
+      @settings.app_key.should == @settings_hash[:app_key]
+    end
+    
+    it "should return the api key" do
+      @settings.api_key.should == @settings_hash[:api_key]
+    end
+    
+    it "should return the version" do
+      @settings.version.should == @settings_hash[:version]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'riaction'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: riaction
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Eberz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156171600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2156171600
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &2156170920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156170920
+- !ruby/object:Gem::Dependency
+  name: faraday-stack
+  requirement: &2156162140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156162140
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2156160880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156160880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2156159100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156159100
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &2156158240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156158240
+description: Wrapper for IActionable's restful API and an "acts-as" style interface
+  for models to behave as profiles and drive game events.
+email:
+- ceberz@elctech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- lib/riaction.rb
+- lib/riaction/iactionable/api.rb
+- lib/riaction/iactionable/connection.rb
+- lib/riaction/iactionable/error.rb
+- lib/riaction/iactionable/objects.rb
+- lib/riaction/iactionable/objects/achievement.rb
+- lib/riaction/iactionable/objects/awardable.rb
+- lib/riaction/iactionable/objects/challenge.rb
+- lib/riaction/iactionable/objects/goal.rb
+- lib/riaction/iactionable/objects/i_actionable_object.rb
+- lib/riaction/iactionable/objects/identifier.rb
+- lib/riaction/iactionable/objects/leaderboard.rb
+- lib/riaction/iactionable/objects/leaderboard_report.rb
+- lib/riaction/iactionable/objects/level.rb
+- lib/riaction/iactionable/objects/level_type.rb
+- lib/riaction/iactionable/objects/point_type.rb
+- lib/riaction/iactionable/objects/profile_level.rb
+- lib/riaction/iactionable/objects/profile_points.rb
+- lib/riaction/iactionable/objects/profile_summary.rb
+- lib/riaction/iactionable/objects/progress.rb
+- lib/riaction/iactionable/settings.rb
+- lib/riaction/riaction.rb
+- lib/riaction/version.rb
+- lib/tasks/riaction.rake
+- riaction.gemspec
+- spec/api_spec.rb
+- spec/connection_spec.rb
+- spec/riaction_spec.rb
+- spec/settings_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- spec
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: riaction
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Wrapper for IActionable's restful API and an "acts-as" style interface for
+  models to behave as profiles and drive game events.
+test_files:
+- spec/api_spec.rb
+- spec/connection_spec.rb
+- spec/riaction_spec.rb
+- spec/settings_spec.rb
+- spec/spec_helper.rb