recognition 0.2.0 → 0.3.0

data/README.md

@@ -54,15 +54,14 @@ app/controllers/profiles_controller.rb:
       end
     end
 
-Note:
-=====
+
+### Note
 Due to the way Ruby method aliasing work, if you need to recognize users for 
 non-ActiveRecord actions (anything that's not :create, :update and :destroy),
 make sure you add the `recognize` line *after* the method you want to 
 recognize the user for.
 
-Example:
--------
+## Example
 The following won't work:
 
     class Post < ActiveRecord::Base

data/Rakefile

@@ -30,3 +30,7 @@ task :default => :spec
 
 Bundler::GemHelper.install_tasks
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'CHANGELOG.txt', 'LICENSE.txt', 'CONTRIBUTING.txt']
+  t.options = ['--any', '--extra', '--opts']
+end

data/lib/recognition.rb

@@ -5,15 +5,19 @@ require "redis"
 
 module Recognition
   mattr_accessor :redis
+  # Redis Db connection parameters
   @@redis = 'localhost:6378'
 
   mattr_accessor :backend
+  # Redis Db active connection
   @@backend = nil
   
+  # Initialize recognition
   def self.setup
     yield self
   end
   
+  # Connect to Redis Db
   def self.backend
     if self.redis['redis://']
       @@backend = Redis.connect(:url => self.redis, :thread_safe => true)

data/lib/recognition/action_controller_extension.rb

@@ -1,6 +1,7 @@
 require "recognition/database"
 
 module Recognition
+  # Extending ActiveRecord
   module ActionControllerExtension
     def self.included(base)
       base.extend ClassMethods

data/lib/recognition/active_record_extension.rb

@@ -8,8 +8,8 @@ module Recognition
       base.class_attribute :recognizable
     end
 
-    module ClassMethods #:nodoc:
-      # to be called from user-model
+    module ClassMethods
+      # to be called from user model
       def acts_as_recognizable options = {}
         include RecognizableInstanceMethods
         self.recognizable = true
@@ -18,8 +18,10 @@ module Recognition
           amount: options[:initial]
         }
         after_save :add_initial_points
+        
       end
   
+      # to be called from other models
       def recognize recognizable, condition
         include ObjectInstanceMethods
         self.recognitions ||= {}
@@ -50,9 +52,17 @@ module Recognition
         # have been persisted
         after_save :recognize_creating
       end
+
+      # to be called from user-model
+      def acts_as_voucher options = {}
+        include VoucherInstanceMethods
+        self.recognitions = options
+        before_create :regenerate_code
+      end
     end
 
-    module RecognizableInstanceMethods #:nodoc:
+    module RecognizableInstanceMethods
+      # Determine user current balance of points
       def points
         Database.get_user_points self.id
       end
@@ -68,9 +78,13 @@ module Recognition
       def update_points amount, bucket
         Database.log(self.id, amount.to_i, bucket)
       end
+      
+      def transactions page = 0, per = 20
+        Database.get_user_transactions self.id, page, per
+      end
     end
     
-    module ObjectInstanceMethods #:nodoc:
+    module ObjectInstanceMethods
       def recognize_creating
         if self.id_changed? # Unless we are creating
           Database.update_points self, :create, self.class.recognitions[:create] unless self.class.recognitions[:create].nil?
@@ -88,5 +102,48 @@ module Recognition
       end
   
     end
+    
+    module VoucherInstanceMethods
+      def regenerate_code
+        l = self.class.recognitions[:code_length] || 10
+        dict = [('a'..'z'),('A'..'Z'),(0..9)].map{|i| i.to_a}.flatten
+        code = (1..l).map{ dict[rand(dict.length)] }.join
+        # Prevent code collision at all costs
+        if self.class.to_s.constantize.find_all_by_code(code).any?
+          regenerate_code
+        else
+          self.code = code
+          self
+        end
+      end
+      
+      def redeem recognizable
+        # Make sure we have an amount beforehand
+        if defined? self.amount
+          if self.redeemable? recognizable
+            Database.redeem_voucher recognizable.id, self.code, self.amount
+          end
+        end
+      end
+      
+      def redeemable? recognizable
+        # default: not redeemable
+        pass = false
+        # has the voucher ever been redeemed?
+        if Database.get_voucher_transactions(self.code).any?
+          # has the voucher ever been redeemed by this user?
+          if Database.get_user_voucher(recognizable.id, code) != 0
+            pass = false
+          # is the voucher reusable?
+          elsif defined?(self.reusable?) && self.reusable?
+            pass = true
+          end
+        else
+          pass = true
+        end
+        pass
+      end
+      
+    end
   end
 end

data/lib/recognition/database.rb

@@ -1,29 +1,18 @@
 require "recognition/transaction"
 
 module Recognition
+  # Handle all Transactions and logging to Redis
   module Database
-    def self.log id, amount, bucket
+    def self.log id, amount, bucket, code = nil
       hash = Time.now.to_f.to_s
       Recognition.backend.multi do
-        # Recognition.backend.incrby "recognition:user:#{ id }:points", amount
         Recognition.backend.hincrby "recognition:user:#{ id }:counters", 'points', amount
         Recognition.backend.hincrby "recognition:user:#{ id }:counters", bucket, amount
         Recognition.backend.zadd "recognition:user:#{ id }:transactions", hash, { hash: hash, amount: amount, bucket: bucket, datetime: DateTime.now.to_s }.to_json
         Recognition.backend.zadd 'recognition:transactions', hash, { hash: hash, id: id, amount: amount, bucket: bucket, datetime: DateTime.now.to_s }.to_json
-      end
-    end
-    
-    def self.record transaction
-      unless transaction.class.to_s == Recognition::Transaction
-        raise ArgumentError, 'parameter should be of type Recognition::Transaction'
-      end
-      hash = Time.now.to_f.to_s
-      Recognition.backend.multi do
-        # Recognition.backend.incrby "recognition:user:#{ id }:points", amount
-        Recognition.backend.hincrby "recognition:user:#{ id }:counters", 'points', transactions.amount
-        Recognition.backend.hincrby "recognition:user:#{ id }:counters", transactions.bucket, transactions.amount
-        Recognition.backend.zadd "recognition:user:#{ id }:transactions", hash, { amount: transactions.amount, bucket: transactions.bucket, datetime: DateTime.now.to_s }.to_json
-        Recognition.backend.zadd 'recognition:transactions', hash, { id: id, amount: transactions.amount, bucket: transactions.bucket, datetime: DateTime.now.to_s }.to_json
+        unless code.nil?
+          Recognition.backend.zadd "recognition:voucher:#{ code }:transactions", hash, { hash: hash, id: id, bucket: bucket, datetime: DateTime.now.to_s }.to_json
+        end
       end
     end
     
@@ -40,6 +29,19 @@ module Recognition
       counter.to_i
     end
     
+    def self.get_user_transactions id, page = 0, per = 20
+      start = page * per 
+      stop = (1 + page) * per 
+      keypart = "user:#{ id }"
+      self.get_transactions keypart, start, stop
+    end
+    
+    def self.get_voucher_transactions code, page = 0, per = 20
+      start = page * per
+      stop = (1 + page) * per 
+      keypart = "voucher:#{ code }"
+      self.get_transactions keypart, start, stop
+    end
     
     def self.update_points object, action, condition
       if condition[:bucket].nil?
@@ -59,6 +61,27 @@ module Recognition
       end
     end
     
+    def self.redeem_voucher id, code, amount
+      bucket = "Voucher:redeem##{ code }"
+      Database.log(id, amount.to_i, bucket, code)
+    end
+    
+    def self.get_user_voucher id, code
+      bucket = "Voucher:redeem##{ code }"
+      Database.get_user_counter id, bucket
+    end
+    
+    private
+    
+    def self.get_transactions keypart, start, stop
+      transactions = []
+      range = Recognition.backend.zrange "recognition:#{ keypart }:transactions", start, stop
+      range.each do |transaction|
+        transactions << JSON.parse(transaction, { symbolize_names: true })
+      end
+      transactions
+    end
+    
     def self.parse_user object, condition
       if condition[:recognizable].nil?
         user = object

data/lib/recognition/version.rb

@@ -1,3 +1,4 @@
 module Recognition
-  VERSION = "0.2.0"
+  # Current Version
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recognition
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,6 +107,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Recognize users by giving them points and rewards for their actions
 email:
 - owahab@gmail.com
@@ -145,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -334073944928313035
+      hash: -2843760632124197996
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -334073944928313035
+      hash: -2843760632124197996
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -162,3 +194,4 @@ signing_key:
 specification_version: 3
 summary: Recognize users by giving them points and rewards for their actions
 test_files: []
+has_rdoc: