gamifier 1.0.3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gamifier.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Cyril Rohr
+
+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,60 @@
+# Gamifier
+
+This gem abstracts the Badgeville API behind high level concepts such as
+user, player, activities, rewards, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gamifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamifier
+
+## Usage
+
+Configure Gamifier with the right parameter for the API you're using:
+
+    Gamifier.set :key => "1234", :uri => "http://sandbox.v2.badgeville.com/api/berlin/"
+
+Then here is an example usage to credit an existing player:
+
+    Gamifier.engine do |engine|
+      player = engine.players.find_by_site_and_email('my-site.com', '1234@dimelo-badges.com')
+      player.credit('visit', :url => "http://server.ltd/page.html", :other_key => "value")
+    end
+
+See the `examples/` directory for examples on how to use the DSL to
+declare activities, rewards and missions, and you can execute a DSL as
+follows:
+
+    BADGEVILLE_KEY=xzy bundle exec ruby -I lib examples/dev.rb
+
+## Tests
+
+Run the unit tests with:
+
+    bundle exec spec spec/unit
+
+Run the integration tests as follows:
+
+    BADGEVILLE_KEY=1234 bundle exec spec spec/integration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Authors
+
+* Cyril Rohr <cyril.rohr@gmail.com>

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/dev.rb

@@ -0,0 +1,186 @@
+require 'gamifier'
+require 'json'
+
+Gamifier.set :uri => "http://sandbox.v2.badgeville.com/api/berlin/", :key => ENV.fetch('BADGEVILLE_KEY')
+Gamifier.logger.level = Logger::DEBUG
+
+network = Gamifier.dsl do
+  site 'dev2.domain-test.crohr.me' do |site|
+    set :url, 'dev2.domain-test.crohr.me'
+
+    unit :karma do
+      set :label, 'Karma'
+      set :abbreviation, 'kar'
+    end
+
+    behavior 'visit' do
+      set :description, "visit"
+      set :selector, {
+        :verb => 'visit'
+      }
+
+      set :enable_count_limiting, false
+      set :enable_rate_limiting, false
+
+      set :hide_in_widgets, true
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+
+    behavior 'signin' do
+      set :description, "signin"
+      set :selector, {
+        :verb => 'signin'
+      }
+
+      set :enable_count_limiting, false
+      set :enable_rate_limiting, true
+      set :bucket_max_capacity, 2
+      set :bucket_drain_rate, bucket_max_capacity/1.5
+
+      set :hide_in_widgets, false
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+
+    behavior 'comment' do
+      set :description, "new comment"
+      set :selector, {
+        :verb => 'comment'
+      }
+      set :adjustment, {
+        :points => 1, :karma => 1
+      }
+
+      set :enable_count_limiting, false
+      # set :limit_per_player, 20
+
+      set :enable_rate_limiting, true
+      set :bucket_max_capacity, 2
+      set :bucket_drain_rate, bucket_max_capacity/1.5
+
+      set :hide_in_widgets, false
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+
+    # behavior 'comment_databases' do
+    #   set :description, "new comment in category databases"
+    #   set :selector, {
+    #     :verb => 'comment',
+    #     :category_slug => 'databases'
+    #   }
+    #   set :adjustment, {
+    #     :points => 1, :karma => 1
+    #   }
+    # 
+    #   set :enable_count_limiting, true
+    #   set :limit_per_player, 10
+    #   set :limit_field_scope, 'category_id'
+    # 
+    #   set :enable_rate_limiting, true
+    #   set :bucket_max_capacity, 2
+    #   set :bucket_drain_rate, bucket_max_capacity/1.5
+    # 
+    #   set :hide_in_widgets, false
+    #   set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    # end
+
+    r_member = reward 'member' do
+      set :reward_template, {
+        :message => "Congrats, you signed in for the first time!"
+      }
+      set :components, [
+        {:command => "count", :comparator => 1, :where => {:verb => 'signin', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 2
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+    
+    r_active_member = reward 'active member' do
+      set :reward_template, {
+        :message => "Looks like you like the site, thank you and keep up on being active on the site!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'signin', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 5
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    r_commenter = reward 'commenter' do
+      set :reward_template, {
+        :message => "Congrats, you commented on something!"
+      }
+      set :components, [
+        {:command => "count", :comparator => 1, :where => {:verb => 'comment', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 1
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+    
+    r_active_commenter = reward 'active commenter' do
+      set :reward_template, {
+        :message => "You have commented more than 3 times in any category!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'comment', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 3
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    r_db_commenter = reward 'database commenter' do
+      set :reward_template, {
+        :message => "You have commented more than 3 times in the database category!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'comment', :player_id => "%player_id", :category_slug => "database"}}
+      ]
+      set :adjustment, {
+        :points => 3
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    mission 'community member' do
+      # allow a player to complete this mission more than once?
+      set :repeatable, false
+      set :active, true
+      # give points and reward upon completing mission? (This is required for track progression)
+      set :enable_rewards, true
+      # points and secondary units to award when completing a mission
+      set :adjustment, {
+        :points => 10
+      }
+      set :reward_definition_ids do [r_active_commenter._id, r_db_commenter._id] end
+    end
+    # reward 'top commenter' do
+    #   set :reward_template, {
+    #     :message => "Congrats!"
+    #   }
+    #   set :components, [
+    #     {:command => "count", :comparator => 1, :where => {:verb => 'comment', :player_id => "%player_id"}},
+    #     # the first player who performs at least twice the 'new_question' behaviour
+    #     {:command => "count", :comparator => {"$gt" => 2}, :where => {:verb => 'new_question', :site_id => "%site_id"}}
+    #   ]
+    #   set :adjustment, {
+    #     :points => 5
+    #   }
+    #   set :active, true
+    #   set :allow_duplicates, false
+    # end
+  end
+end
+
+network.save!

data/examples/preprod.rb

@@ -0,0 +1,218 @@
+require 'gamifier'
+require 'json'
+
+Gamifier.set :uri => "http://sandbox.v2.badgeville.com/api/berlin/", :key => ENV.fetch('BADGEVILLE_KEY')
+Gamifier.logger.level = Logger::INFO
+
+network = Gamifier.dsl do
+  site 'preprod.domain-test.crohr.me' do
+    set :url, 'preprod.domain-test.answers.crohr.me'
+
+    unit :karma do
+      set :label, 'Karma'
+      set :abbreviation, 'kar'
+    end
+
+    behavior 'visit' do
+      set :description, "visit"
+      set :selector, {
+        :verb => 'visit'
+      }
+
+      set :enable_count_limiting, false
+      set :enable_rate_limiting, false
+
+      set :hide_in_widgets, true
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+
+    behavior 'signin' do
+      set :description, "signin"
+      set :selector, {
+        :verb => 'signin'
+      }
+
+      set :enable_count_limiting, false
+      set :enable_rate_limiting, true
+      set :bucket_max_capacity, 2
+      set :bucket_drain_rate, bucket_max_capacity/1.5
+
+      set :hide_in_widgets, false
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+
+    behavior 'comment' do
+      set :description, "new comment"
+      set :selector, {
+        :verb => 'comment'
+      }
+      set :adjustment, {
+        :points => 1, :karma => 1
+      }
+
+      set :enable_count_limiting, false
+      # set :limit_per_player, 20
+
+      set :enable_rate_limiting, true
+      set :bucket_max_capacity, 2
+      # max capacity (i.e. max number of times the behavior is
+      # performed) per number of hours.
+      set :bucket_drain_rate, bucket_max_capacity/1.5
+
+      set :hide_in_widgets, false
+      set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    end
+    
+    
+    behavior 'ask' do
+      set :description, "ask a question"
+      set :selector, {
+        :verb => 'ask'
+      }
+
+      set :enable_count_limiting, false
+      set :enable_rate_limiting, true
+      set :bucket_max_capacity, 2
+      set :bucket_drain_rate, bucket_max_capacity/1.5
+
+      set :hide_in_widgets, false
+    end
+
+    # behavior 'comment_databases' do
+    #   set :description, "new comment in category databases"
+    #   set :selector, {
+    #     :verb => 'comment',
+    #     :category_slug => 'databases'
+    #   }
+    #   set :adjustment, {
+    #     :points => 1, :karma => 1
+    #   }
+    # 
+    #   set :enable_count_limiting, true
+    #   set :limit_per_player, 10
+    #   set :limit_field_scope, 'category_id'
+    # 
+    #   set :enable_rate_limiting, true
+    #   set :bucket_max_capacity, 2
+    #   set :bucket_drain_rate, bucket_max_capacity/1.5
+    # 
+    #   set :hide_in_widgets, false
+    #   set :icon, "http://s3.amazonaws.com/icons/icon1.png"
+    # end
+
+    r_member = reward 'member' do
+      set :reward_template, {
+        :message => "Congrats, you signed in for the first time!"
+      }
+      set :components, [
+        {:command => "count", :comparator => 1, :where => {:verb => 'signin', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 2
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+    
+    r_active_member = reward 'active member' do
+      set :reward_template, {
+        :message => "Looks like you like the site, thank you and keep up on being active on the site!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'signin', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 5
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    r_reader = reward 'reader' do
+      set :reward_template, {
+        :message => "You've read more than 10 pages!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 10}, :where => {:verb => 'visit', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 3
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    r_commenter = reward 'commenter' do
+      set :reward_template, {
+        :message => "Congrats, you commented on something!"
+      }
+      set :components, [
+        {:command => "count", :comparator => 1, :where => {:verb => 'comment', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 1
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+    
+    r_active_commenter = reward 'active commenter' do
+      set :reward_template, {
+        :message => "You have commented more than 3 times in any category!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'comment', :player_id => "%player_id"}}
+      ]
+      set :adjustment, {
+        :points => 3
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    r_courrier_commenter = reward 'courrier commenter' do
+      set :reward_template, {
+        :message => "You have commented more than 3 times in the courrier category!"
+      }
+      set :components, [
+        {:command => "count", :comparator => {"$gt" => 3}, :where => {:verb => 'comment', :player_id => "%player_id", :category_slug => "courrier"}}
+      ]
+      set :adjustment, {
+        :points => 3
+      }
+      set :active, true
+      set :allow_duplicates, false
+    end
+
+    mission 'community member' do
+      # allow a player to complete this mission more than once?
+      set :repeatable, false
+      set :active, true
+      # give points and reward upon completing mission? (This is required for track progression)
+      set :enable_rewards, true
+      # points and secondary units to award when completing a mission
+      set :adjustment, {
+        :points => 10
+      }
+      set :reward_definition_ids do [r_active_commenter._id, r_db_commenter._id] end
+    end
+
+    # reward 'top commenter' do
+    #   set :reward_template, {
+    #     :message => "Congrats!"
+    #   }
+    #   set :components, [
+    #     {:command => "count", :comparator => 1, :where => {:verb => 'comment', :player_id => "%player_id"}},
+    #     # the first player who performs at least twice the 'new_question' behaviour
+    #     {:command => "count", :comparator => {"$gt" => 2}, :where => {:verb => 'new_question', :site_id => "%site_id"}}
+    #   ]
+    #   set :adjustment, {
+    #     :points => 5
+    #   }
+    #   set :active, true
+    #   set :allow_duplicates, false
+    # end
+  end
+end
+
+network.save!

data/gamifier.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gamifier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Cyril Rohr"]
+  gem.email         = ["cyril.rohr@gmail.com"]
+  gem.description   = %q{Gem for accessing game engine APIs}
+  gem.summary       = %q{Currently supports Badgeville Core API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gamifier"
+  gem.require_paths = ["lib"]
+  gem.version       = Gamifier::VERSION
+
+  gem.add_dependency "faraday", "~> 0.4.1"
+  gem.add_dependency "json"
+  gem.add_dependency "rack"
+
+  gem.add_development_dependency('rspec', '~> 2')
+  gem.add_development_dependency('webmock')
+end

data/lib/gamifier/collection.rb

@@ -0,0 +1,26 @@
+require 'gamifier/model'
+
+module Gamifier
+  class Collection
+    include Gamifier::Model::FinderMethods
+    
+    attr_accessor :engine
+    attr_reader :model
+
+    def path
+      model.path
+    end
+
+    def initialize(engine, model)
+      @engine = engine
+      @model = model
+      self.extend model::FinderMethods
+    end
+
+    def build(entry)
+      instance = model.new(entry)
+      instance.engine = engine
+      instance
+    end
+  end
+end

data/lib/gamifier/dsl/network.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+module Gamifier
+  module DSL
+    class Network
+      extend Forwardable
+      def_delegator :Gamifier, :engine, :engine
+
+      attr_reader :sites
+
+      def initialize
+        @sites = []
+      end
+
+      def site(name, &block)
+        new_site = DSL::Site.new(:name => name)
+        new_site.source.engine = engine
+        @sites.push(new_site)
+
+        DSL.eval_with_context(new_site, &block)
+      end
+      
+      def save!
+        sites.each do |site|
+          if gsite = engine.sites.find(site.url)
+            site._id = gsite._id
+          end
+          site.save
+        end
+      end
+    end
+  end
+end