badgeville_berlin 1.0.3 → 1.0.4

data/lib/badgeville_berlin.rb

@@ -17,6 +17,7 @@ require "badgeville_berlin/player.rb"
 require "badgeville_berlin/reward.rb"
 require "badgeville_berlin/reward_definition.rb"
 require "badgeville_berlin/site.rb"
+require "badgeville_berlin/team.rb"
 require "badgeville_berlin/track.rb"
 require "badgeville_berlin/user.rb"
 

data/lib/badgeville_berlin/base_resource.rb

@@ -24,7 +24,7 @@ module BadgevilleBerlin
 
       attributes = ActiveResource::Formats.remove_root(attributes) if remove_root
 
-      attributes.each do |key, value|
+      customize_keys_for_request(attributes).each do |key, value|
         @attributes[key.to_s] =
             case value
               when Array
@@ -52,6 +52,27 @@ module BadgevilleBerlin
       self
     end
 
+    # Enables revising Berlin JSON response key names to match what
+    # is expected by model-level logic. (e.g. Berlin JSON payload
+    # returns the player's nickname under the key :nick_name, but the
+    # Player model expects it as :nickname without the underscore.)
+    #
+    # @example Rewrites the BadgevilleBerlin::Player :nick_name key as 
+    # :nickname.
+    def customize_keys_for_request(attrs)
+      # The given resource type determined by self.class. For each attribute key
+      # in the ActiveResource object that needs renaming, replace the original
+      # hash key with the revised hash key as specified in the resource type
+      # -specific constant CUSTOM_ATTRS_FOR_REQUEST.
+      if defined?(self.class::CUSTOM_REQUEST_KEYS)
+        self.class::CUSTOM_REQUEST_KEYS.each do |orig_key, revised_key| 
+          attrs[revised_key] = attrs.delete(orig_key) if attrs.include?(orig_key) 
+        end
+      end
+      attrs
+    end
+
+
     # Overrides encode call to prevent to_json from converting non-valid type
     # objects to nested-json hash (e.g. BadgevilleBerlin::ActivityDefinition::Selector)
     # to allow for 200 OK response on PUT

data/lib/badgeville_berlin/player.rb

@@ -1,6 +1,12 @@
 # Subclasses BaseResource to represent a remote resource model class.
 module BadgevilleBerlin
   class Player < BadgevilleBerlin::BaseResource
-    COMPLEX_ATTRIBUTES = [:custom]
+    COMPLEX_ATTRIBUTES = [:custom, :preferences]
+
+    # Enables revising Berlin JSON response key names to match what
+    # is expected by model-level logic. (e.g. Berlin JSON payload 
+    # returns the player's nickname under the key :nick_name, but the
+    # Player model expects it as :nickname without the underscore.)
+    CUSTOM_REQUEST_KEYS = {:nick_name => :nickname, :teams => :team_ids}
   end
 end

data/lib/badgeville_berlin/team.rb

@@ -0,0 +1,12 @@
+# Subclasses BaseResource to represent a remote resource model class.
+module BadgevilleBerlin
+  class Team < BadgevilleBerlin::BaseResource
+    COMPLEX_ATTRIBUTES = [:custom, :preferences]
+
+    # Enables revising Berlin JSON response key names to match what
+    # is expected by model-level logic. (e.g. Berlin JSON payload 
+    # returns the player's nickname under the key :nick_name, but the
+    # Player model expects it as :nickname without the underscore.)
+    CUSTOM_REQUEST_KEYS = {:nick_name => :nickname}
+  end
+end

data/lib/badgeville_berlin/version.rb

@@ -1,3 +1,3 @@
 module BadgevilleBerlin
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/use_case/readme_use_case_spec.rb

@@ -6,17 +6,18 @@ module BadgevilleBerlin
       # Initializations
       @rand1 = rand(5000)
       @rand2 = rand(5000)
-      @my_network_id = '<my_network_id>'
-      
-      # Set FakeWeb to allow a real connection to the Badgeville server as
-      # configured in spec_helper.rb
-      FakeWeb.allow_net_connect = true
+      @rand3 = rand(5000)
 
       # Configure the gem with the host site and the API Key
       my_hostname = '<http://myhostname.com>'
       my_api_key = '<my_api_key>'
- 
+      @my_network_id = '<my_network_id>' 
+
       Config.conf(:host_name => my_hostname, :api_key => my_api_key)
+     
+      # Set FakeWeb to allow a real connection to the Badgeville server as
+      # configured in spec_helper.rb
+      FakeWeb.allow_net_connect = true
     end
 
     describe "README examples" do
@@ -58,7 +59,7 @@ module BadgevilleBerlin
           :verb      => "share",
           :player_id => @new_player.id )
         @share_activity_created = @share_activity.save
