activerecord-reputation-system 1.0.0

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,255 @@
+## Active Record Reputation System  [![Build Status](https://secure.travis-ci.org/twitter/activerecord-reputation-system.png)](http://travis-ci.org/twitter/activerecord-reputation-system)
+
+The Active Record Reputation System helps you discover more about your application and make better decisions. The Reputation System gem makes it easy to integrate reputation systems into Rails applications, decouple the system from the main application and provide guidelines for good design of reputation systems.
+
+## Concept
+
+In this gem, the reputation system is described as a network of reputations where updates are triggered by evaluations and reputation values are computed and propagated by the network. In this network, reputations with values directly computed from evaluations are called primary reputations and reputations with values indirectly computed from evaluations are called non-primary reputations. The following is an abstract view of a possible Reputation System:
+
+![Alt text](./activerecord-reputation-system/raw/master/abs_rs.png "Abstract view of Reputation System")
+
+## Installation
+
+`gem install reputation_system && rails generator reputation_system && rake db:migrate`
+
+## Usage Example
+
+Let's say we want to keep track of user karma in Q&A site where user karma is sum of questioning skill and answering skill. Questioning skill is sum of votes for user's questions and Answering skill is sum of average rating of user's answers. This can be defined as follow:
+```ruby
+class User < ActiveRecord::Base
+  has_many :answers
+  has_many :questions
+
+  has_reputation :karma,
+      :source => [
+          { :reputation => :questioning_skill, :weight => 0.8 },
+          { :reputation => :answering_skill }],
+      aggregated_by => :sum
+
+  has_reputation :questioning_skill,
+      :source => { :reputation => :votes, :of => :questions },
+      :aggregated_by => :sum
+
+  has_reputation :answering_skill,
+      :source => { :reputation => :avg_rating, :of => :answers },
+      :aggregated_by => :sum
+end
+
+class Answer < ActiveRecord::Base
+  belongs_to :user, :as => :author
+
+  has_reputation :avg_rating,
+      :source => :user,
+      :aggregated_by => :average,
+      :source_of => [{ :reputation => :answering_skill, :of => :author }]
+end
+
+
+class Question < ActiveRecord::Base
+  belongs_to :user
+
+  has_reputation :votes,
+      :source => :user,
+      :aggregated_by => :sum
+end
+```
+
+Once reputation system is defined, evaluations for answers and questions can be added as follow:
+```ruby
+@answer.add_evaluation(:avg_rating, 3, @user)
+@question.add_evaluation(:votes, 1, @user)
+```
+
+Reputation value can be accessed as follow:
+```ruby
+@answer.reputation_value_for(:avg_rating)
+@question.reputation_value_for(:votes)
+@user.reputation_value_for(:karma)
+```
+
+## Defining Reputation System
+
+All reputations can be defined in their target ActiveRecord models like this:
+```ruby
+# Primary Reputation
+has_reputation  :name,
+        :source => source,
+        :aggregated_by => process,
+        :source_of => [{:reputation => name, :of => attribute}, ...],
+        :init_value => initial_value
+
+# Non Primary Reputation
+has_reputation  :name,
+        :source => [{:reputation => name, :of => attribute, :weight => weight}, ...],
+        :aggregated_by => process,
+        :source_of => [{:reputation => name, :of => attribute}, ...],
+        :init_value => initial_value
+```
+* :name is the name of the reputation.
+* :source is a source of the reputation. If it is primary reputation, it takes a class name as input. If it's a non-primary reputation, it takes one or more source definitions, which consist of:
+** :reputation - name of reputation to be used as a source.
+** :of - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
+** :weight (optional) - weight value to be used for aggregation (default: 1).
+* :aggregated_by is a mathematical process to be used to aggregate reputation or evaluation values. The following processes are available (each value is weighted by a predefined weight):
+** average - averages all values received.
+** sum - sums up all the values received.
+** product - multiplies all the values received.
+* :source_of (optional) - just like active record association, you don't need to define this if a name can be derived from class name; otherwise if the reputation is used as a part of a source belonging to other reputations, you must define. It takes one or more source definitions, which consists of:
+** :reputation - name of the reputation to be used as a source.
+** :of - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
+* :init_value (optional) - initial reputation value assigned to new reputation. It is 0 for average and sum process and 1 for product by default.
+
+## Evaluation
+```ruby
+# Adds an evaluation to the reputation with the specified name.
+add_evaluation(reputation_name, evaluation_value, source)
+
+# Updates an existing evaluation of the reputation with the specified name by the specified source.
+update_evaluation(reputation_name, evaluation_value, source)
+
+# Adds an evaluation to the reputation with the specified name if it exists; otherwise it updates the existing reputation.
+add_or_update_evaluation(reputation_name, evaluation_value, source)
+
+# Deletes an evaluation from the reputation with the specified name submitted by the specified source. It returns nil if it does not exist.
+delete_evaluation(reputation_name, source)
+
+# Deletes an evaluation from the reputation with the specified name submitted by specified source. Raises an exception if it does not exist.
+delete_evaluation!(reputation_name, source)
+```
+
+## Reputation
+```ruby
+# Returns the reputation value of the reputation with the given name.
+reputation_value_for(reputation_name)
+
+# Returns the reputation rank of the reputation with the given name.
+rank_for(reputation_name)
+
+# Returns the normalized reputation value of the reputation with the given name. The normalization is computed using the following equation (assuming linear distribution):
+# normalized_value = (x - min) / (max - min) if max - min&nbsp;is not 0
+# normalized_value = 1 if max - min is 0
+normalized_reputation_value_for(reputation_name)
+
+# Activates all reputations in the record. Active reputations are used when computing ranks or normalized reputation values.
+activate_all_reputations
+
+# Deactivates all reputations in the record. Inactive reputations are not used when computing ranks or normalized reputation values.
+deactivate_all_reputations
+
+# Checks if reputation is active.
+reputations_activated?(reputation_name)
+```
+
+## Querying with Reputation
+```ruby
+# Includes the specified reputation value for the given name via a normal Active Record find query.
+ActiveRecord::Base.find_with_reputation(reputation_name, find_scope, options)
+# For example:
+ActiveRecord::Base.find_with_reputation(:maturity, :all, {:select => "id", :conditions => ["maturity > ?", 3], :order => "maturity"})
+
+# Includes the specified normalized reputation value for the given name via a normal Active Record find query.
+ActiveRecord::Base.find_with_normalized_reputation(reputation_name, find_options)
+# For example:
+ActiveRecord::Base.find_with_normalized_reputation(:maturity, :all, {:select => "id", :conditions => ["maturity > ?", 3], :order => "maturity"})
+
+# Includes the specified reputation value for the given name via a normal Active Record count query.
+ActiveRecord::Base.count_with_reputation(reputation_name, find_options)
+
+# This method returns a SQL statement rather than a query result.
+ActiveRecord::Base.find_with_reputation_sql(reputation_name, find_options)
+```
+
+## Advanced Topics
+### Scope
+Reputations can have different scopes to provide additional context.
+
+For example, let's say `question` has a reputation called `difficulty`.  You might want to keep track of that reputation by country, such that each question has a different difficulty rating in each country.
+
+Scopes can be defined like this:
+```ruby
+has_reputation :name,
+    ...
+    :scopes => [:scope1, :scope2, ...]
+```
+Once scopes are defined, evaluations can be added in the context of defined scopes:
+```ruby
+add_evaluation(:reputation_name, :scope)
+```
+Also, reputations can be accessed in the context of scopes:
+```ruby
+reputation_value_for(:reputation_name, :scope)
+```
+To use a scoped reputation as a source in another reputation, try this:
+```ruby
+has_reputation :rep1,
+    :source => {:reputation => :rep2, :scope => :scope1}
+    ...
+has_reputation :rep2,
+    ...
+    :scopes => [:scope1, :scope2, ...],
+    :source_of => {:reputation => :rep1, :defined_for_scope => [:scope1]}
+```
+To execute an Active Record query using a scoped reputation, try this:
+```ruby
+ActiveRecord::Base.find_with_reputation(:reputation_name, :scope, :find_options)
+```
+There are a few more helper methods available for scopes:
+```ruby
+# Allows you to add a scope dynamically.
+add_scope_for(reputation_name, scope)
+
+# Returns true if the reputation has scopes.
+has_scopes?(reputation_name)
+
+# Returns true if the reputation has a given scope.
+has_scope?(reputation_name, scope)
+```
+
+### Performance
+
+For applications with large data set, computation of reputation values can be expensive. Therefore, it is common to perform the computation asynchronously (in batch). If you wish to asynchronously compute reputation values, I strongly recommend you to use [collectiveidea's Delayed Job](https://github.com/collectiveidea/delayed_job). For example:
+
+```ruby
+class User < ActiveRecord
+  has_reputation :karma,
+    :source => :user,
+    :aggregated_by => :sum
+
+  handle_asynchronously :add_evaluation
+  handle_asynchronously :update_evaluation
+  handle_asynchronously :delete_evaluation
+end
+```
+
+### Reflect Past Data
+
+If you wish to reflect past data into new reputation system, I recommend you write a script which simulates all evaluations that would have happened in the past. You probably want to use [collectiveidea's Delayed Job](https://github.com/collectiveidea/delayed_job) to enqueue those past evaluation tasks first and then new ongoing evaluation task so that evaluations are performed in proper time sequence.
+
+## Running Tests
+
+`rake` should do the trick. Tests are written in RSpec.
+
+## Versioning
+
+For transparency and insight into our release cycle, releases will be numbered with the follow format:
+
+`<major>.<minor>.<patch>`
+
+And constructed with the following guidelines:
+
+* Breaking backwards compatibility bumps the major
+* New additions without breaking backwards compatibility bumps the minor
+* Bug fixes and misc changes bump the patch
+
+For more information on semantic versioning, please visit http://semver.org/.
+
+## Authors
+
+* Katsuya Noguchi: http://github.com/katsuyan
+* Inspired by ["Building Web Reputation Systems" by Randy Farmer and Bryce Glass](http://shop.oreilly.com/product/9780596159801.do)
+
+## License
+
+Copyright 2012 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rdoc/task'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :rspec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = ['--color']
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+spec = Gem::Specification.load("#{File.dirname(__FILE__)}/activerecord-reputation-system.gemspec")
+
+desc "Package gem."
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end