achievements 0.0.2 → 0.0.3

data/README.markdown

@@ -39,14 +39,17 @@ Here's how you get achievements into your application:
       # now this relies on the existence of a class which responds to
       # id, name, and achievement methods:
       achievements Achievement.all
-
     end
 
 Here's how you could interact with it in a session with the above
 class loaded:
 
-    
+    # Grab the engine 
+    @engine = Achievements.engine
 
+    # Achieve something!
+    @engine.achieve(:context1, 1, :one_time)
+    => [[:context1,:one_time,"1"]]    
 
 For the most up to date look at what this library is supposed to do,
 please refer to the test directory.
@@ -82,6 +85,11 @@ class directly.
 
 ## Project Metainfo
 
+### Dependencies
+
+* A running Redis server
+* The Redis Ruby Gem
+
 ### TODO
 
 * Better Redis interface methods for making/closing/keeping conneciton

data/lib/achievements/achievements_agent.rb

@@ -23,5 +23,10 @@ module Achievements
     def achieve(context,name)
       self.class.engine.achieve context, @id, name
     end
+
+    # Determine a user's 'score'
+    def score(context=nil,name=nil)
+      self.class.engine.score(@id, context, name)
+    end
   end
 end

data/lib/achievements/achievements_engine.rb

@@ -51,7 +51,7 @@ module Achievements
       def achievements(object_array)
         object_array.each do |object|
           make_engine(context) if !@engine
-          @engine.achievement object.context, object.name, object.threshold
+          @engine.achievement(object.context, object.name, object.threshold)
         end
       end
 
@@ -67,11 +67,15 @@ module Achievements
 
       def achieves(context_name_array)
         context_name_array.each do |cna|
-          Achievements.engine.achieve cna[0], @id, cna[1]
+          @engine.achieve cna[0], @id, cna[1]
         end
       end
-      
 
+      #
+      def score(agent_id,context,name)
+        @engine.score(agent_id,context,name)
+      end
+    
     end
   end
 end

data/lib/achievements/engine.rb

@@ -1,17 +1,17 @@
 module Achievements
-  # Triggering multiple at once
-  
   class Engine
     attr_accessor :achievements
     attr_accessor :contexts
     attr_accessor :redis
-    
+
+    # Initialize an Achievements Engine by passing a connected redis instance
     def initialize(redis)
       @contexts = []
       @redis = redis
       @achievements = {}
     end
-    
+
+    # Bind one achievement at a time.  Accepts context, name, and threshold.
     def achievement(context,name,threshold)
       @contexts << context if !@contexts.include?(context)
       if achievement = Achievement.new(context,name,threshold)
@@ -20,6 +20,15 @@ module Achievements
         end
       end
     end
+
+    # Bind multiple achievements at a time.  Accepts an array of
+    # objects which respond to the context, name, and threshold methods.
+    def achievements(achievement_array)
+      return unless achievement_array.is_a?(Array)
+      achievement_array.each do |achievement|
+        achievement(achievement.context, achievement.name, achievement.threshold)
+      end
+    end
     
     # The trigger method accepts:
     # context, agent_id, name
@@ -29,6 +38,10 @@ module Achievements
     def achieve(context, agent_id, name)
       achieved = []
       
+      # Increment user counter
+      counter = "agent:#{agent_id}"
+      incr counter
+      
       # Increment parent counter
       counter = Counter.make(context,agent_id,"parent")
       incr counter
@@ -38,32 +51,53 @@ module Achievements
       result = incr counter
 
       # Check Threshold
-    
       if  @redis.sismember("#{context}:#{name}:threshold", result) == true
         achieved << [context,name, result.to_s]
         return achieved
       else
         return []
       end
-      
     end
 
-    # incr key
+    # Submit multiple achievements to the engine at one time, as an
+    # array of arrays.  
+    def achieves(achievements)
+      response = []
+      achievements.each do |a|
+        response << achieve(a[0],a[1],a[2]).flatten
+      end
+      response
+    end
+
+    # Increment a given counter
     def incr(counter)
       @redis.incr counter
     end
     
-    # decr key
+    # Decrement a given counter
     def decr(counter)
       @redis.decr counter
     end
 
+    # Deactivate a counter by setting it to "ACHIEVED," this making it
+    # incapable of being incremented or decremented
     def deactiveate(counter)
       @redis.set counter, "ACHIEVED"
     end
+
+    # Retrieve the score of:
+    # - specific counter (provide user_id, context, name)
+    # - context counter (provide user_id, context)
+    # - user counter (provide user_id)
+    def score(user_id, context = nil, name = nil)
+      scores = []
+      scores << @redis.get("agent:#{user_id}")
+      scores << @redis.get("#{context}:agent:#{user_id}:parent") unless context.nil?
+      scores << @redis.get("#{context}:agent:#{user_id}:#{name}") unless name.nil?
+      scores
+    end
     
     ## Class Methods
    
-       
   end
 end

data/lib/achievements/version.rb

@@ -1,4 +1,4 @@
 
 module Achievements
-  Version = VERSION = '0.0.2'
+  Version = VERSION = '0.0.3'
 end

data/test/achievements_test.rb

@@ -1,17 +1,51 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-context "Achievement Restructure Test" do
+context "Achievement Test" do
   
   setup do
     # Flush redis before each test
     Achievements.redis.flushall
 
