riaction 0.0.1

data/lib/riaction/version.rb

@@ -0,0 +1,3 @@
+module Riaction
+  VERSION = "0.0.1"
+end

data/lib/tasks/riaction.rake

@@ -0,0 +1,101 @@
+namespace 'iactionable' do
+  namespace 'list' do
+    desc "List all registered events"
+    task :events => :environment do
+      Dir.glob(File.join(RAILS_ROOT,"app","models","*.rb")).each do |rbfile|
+        require rbfile
+      end
+      
+      Riaction::EVENT_LOGGING_CLASSES.each do |klass|
+        puts "#{klass} defines the following events:"
+        klass.riaction_events.each_pair do |name, deets|
+          puts " :#{name}:"
+          if Riaction.crud_actions.include? deets[:trigger]
+            puts "    Trigger: Fired on ActiveRecord after_#{deets[:trigger]} callback"
+          else
+            puts "    Trigger: By calling :trigger_#{deets[:trigger]}!"
+          end
+          case deets[:profile]
+          when Symbol
+            if deets[:profile] == :self
+              puts "    Profile: (self)"
+            else
+              puts "    Profile: Value returned by :#{deets[:profile]}"
+            end
+          when Proc
+            puts "    Profile: Returned via Proc"
+          end
+          case deets[:params]
+          when NilClass
+            puts "    Event Params: None"
+          when Symbol
+            puts "    Event Params: Hash returned by :#{deets[:params]}"
+          when Proc
+            puts "    Event Params: Hash returned via Proc"
+          when Hash
+            puts "    Event Params: #{deets[:params]}"
+          end
+          case deets[:guard]
+          when NilClass
+            puts "    Guard: None"
+          when Proc
+            puts "    Guard: Boolean returned via Proc"
+          when Hash
+            puts "    Guard: Boolean returned by :#{deets[:guard]}"
+          end
+          puts ""
+        end
+        puts "-------------------------------------------------------"
+      end
+    end
+
+    desc "List all registered profiles"
+    task :profiles => :environment do
+      Dir.glob(File.join(RAILS_ROOT,"app","models","*.rb")).each do |rbfile|
+        require rbfile
+      end
+      
+      Riaction::PROFILE_CLASSES.each do |klass|
+        puts "#{klass} defines the following profile types:"
+        klass.riaction_profiles.each_pair do |type, ids|
+          puts " :#{type}:"
+          puts "    With the following ID types, and field used for the value:"
+          ids.each_pair do |id_type, id|
+            puts "      :#{id_type} => :#{id}"
+          end
+          puts ""
+        end
+        puts "-------------------------------------------------------"
+      end
+    end
+  end
+  
+  namespace 'process' do
+    desc "Run through all classes acting as profiles and make sure each record/instance exists on IActionable"
+    task :profiles => :environment do
+      Dir.glob(File.join(RAILS_ROOT,"app","models","*.rb")).each do |rbfile|
+        require rbfile
+      end
+      
+      Riaction::PROFILE_CLASSES.each do |klass|
+        begin
+          klass.all.each do |obj|
+            puts "Addressing #{klass} record #{obj.id}..."
+            klass.riaction_profiles.each_pair do |type, ids|
+              puts "...creating profile under type '#{type}'"
+              obj.riaction_create_profile(type)
+              default_keys = obj.riaction_profile_keys(type)
+              ids.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(type, default_keys[:profile_type], id_type)
+              end
+            end
+          end
+        rescue IAction::Error::NoProfileDefined => e
+          puts "ERROR: #{klass} does not properly define a profile; skipping"
+        end
+      end
+    end
+  end
+end

