gamifier 1.0.3

data/spec/integration/dsl_integration_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_integration_helper'
+
+describe "DSL" do
+  before do
+    @network = Gamifier.dsl do
+      site 'mydomain' do
+        set :url, 'mydomain.com'
+
+        unit :karma do
+          set :label, 'Karma'
+          set :abbreviation, 'kar'
+        end
+
+        behavior 'new comment' do
+          set :description, "new comment behaviour"
+          set :selector, {
+            :verb => 'new_comment',
+            :category_id => 'hello'
+          }
+          set :adjustment, {
+            :points => 15, :karma => 10
+          }
+
+          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://crohr.me/images/cyrilrohr.jpg"
+        end
+
+
+        r1 = reward 'top commenter' do
+          set :reward_template, {
+            :message => "Congrats!"
+          }
+          set :components, [
+            {:command => "count", :comparator => 1, :where => {:verb => 'new_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
+        
+        m1 = 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 [r1._id] end
+        end
+        
+        track 'commenting' do
+          set :group_definition_ids do [m1._id] end
+        end
+      end
+    end
+  end
+  it "should work twice" do
+    expect{ @network.save! }.to_not raise_error
+    expect{ @network.save! }.to_not raise_error
+  end
+end

data/spec/integration/player_integration_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_integration_helper'
+
+describe "managing players" do
+  before :all do
+    destroy_test_player!
+  end
+
+  it "should list all players" do
+    players = ENGINE.players.all
+    players.all?{|p| p.kind_of?(Gamifier::Player)}.should be_true
+  end
+
+  it "should create a new player" do
+    find_or_create_test_user
+    player = ENGINE.players.build(player_attributes)
+    player.save
+    ENGINE.players.find(player._id).should_not be_nil
+  end
+
+  describe "with an existing player" do
+    before do
+      @player = find_or_create_test_player
+    end
+
+    it "should credit an activity for the player" do
+      activity = @player.credit("visit", :contents_attributes => [{:content_url => "http://somwhere.ltd", :content_type => "page", :title => "Test1"}])
+      activity.should_not be_false
+      activity.contents.first["title"].should == "Test1"
+      activity.rewards.should be_empty
+      activity.points.should == 1
+    end
+
+    it "should update the picture_url" do
+      url = "http://s3.amazonaws.com/crohr.dimelo/identity_avatars/2ffbf54be4af49e7/avatar_normal.png?f59510d"
+      @player.picture_url = url
+      @player.save.should be_true
+      ENGINE.players.find(@player._id).picture_url.should == url
+    end
+  end
+
+end

data/spec/integration/user_integration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_integration_helper'
+
+describe "managing users" do
+
+  before :all do
+    user = ENGINE.users.find(user_attributes[:email])
+    if user
+      puts "Found user #{user}. Deleting..."
+      user.destroy.should be_true
+    end
+  end
+
+  it "should create a new user" do
+    user = ENGINE.users.build(user_attributes)
+    user.should be_new
+    user.save.should be_true
+    user.should_not be_new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'webmock/rspec'
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'gamifier'
+
+WebMock.disable_net_connect!

data/spec/spec_integration_helper.rb

@@ -0,0 +1,51 @@
+require 'rspec'
+require 'webmock/rspec'
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'gamifier'
+
+WebMock.allow_net_connect!
+
+RSpec.configure do |config|
+
+  config.before :all do
+    Gamifier.set :uri, ENV.fetch("BADGEVILLE_URI") { "http://sandbox.v2.badgeville.com/api/berlin/" }
+    Gamifier.set :key, ENV.fetch("BADGEVILLE_KEY") { "1234" }
+    ENGINE = Gamifier.engine
+    Gamifier.logger.level = Logger::DEBUG
+  end
+
+  def player_attributes
+    {:email => "1234@test.com", :site => "ibadgedyou.dev", :display_name => "John Doe"}
+  end
+
+  def user_attributes
+    {:email => "1234@test.com"}
+  end
+
+  def find_or_create_test_user
+    user = ENGINE.users.find(user_attributes[:email]) || ENGINE.users.build(user_attributes).save
+    user.should_not be_nil
+  end
+
+  def destroy_test_player!
+    player = ENGINE.players.find_by_site_and_email(player_attributes[:site], player_attributes[:email])
+    if player
+      puts "Found player #{player}. Deleting..."
+      player.destroy.should be_true
+    end
+  end
+
+  def find_or_create_test_player
+    find_or_create_test_user
+    player = ENGINE.players.find_by_site_and_email(player_attributes[:site], player_attributes[:email])
+    if player.nil?
+      player = ENGINE.players.build(player_attributes).save
+      player.should_not be_false
+      player
+    else
+      player
+    end
+  end
+
+end

data/spec/unit/collection_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gamifier::Collection do
+  before do
+    @engine = mock(Gamifier::Engine)
+    @collection = Gamifier::Collection.new(@engine, Gamifier::Model)
+  end
+
+  it "should have included the FinderMethods of the model" do
+    Gamifier::Model::FinderMethods.public_instance_methods.each do |method|
+      @collection.should respond_to(method)
+    end
+  end
+
+  it "should correctly build a new object with a correct reference to the current engine" do
+    object = @collection.build(:key => "value")
+    object.should be_a(Gamifier::Model)
+    object.key.should == "value"
+  end
+
+end

data/spec/unit/dsl/network_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Gamifier::DSL::Network do
+  before do
+    Gamifier.set :uri => "http://somewhere.ltd/path/", :key => "1234"
+    @network = Gamifier::DSL::Network.new
+  end
+  it "should be linked to the gamifier engine" do
+    @network.engine.should == Gamifier.engine
+  end
+  it "should have an empty list of sites" do
+    @network.sites.should be_empty
+  end
+
+  describe "creating sites" do
+    it "should add a new site to its list when calling #site" do
+      expect {
+        @network.site 'site-name'
+      }.to change{ @network.sites.count }.by(1)
+    end
+
+    it "creates a site with the given name" do
+      new_site = @network.site 'site-name'
+      new_site.name.should == 'site-name'
+    end
+
+    it "should call eval_with_context" do
+      block = proc{}
+      Gamifier::DSL.should_receive(:eval_with_context).with(instance_of(Gamifier::DSL::Site), &block)
+      @network.site 'site-name', &block
+    end
+  end
+
+end

data/spec/unit/dsl/site_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Gamifier::DSL::Site do
+  before do
+    @site = Gamifier::DSL::Site.new(:name => "site-name")
+  end
+  
+  describe "creating units" do
+
+    it "adds a unit to the site" do
+      expect{ @site.unit 'unit-name' }.to change{ @site.units.count }.by(1)
+    end
+  end
+
+  describe "creating behaviours" do
+
+    it "adds a behavior to the site" do
+      expect{ @site.behavior 'behavior-name' }.to change{ @site.behaviors.count }.by(1)
+    end
+
+    it "should call eval_with_context" do
+      block = proc{}
+      Gamifier::DSL.should_receive(:eval_with_context).with(instance_of(Gamifier::ActivityDefinition), &block)
+      @site.behavior 'behavior-name', &block
+    end
+
+    it "should work" do
+      new_behavior = @site.behavior 'behavior-name' do
+        set :key, 'value'
+        set :enable, true
+      end
+      new_behavior.key.should == 'value'
+      new_behavior.enable.should == true
+    end
+  end
+  
+  describe "creating rewards" do
+    it "adds a reward to the site" do
+      expect{ @site.reward 'reward-name' }.to change{ @site.rewards.count }.by(1)
+    end
+  end
+  
+  describe "creating missions" do
+    it "adds a mission to the site" do
+      expect{ @site.mission 'mission-name' }.to change{ @site.missions.count }.by(1)
+    end
+  end
+
+  describe "creating tracks" do
+    it "adds a track to the site" do
+      expect{ @site.track 'track-name' }.to change{ @site.tracks.count }.by(1)
+    end
+  end
+end

data/spec/unit/dsl_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Gamifier::DSL do
+  
+  class Whatever
+    include Gamifier::DSL
+  end
+
+end

data/spec/unit/engine_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Gamifier::Engine do
+
+  def site
+    {
+      "name" => "ibadgedyou",
+      "created_at" => "2012-05-14T01:50:49-07:00",
+      "url" => "ibadgedyou.dev",
+      "id" => "4fb0c76949f83818c20000eb",
+      "_id" => "4fb0c76949f83818c20000eb"
+    }
+  end
+
+  before do
+    @logger = Logger.new(STDERR)
+    Gamifier.stub!(:config) {
+      {:uri => "http://somewhere.ltd/path/", :key => "1234"}
+    }
+    Gamifier.stub!(:logger).and_return @logger
+
+    @engine = Gamifier::Engine.new
+  end
+
+  describe "#uri_to" do
+    it "should correctly concatenate URIs" do
+      @engine.uri_to.to_s.should == "http://somewhere.ltd/path/1234/"
+      @engine.uri_to("resource").to_s.should == "http://somewhere.ltd/path/1234/resource"
+      @engine.uri_to("/resource").to_s.should == "http://somewhere.ltd/resource"
+      @engine.uri_to("../resource").to_s.should == "http://somewhere.ltd/path/resource"
+    end
+  end
+
+  describe "configuration" do
+    before do
+      @engine = Gamifier::Engine.new(:key => "new-key")
+    end
+    it "should overwrite the global configuration with the given parameters at intialization time" do
+      @engine.config.should == {:uri => "http://somewhere.ltd/path/", :key => "new-key"}
+      Gamifier.config.should == {:uri => "http://somewhere.ltd/path/", :key => "1234"}
+    end
+
+    describe "#ok?" do
+      it "should be true" do
+        @engine.should be_ok
+      end
+
+      it "should be false if the key is missing" do
+        @engine.config[:key] = ""
+        @engine.should_not be_ok
+      end
+
+      it "should be false if the uri is missing" do
+        @engine.config[:uri] = ""
+        @engine.should_not be_ok
+      end
+    end
+
+  end
+
+  it "should have initialized a connection" do
+    @engine.connection.should be_a(Object)
+  end
+
+  describe "#transmit" do
+    it "transmits POST requests to the API" do
+      stub_request(:post, "http://somewhere.ltd/path/1234/resource.json").
+        with(:body => Gamifier::Engine.encode_www_form({:a => "b", :c => ["d", "e"]}), :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' })
+      @engine.transmit :post, "resource", :body => {"a" => "b", :c => ["d", "e"]}
+    end
+    it "transmits GET requests to the API" do
+      stub_request(:get, "http://somewhere.ltd/path/1234/resource.json").
+        with(:query => {"limit" => "5"})
+      @engine.transmit :get, "resource", :query => {"limit" => "5"}
+    end
+    it "should return true if the response is 204" do
+      stub_request(:get, "http://somewhere.ltd/resource.json").
+        to_return(:status => 204)
+      @engine.transmit(:get, "/resource").should be_true
+    end
+    it "should return the parsed response if the status is in the 2xx range (except 204)" do
+      stub_request(:get, "http://somewhere.ltd/resource.json").
+        to_return(:body => JSON.dump(site), :headers => {'Content-Type' => 'application/json;charset=utf-8'})
+      @engine.transmit(:get, "/resource").should == site
+    end
+    [:get, :head].each do |method|
+      it "should return nil if the response status is 422 (Unprocessable Entity) and method is #{method}" do
+        stub_request(method, "http://somewhere.ltd/resource.json").
+          to_return(:status => 422)
+        @engine.transmit(method, "/resource").should be_nil
+      end
+    end
+    [:delete, :post, :put].each do |method|
+      it "should return false if the response status is 422 (Unprocessable Entity) and method is #{method}" do
+        stub_request(method, "http://somewhere.ltd/resource.json").
+          to_return(:status => 422)
+        @engine.transmit(method, "/resource").should be_false
+      end
+    end
+    it "should return nil if the response status is 404" do
+      stub_request(:get, "http://somewhere.ltd/resource.json").
+        to_return(:status => 404)
+      @engine.transmit(:get, "/resource").should be_nil
+    end
+    it "should raise an HTTPServerError for a 5xx code" do
+      stub_request(:get, "http://somewhere.ltd/resource.json").
+        to_return(:status => 500)
+      expect {
+        @engine.transmit(:get, "/resource")
+      }.to raise_error Gamifier::HTTPServerError
+    end
+    it "should raise an HTTPClientError for a 4xx code" do
+      stub_request(:get, "http://somewhere.ltd/resource.json").
+        to_return(:status => 400)
+      expect {
+        @engine.transmit(:get, "/resource")
+      }.to raise_error Gamifier::HTTPClientError
+    end
+  end
+
+  describe "collections" do
+    %w{activities activity_definitions groups players rewards reward_definitions sites units users}.each do |collection|
+      it "should respond ##{collection}" do
+        @engine.should respond_to(collection.to_sym)
+      end
+    end
+    it "should instantiate a new collection object with the correct model" do
+      collection = @engine.players
+      collection.should be_a(Gamifier::Collection)
+      collection.engine.should == @engine
+      collection.model.should == Gamifier::Player
+    end
+
+  end
+end

data/spec/unit/gamifier_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Gamifier do
+
+  before do
+    Gamifier.reset!
+  end
+
+  it "should allow to set the API URI" do
+    Gamifier.set :uri, "http://somwhere.ltd"
+    Gamifier.config[:uri].should == "http://somwhere.ltd"
+  end
+
+  it "should allow to set the API KEY" do
+    Gamifier.set :key, "1234"
+    Gamifier.config[:key].should == "1234"
+  end
+
+  it "should allow to set multiple configuration options at once" do
+    Gamifier.set :uri => "http://somewhere.ltd", "key" => "1234"
+    Gamifier.config[:uri].should == "http://somewhere.ltd"
+    Gamifier.config[:key].should == "1234"
+  end
+
+  it "should allow to reset the state" do
+    Gamifier.set :key, "http://somewhere.ltd"
+    Gamifier.reset!
+    Gamifier.config.should be_empty
+  end
+
+  it "should accept a logger object" do
+    logger = mock("logger")
+    Gamifier.logger = logger
+    Gamifier.logger.should == logger    
+  end
+
+  describe "with proper configuration" do
+    before do
+      Gamifier.set :uri => "http://somewhere.ltd/path/", :key => "1234"
+    end
+
+    it "should return a singleton object when calling Gamifier#engine" do
+      engine = Gamifier.engine
+      engine.should be_a(Object)
+      Gamifier.engine.should be_equal(engine)
+    end
+
+    it "should return an instance of Gamifier::Engine" do
+      Gamifier.engine.should be_instance_of(Gamifier::Engine)
+    end
+    
+    it "should create a new engine object after reset" do
+      engine = Gamifier.engine
+      Gamifier.reset!
+      Gamifier.set :uri => "http://somewhere.ltd/path/", :key => "1234"
+      Gamifier.engine.should_not be_equal(engine)
+    end
+  end
+
+end