scorecard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d64b389e1a10a193f8d53fb445000f19b15b3c8
+  data.tar.gz: 426aaad02a63b1c11904ff53f4a8f4795f895e25
+SHA512:
+  metadata.gz: 1de862ba8ae7f660ec7b39e03d045f676c9f5658f1057d2768562cc764c7f430632bf3be98a91d4189253c92573f8309c36545ed0a3c85b9884dac61b16bf82c
+  data.tar.gz: 754029cc38373c33d8a3487093f3988688fbfdeec2b0dfb44e4d3dbdb88acaa01111efcec7756729b212bb89a780a4656d5227b02b19f5f37e5b5e3dd9f5355a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/internal/db/*.sqlite
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  campfire:
+    rooms:
+      - secure: "nK5kN3xf43qNUzQ2e+3hCD1Iy/XzqMS1EOm1aDyvbi1nv4xHD7ZkKTRgFAPYGJj/SpuSkIlWbFybYUfeGe9SVrg9/C70vlNmmuNkK2YV106qd5IemB65qzVb35yU7kyF84u5/kAHg8EdWfXsBYxB6KoXJoql1lGCYQMaH0L6Rb8="
+    on_success: change
+    on_failure: change

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Inspire9 and Pat Allan
+
+MIT License
+
+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.md

@@ -0,0 +1,68 @@
+# Scorecard
+
+A Rails engine for tracking points, badges and levels for gamification.
+
+For anyone who comes across this, please note this is not yet feature complete, and the API will very likely change.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scorecard'
+
+Don't forget to bundle:
+
+    $ bundle
+
+Then, add the migrations to your app and update your database accordingly:
+
+    $ rake scorecard:install:migrations db:migrate
+
+## Rules
+
+In an initializer, define the events that points are tied to - with a unique context and the number of points:
+
+```ruby
+Scorecard::PointRule.new :new_post, 50
+```
+
+You can also provide a block with logic for whether to award the points, the maximum number of points allowed to be awarded for this rule, and the timeframe for that limit:
+
+```ruby
+Scorecard::PointRule.new :new_post, 50, limit: 100, timeframe: :day,
+  if: lambda { |payload| payload[:user].posts.count <= 1 }
+```
+
+The payload object contains the context plus every option you send through to `score` call (see below).
+
+## Scoring
+
+And then, when you want to fire those events, use code much like the following:
+
+```ruby
+Scorecard::Points.score :new_post, gameable: post
+```
+
+This presumes that the user the points are for is a method on the gameable object. If that's not the case, you can pass in a custom user:
+
+```ruby
+Scorecard::Points.score :new_post, gameable: post, user: user
+```
+
+If you're using Sidekiq, you can push the scoring behaviour into a background worker using `score_async` instead. Make sure `scorecard` is listed below `sidekiq` in your `Gemfile`.
+
+```ruby
+Scorecard::Points.score_async :new_post, gameable: post
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Licence
+
+Copyright (c) 2013, Scorecard is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/app/models/scorecard/point.rb

@@ -0,0 +1,25 @@
+class Scorecard::Point < ActiveRecord::Base
+  self.table_name = 'scorecard_points'
+
+  belongs_to :user,     polymorphic: true
+  belongs_to :gameable, polymorphic: true
+
+  validates :context,    presence: true
+  validates :identifier, presence: true, uniqueness: {
+    scope: [:context, :user_type, :user_id]
+  }
+  validates :amount,     presence: true
+  validates :user,       presence: true
+
+  def self.for_user(context, user)
+    where(
+      context:   context,
+      user_id:   user.id,
+      user_type: user.class.name
+    )
+  end
+
+  def self.for_user_in_timeframe(context, user, timeframe)
+    for_user(context, user).where(created_at: timeframe)
+  end
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/db/migrate/1_create_points.rb

@@ -0,0 +1,21 @@
+class CreatePoints < ActiveRecord::Migration
+  def change
+    create_table :scorecard_points do |table|
+      table.string  :context,       null: false
+      table.string  :identifier,    null: false
+      table.integer :amount,        null: false
+      table.string  :user_type,     null: false
+      table.integer :user_id,       null: false
+      table.string  :gameable_type
+      table.integer :gameable_id
+      table.timestamps
+    end
+
+    add_index :scorecard_points, :context
+    add_index :scorecard_points, :identifier
+    add_index :scorecard_points, [:user_type, :user_id]
+    add_index :scorecard_points, [:gameable_type, :gameable_id]
+    add_index :scorecard_points, [:context, :identifier, :user_type, :user_id],
+      unique: true, name: :unique_points
+  end
+end

data/lib/scorecard.rb

@@ -0,0 +1,16 @@
+module Scorecard
+  def self.configure
+    yield self
+  end
+
+  def self.rules
+    @rules ||= Scorecard::Rules.new
+  end
+end
+
+require 'scorecard/engine'
+require 'scorecard/points'
+require 'scorecard/point_rule'
+require 'scorecard/rules'
+require 'scorecard/subscriber'
+require 'scorecard/worker' if defined?(Sidekiq)

data/lib/scorecard/engine.rb

@@ -0,0 +1,7 @@
+class Scorecard::Engine < Rails::Engine
+  engine_name :scorecard
+
+  initializer :scorecard do |app|
+    Scorecard::Subscriber.attach_to :scorecard
+  end
+end

data/lib/scorecard/point_rule.rb

@@ -0,0 +1,46 @@
+class Scorecard::PointRule
+  TIMESPANS = [:day, :week, :month, :year]
+
+  attr_accessor :context, :amount, :options
+
+  def initialize(context, amount, options = {})
+    @context, @amount, @options = context, amount, options
+  end
+
+  def allowed?(payload)
+    if limit
+      return false unless current_points(payload).sum(:amount) < limit
+    elsif timeframe
+      return false unless current_points(payload).count.zero?
+    end
+
+    options[:if].nil? || options[:if].call(payload)
+  end
+
+  private
+
+  def current_points(payload)
+    if timeframe.nil?
+      Scorecard::Point.for_user(payload[:context], payload[:user])
+    else
+      Scorecard::Point.for_user_in_timeframe(payload[:context], payload[:user], time_range)
+    end
+  end
+
+  def limit
+    options[:limit]
+  end
+
+  def timeframe
+    options[:timeframe]
+  end
+
+  def time_range
+    unless TIMESPANS.include? timeframe
+      raise ArgumentError, "Unknown timeframe argument #{timeframe.inspect}"
+    end
+
+    now = Time.zone.now
+    now.send("beginning_of_#{timeframe}")..now.send("end_of_#{timeframe}")
+  end
+end

data/lib/scorecard/points.rb

@@ -0,0 +1,18 @@
+class Scorecard::Points
+  def self.score(context, options)
+    ActiveSupport::Notifications.instrument 'points.scorecard',
+      options.merge(context: context)
+  end
+
+  def self.score_async(context, options)
+    [:gameable, :user].each do |prefix|
+      next unless options[prefix]
+
+      options["#{prefix}_id"]   = options[prefix].id
+      options["#{prefix}_type"] = options[prefix].class.name
+      options.delete prefix
+    end
+
+    Scorecard::Worker.perform_async context, options.stringify_keys
+  end
+end

data/lib/scorecard/rules.rb

@@ -0,0 +1,19 @@
+class Scorecard::Rules
+  attr_reader :point_rules
+
+  def initialize
+    @point_rules = []
+  end
+
+  def add_rule_for_points(context, amount, options = {})
+    point_rules << Scorecard::PointRule.new(context, amount, options)
+  end
+
+  def find_rule_for_points(context)
+    point_rules.detect { |rule| rule.context == context }
+  end
+
+  def clear
+    point_rules.clear
+  end
+end

data/lib/scorecard/subscriber.rb

@@ -0,0 +1,29 @@
+class Scorecard::Subscriber
+  def self.attach_to(suffix)
+    subscriber = new
+    subscriber.public_methods(false).each do |event|
+      next if event.to_s == 'call'
+
+      ActiveSupport::Notifications.subscribe "#{event}.#{suffix}", subscriber
+    end
+  end
+
+  def call(message, *args)
+    method = message.split('.').first
+    send method, ActiveSupport::Notifications::Event.new(message, *args)
+  end
+
+  def points(event)
+    rule = Scorecard.rules.find_rule_for_points event.payload[:context]
+
+    event.payload[:amount]     ||= rule.amount
+    event.payload[:identifier] ||= event.payload[:gameable].id
+    event.payload[:user]       ||= event.payload[:gameable].user
+
+    return unless rule && rule.allowed?(event.payload)
+
+    Scorecard::Point.create(
+      event.payload.slice(:context, :amount, :identifier, :user, :gameable)
+    )
+  end
+end

data/lib/scorecard/worker.rb

@@ -0,0 +1,14 @@
+class Scorecard::Worker
+  include Sidekiq::Worker
+
+  def perform(context, options)
+    %w(gameable user).each do |prefix|
+      next unless options["#{prefix}_type"]
+
+      klass = options.delete("#{prefix}_type").constantize
+      options[prefix] = klass.find options.delete("#{prefix}_id")
+    end
+
+    Scorecard::Points.score context.to_sym, options.symbolize_keys
+  end
+end

data/scorecard.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'scorecard'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = 'Rails Engine for common scorecard patterns'
+  spec.description   = 'Use an engine to track points, badges and levels in your Rails app.'
+  spec.homepage      = 'https://github.com/inspire9/scorecard'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'rspec-rails', '~> 2.14.0'
+  spec.add_development_dependency 'sidekiq',     '~> 2.15'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
+end

data/spec/acceptance/points_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe 'Scorecard' do
+  before :each do
+    Scorecard.rules.clear
+  end
+
+  it "stores points for configured behaviour" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_post, 50
+    end
+
+    user = User.create!
+    post = Post.create! user: user
+
+    Scorecard::Point.where(
+      context:       'new_post',
+      amount:        50,
+      identifier:    post.id.to_s,
+      user_id:       user.id,
+      user_type:     'User',
+      gameable_id:   post.id,
+      gameable_type: 'Post'
+    ).should_not be_empty
+  end
+
+  it "only stores points when provided logic passes" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_post, 50,
+        if: lambda { |payload| Post.count <= 1 }
+    end
+
+    user = User.create!
+    post = Post.create! user: user
+    post = Post.create! user: user
+
+    Scorecard::Point.where(
+      context: 'new_post',
+      amount:  50
+    ).count.should == 1
+  end
+
+  it "does not double-up on points for the same event" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_post, 50
+    end
+
+    user = User.create!
+    post = Post.create! user: user
+    Scorecard::Points.score :new_post, gameable: post
+
+    Scorecard::Point.where(
+      context:       'new_post',
+      amount:        50,
+      identifier:    post.id.to_s,
+      user_id:       user.id,
+      user_type:     'User',
+      gameable_id:   post.id,
+      gameable_type: 'Post'
+    ).count.should == 1
+  end
+
+  it "respects limit options" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_post, 50, limit: 100
+    end
+
+    user = User.create!
+    post = Post.create! user: user
+    post = Post.create! user: user
+    post = Post.create! user: user
+
+    Scorecard::Point.where(
+      context: 'new_post',
+      amount:  50
+    ).count.should == 2
+  end
+
+  it "respects timeframe options" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_post, 50, timeframe: :day
+    end
+
+    user = User.create!
+    post = Post.create! user: user
+    post = Post.create! user: user
+
+    Scorecard::Point.where(
+      context: 'new_post',
+      amount:  50
+    ).count.should == 1
+  end
+
+  it "allows for processing via Sidekiq" do
+    Scorecard.configure do |config|
+      config.rules.add_rule_for_points :new_user, 20
+    end
+
+    user = User.create!
+    Scorecard::Points.score_async :new_user, gameable: user, user: user
+
+    Scorecard::Point.where(
+      context:       'new_user',
+      amount:        20,
+      identifier:    user.id.to_s,
+      user_id:       user.id,
+      user_type:     'User',
+      gameable_id:   user.id,
+      gameable_type: 'User'
+    ).should_not be_empty
+  end
+end

data/spec/internal/app/models/post.rb

@@ -0,0 +1,7 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  after_create lambda { |post|
+    Scorecard::Points.score :new_post, gameable: post
+  }
+end

data/spec/internal/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  #
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define do
+  create_table :posts, :force => true do |table|
+    table.string  :subject
+    table.text    :content
+    table.integer :user_id
+    table.timestamps
+  end
+
+  create_table :users, :force => true do |table|
+    table.string :email
+    table.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+
+Bundler.setup :default, :development
+
+require 'combustion'
+require 'sidekiq'
+require 'sidekiq/testing/inline'
+require 'scorecard'
+
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+
+Dir["./spec/support/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: scorecard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+description: Use an engine to track points, badges and levels in your Rails app.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/scorecard/point.rb
+- config.ru
+- db/migrate/1_create_points.rb
+- lib/scorecard.rb
+- lib/scorecard/engine.rb
+- lib/scorecard/point_rule.rb
+- lib/scorecard/points.rb
+- lib/scorecard/rules.rb
+- lib/scorecard/subscriber.rb
+- lib/scorecard/worker.rb
+- scorecard.gemspec
+- spec/acceptance/points_spec.rb
+- spec/internal/app/models/post.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+homepage: https://github.com/inspire9/scorecard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.2
+signing_key: 
+specification_version: 4
+summary: Rails Engine for common scorecard patterns
+test_files:
+- spec/acceptance/points_spec.rb
+- spec/internal/app/models/post.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb