achievements 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael R. Bernstein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,103 @@
+# Achievements
+
+Achievements is a drop in Achievements/Badging engine designed to work
+with Ruby, ORM backed web applications.
+
+Achievements uses Redis for persistence and tries to be as abstract as
+possible, essentially acting as a counter server with assignable
+thresholds.
+
+The application Achievements was developed for uses a User class to
+instantiate the Engine and an Achievement class to persist the details
+of the achievements on the application side.
+
+## Achievements, Briefly
+
+Here's how you get achievements into your application:
+
+    require 'achievements'
+
+    class Engine
+      # Include the AchievementsEngine module from the Achievements
+      # gem to make your Engine class an AchievementsEngine class. 
+      include Achievements::AchievementsEngine
+      
+      # Now you can define achievements in this class.  One at a time
+      # using the achievement method:
+
+      # One achievement, one level
+      achievement :context1, :one_time, 1
+      
+      # Two achievements, one level
+      achievement :context2, :one_time, 1
+      achievement :context2, :three_times, 3
+
+      # One achievement, multiple levels
+      achievement :context3, :multiple_levels, [1, 5, 10]
+      
+      # Or all at once using the achievements (plural) method.  Right
+      # 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:
+
+    
+
+
+For the most up to date look at what this library is supposed to do,
+please refer to the test directory.
+    
+## Details
+
+### Contexts
+
+Contexts are categories for achievements.  Every time an achievement
+is triggered, it's "parent" or context counter is also triggered and
+incremented.  This makes it easier to gauge overall participation in
+the system and makes "score" based calculations less expensive.
+
+### Achievements
+
+Achievements are named, contextualized counters with one or more thresholds. 
+
+### Output
+
+When a threshold isn't crossed, and nothing changes, the engine will
+return nothing when triggered.
+
+When a threshold is crossed, the engine will return an array of
+symbols which correspond to the names of the achievements which have
+been reached, along with the threshold being crossed.  Your application can consume this output as you see
+fit.
+
+### Achievement API Compliance
+
+Your Achievement class must have a name, context, and threshold method
+in order to adapt to the Engine, in order to be consumed by the Agent
+class directly.
+
+## Project Metainfo
+
+### TODO
+
+* Better Redis interface methods for making/closing/keeping conneciton
+
+### Contributing
+
+0. Do some work on the library, commit
+1. [Fork][1] Achievements
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][2] with a link to your branch
+5. That's it!
+
+[1]: http://help.github.com/forking/
+[2]: http://github.com/mrb/achievements/issues
+
+### Author
+
+Michael R. Bernstein - *michaelrbernstein@gmail.com* - twitter.com/mrb_bk

data/Rakefile

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift 'lib'
+#
+# Publishing
+#
+
+desc "Push a new version to Gemcutter"
+task :publish do
+  require 'achievements/version'
+
+  sh "gem build achievements.gemspec"
+  sh "gem push achievements-#{Achievements::Version}.gem"
+  sh "git tag v#{Achievements::Version}"
+  sh "git push origin v#{Achievements::Version}"
+  sh "git push origin master"
+  sh "git clean -fd"
+  
+end

data/lib/achievements.rb

@@ -0,0 +1,21 @@
+# An Abstract, Redis-Backed Achievements Engine
+require 'redis'
+
+require 'achievements/achievement'
+require 'achievements/achievements_achievement'
+require 'achievements/achievements_agent'
+require 'achievements/achievements_engine'
+require 'achievements/agent'
+require 'achievements/counter'
+require 'achievements/engine'
+require 'achievements/version'
+
+module Achievements
+  def self.redis
+    @redis || @redis = Redis.connect
+  end
+
+  def self.engine
+    AchievementsEngine.engine
+  end
+end

data/lib/achievements/achievement.rb

@@ -0,0 +1,23 @@
+module Achievements
+  
+  # Achievement, basis of counters
+  class Achievement
+    attr_accessor :name
+    attr_accessor :threshold
+    attr_accessor :context
+    
+    # A method needs a context, name, and threshold, in that order.
+    # 
+    def initialize(context, name, threshold)
+      @context = context
+      @name = name
+      @threshold = threshold
+    end
+
+    # Convenience to_hash method
+    def to_hash
+      {:name => @name, :threshold => @threshold, :context => @context}
+    end
+
+  end
+end

data/lib/achievements/achievements_achievement.rb

@@ -0,0 +1,16 @@
+module Achievements
+  module AchievementsAchievement
+    # Convenience methods
+    def self.included(base)
+      base.extend IncludeClassMethods
+    end
+
+    module IncludeClassMethods
+      # Update the threshold for the AchievementEngine achievement
+      # that matches context, achievement, and sets threshold to new_threshold
+      def update_threshold(context, achievement, new_threshold)
+        # find achievement and update threshold
+      end 
+    end
+  end
+end

data/lib/achievements/achievements_agent.rb

