recognition 0.4.0 → 0.5.0

data/README.md

@@ -80,11 +80,63 @@ app/controllers/profiles_controller.rb:
       end
     end
 
+Example:
+
+The following won't work:
+
+    class Post < ActiveRecord::Base
+      attr_accessible :title, :user_id
+      recognize :user, for: :foo, gain: 2
+      def foo
+        # do something useful
+      end
+    end
+
+This one will:
+
+    class Post < ActiveRecord::Base
+      attr_accessible :title, :user_id
+      def foo
+        # do something useful
+      end
+      recognize :user, for: :foo, gain: 2
+    end
+
 ### Vouchers
 
+    Use an existing model or generate a new one using:
+
+        $ rails generate recogintion:voucher
+
+    Your model might have the following attributes:
+
+    *  `:code` **required**
+    *  `:amount` **required**
+    *  `:expires_at` _optional_
+    *  `:reusable` _optional_
+
+    You can specify the following extra parameters for vouchers:
+
+    * `:prefix` can be a number, string or method name or even an anonymous function.
+    * `:suffix` can be a number, string or method name or even an anonymous function.
+
+    app/models/voucher.rb:
+
+        class Voucher < ActiveRecord::Base
+          attr_accessible :code, :amount, :expires_at, :reusable
+            acts_as_voucher code_length: 14
+        end
+
+    Then, you may do:
+
+        voucher = Voucher.create!(amount: 20, expires_at: (DateTime.now + 1.day), reusable: true)
+        voucher.redeem current_user
+
+### Gifts
+
 Use an existing model or generate a new one using:
 
-    $ rails generate recogintion:voucher
+$ rails generate recogintion:gift
 
 Your model might have the following attributes:
 
@@ -93,44 +145,22 @@ Your model might have the following attributes:
 *  `:expires_at` _optional_
 *  `:reusable` _optional_
 
-You can specify the following extra parameters for vouchers:
+You can specify the following extra parameters for gifts:
 
 * `:prefix` can be a number, string or method name or even an anonymous function.
 * `:suffix` can be a number, string or method name or even an anonymous function.
 
-app/models/voucher.rb:
+app/models/gift.rb:
 
-    class Voucher < ActiveRecord::Base
+    class Gift < ActiveRecord::Base
       attr_accessible :code, :amount, :expires_at, :reusable
-        acts_as_voucher code_length: 14
+        acts_as_gift code_length: 14
     end
 
 Then, you may do:
 
-    voucher = Voucher.create!(amount: 20, expires_at: (DateTime.now + 1.day), reusable: true)
-    voucher.redeem current_user
-
-## Example
-The following won't work:
-
-    class Post < ActiveRecord::Base
-      attr_accessible :title, :user_id
-      recognize :user, for: :foo, gain: 2
-      def foo
-        # do something useful
-      end
-    end
-
-This one will:
-
-    class Post < ActiveRecord::Base
-      attr_accessible :title, :user_id
-      def foo
-        # do something useful
-      end
-      recognize :user, for: :foo, gain: 2
-    end
-
+    gift = Gift.create!(amount: 20, expires_at: (DateTime.now + 1.day), reusable: true)
+    gift.redeem current_user
 
 ## Contributing
 

data/lib/generators/recognition/gift_generator.rb

@@ -0,0 +1,25 @@
+module Recognition
+  module Generators
+    class GiftGenerator < ::Rails::Generators::Base
+      desc "Generates a Recognition Gift"
+      
+      def scaffold
+        generate 'scaffold gift code amount:integer reusable:boolean expires_at:datetime'
+      end
+      
+      def set_defaults
+        line = "t.boolean :reusable"
+        gsub_file Dir.glob("db/migrate/*_create_gifts.rb").first, /(#{Regexp.escape(line)})/mi do |match|
+          "#{match}, default: false"
+        end
+      end
+      
+      def add_stanza
+        line = "class Gift < ActiveRecord::Base"
+        gsub_file 'app/models/gift.rb', /(#{Regexp.escape(line)})/mi do |match|
+          "#{match}\n  acts_as_gift code_length: 20 \n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/recognition/voucher_generator.rb

@@ -1,6 +1,8 @@
 module Recognition
   module Generators
-    class VoucherGenerator < Rails::Generators::Base
+    class VoucherGenerator < ::Rails::Generators::Base
+      desc "Generates a Recognition Voucher"
+
       def scaffold
         generate 'scaffold voucher code amount:integer reusable:boolean expires_at:datetime'
       end

data/lib/recognition/database.rb

@@ -29,17 +29,22 @@ module Recognition
       Recognition.log 'foo', condition.to_s
       condition[:bucket] ||= "#{ object.class.to_s.camelize }:#{ action }"
       user = Recognition::Parser.parse_recognizable(object, condition[:recognizable], condition[:proc_params])
-      if condition[:amount].nil? && condition[:gain].nil? && condition[:loss].nil?
-        Recognition.log 'validation', "Unable to determine points: no 'amount', 'gain' or 'loss' specified"
-        false
-      else
-        total = Recognition::Parser.parse_amount(condition[:amount], object, condition[:proc_params]) + Recognition::Parser.parse_amount(condition[:gain], object, condition[:proc_params]) - Recognition::Parser.parse_amount(condition[:loss], object, condition[:proc_params])
-        ground_total = user.recognition_counter(condition[:bucket]) + total
-        if condition[:maximum].nil? || ground_total <= condition[:maximum]
-          log(user.id, total.to_i, condition[:bucket])
+      # Do we have a valid user?
+      if user.respond_to?(:points)
+        if condition[:amount].nil? && condition[:gain].nil? && condition[:loss].nil?
+          Recognition.log 'validation', "Unable to determine points: no 'amount', 'gain' or 'loss' specified"
+          false
         else
-          Recognition.log 'validation', "Unable to add points: bucket maximum reached for bucket '#{condition[:bucket]}'"
+          total = Recognition::Parser.parse_amount(condition[:amount], object, condition[:proc_params]) + Recognition::Parser.parse_amount(condition[:gain], object, condition[:proc_params]) - Recognition::Parser.parse_amount(condition[:loss], object, condition[:proc_params])
+          ground_total = user.recognition_counter(condition[:bucket]) + total
+          if condition[:maximum].nil? || ground_total <= condition[:maximum]
+            log(user.id, total.to_i, condition[:bucket])
+          else
+            Recognition.log 'validation', "Unable to add points: bucket maximum reached for bucket '#{condition[:bucket]}'"
+          end
         end
+      else
+        Recognition.log 'validation', "Unable to add points to #{condition[:recognizable]}, make sure it 'acts_as_recognizable'"
       end
     end
     

data/lib/recognition/extensions/active_record.rb

@@ -53,16 +53,28 @@ module Recognition
           after_save :recognize_creating
         end
 
-        # to be called from user-model
         def acts_as_voucher options = {}
           require "recognition/models/voucher"
           include Recognition::Models::Voucher
           self.recognitions = options
-          cattr_accessor :voucher_validators
+          cattr_accessor :redemption_validators
           def self.validates_voucher_redmeption validators
-            self.voucher_validators ||= []
-            self.voucher_validators << validators
-            self.voucher_validators.flatten!
+            self.redemption_validators ||= []
+            self.redemption_validators << validators
+            self.redemption_validators.flatten!
+          end
+          before_create :regenerate_code
+        end
+
+        def acts_as_gift options = {}
+          require "recognition/models/gift"
+          include Recognition::Models::Gift
+          self.recognitions = options
+          cattr_accessor :redemption_validators
+          def self.validates_gift_redmeption validators
+            self.redemption_validators ||= []
+            self.redemption_validators << validators
+            self.redemption_validators.flatten!
           end
           before_create :regenerate_code
         end

data/lib/recognition/models/gift.rb

@@ -1,65 +1,18 @@
+require 'recognition/models/redeemable'
+
 module Recognition
   module Models
     module Gift
-      def regenerate_code
-        prefix = Recognition::Database.parse_code_part(self.class.recognitions[:prefix], self)
-        suffix = Recognition::Database.parse_code_part(self.class.recognitions[:suffix], self)
-        l = (self.class.recognitions[:code_length] - (prefix.length + suffix.length)) || 10
-        dict = [('a'..'z'),('A'..'Z'),(0..9)].map{|i| i.to_a}.flatten
-        code = (1..l).map{ dict[rand(dict.length)] }.prepend(prefix).append(suffix).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
-            # Call custom validators
-            if defined? self.class.gift_validators
-              self.class.gift_validators.each do |validator|
-                # quit if any validator returned false
-                return if send(validator) == false
-              end
-            end
-            # If all went well:
-            Database.redeem_gift recognizable.id, self.code, self.amount
-          end
-        end
-      end
-    
+      include Recognition::Models::Redeemable
+      
       def redeemable? recognizable
-        # default: not redeemable
-        pass = false
-        # only check if the gift did not expire
-        unless expired?
-          # has the gift ever been redeemed?
-          if Database.get_gift_transactions(self.code).any?
-            # has the gift ever been redeemed by this user?
-            if Database.get_user_gift(recognizable.id, code) != 0
-              pass = false
-              # is the gift reusable?
-            elsif defined?(self.reusable?) && self.reusable?
-              pass = true
-            end
-          else
-            pass = true
-          end
-        end
-        pass
+        recognizable.points >= self.amount && is_redeemable?(recognizable)
       end
       
-      def expired?
-        defined?(self.expires_at) && self.expires_at.present? && self.expires_at < DateTime.now
+      def execute_redemption id
+        actual_amount = (self.amount.to_i * -1)
+        Recognition::Database.redeem id, bucket, self.class.to_s.downcase, self.code, actual_amount
       end
-      
-      private
-      
     end
   end
 end

data/lib/recognition/models/redeemable.rb

@@ -0,0 +1,81 @@
+module Recognition
+  module Models
+    module Redeemable
+      def regenerate_code
+        prefix = Recognition::Parser.parse_code_part(self.class.recognitions[:prefix], self)
+        suffix = Recognition::Parser.parse_code_part(self.class.recognitions[:suffix], self)
+        l = (self.class.recognitions[:code_length] - (prefix.length + suffix.length)) || 10
+        dict = [('a'..'z'),('A'..'Z'),(0..9)].map{|i| i.to_a}.flatten
+        code = (1..l).map{ dict[rand(dict.length)] }.prepend(prefix).append(suffix).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 expired?
+        defined?(self.expires_at) && self.expires_at.present? && self.expires_at < DateTime.now
+      end
+      
+      def is_redeemable? recognizable
+        # default: not redeemable
+        pass = false
+        # only check if the redeemable did not expire
+        unless expired?
+          # has the redeemable ever been redeemed?
+          if transactions.any?
+            # has the redeemable ever been redeemed by this user?
+            if get_user_counter(recognizable.id) != 0
+              pass = false
+              # is the redeemable reusable?
+            elsif defined?(self.reusable?) && self.reusable?
+              pass = true
+            end
+          else
+            pass = true
+          end
+        end
+        pass
+      end
+      
+      def redeem recognizable
+        # Make sure we have an amount beforehand
+        if defined? self.amount
+          if self.redeemable? recognizable
+            # Call custom validators
+            if defined? self.class.redemption_validators
+              self.class.redemption_validators.each do |validator|
+                # quit if any validator returned false
+                if send(validator) == false
+                  Recognition.log self.class.to_s.to_sym, "validation error for #{self.class.to_s}:#{self.id}"
+                  return
+                end
+              end
+            end
+            # If all went well:
+            execute_redemption recognizable.id
+          end
+        end
+      end
+      
+    
+      def bucket
+        "#{self.class.to_s.downcase}:#{ self.code }"
+      end
+      
+      def get_user_counter id
+        Recognition::Database.get_counter "user:#{id}", bucket
+      end
+      
+      def transactions page = 0, per = 20
+        start = page * per
+        stop = (1 + page) * per 
+        Recognition::Database.get_transactions bucket, start, stop
+      end
+    
+    end
+  end
+end

data/lib/recognition/models/voucher.rb

@@ -1,82 +1,17 @@
+require 'recognition/models/redeemable'
+
 module Recognition
   module Models
     module Voucher
-      def regenerate_code
-        prefix = Recognition::Parser.parse_code_part(self.class.recognitions[:prefix], self)
-        suffix = Recognition::Parser.parse_code_part(self.class.recognitions[:suffix], self)
-        l = (self.class.recognitions[:code_length] - (prefix.length + suffix.length)) || 10
-        dict = [('a'..'z'),('A'..'Z'),(0..9)].map{|i| i.to_a}.flatten
-        code = (1..l).map{ dict[rand(dict.length)] }.prepend(prefix).append(suffix).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
-            # Call custom validators
-            if defined? self.class.voucher_validators
-              self.class.voucher_validators.each do |validator|
-                # quit if any validator returned false
-                if send(validator) == false
-                  Recognition.log :voucher, "validation error for voucher:#{self.id}"
-                  return
-                end
-              end
-            end
-            # If all went well:
-            Recognition::Database.redeem recognizable.id, bucket, 'voucher', self.code, amount.to_i
-          end
-        end
-      end
-    
-      def redeemable? recognizable
-        # default: not redeemable
-        pass = false
-        # only check if the voucher did not expire
-        unless expired?
-          # has the voucher ever been redeemed?
-          if transactions.any?
-            # has the voucher ever been redeemed by this user?
-            if get_user_voucher(recognizable.id) != 0
-              pass = false
-              # is the voucher reusable?
-            elsif defined?(self.reusable?) && self.reusable?
-              pass = true
-            end
-          else
-            pass = true
-          end
-        end
-        pass
-      end
-      
-      def expired?
-        defined?(self.expires_at) && self.expires_at.present? && self.expires_at < DateTime.now
-      end
-      
-      private
+      include Recognition::Models::Redeemable
       
-      def bucket
-        "voucher:#{ self.code }"
-      end
-      
-      def get_user_voucher id
-        Recognition::Database.get_counter "user:#{id}", bucket
+      def redeemable? recognizable
+        is_redeemable? recognizable
       end
       
-      def transactions page = 0, per = 20
-        start = page * per
-        stop = (1 + page) * per 
-        Recognition::Database.get_transactions bucket, start, stop
+      def execute_redemption id
+        Recognition::Database.redeem id, bucket, self.class.to_s.downcase, self.code, self.amount.to_i
       end
-    
     end
   end
 end

data/lib/recognition/version.rb

@@ -1,4 +1,4 @@
 module Recognition
   # Current Version
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recognition
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -146,6 +146,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/recognition/gift_generator.rb
 - lib/generators/recognition/install_generator.rb
 - lib/generators/recognition/templates/recognition.rb
 - lib/generators/recognition/templates/recognition.yml
@@ -159,6 +160,7 @@ files:
 - lib/recognition/models/gift.rb
 - lib/recognition/models/recognizable.rb
 - lib/recognition/models/recognizer.rb
+- lib/recognition/models/redeemable.rb
 - lib/recognition/models/voucher.rb
 - lib/recognition/parser.rb
 - lib/recognition/rails/engine.rb
@@ -183,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4080240542959513995
+      hash: 2026242214967045348
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -192,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4080240542959513995
+      hash: 2026242214967045348
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23