gamifier 1.0.8 → 1.1.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -22,6 +22,12 @@ Or install it yourself as:
 Configure Gamifier with the right parameter for the API you're using:
 
     Gamifier.set :key => "1234", :uri => "http://sandbox.v2.badgeville.com/api/berlin/"
+    
+Gamifier support the last version of Badgeville API using *enterprise api key*:
+
+	Gamifier.set :key => '1234', :uri => "http://sandbox.v2.badgeville.com/api/berlin/", :enterprise_key => '5678'
+	
+*Note that you have to specify either a private API key or an enterprise API key.*
 
 Then here is an example usage to credit an existing player:
 
@@ -35,16 +41,58 @@ declare activities, rewards and missions, and you can execute a DSL as
 follows:
 
     BADGEVILLE_KEY=xzy bundle exec ruby -I lib examples/dev.rb
+    
+## Create Network using the DSL
+
+Since the new Badgeville API, you can create new Network and API Keys using the Badgeville API. We updated the DSL for you:
+
+	network = Gamifier.dsl do
+	  set :label, 'MyNetwork'
+	  set :email, 'dev@mynetwork.com'
+
+	  api_key do
+	    set :access, 'public'
+	  end
+
+	  api_key do
+	    set :access, 'private'
+	  end
+	  
+	  site 'foo' do
+		# as usual here
+	  end
+	end
+	
+To only save the network on Badgeville do:
+
+	network.save_network!
+	
+To only save the sites, behaviors, rewards, etc do:
+
+	network.save!
+	
+If you want to create a new Network and create Sites, Behaviors, Rewards, etc on that new Network, you'll need the network's private API key.
+
+	api_key do
+	  set :access, 'private'
+	end
+	
+These lines will create a new Private API key on current network. You'll need to:
+
+1. Create and Save the network: `network.save_network!`
+2. Create and Save the sites, behaviors and so on: `network.save!`
+
+`network.save!` will use by default the new private API key if any, otherwise it will fallback to Gamifier's config.
 
 ## Tests
 
 Run the unit tests with:
 
-    bundle exec spec spec/unit
+    bundle exec rspec spec/unit
 
 Run the integration tests as follows:
 
-    BADGEVILLE_KEY=1234 bundle exec spec spec/integration
+    BADGEVILLE_KEY=1234 bundle exec rspec spec/integration
 
 ## Contributing
 
@@ -52,9 +100,13 @@ Run the integration tests as follows:
 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
+5. Create new Pull Request on Github
 
 
 ## Authors
 
 * Cyril Rohr <cyril.rohr@gmail.com>
