recognition 0.5.0 → 0.6.0

data/README.md

@@ -12,7 +12,6 @@ A fully-fledged reward system for Rails 3.1+.
 
 *  [Installation](#Installation)
 *  [Usage](#usage)
-*  [Examples](#example)
 *  [Wiki](https://github.com/rayasocialmedia/recognition/wiki)
 *  [Code Documentation](http://rubydoc.info/gems/recognition/frames)
 *  [Changelog](https://raw.github.com/rayasocialmedia/recognition/master/CHANGELOG.txt)
@@ -104,33 +103,33 @@ This one will:
 
 ### Vouchers
 
-    Use an existing model or generate a new one using:
+Use an existing model or generate a new one using:
 
-        $ rails generate recogintion:voucher
+    $ rails generate recogintion:voucher
 
-    Your model might have the following attributes:
+Your model might have the following attributes:
 
-    *  `:code` **required**
-    *  `:amount` **required**
-    *  `:expires_at` _optional_
-    *  `:reusable` _optional_
+*  `:code` **required**
+*  `:amount` **required**
+*  `:expires_at` _optional_
+*  `:reusable` _optional_
 
-    You can specify the following extra parameters for vouchers:
+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.
+* `: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/voucher.rb:
 
-        class Voucher < ActiveRecord::Base
-          attr_accessible :code, :amount, :expires_at, :reusable
-            acts_as_voucher code_length: 14
-        end
+    class Voucher < ActiveRecord::Base
+      attr_accessible :code, :amount, :expires_at, :reusable
+        acts_as_voucher code_length: 14
+    end
 
-    Then, you may do:
+Then, you may do:
 
-        voucher = Voucher.create!(amount: 20, expires_at: (DateTime.now + 1.day), reusable: true)
-        voucher.redeem current_user
+    voucher = Voucher.create!(amount: 20, expires_at: (DateTime.now + 1.day), reusable: true)
+    voucher.redeem current_user
 
 ### Gifts
 

data/lib/generators/recognition/templates/recognition.rb

@@ -3,4 +3,5 @@ rails_env = Rails.env || 'development'
 
 Recognition.setup do |config|
   config.redis = YAML.load_file("#{ rails_root.to_s }/config/recognition.yml")[Rails.env.to_s]
+  config.debug = false
 end

data/lib/recognition.rb

@@ -11,6 +11,10 @@ module Recognition
   # Redis Db connection parameters
   @@redis = 'localhost:6378'
 
+  mattr_accessor :debug
+  # Show debugging messages in log
+  @@debug = false
+
   mattr_accessor :backend
   # Redis Db active connection
   @@backend = nil

data/lib/recognition/database.rb

@@ -26,7 +26,6 @@ module Recognition
     end
     
     def self.update_points object, action, condition
-      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])
       # Do we have a valid user?

data/lib/recognition/logger.rb

@@ -16,7 +16,7 @@ module Recognition
 
     def logging? #:nodoc:
       # TODO: Add an option to toggle logging
-      false
+      Recognition.debug
     end
   end
 end

data/lib/recognition/models/redeemable.rb

@@ -2,9 +2,10 @@ module Recognition
   module Models
     module Redeemable
       def regenerate_code
+        self.class.recognitions[:code_length] = 10 if self.class.recognitions[:code_length].nil?
         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
+        l = (self.class.recognitions[:code_length] - (prefix.length + suffix.length))
         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
@@ -24,11 +25,14 @@ module Recognition
         # default: not redeemable
         pass = false
         # only check if the redeemable did not expire
-        unless expired?
+        if expired?
+          Recognition.log self.class.to_s.downcase.to_sym, "validation error for #{self.class.to_s}##{self.id}: expired"
+        else
           # 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
+              Recognition.log self.class.to_s.downcase.to_sym, "validation error for #{self.class.to_s}##{self.id}: user has already redeemed the voucher"
               pass = false
               # is the redeemable reusable?
             elsif defined?(self.reusable?) && self.reusable?
@@ -50,7 +54,7 @@ module Recognition
               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}"
+                  Recognition.log self.class.to_s.downcase.to_sym, "validation error for #{self.class.to_s}##{self.id}: custom validation error"
                   return
                 end
               end
@@ -58,6 +62,8 @@ module Recognition
             # If all went well:
             execute_redemption recognizable.id
           end
+        else
+          Recognition.log self.class.to_s.downcase.to_sym, "validation error for #{self.class.to_s}##{self.id}: amount is nil"
         end
       end
       

data/lib/recognition/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recognition
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2026242214967045348
+      hash: 2674790401115674200
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2026242214967045348
+      hash: 2674790401115674200
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23