-
+ 
         # Advanced README: Create an activity definition to specify that a player will earn 4
         # points each time they perform the "comment" behavior.
         @new_activity_definition = ActivityDefinition.new(
@@ -159,7 +160,7 @@ module BadgevilleBerlin
       end
 
       it "should have registered a new share activity", :affects_bv_server => true do
-        @share_activity.verb.should == "share"
+        Activity.find(@share_activity.id).verb.should == "share"
       end
 
       # CREATE ActivityDefinition
@@ -168,7 +169,7 @@ module BadgevilleBerlin
       end
 
       it "should have a new activity definition for comment", :affects_bv_server => true do
-        @new_activity_definition.verb.should == "comment"
+        ActivityDefinition.find(@new_activity_definition.id).verb.should == "comment"
       end
 
       # CREATE Activity (comment)
@@ -177,7 +178,7 @@ module BadgevilleBerlin
       end
 
       it "should have registered a new comment activity", :affects_bv_server => true do
-        @comment_activity.verb.should == "comment"
+        Activity.find(@comment_activity.id).verb.should == "comment"
       end
 
       it "should have added 3 points to the new player", :affects_bv_server => true do
@@ -205,8 +206,8 @@ module BadgevilleBerlin
         @user_found_by_id.email = "visitor#{@rand2}@emailserver.com"
         @user_updated           = @user_found_by_id.save
 
-        User.find(@new_user.id).email.should == "visitor#{@rand2}@emailserver.com"
         @user_updated.should == true
+        User.find(@new_user.id).email.should == "visitor#{@rand2}@emailserver.com"
       end
 
       # UPDATE ActivityDefinition (points)
@@ -311,6 +312,72 @@ module BadgevilleBerlin
         Site.delete(@site.id)
       end
 
+      describe "BadgevilleBerlin::Player", :affects_bv_server => true do
+        before(:all) do
+
+          # Create a new user
+          @new_user = User.new(
+            :name       => "user#{@rand3}",
+            :network_id => @my_network_id,
+            :email      => "user#{@rand3}@emailserver.com")
+          @user_created = @new_user.save
+
+          # Create a player
+          @new_player = Player.new(
+            :site_id      => @site.id,
+            :user_id      => @new_user.id,
+            :display_name => "Visitor #{@rand3}" )
+          @player_created = @new_player.save
+        end
+
+        context 'updating nickname' do
+          it 'should support the "nickname" setter & getter' do
+            @new_player.nickname = 'Sasha'
+            @new_player.save
+            Player.find(@new_player.id).nickname.should eq('Sasha')
+          end
+
+          it 'should NOT set "nickname" when the "nick_name" setter is used' do
+            # Create a new user
+            @new_user2 = User.new(
+              :name       => "user#{@rand2}",
+              :network_id => @my_network_id,
+              :email      => "user#{@rand2}@emailserver.com")
+            @user_created2 = @new_user2.save
+
+            #Create a player
+            @new_player2 = Player.new(
+              :site_id      => @site.id,
+              :user_id      => @new_user2.id,
+              :display_name => "Visitor #{@rand2}" )
+            @player_created2 = @new_player2.save
+
+            @new_player2.nick_name = 'Sasha'
+            @new_player2.save
+            Player.find(@new_player2.id).nickname.should be_nil
+          end
+
+        end
+
+        context 'updating player preferences' do
+          it "should default preferences field hide_notifications to false" do
+            Player.find(@new_player.id).preferences['hide_notifications'].should be_false
+          end
+
+          it 'should update preferences field hide_notifications to true if set to Boolean true' do
+            @new_player.preferences = {'hide_notifications' => true}
+            @new_player.save
+            Player.find(@new_player.id).preferences['hide_notifications'].should be_true
+          end
+
+          it 'should update preferences field hide_notifications to true if set to String "true"' do
+            @new_player.preferences = {'hide_notifications' => 'true'}
+            @new_player.save
+            Player.find(@new_player.id).preferences['hide_notifications'].should be_true
+          end
+        end
+      end
+
       describe "BadgevilleBerlin::RewardDefinition", :affects_bv_server => true do
         before(:all) do
           @new_rd = RewardDefinition.new(
@@ -351,7 +418,7 @@ module BadgevilleBerlin
         end
     
         it "should parse correctly a group index call which includes rewards keyed under reward definitions", :affects_bv_server => true do
-          BadgevilleBerlinJsonFormat.stub!(:decode).and_return([JSON.parse(BadgevilleBerlin.response_json["valid_group_all"])])
+          BadgevilleBerlinJsonFormat.stub(:decode).and_return([JSON.parse(BadgevilleBerlin.response_json["valid_group_all"])])
           response = Group.all
           response.first.rewards.count.should == 2
         end
@@ -404,6 +471,42 @@ module BadgevilleBerlin
           lambda { Leaderboard.find(@new_leaderboard.id) }.should raise_error(ActiveResource::ResourceNotFound)
         end
       end
+
+      describe "BadgevilleBerlin::Team", :affects_bv_server => true do
+        before(:all) do
+          # Create a team
+          @team = Team.new(
+            :site_id      => @site.id,
+            :display_name => "Team #{@rand1}" )
+          @team.save!
+          @team
+        end
+
+        it 'should save teams using the team_ids= setter' do
+          # Create a player
+          @u1 = User.new(:name => "user#{@rand1}", :network_id => @my_network_id, :email => "team_player#{@rand1}@emailserver.com")
+          @u1.save
+          @p1 = Player.new(:site_id => @site.id, :user_id => @u1.id)
+          @p1.save
+
+          @p1.team_ids = [@team.id.to_s]
+          @p1.save!
+          Player.find(@p1.id).team_ids.should eq([@team.id.to_s])
+        end
+
+        it 'should NOT set teams using the teams= setter because "teams" is not attr_accessible' do
+          # Create a player
+          @u2 = User.new(:name => "user#{@rand2}", :network_id => @my_network_id, :email => "team_player#{@rand2}@emailserver.com")
+          @u2.save
+          @p2 = Player.new(:site_id => @site.id, :user_id => @u2.id)
+          @p2.save
+
+          @p2.teams = [@team.id.to_s]
+          @p2.save!
+          Player.find(@p2.id).team_ids.should eq([])
+        end
+      end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgeville_berlin
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
@@ -218,6 +218,7 @@ files:
 - lib/badgeville_berlin/reward.rb
 - lib/badgeville_berlin/reward_definition.rb
 - lib/badgeville_berlin/site.rb
+- lib/badgeville_berlin/team.rb
 - lib/badgeville_berlin/track.rb
 - lib/badgeville_berlin/user.rb
 - lib/badgeville_berlin/version.rb