+
+## Contributors
+
+* [Pierre-Louis Gottfrois](https://github.com/gottfrois)

data/examples/dev.rb

@@ -1,10 +1,21 @@
 require 'gamifier'
 require 'json'
 
-Gamifier.set :uri => "http://sandbox.v2.badgeville.com/api/berlin/", :key => ENV.fetch('BADGEVILLE_KEY')
+Gamifier.set :uri => "http://sandbox.v2.badgeville.com/api/berlin/", :key => ENV.fetch('BADGEVILLE_KEY'), :enterprise_key => ENV.fetch('BADGEVILLE_ENTERPRISE_KEY')
 Gamifier.logger.level = Logger::DEBUG
 
 network = Gamifier.dsl do
+  set :label, 'MyNetwork'
+  set :email, 'dev@mynetwork.com'
+
+  api_key do
+    set :access, 'public'
+  end
+
+  api_key do
+    set :access, 'private'
+  end
+
   site 'dev.domain-test.crohr.me' do |site|
     set :url, 'dev.domain-test.crohr.me'
 
@@ -69,15 +80,15 @@ network = Gamifier.dsl do
     #   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
@@ -95,7 +106,7 @@ network = Gamifier.dsl do
       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!"
@@ -123,7 +134,7 @@ network = Gamifier.dsl do
       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!"
@@ -183,4 +194,4 @@ network = Gamifier.dsl do
   end
 end
 
-network.save!
+network.save!

data/lib/gamifier/dsl/api_key.rb

@@ -0,0 +1,19 @@
+module Gamifier
+  module DSL
+    class ApiKey
+      attr_reader :source
+
+      def initialize(*args)
+        @source = ::Gamifier::ApiKey.new(*args)
+      end
+
+      def engine
+        source.engine
+      end
+
+      def method_missing(*args, &block)
+        source.send(*args, &block)
+      end
+    end
+  end
+end

data/lib/gamifier/dsl/network.rb

@@ -6,28 +6,82 @@ module Gamifier
       extend Forwardable
       def_delegator :Gamifier, :engine, :engine
 
+      attr_reader :source
       attr_reader :sites
+      attr_reader :api_keys
 
-      def initialize
-        @sites = []
+      def initialize(*args)
+        @source         = ::Gamifier::Network.new(*args)
+        @sites          = []
+        @api_keys       = []
+      end
+
+      def engine
+        @engine ||= Gamifier::Engine.new(:key => get_key('private') || Gamifier.config[:key])
+      end
+
+      def enterprise_engine
+        raise ArgumentError, "You must specify an enterprise key" unless Gamifier.config[:enterprise_key]
+        @enterprise_engine ||= Gamifier::Engine.new(:key => Gamifier.config[:enterprise_key])
       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!
+
+      def api_key(&block)
+        new_key = DSL::ApiKey.new
+        new_key.source.engine = enterprise_engine
+        @api_keys.push(new_key)
+
+        DSL.eval_with_context(new_key, &block)
+      end
+
+      def save_network!
+        begin
+          if self.save
+            save_api_keys!
+          end
+        rescue
+          Gamifier.logger.debug "Can't save #{self}"
+        end
+      end
+
+      def save_api_keys!
+        api_keys.each do |key|
+          key.engine = enterprise_engine
+          key.network_id = self.id
+          key.save
+        end
+      end
+
+      def save_sites!
         sites.each do |site|
           if gsite = engine.sites.find(site.url)
             site._id = gsite._id
           end
+          site.engine = engine
           site.save
         end
       end
+
+      def get_key(access = 'private')
+        key = self.api_keys.select {|k| k.access == access}.first
+        return key.key if key
+        nil
+      end
+
+      def save!
+        save_sites!
+      end
+
+      def method_missing(*args, &block)
+        source.send(*args, &block)
+      end
+
     end
   end
-end
+end

data/lib/gamifier/dsl/site.rb

@@ -78,6 +78,7 @@ module Gamifier
             # response, remove the next line:
             next
           end
+          unit.engine = engine
           unit.save || raise(Error, "Can't save #{unit}")
         end
       end
@@ -89,6 +90,7 @@ module Gamifier
           if gbehavior = engine.send(behavior.class.path).find_by_name(behavior.name, :site => self.url)
             behavior._id = gbehavior._id
           end
+          behavior.engine = engine
           behavior.save || raise(Error, "Can't save #{behavior}")
         end
       end
@@ -100,6 +102,7 @@ module Gamifier
           if greward = engine.send(reward.class.path).find_by_name(reward.name, :site => self.url)
             reward._id = greward._id
           end
+          reward.engine = engine
           reward.save || raise(Error, "Can't save #{reward}")
         end
       end
@@ -111,6 +114,7 @@ module Gamifier
           if gmission = engine.send(mission.class.path).find_by_name(mission.name, :site => self.url)
             mission._id = gmission._id
           end
+          mission.engine = engine
           mission.save || raise(Error, "Can't save #{mission}")
         end
       end
@@ -122,6 +126,7 @@ module Gamifier
           if gtrack = engine.send(track.class.path).find_by_label(track.label, :site => self.url)
             track._id = gtrack._id
           end
+          track.engine = engine
           track.save || raise(Error, "Can't save #{track}")
         end
       end

data/lib/gamifier/dsl.rb

@@ -1,4 +1,5 @@
 require 'gamifier/dsl/network'
+require 'gamifier/dsl/api_key'
 require 'gamifier/dsl/site'
 
 module Gamifier
@@ -12,7 +13,7 @@ module Gamifier
         new_context
       end
     end
-    
+
     def set(key, *args, &block)
       if block
         self.send("#{key}=".to_sym, block)
@@ -21,4 +22,4 @@ module Gamifier
       end
     end
   end
-end
+end

data/lib/gamifier/engine.rb

@@ -4,7 +4,7 @@ require 'gamifier/collection'
 
 module Gamifier
   class Engine
-    MODELS = %w{Activity ActivityDefinition Group Player Reward RewardDefinition Site Track Unit User}
+    MODELS = %w{ApiKey Network Activity ActivityDefinition Group Player Reward RewardDefinition Site Track Unit User}
 
     attr_accessor :connection
     attr_writer :config
@@ -26,7 +26,11 @@ module Gamifier
     end
 
     def ok?
-      !config.values_at(:key, :uri).any?{|k| k.nil? || k.empty?}
+      if config[:enterprise_key].nil? || config[:enterprise_key].empty?
+        !config.values_at(:key, :uri).any?{|k| k.nil? || k.empty?}
+      else
+        !(config[:uri].nil? || config[:uri].empty?)
+      end
     end
 
     # Sends an HTTP request corresponding to +method+, on +path+, with
@@ -65,8 +69,8 @@ module Gamifier
       end
     end
 
-    def uri_to(path = "")
-      URI.join(File.join(::Gamifier.config[:uri], ::Gamifier.config[:key], ""), path)
+    def uri_to(path = '')
+      URI.join(File.join(self.config[:uri], self.config[:key] || '', ''), path)
     end
 
     MODELS.each do |model|

data/lib/gamifier/models/api_key.rb

@@ -0,0 +1,10 @@
+require 'gamifier/model'
+
+module Gamifier
+  class ApiKey < Model
+    def engine
+      raise ArgumentError, "You must specify an enterprise key" unless Gamifier.config[:enterprise_key]
+      @engine ||= Gamifier::Engine.new(:key => Gamifier.config[:enterprise_key])
+    end
+  end
+end

data/lib/gamifier/models/network.rb

@@ -0,0 +1,10 @@
+require 'gamifier/model'
+
+module Gamifier
+  class Network < Model
+    def engine
+      raise ArgumentError, "You must specify an enterprise key" unless Gamifier.config[:enterprise_key]
+      @engine ||= Gamifier::Engine.new(:key => Gamifier.config[:enterprise_key])
+    end
+  end
+end

data/lib/gamifier/version.rb

@@ -1,3 +1,3 @@
 module Gamifier
-  VERSION = "1.0.8" unless defined?(Gamifier::VERSION)
+  VERSION = "1.1.0" unless defined?(Gamifier::VERSION)
 end

data/lib/gamifier.rb

@@ -33,9 +33,9 @@ module Gamifier
 
     # Creates and returns a new DSL::Network object. The given block
     # will be evaluated in the context of the network object.
-    # 
+    #
     # Usage:
-    # 
+    #
     #   network = Gamifier.dsl do
     #     site 'my-site' do
     #       set :url, 'my-site.com'
@@ -44,8 +44,7 @@ module Gamifier
     #   end
     def dsl(&block)
       network = DSL::Network.new
-      network.instance_eval(&block)
-      network
+      DSL.eval_with_context(network, &block)
     end
 
     def logger

data/spec/integration/collection_integration_spec.rb

@@ -2,19 +2,19 @@ require 'spec_integration_helper'
 
 describe "managing collections" do
   before :all do
-    @site = ENGINE.sites.find("ibadgedyou.dev")
+    @site = Gamifier.engine.sites.find("ibadgedyou.dev")
     @site.should_not be_nil
-    ENGINE.activity_definitions.reset!(:site => "ibadgedyou.dev")
+    Gamifier.engine.activity_definitions.reset!(:site => "ibadgedyou.dev")
   end
 
   it "should list all players" do
     3.times do |i|
-      behavior = ENGINE.activity_definitions.build({:selector => {:verb => "visit#{i}"}, :name => "visit#{i}", :site_id => @site._id}).save
+      behavior = Gamifier.engine.activity_definitions.build({:selector => {:verb => "visit#{i}"}, :name => "visit#{i}", :site_id => @site._id}).save
       behavior.should_not be_nil
     end
-    ENGINE.activity_definitions.all(:site => "ibadgedyou.dev").length.should == 3
-    ENGINE.activity_definitions.reset!(:site => "ibadgedyou.dev")
-    ENGINE.activity_definitions.all(:site => "ibadgedyou.dev").length.should == 0
+    Gamifier.engine.activity_definitions.all(:site => "ibadgedyou.dev").length.should eq 3
+    Gamifier.engine.activity_definitions.reset!(:site => "ibadgedyou.dev")
+    Gamifier.engine.activity_definitions.all(:site => "ibadgedyou.dev").length.should eq 0
   end
 
 end

data/spec/integration/dsl_integration_spec.rb

@@ -1,76 +1,72 @@
-require 'spec_integration_helper'
+require 'spec_helper'
 
 describe "DSL" do
-  before do
-    @network = Gamifier.dsl do
-      site 'mydomain' do
-        set :url, 'mydomain.com'
+
+  let(:url) { 'http://foo.com' }
+  let(:key) { '1234' }
+  let(:enterprise_key) { '5678' }
+  let(:network) {
+    Gamifier.dsl do
+      set :label, 'foo'
+      set :email, 'foo@bar.com'
+
+      api_key do
+        set :access, 'private'
+      end
+
+      site 'foo' do
+        set :url, 'bar.com'
 
         unit :karma do
-          set :label, 'Karma'
+          set :label, 'karma'
           set :abbreviation, 'kar'
         end
+      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
+    end
+  }
 
+  let(:network_response) { '{"id":"5112257849f8387b000e85f6","label":"foo","email":"foo@bar.com","api_explorer_post":null,"permissions":{"api_explorer_posting":true,"social_mechanics":true,"read_only_widgets":true,"show_community_link":true},"attempts":20,"timeout":180,"whitelist_filter":null,"require_strong_passwords":false,"password_reset_in_days":60,"force_password_resets":false,"deny_previous_passwords":false,"enable_ip_whitelist":false}' }
+  let(:site_response) { '{"name":"foo","created_at":"2013-02-06T01:44:22-08:00","url":"bar.com","id":"511225f6297c011c62106fb7","_id":"511225f6297c011c62106fb7","network_id":"4fac5d4f3dc6483a0100000b","timed_reset":false,"reset_interval":null,"reset_month":null,"reset_date":null,"reset_day":null,"reset_hour":null,"interval_start":null,"interval_end":null}' }
+  let(:unit_response) { '{"id":"511226da297c011c4b11543e","name":"karma","label":"karma","normalized_name":"unit_karma","type":"point","abbreviation":"kar","display_priority":0}' }
 
-        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
+  before do
+    stub_request(:get, "#{url}/#{key}/sites/bar.com.json").to_return(:status => 404, :body => '')
+    stub_request(:post, "#{url}/#{key}/sites.json").to_return(:status => 200, :body => site_response)
+    stub_request(:get, "#{url}/#{key}/units.json?page=1&per_page=50&site=bar.com").to_return(:status => 404, :body => '')
+    stub_request(:post, "#{url}/#{key}/units.json").to_return(:status => 200, :body => unit_response)
+    Gamifier.set :uri => url, :key => key, :enterprise_key => enterprise_key
+  end
+
+  context "when network already exists" do
+
+    let(:network_error_response) { '{"name":["is already taken"],"label":["is already taken"]}' }
+
+    before do
+      stub_request(:post, "#{url}/#{enterprise_key}/networks.json").to_return(:status => 422, :body => network_error_response)
+    end
+
+    it { expect { network.save_network! }.to_not raise_error }
+
+  end
+
+  context "when network does not exists" do
+
+    let(:api_key_response) { '{"id":"51122b073dc6480b760f66ce","network_id":"5112257849f8387b000e85f6","key":"5c3782a61ff639c92c30ea73d294e25e","access":"private","enable_whitelist":false,"ip_addresses":null}' }
+
+    before do
+      stub_request(:post, "#{url}/#{enterprise_key}/networks.json").to_return(:status => 200, :body => network_response)
+      stub_request(:post, "#{url}/#{enterprise_key}/api_keys.json").to_return(:status => 200, :body => api_key_response)
     end
+
+    it { expect { network.save_network! }.to_not raise_error }
+
   end
+
+  it { expect{ network.save! }.to_not raise_error }
+
   it "should work twice" do
-    expect{ @network.save! }.to_not raise_error
-    expect{ @network.save! }.to_not raise_error
+    expect{ network.save! }.to_not raise_error
+    expect{ network.save! }.to_not raise_error
   end
-end
+end

data/spec/integration/player_integration_spec.rb

@@ -1,23 +1,25 @@
 require 'spec_integration_helper'
 
 describe "managing players" do
-  before :all do
+
+  before do
     destroy_test_player!
   end
 
   it "should list all players" do
-    players = ENGINE.players.all
+    players = Gamifier.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 = Gamifier.engine.players.build(player_attributes)
     player.save
-    ENGINE.players.find(player._id).should_not be_nil
+    Gamifier.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
@@ -34,8 +36,9 @@ describe "managing players" 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
+      Gamifier.engine.players.find(@player._id).picture_url.should == url
     end
+
   end
 
 end

data/spec/integration/user_integration_spec.rb

@@ -2,18 +2,27 @@ 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
+  let(:url) { 'http://foo.com' }
+  let(:key) { '1234' }
+
+  before do
+    Gamifier.set :uri => url, :key => key
   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
+  context "when user does not exists" do
+
+    let(:user) { Gamifier.engine.users.build(user_attributes) }
+    let(:users_response) { '"name": "Foo Bar","created_at": "2013-02-12T06:13:50-08:00","email": "user@foo.com","_id": "511a4e1e297c0148ed00238c","id": "511a4e1e297c0148ed00238c"' }
+
+    before do
+      stub_request(:post, "#{url}/#{key}/users.json").to_return(:status => 200, :body => users_response)
+    end
+
+    subject { user }
+
+    it { should be_new }
+    it { subject.save.should be_true }
+
   end
-end
+
+end