data/riaction.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "riaction/version"
+
+Gem::Specification.new do |s|
+  s.name        = "riaction"
+  s.version     = Riaction::VERSION
+  s.authors     = ["Chris Eberz"]
+  s.email       = ["ceberz@elctech.com"]
+  s.homepage    = ""
+  s.summary     = %q{Wrapper for IActionable's restful API and an "acts-as" style interface for models to behave as profiles and drive game events.}
+  s.description = %q{Wrapper for IActionable's restful API and an "acts-as" style interface for models to behave as profiles and drive game events.}
+
+  s.rubyforge_project = "riaction"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "spec"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  
+  s.add_development_dependency "rspec", "~> 2.6"
+  
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "faraday-stack"
+  s.add_runtime_dependency "activesupport", "~> 2.0"
+  s.add_runtime_dependency "activerecord"
+  s.add_runtime_dependency "resque"
+end

data/spec/api_spec.rb

@@ -0,0 +1,288 @@
+require 'spec_helper.rb'
+
+describe IActionable::Api do
+  before do
+    @mock_settings = mock("mock settings")
+    @mock_connection = mock("connection")
+    @mock_response = mock("mock response")
+    @mock_response_item = mock("mock response item")
+    
+    IActionable::Connection.stub!(:new).and_return(@mock_connection)
+    IActionable::Settings.stub!(:new).and_return(@mock_settings)
+    
+    @mock_response.stub!(:map).and_yield(@mock_response_item).and_return(@mock_response)
+    @mock_response.stub!(:[]).and_return(@mock_response)
+    
+    IActionable::Api.init_settings(nil)
+    
+    @api = IActionable::Api.new
+    @profile_type = "user"
+    @id_type = "custom"
+    @id = 42
+  end
+  
+  describe "initialization" do
+    it "should initialize the connection with the previously initialized settings" do
+      IActionable::Settings.should_receive(:new).once.with({:foo => "bar"})
+      IActionable::Connection.should_receive(:new).once.with(@mock_settings)
+      IActionable::Api.init_settings({:foo => "bar"})
+      IActionable::Api.new
+    end
+    
+    describe "without having been pre-initialized with settings" do
+      before do
+        IActionable::Api.class_variable_set(:@@settings, nil)
+      end
+      
+      it "should raise a config error" do
+        lambda { IActionable::Api.new }.should raise_error(IActionable::ConfigError)
+      end
+    end
+  end
+  
+  describe "event creation" do
+    before do
+      @event_key = "some_event"
+      @mock_event_attrs = mock("mock event attrs")
+    end
+    
+    it "should make the correct IActionable API all" do
+      @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+      @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+      @mock_connection.should_receive(:with_api_key).and_return(@mock_connection)
+      @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/events/#{@event_key}").and_return(@mock_connection)
+      @mock_connection.should_receive(:with_params).with(@mock_event_attrs).and_return(@mock_connection)
+      @mock_connection.should_receive(:post).and_return(@mock_response)
+      @api.log_event(@profile_type, @id_type, @id, @event_key, @mock_event_attrs).should == @mock_response
+    end
+  end
+  
+  describe "profile" do
+    before do
+      @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+      @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+    end
+    
+    describe "fetching" do
+      before do
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}").and_return(@mock_connection)
+        @mock_connection.should_receive(:get).and_return(@mock_response)
+        IActionable::Objects::ProfileSummary.stub!(:new)
+      end
+      
+      describe "with achivement count" do
+        before do
+          @achievement_count = 10
+        end
+        
+        it "should be the correct IActionable API call" do
+          @mock_connection.should_receive(:with_params).with({:achievement_count => @achievement_count}).and_return(@mock_connection)
+          @api.get_profile_summary(@profile_type, @id_type, @id, @achievement_count)
+        end
+      end
+      
+      describe "without achievement count" do
+        it "should be the correct IActionable API call" do
+          @mock_connection.should_not_receive(:with_params)
+          @api.get_profile_summary(@profile_type, @id_type, @id, nil)
+        end
+      end
+      
+      it "should return the response as a ProfileSummary object" do
+        IActionable::Objects::ProfileSummary.should_receive(:new).once.with(@mock_response)
+        @api.get_profile_summary(@profile_type, @id_type, @id, nil)
+      end
+    end
+    
+    describe "creation" do
+      before do
+        @mock_connection.should_receive(:with_api_key).and_return(@mock_connection)
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}").and_return(@mock_connection)
+        @mock_connection.should_receive(:post).and_return(@mock_response)
+      end
+      
+      describe "with optional display name" do
+        before do
+          @display_name = "zortnac"
+        end
+        
+        it "should be the correct IActionable API call" do
+          @mock_connection.should_receive(:with_params).with({:display_name => @display_name}).and_return(@mock_connection)
+          @api.create_profile(@profile_type, @id_type, @id, @display_name).should == @mock_response
+        end
+      end
+      
+      describe "without optional display name" do
+        it "should be the correct IActionable API call" do
+          @mock_connection.should_not_receive(:with_params)
+          @api.create_profile(@profile_type, @id_type, @id, nil).should == @mock_response
+        end
+      end
+    end
+    
+    describe "updating" do
+      it "should make the correct IActionable API all" do
+        new_type = "email"
+        new_id = 2
+        @mock_connection.should_receive(:with_api_key).and_return(@mock_connection)
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/identifiers/#{new_type}/#{new_id}").and_return(@mock_connection)
+        @mock_connection.should_receive(:post).and_return(@mock_response)
+        @api.add_profile_identifier(@profile_type, @id_type, @id, new_type, new_id).should == @mock_response
+      end
+    end
+  end
+  
+  describe "profile points" do
+    before do
+      @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+      @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+      @point_type = "experience_points"
+      IActionable::Objects::ProfilePoints.stub!(:new).and_return(@mock_response)
+    end
+    
+    describe "fetching" do
+      it "should make the correct IActionable API all" do
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/points/#{@point_type}").and_return(@mock_connection)
+        @mock_connection.should_receive(:get).and_return(@mock_response)
+        @api.get_profile_points(@profile_type, @id_type, @id, @point_type)
+      end
+      
+      it "should return the response as a ProfileSummary object" do
+        @mock_connection.stub!(:to).and_return(@mock_connection)
+        @mock_connection.stub!(:get).and_return(@mock_response)
+        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
+        @api.get_profile_points(@profile_type, @id_type, @id, @point_type).should == @mock_response
+      end
+    end
+    
+    describe "updating" do
+      before do
+        @amount = 100
+        @mock_connection.should_receive(:with_api_key).and_return(@mock_connection)
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/points/#{@point_type}").and_return(@mock_connection)
+        @mock_connection.should_receive(:with_params).with(hash_including(:value => @amount)).and_return(@mock_connection)
+        @mock_connection.should_receive(:post).and_return(@mock_response)
+      end
+      
+      describe "with optional reason" do
+        it "should make the correct IActionable API all" do
+          reason = "some reason"
+          @mock_connection.should_receive(:with_params).with(hash_including(:description => reason)).and_return(@mock_connection)
+          @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, reason)
+        end
+      end
+      
+      describe "without optional reason" do
+        it "should make the correct IActionable API all" do
+          reason = "some reason"
+          @mock_connection.should_not_receive(:with_params).with(hash_including(:description => reason))
+          @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, nil)
+        end
+      end
+      
+      it "should return the response as a ProfileSummary object" do
+        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
+        @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, nil).should == @mock_response
+      end
+    end
+  end
+  
+  [ [:achievements, IActionable::Objects::Achievement],
+    [:challenges, IActionable::Objects::Challenge],
+    [:goals, IActionable::Objects::Goal]].each do |type|
+    describe "loading all #{type} for a profile" do
+      before do 
+        type[1].stub!(:new)
+        @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+        @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+        @mock_connection.should_receive(:get).and_return(@mock_response)
+      end
+      
+      describe "filtered by available" do
+        it "should make the correct IActionable API all" do
+          @mock_connection.should_receive(:to).once.with("/#{@profile_type}/#{@id_type}/#{@id}/#{type[0]}/Available").and_return(@mock_connection)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :available)
+        end
+        
+        it "should return as the proper object type" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          type[1].should_receive(:new).once.with(@mock_response_item)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :available).should == @mock_response
+        end
+      end
+      
+      describe "filtered by complete" do
+        it "should make the correct IActionable API all" do
+          @mock_connection.should_receive(:to).once.with("/#{@profile_type}/#{@id_type}/#{@id}/#{type[0]}/Completed").and_return(@mock_connection)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :completed)
+        end
+        
+        it "should return as the proper object type" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          type[1].should_receive(:new).once.with(@mock_response_item)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :completed).should == @mock_response
+        end
+      end
+      
+      describe "unfiltered" do
+        it "should make the correct IActionable API all" do
+          @mock_connection.should_receive(:to).once.with("/#{@profile_type}/#{@id_type}/#{@id}/#{type[0]}").and_return(@mock_connection)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil)
+        end
+        
+        it "should return as the proper object type, in a hash with both filter types" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          type[1].should_receive(:new).twice.with(@mock_response_item)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil).should == {:available => @mock_response, :completed => @mock_response}
+        end
+      end
+    end
+  end
+  
+  describe "leaderboards" do
+    before do
+      @point_type = "experience_points"
+      @leaderboard = "top_players"
+      @page_number = 3 
+      @page_count = 9
+      @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+      @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+      IActionable::Objects::LeaderboardReport.stub!(:new).and_return(@mock_response)
+    end
+    
+    describe "fetching" do
+      it "should make the correct IActionable API all" do
+        @mock_connection.should_receive(:to).with("/#{@profile_type}/leaderboards/points/#{@point_type}/#{@leaderboard}").and_return(@mock_connection)
+        @mock_connection.should_receive(:with_params).with(hash_including(:pageNumber => @page_number)).and_return(@mock_connection)
+        @mock_connection.should_receive(:with_params).with(hash_including(:pageCount => @page_count)).and_return(@mock_connection)
+        @mock_connection.should_receive(:with_params).with(hash_including(:id => @id)).and_return(@mock_connection)
+        @mock_connection.should_receive(:with_params).with(hash_including(:idType => @id_type)).and_return(@mock_connection)
+        @mock_connection.should_receive(:get).and_return(@mock_response)
+        @api.get_leaderboard(@profile_type, @point_type, @leaderboard, @page_number, @page_count, @id, @id_type)
+      end
+      
+      it "should return the response as a LeaderboardReport object" do
+        @mock_connection.stub!(:to).and_return(@mock_connection)
+        @mock_connection.stub!(:with_params).and_return(@mock_connection)
+        @mock_connection.stub!(:get).and_return(@mock_response)
+        IActionable::Objects::LeaderboardReport.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
+        @api.get_leaderboard(@profile_type, @point_type, @leaderboard, nil, nil, nil, nil).should == @mock_response
+      end
+    end
+  end
+  
+  describe "notifications" do
+    it "should make the correct IActionable API all" do
+      IActionable::Objects::Achievement.stub!(:new)
+      IActionable::Objects::Challenge.stub!(:new)
+      IActionable::Objects::Goal.stub!(:new)
+      IActionable::Objects::Level.stub!(:new)
+      IActionable::Objects::ProfilePoints.stub!(:new)
+      @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+      @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+      @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/notifications").and_return(@mock_connection)
+      @mock_connection.should_receive(:get).and_return(@mock_response)
+      @api.get_profile_notifications(@profile_type, @id_type, @id)
+    end
+  end
+end

data/spec/connection_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper.rb'
+
+describe IActionable::Connection do
+  before do
+    @settings_hash = {
+      :app_key => "12345",
+      :api_key => "abcde",
+      :version => "3"
+    }
+    @settings = IActionable::Settings.new(@settings_hash)
+  end
+  
+  describe "initialization" do
+    it "should initialize a new Faraday connection object" do
+      mock_faraday_bulder = mock("faraday builder")
+      
+      Faraday.should_receive(:new).once.with("http://api.iactionable.com/v#{@settings.version}/").and_yield(mock_faraday_bulder)
+      mock_faraday_bulder.should_receive(:use).once.with(FaradayStack::ResponseJSON, {:content_type => 'application/json'})
+      mock_faraday_bulder.should_receive(:use).once.with(Faraday::Response::RaiseError)
+      mock_faraday_bulder.should_receive(:use).once.with(Faraday::Adapter::NetHttp)
+      
+      IActionable::Connection.new(@settings)
+    end
+  end
+  
+  describe "requests" do
+    before do
+      @mock_faraday_connection = mock("mock faraday connection")
+      @mock_faraday_response = mock("mock faraday response")
+      @mock_faraday_request_builder = mock("mock faraday request builder")
+      @mock_response_body = mock("mock response body")
+      @mock_faraday_request_headers = mock("mock faraday request headers")
+      @mock_faraday_response.stub!(:body).and_return(@mock_response_body)
+      @mock_faraday_request_builder.stub!(:headers).and_return(@mock_faraday_request_headers)
+      @mock_faraday_request_headers.stub!(:merge!).and_return(true)
+      Faraday.stub!(:new).and_return(@mock_faraday_connection)
+      @connection = IActionable::Connection.new(@settings)
+      @path = "/test/path"
+    end
+    
+    describe "using get method" do
+      describe "requiring an app key" do
+        describe "with optional params" do
+          it "should request correctly through faraday and return the body" do
+            @mock_faraday_connection.should_receive(:get).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+            @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key, :foo => :bar))
+            @mock_faraday_request_builder.should_receive(:headers).any_number_of_times
+            @connection.request.to(@path).with_app_key.with_params(:foo => :bar).get.should == @mock_response_body
+          end
+        end
+        
+        describe "without optional params" do
+          it "should request correctly through faraday and return the body" do
+            @mock_faraday_connection.should_receive(:get).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+            @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key))
+            @mock_faraday_request_builder.should_receive(:headers).any_number_of_times
+            @connection.request.to(@path).with_app_key.get.should == @mock_response_body
+          end
+        end
+      end
+    end
+    
+    describe "using post method" do
+      describe "requiring an app key" do
+        describe "requiring an api key" do
+          describe "with optional params" do
+            it "should request correctly through faraday and return the body" do
+              @mock_faraday_connection.should_receive(:post).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+              @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key, :foo => :bar))
+              @mock_faraday_request_builder.should_receive(:headers).once.and_return(@mock_faraday_request_headers)
+              @mock_faraday_request_headers.should_receive(:merge!).once.with(:Authorization => @settings.api_key)
+              @connection.request.to(@path).with_app_key.with_api_key.with_params(:foo => :bar).post.should == @mock_response_body
+            end
+          end
+        
+          describe "without optional params" do
+            it "should request correctly through faraday and return the body" do
+              @mock_faraday_connection.should_receive(:post).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+              @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key))
+              @mock_faraday_request_builder.should_receive(:headers).once.and_return(@mock_faraday_request_headers)
+              @mock_faraday_request_headers.should_receive(:merge!).once.with(:Authorization => @settings.api_key)
+              @connection.request.to(@path).with_app_key.with_api_key.post.should == @mock_response_body
+            end
+          end
+          
+          describe "with an optional body" do
+            it "should request correctly through faraday and return the body" do
+              @mock_faraday_connection.should_receive(:post).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+              @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key))
+              @mock_faraday_request_builder.should_receive(:headers).once.and_return(@mock_faraday_request_headers)
+              @mock_faraday_request_headers.should_receive(:merge!).once.with(:Authorization => @settings.api_key)
+              @mock_faraday_request_builder.should_receive(:body=).once.with(:foo => :bar)
+              @connection.request.to(@path).with_app_key.with_api_key.with_body(:foo => :bar).post.should == @mock_response_body
+            end
+          end
+        
+          describe "without an optional body" do
+            it "should request correctly through faraday and return the body" do
+              @mock_faraday_connection.should_receive(:post).and_yield(@mock_faraday_request_builder).and_return(@mock_faraday_response)
+              @mock_faraday_request_builder.should_receive(:url).once.with(@path, hash_including(:appKey => @settings.app_key))
+              @mock_faraday_request_builder.should_receive(:headers).once.and_return(@mock_faraday_request_headers)
+              @mock_faraday_request_headers.should_receive(:merge!).once.with(:Authorization => @settings.api_key)
+              @mock_faraday_request_builder.should_not_receive(:body=)
+              @connection.request.to(@path).with_app_key.with_api_key.post.should == @mock_response_body
+            end
+          end
+        end
+      end
+    end
+  end
+end