@@ -0,0 +1,27 @@
+module Achievements
+  module AchievementsAgent
+    # Convenience methods for instantiating an engine and adding achievements
+    def self.included(base)
+      base.extend IncludeClassMethods
+    end
+  
+    # Convenience Class Methods for ActiveRecord::Base like User Classes
+    module IncludeClassMethods
+      def engine_class(engine_class)
+        @engine_class = engine_class
+      end
+
+      def engine
+        @engine_class
+      end
+    end
+
+    # Agent instance methods
+
+    # Agent instance level achievement trigger.  Automatically sends
+    # agent id along with context and name to the AchievementEngine
+    def achieve(context,name)
+      self.class.engine.achieve context, @id, name
+    end
+  end
+end

data/lib/achievements/achievements_engine.rb

@@ -0,0 +1,77 @@
+module Achievements
+  module AchievementsEngine
+    def self.engine
+      @engine
+    end
+
+    def self.included(base)
+      base.extend IncludeClassMethods
+    end
+
+    module IncludeClassMethods
+      # Instantiates the AchievementEngine and sets
+      # the contexts, which instantiate context specific counters.  Use
+      # only once.
+      # 
+      # make_engine [:context1,:context2]
+      #
+      def make_engine(contexts)
+        @redis = Achievements.redis
+        @engine = Engine.new(@redis)
+      end
+      
+      # Convenience method for accessing the current engine instance directly
+      def engine
+        @engine
+      end
+      
+      # Convenienve method for accessing redis instance
+      def redis
+        @redis
+      end
+
+      # Binds an achievement with a specific counter threshold. Use as
+      # many as you'd like.
+      #
+      # bind :context, :name, threshold
+      #
+      def achievement(context, name, threshold)
+        make_engine(context) if !@engine
+        @engine.achievement(context,name,threshold)
+      end
+      
+      # Alternately, bind an entire array of achievement objects.  To
+      # use this, achievements must respond to the context, name, and
+      # threshold methods.
+      #
+      # For example, when using with rails:
+      #
+      # bind_all Achievement.all
+      #
+      def achievements(object_array)
+        object_array.each do |object|
+          make_engine(context) if !@engine
+          @engine.achievement object.context, object.name, object.threshold
+        end
+      end
+
+      # Trigger a bound achievement method.  Since this is a class
+      # level method, you must include the agent id along with the
+      # method call
+      #
+      # trigger agent_id, context, name
+      #
+      def achieve(context, agent_id, name)
+        @engine.achieve context, agent_id, name
+      end
+
+      def achieves(context_name_array)
+        context_name_array.each do |cna|
+          Achievements.engine.achieve cna[0], @id, cna[1]
+        end
+      end
+      
+
+    end
+  end
+end

data/lib/achievements/counter.rb

@@ -0,0 +1,8 @@
+module Achievements
+  # Counter class is a Redis key factory.
+  class Counter
+    def self.make(context, agent_id, name)
+      @key = "#{context}:agent:#{agent_id}:#{name}"
+    end
+  end
+end

data/lib/achievements/engine.rb

@@ -0,0 +1,69 @@
+module Achievements
+  # Triggering multiple at once
+  
+  class Engine
+    attr_accessor :achievements
+    attr_accessor :contexts
+    attr_accessor :redis
+    
+    def initialize(redis)
+      @contexts = []
+      @redis = redis
+      @achievements = {}
+    end
+    
+    def achievement(context,name,threshold)
+      @contexts << context if !@contexts.include?(context)
+      if achievement = Achievement.new(context,name,threshold)
+        [threshold].flatten.each do |thresh|
+          @redis.sadd "#{context}:#{name}:threshold", thresh.to_s
+        end
+      end
+    end
+    
+    # The trigger method accepts:
+    # context, agent_id, name
+    #
+    # And returns:
+    # context, name, threshold
+    def achieve(context, agent_id, name)
+      achieved = []
+      
+      # Increment parent counter
+      counter = Counter.make(context,agent_id,"parent")
+      incr counter
+
+      # Increment child counter
+      counter = Counter.make(context,agent_id,name)
+      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
+    def incr(counter)
+      @redis.incr counter
+    end
+    
+    # decr key
+    def decr(counter)
+      @redis.decr counter
+    end
+
+    def deactiveate(counter)
+      @redis.set counter, "ACHIEVED"
+    end
+    
+    ## Class Methods
+   
+       
+  end
+end

data/lib/achievements/version.rb

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

data/test/achievements_test.rb