+    # A sample achievement class.  The instances implement the
+    # appropriate methods to be consumed by the engine class, and the
+    # class implements a ".all" method to emulate popular ORMs.  This
+    # intends to show that it's easy to store your achievements in a
+    # database and load them in from there.
+    class Achievement
+      attr_accessor :context, :name, :threshold
+
+      def self.all
+        @all
+      end
+
+      def self.all=(a)
+        @all ||= []
+        @all << a
+      end
+      
+      def initialize(context,name,threshold)
+        self.context = context
+        @name = name
+        @threshold = threshold
+        self.class.all = self
+      end
+    end
+
+    # Make some achievements for the achievements method demonstration
+    [[:context4,:five_times,5],[:context5,:two_times,2],[:context6,:once,1]].each do |a|
+      Achievement.new(a[0],a[1],a[2])
+    end
+
     # A sample engine class that demonstrates how to use the
     # AchievementsEngine include to instantiate the engine, make
     # achievements, etc.
     class Engine
       include Achievements::AchievementsEngine
-
+      
+      # You can either add one achievement at a time with the
+      # achievement method which accepts the name of the achievement's
+      # context, name, and threshold:
+      
       # One achievement, one level
       achievement :context1, :one_time, 1
       
@@ -21,6 +55,16 @@ context "Achievement Restructure Test" do
 
       # One achievement, multiple levels
       achievement :context3, :multiple_levels, [1, 5, 10]
+
+      # Or you can add multiple achievements at once with the
+      # achievements method, which accepts an array.  This array must
+      # contain objects which implement id, name, and context
+      # methods.  The example below assumes that you have an "all"
+      # class method on the Achievement class which returns an array
+      # of all instances of that class:
+  
+      # Passing an array of compliant objects to the achievements method
+      achievements Achievement.all
     end
 
     # A sample agent class that demonstrates how to use the
@@ -35,7 +79,7 @@ context "Achievement Restructure Test" do
         @id = id
       end
     end
-
+    
     # Make a new user with an ID different from the one used in most tests
     @user = User.new(10)
 
@@ -45,7 +89,8 @@ context "Achievement Restructure Test" do
   end
 
   test "Engine gets assigned appropriate contexts" do
-    assert_equal @engine.contexts, [:context1,:context2,:context3]
+    assert_equal @engine.contexts, [:context1, :context2, :context3,
+                                    :context4, :context5, :context6]
   end
 
   test "Contexts get threshold sets" do
@@ -79,6 +124,7 @@ context "Achievement Restructure Test" do
       results << @engine.achieve(:context3,1,:multiple_levels)
     end
     assert_equal results, [[[:context3, :multiple_levels, "1"]], [], [], [], [[:context3, :multiple_levels, "5"]], [], [], [], [], [[:context3, :multiple_levels, "10"]]]
+    assert_equal @redis.get("agent:1"), "10"
   end
 
   test "Achieving from the agent class" do
@@ -92,4 +138,41 @@ context "Achievement Restructure Test" do
     @engine.achieve(:context1,1,:one_time)
     assert_equal @engine.achieve(:context1,1,:one_time),[]
   end
+
+  test "Members of achievement class should implement methods" do
+    Achievement.all.each do |a|
+      assert a.respond_to?(:context)
+      assert a.respond_to?(:name)
+      assert a.respond_to?(:id)
+    end
+  end
+
+  test "Achievement class should have three members" do
+    assert_equal Achievement.all.length, 3
+  end
+
+  test "Achieving more than one achievement at a time, no thresholds crossed" do
+    assert_equal @engine.achieves([[:context4,1,:five_times],[:context4,1,:five_times]]), [[],[]]
+  end
+
+  test "Achieving more than one at a time, threshold crosssed" do
+    assert_equal @engine.achieves([[:context1,1,:one_time],[:context2,1,:three_times]]), [[:context1,:one_time,"1"],[]]
+  end
+
+  test "Any trigger should increment agent counter" do
+    20.times do
+      @engine.achieve(:context1,20,:one_time)
+    end
+    assert_equal @redis.get("agent:20"), "20"
+  end
+
+  test "Score retrieval" do
+    20.times do
+      @user.achieve(:context1,:one_time)
+    end
+   
+    assert_equal @user.score, ["20"]
+    assert_equal @user.score(:context1), ["20","20"]
+    assert_equal @user.score(:context1,:one_time), ["20","20","20"]
+  end
 end

data/test/test_helper.rb

@@ -39,7 +39,7 @@ at_exit do
 end
 
 puts "Starting redis for testing at localhost:9736..."
-`redis-server #{dir}/redis-test.conf`
+'redis-server #{dir}/redis-test.conf'
 # AchievementEngine.redis = 'localhost:9736'
 
 ##

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: achievements
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Michael R. Bernstein
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 -04:00
+date: 2010-11-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,14 +48,13 @@ files:
 - Rakefile
 - LICENSE
 - HISTORY.markdown
-- lib/achievements/counter.rb
-- lib/achievements/achievements_engine.rb
+- lib/achievements/achievement.rb
 - lib/achievements/achievements_achievement.rb
 - lib/achievements/achievements_agent.rb
-- lib/achievements/version.rb
-- lib/achievements/agent.rb
+- lib/achievements/achievements_engine.rb
+- lib/achievements/counter.rb
 - lib/achievements/engine.rb
-- lib/achievements/achievement.rb
+- lib/achievements/version.rb
 - lib/achievements.rb
 - test/achievements_test.rb
 - test/test_helper.rb