@@ -0,0 +1,95 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context "Achievement Restructure Test" do
+  
+  setup do
+    # Flush redis before each test
+    Achievements.redis.flushall
+
+    # A sample engine class that demonstrates how to use the
+    # AchievementsEngine include to instantiate the engine, make
+    # achievements, etc.
+    class Engine
+      include Achievements::AchievementsEngine
+
+      # One achievement, one level
+      achievement :context1, :one_time, 1
+      
+      # Two achievements, one level
+      achievement :context2, :one_time, 1
+      achievement :context2, :three_times, 3
+
+      # One achievement, multiple levels
+      achievement :context3, :multiple_levels, [1, 5, 10]
+    end
+
+    # A sample agent class that demonstrates how to use the
+    # AchievementsAgent include to achieve directly from a user
+    # class.  User class must have an id attribute to comply with the API.
+    class User
+      attr_accessor :id
+      include Achievements::AchievementsAgent
+      engine_class Engine
+      
+      def initialize(id)
+        @id = id
+      end
+    end
+
+    # Make a new user with an ID different from the one used in most tests
+    @user = User.new(10)
+
+    # For testing purposes, access the engine and redis directly
+    @engine = Engine.engine
+    @redis = Engine.redis
+  end
+
+  test "Engine gets assigned appropriate contexts" do
+    assert_equal @engine.contexts, [:context1,:context2,:context3]
+  end
+
+  test "Contexts get threshold sets" do
+    assert_equal @redis.smembers("context1:one_time:threshold"), ["1"]
+    assert_equal @redis.smembers("context2:one_time:threshold"), ["1"]
+    assert_equal @redis.smembers("context2:three_times:threshold"), ["3"]
+    assert_equal @redis.smembers("context3:multiple_levels:threshold").sort, ["1","10","5"]
+  end
+
+  test "Trigger should increment parent (context) and child counter" do
+    @engine.achieve(:context1,1,:one_time)
+    assert_equal @redis.get("context1:agent:1:parent"), "1"
+    assert_equal @redis.get("context1:agent:1:one_time"), "1"
+  end
+
+  test "Trigger should return crossed threshold" do
+    response = @engine.achieve(:context1, 1,:one_time)
+    assert_equal [[:context1,:one_time, "1"]], response
+  end
+
+  test "Trigger with threshold higher than 1" do
+    @engine.achieve(:context2, 1, :three_times)
+    @engine.achieve(:context2, 1, :three_times)
+    result = @engine.achieve(:context2, 1, :three_times)
+    assert_equal [[:context2,:three_times, "3"]], result
+  end
+
+  test "Multiple thresholds" do
+    results = []
+    10.times do 
+      results << @engine.achieve(:context3,1,:multiple_levels)
+    end
+    assert_equal results, [[[:context3, :multiple_levels, "1"]], [], [], [], [[:context3, :multiple_levels, "5"]], [], [], [], [], [[:context3, :multiple_levels, "10"]]]
+  end
+
+  test "Achieving from the agent class" do
+    response = @user.achieve(:context1,:one_time)
+    assert_equal response, [[:context1,:one_time,"1"]]
+  end
+
+  test "Achieving after threshold returns empty from agent and engine class" do
+    @user.achieve(:context1,:one_time)
+    assert_equal @user.achieve(:context1,:one_time), []
+    @engine.achieve(:context1,1,:one_time)
+    assert_equal @engine.achieve(:context1,1,:one_time),[]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+require 'rubygems'
+require 'test/unit'
+require 'achievements'
+
+begin
+  require 'leftright'
+rescue LoadError
+end
+
+# Thanks, Resque!
+# http://github.com/defunkt/resque
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  abort ''
+end
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+at_exit do
+  next if $!
+
+  if defined?(MiniTest)
+    exit_code = MiniTest::Unit.new.run(ARGV)
+  else
+    exit_code = Test::Unit::AutoRunner.run
+  end
+
+  pid = `ps -A -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+# AchievementEngine.redis = 'localhost:9736'
+
+##
+# test/spec/mini 3
+# http://gist.github.com/25455
+# chris@ozmm.org
+#
+def context(*args, &block)
+  return super unless (name = args.first) && block
+  require 'test/unit'
+  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
+    def self.test(name, &block)
+      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
+    end
+    def self.xtest(*args) end
+    def self.setup(&block) define_method(:setup, &block) end
+    def self.teardown(&block) define_method(:teardown, &block) end
+  end
+  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
+  klass.class_eval &block
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: achievements
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael R. Bernstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 2
+        - 0
+        - 11
+        version: 2.0.11
+  type: :runtime
+  version_requirements: *id001
+description: "    Achievements is an abstract, Redis-backed, counter based achievements engine\n    designed to be included in Model classes in web applications.\n\n    Achievements lets you track and persist user actions with a simple bind and\n    trigger design pattern.\n"
+email: michaelrbernstein@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- LICENSE
+- HISTORY.markdown
+- lib/achievements/counter.rb
+- lib/achievements/achievements_engine.rb
+- lib/achievements/achievements_achievement.rb
+- lib/achievements/achievements_agent.rb
+- lib/achievements/version.rb
+- lib/achievements/agent.rb
+- lib/achievements/engine.rb
+- lib/achievements/achievement.rb
+- lib/achievements.rb
+- test/achievements_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mrb/achievements
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Achievements adds Redis-backed achievments
+test_files: []
+