riaction 0.5.1 → 1.0.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG #
 
+## 1.0.0 ##
+
+* API return values are now all objects, not mix of key/value pairs and objects.
+* Objects turn themselves back in to original key/value data from IActionable.
+
 ## 0.5.1 ##
 
 * Fixed bug preventing profile updates.

data/lib/riaction/iactionable/api.rb

@@ -81,20 +81,12 @@ module IActionable
       case filter_type
       when :completed
         request.to("/#{profile_type}/#{id_type}/#{id}/achievements/Completed")
-        response = request.get
-        response.map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)}
       when :available
         request.to("/#{profile_type}/#{id_type}/#{id}/achievements/Available")
-        response = request.get
-        response.map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)}
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/achievements")
-        response = request.get
-        {
-          :available => response["Available"].map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)},
-          :completed => response["Completed"].map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)}
-        }
       end
+      IActionable::Objects::ProfileAchievements.new(request.get)
     end
   
     def get_achievements()
@@ -113,20 +105,12 @@ module IActionable
       case filter_type
       when :completed
         request.to("/#{profile_type}/#{id_type}/#{id}/challenges/Completed")
-        response = request.get
-        response.map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)}
       when :available
         request.to("/#{profile_type}/#{id_type}/#{id}/challenges/Available")
-        response = request.get
-        response.map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)}
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/challenges")
-        response = request.get
-        {
-          :available => response["Available"].map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)},
-          :completed => response["Completed"].map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)}
-        }
       end
+      IActionable::Objects::ProfileChallenges.new(request.get)
     end
   
     def get_challenges()
@@ -145,20 +129,12 @@ module IActionable
       case filter_type
       when :completed
         request.to("/#{profile_type}/#{id_type}/#{id}/goals/Completed")
-        response = request.get
-        response.map{|goal_json| IActionable::Objects::Goal.new(goal_json)}
       when :available
         request.to("/#{profile_type}/#{id_type}/#{id}/goals/Available")
-        response = request.get
-        response.map{|goal_json| IActionable::Objects::Goal.new(goal_json)}
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/goals")
-        response = request.get
-        {
-          :available => response["Available"].map{|goal_json| IActionable::Objects::Goal.new(goal_json)},
-          :completed => response["Completed"].map{|goal_json| IActionable::Objects::Goal.new(goal_json)}
-        }
       end
+      IActionable::Objects::ProfileGoals.new(request.get)
     end
   
     def get_goals()
@@ -188,22 +164,7 @@ module IActionable
   
     def get_profile_notifications(profile_type, id_type, id)
       response = @connection.request.with_app_key.to("/#{profile_type}/#{id_type}/#{id}/notifications").get
-      {
-        :achievements => {
-          :available => response["Achievements"]["Available"].map{|a| IActionable::Objects::Achievement.new(a)},
-          :completed => response["Achievements"]["Completed"].map{|a| IActionable::Objects::Achievement.new(a)}
-        },
-        :challenges => {
-          :available => response["Challenges"]["Available"].map{|c| IActionable::Objects::Challenge.new(c)},
-          :completed => response["Challenges"]["Completed"].map{|c| IActionable::Objects::Challenge.new(c)}
-        },
-        :goals => {
-          :available => response["Goals"]["Available"].map{|g| IActionable::Objects::Goal.new(g)},
-          :completed => response["Goals"]["Completed"].map{|g| IActionable::Objects::Goal.new(g)}
-        },
-        :levels => response["Levels"].map{|l| IActionable::Objects::Level.new(l)},
-        :points => response["Points"].map{|p| IActionable::Objects::ProfilePoints.new(p)}
-      }
+      IActionable::Objects::ProfileNotifications.new(response)
     end
   end
 end

data/lib/riaction/iactionable/objects/achievement.rb

@@ -12,6 +12,18 @@ module IActionable
       end
       
       awardable
+      
+      def to_hash
+        hash = {
+          "Key" => @key,
+          "Description" => @description,
+          "ImageURL" => @image_url,
+          "Name" => @name
+        }
+        hash.merge!(awardable_hash) unless @progress.empty?
+        hash.delete("AwardDate") if @award_date.nil?
+        hash
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/awardable.rb

@@ -8,6 +8,7 @@ module IActionable
       module ClassMethods
         def awardable
           attr_accessor :award_date
+          attr_accessor :original_award_date
           attr_accessor :progress
           include IActionable::Objects::Awardable::InstanceMethods
         end
@@ -18,7 +19,7 @@ module IActionable
           @progress = extract_many_as(key_values, "Progress", IActionable::Objects::Progress)
           # convert the miliseconds within the date string to seconds (per ruby)
           # "/Date(1275706032317-0600)/" => "1275706032-0600"
-          @award_date = key_values.delete("AwardDate")
+          @original_award_date = @award_date = key_values.delete("AwardDate")
           @award_date = IActionableObject.timestamp_to_seconds(@award_date) unless @award_date.blank?
         end
       
@@ -36,6 +37,13 @@ module IActionable
           # bug in ruby 1.9.2 where Time.strptime does not support seconds-since-epoch format, but Date.strptime does, so we'll use that for now
           Date.strptime(@award_date, "%s%z").to_time unless @award_date.blank?
         end
+        
+        def awardable_hash
+          {
+            "AwardDate" => @original_award_date,
+            "Progress" => @progress.map{|prog| prog.to_hash}
+          }
+        end
       end
     end
   end

data/lib/riaction/iactionable/objects/challenge.rb

@@ -11,6 +11,17 @@ module IActionable
         initialize_awardable(key_values)
         super(key_values)
       end
+      
+      def to_hash
+        hash = {
+          "Key" => @key,
+          "Description" => @description,
+          "Name" => @name
+        }
+        hash.merge!(awardable_hash) unless @progress.empty?
+        hash.delete("AwardDate") if @award_date.nil?
+        hash
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/goal.rb

@@ -12,6 +12,19 @@ module IActionable
         initialize_awardable(key_values)
         super(key_values)
       end
+      
+      def to_hash
+        hash = {
+          "Key" => @key,
+          "Description" => @description,
+          "Name" => @name,
+          "Interval" => @interval
+        }
+        hash.merge!(awardable_hash) unless @progress.empty?
+        hash.delete("AwardDate") if @award_date.nil?
+        hash.delete("Interval") if @interval.nil?
+        hash
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/identifier.rb

@@ -4,6 +4,14 @@ module IActionable
       attr_accessor :id
       attr_accessor :id_hash
       attr_accessor :id_type
+      
+      def to_hash
+        {
+          "ID" => @id,
+          "IDHash" => @id_hash,
+          "IDType" => @id_type
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/leaderboard.rb

@@ -3,6 +3,13 @@ module IActionable
     class Leaderboard < IActionableObject
       attr_accessor :key
       attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/leaderboard_report.rb

@@ -14,6 +14,17 @@ module IActionable
         @profiles = extract_many_as(key_values, "Profiles", IActionable::Objects::ProfileSummary)
         super(key_values)
       end
+      
+      def to_hash
+        {
+          "PageCount" => @page_count,
+          "PageNumber" => @page_number,
+          "TotalCount" => @total_count,
+          "Leaderboard" => @leaderboard.to_hash,
+          "PointType" => @point_type.to_hash,
+          "Profiles" => @profiles.map{|profile| profile.to_hash}
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/level.rb

@@ -10,6 +10,15 @@ module IActionable
         @level_type = IActionable::Objects::LevelType.new(key_values.delete("LevelType"))
         super(key_values)
       end
+      
+      def to_hash
+        {
+          "Name" => @name,
+          "Number" => @number,
+          "RequiredPoints" => @required_points,
+          "LevelType" => @level_type.to_hash
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/level_type.rb

@@ -3,6 +3,13 @@ module IActionable
     class LevelType < IActionableObject
       attr_accessor :key
       attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/point_type.rb

@@ -3,6 +3,13 @@ module IActionable
     class PointType < IActionableObject
       attr_accessor :key
       attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/profile_achievements.rb

@@ -0,0 +1,20 @@
+module IActionable
+  module Objects
+    class ProfileAchievements < IActionableObject
+      attr_accessor :available
+      attr_accessor :completed
+      
+      def initialize(key_values={})
+        @available = extract_many_as(key_values, "Available", IActionable::Objects::Achievement)
+        @completed = extract_many_as(key_values, "Completed", IActionable::Objects::Achievement)
+      end
+      
+      def to_hash
+        {
+          "Available" => @available.map{|achievement| achievement.to_hash},
+          "Completed" => @completed.map{|achievement| achievement.to_hash}
+        }
+      end
+    end
+  end
+end

data/lib/riaction/iactionable/objects/profile_challenges.rb

@@ -0,0 +1,20 @@
+module IActionable
+  module Objects
+    class ProfileChallenges < IActionableObject
+      attr_accessor :available
+      attr_accessor :completed
+      
+      def initialize(key_values={})
+        @available = extract_many_as(key_values, "Available", IActionable::Objects::Challenge)
+        @completed = extract_many_as(key_values, "Completed", IActionable::Objects::Challenge)
+      end
+      
+      def to_hash
+        {
+          "Available" => @available.map{|challenge| challenge.to_hash},
+          "Completed" => @completed.map{|challenge| challenge.to_hash}
+        }
+      end
+    end
+  end
+end

data/lib/riaction/iactionable/objects/profile_goals.rb

@@ -0,0 +1,20 @@
+module IActionable
+  module Objects
+    class ProfileGoals < IActionableObject
+      attr_accessor :available
+      attr_accessor :completed
+      
+      def initialize(key_values={})
+        @available = extract_many_as(key_values, "Available", IActionable::Objects::Goal)
+        @completed = extract_many_as(key_values, "Completed", IActionable::Objects::Goal)
+      end
+      
+      def to_hash
+        {
+          "Available" => @available.map{|goal| goal.to_hash},
+          "Completed" => @completed.map{|goal| goal.to_hash}
+        }
+      end
+    end
+  end
+end

data/lib/riaction/iactionable/objects/profile_level.rb

@@ -8,6 +8,13 @@ module IActionable
         @current = IActionable::Objects::Level.new(key_values.delete("Current")) unless key_values["Current"].blank?
         @next = IActionable::Objects::Level.new(key_values.delete("Next")) unless key_values["Next"].blank?
       end
+      
+      def to_hash
+        {
+          "Current" => @current.to_hash,
+          "Next" => @next.to_hash
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/profile_notifications.rb

@@ -0,0 +1,29 @@
+module IActionable
+  module Objects
+    class ProfileNotifications < IActionableObject
+      attr_accessor :achievements
+      attr_accessor :challenges
+      attr_accessor :goals
+      attr_accessor :levels
+      attr_accessor :points
+      
+      def initialize(key_values={})
+        @achievements = IActionable::Objects::ProfileAchievements.new(key_values.delete("Achievements"))
+        @challenges = IActionable::Objects::ProfileChallenges.new(key_values.delete("Challenges"))
+        @goals = IActionable::Objects::ProfileGoals.new(key_values.delete("Goals"))
+        @levels = extract_many_as(key_values, "Levels", IActionable::Objects::Level)
+        @points = extract_many_as(key_values, "Points", IActionable::Objects::ProfilePoints)
+      end
+      
+      def to_hash
+        {
+          "Achievements" => @achievements.to_hash,
+          "Challenges" => @challenges.to_hash,
+          "Goals" => @goals.to_hash,
+          "Levels" => @levels.map{|level| level.to_hash},
+          "Points" => @points.map{|point| point.to_hash}
+        }
+      end
+    end
+  end
+end

data/lib/riaction/iactionable/objects/profile_points.rb

@@ -12,6 +12,18 @@ module IActionable
         @point_type = IActionable::Objects::PointType.new(key_values.delete("PointType"))
         super(key_values)
       end
+      
+      def to_hash
+        hash = {
+          "Level" => @level.nil? ? nil : @level.to_hash,
+          "PointType" => @point_type.to_hash,
+          "Points" => @points,
+          "Reason" => @reason
+        }
+        hash.delete "Level" if @level.nil?
+        hash.delete "Reason" if @reason.nil?
+        hash
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/profile_summary.rb

@@ -8,9 +8,9 @@ module IActionable
     class ProfileSummary < IActionableObject
       attr_accessor :display_name
       attr_accessor :identifiers
-      attr_accessor :points
-      attr_accessor :recent_achievements
-      attr_accessor :rank
+      attr_accessor :points 
+      attr_accessor :recent_achievements # not always present
+      attr_accessor :rank # not always present
       
       def initialize(key_values={})
         @identifiers = extract_many_as(key_values, "Identifiers", IActionable::Objects::Identifier)
@@ -19,6 +19,19 @@ module IActionable
         
         super(key_values)
       end      
+      
+      def to_hash
+        hash = {
+          "DisplayName" => @display_name,
+          "Identifiers" => @identifiers.map{|identifier| identifier.to_hash}
+        }
+        unless @points.nil?
+          hash["Points"] = @points.kind_of?(Array) ? @points.map{|point| point.to_hash} : @points
+        end
+        hash["RecentAchievements"] = @recent_achievements.map{|recent_achievement| recent_achievement.to_hash} unless @recent_achievements.empty?
+        hash["Rank"] = @rank unless @rank.nil?
+        hash
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects/progress.rb

@@ -3,6 +3,7 @@ module IActionable
     class Progress < IActionableObject
       attr_accessor :description
       attr_accessor :condition_met_date
+      attr_accessor :original_condition_met_date
       attr_accessor :current_value
       attr_accessor :required_value
       attr :complete
@@ -11,6 +12,7 @@ module IActionable
         super(key_values)
         # convert the miliseconds within the date string to seconds (per ruby)
         # "/Date(1275706032317-0600)/" => "1275706032-0600"
+        @original_condition_met_date = @condition_met_date
         @condition_met_date = IActionableObject.timestamp_to_seconds(@condition_met_date) unless @condition_met_date.blank?
       end
       
@@ -30,6 +32,15 @@ module IActionable
         # bug in ruby 1.9.2 where Time.strptime does not support seconds-since-epoch format, but Date.strptime does, so we'll use that for now
         Date.strptime(@condition_met_date, "%s%z").to_time unless @condition_met_date.blank?
       end
+      
+      def to_hash
+        {
+          "Description" => @description,
+          "CurrentValue" => @current_value,
+          "RequiredValue" => @required_value,
+          "ConditionMetDate" => @original_condition_met_date
+        }
+      end
     end
   end
 end

data/lib/riaction/iactionable/objects.rb

@@ -21,3 +21,7 @@ require 'riaction/iactionable/objects/point_type.rb'
 require 'riaction/iactionable/objects/profile_level.rb'
 require 'riaction/iactionable/objects/profile_points.rb'
 require 'riaction/iactionable/objects/profile_summary.rb'
+require 'riaction/iactionable/objects/profile_achievements.rb'
+require 'riaction/iactionable/objects/profile_challenges.rb'
+require 'riaction/iactionable/objects/profile_goals.rb'
+require 'riaction/iactionable/objects/profile_notifications.rb'

data/lib/riaction/version.rb

@@ -1,3 +1,3 @@
 module Riaction
-  VERSION = "0.5.1"
+  VERSION = "1.0.0"
 end

data/spec/api_spec.rb

@@ -6,6 +6,7 @@ describe IActionable::Api do
     @mock_connection = mock("connection")
     @mock_response = mock("mock response")
     @mock_response_item = mock("mock response item")
+    @mock_object = mock("mock object")
     
     IActionable::Connection.stub!(:new).and_return(@mock_connection)
     IActionable::Settings.stub!(:new).and_return(@mock_settings)
@@ -187,12 +188,12 @@ describe IActionable::Api do
     end
   end
   
-  [ [:achievements, IActionable::Objects::Achievement],
-    [:challenges, IActionable::Objects::Challenge],
-    [:goals, IActionable::Objects::Goal]].each do |type|
+  [ [:achievements, IActionable::Objects::ProfileAchievements, IActionable::Objects::Achievement],
+    [:challenges, IActionable::Objects::ProfileChallenges, IActionable::Objects::Challenge],
+    [:goals, IActionable::Objects::ProfileGoals, IActionable::Objects::Goal]].each do |type|
     describe "loading all #{type} for a profile" do
       before do 
-        type[1].stub!(:new)
+        type[1].stub!(:new).and_return(@mock_object)
         @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
         @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
         @mock_connection.should_receive(:get).and_return(@mock_response)
@@ -206,8 +207,8 @@ describe IActionable::Api do
         
         it "should return as the proper object type" do
           @mock_connection.stub!(:to).and_return(@mock_connection)
-          type[1].should_receive(:new).once.with(@mock_response_item)
-          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :available).should == @mock_response
+          type[1].should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :available).should == @mock_object
         end
       end
       
@@ -219,8 +220,8 @@ describe IActionable::Api do
         
         it "should return as the proper object type" do
           @mock_connection.stub!(:to).and_return(@mock_connection)
-          type[1].should_receive(:new).once.with(@mock_response_item)
-          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :completed).should == @mock_response
+          type[1].should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, :completed).should == @mock_object
         end
       end
       
@@ -230,13 +231,33 @@ describe IActionable::Api do
           @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil)
         end
         
-        it "should return as the proper object type, in a hash with both filter types" do
+        it "should return as the proper object type" do
           @mock_connection.stub!(:to).and_return(@mock_connection)
-          type[1].should_receive(:new).twice.with(@mock_response_item)
-          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil).should == {:available => @mock_response, :completed => @mock_response}
+          type[1].should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil).should == @mock_object
         end
       end
     end
+    
+    describe "loading all #{type[0]} outside of a profile context" do
+      before do
+        type[2].stub!(:new).and_return(@mock_object)
+        @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
+        @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
+        @mock_connection.should_receive(:get).and_return(@mock_response)
+      end
+      
+      it "should make the correct IActionable API all" do
+        @mock_connection.should_receive(:to).once.with("/#{type[0]}").and_return(@mock_connection)
+        @api.send("get_#{type[0]}")
+      end
+      
+      it "should return as the proper object type" do
+        @mock_connection.stub!(:to).and_return(@mock_connection)
+        type[2].should_receive(:new).once.with(@mock_response_item).and_return(@mock_object)
+        @api.send("get_#{type[0]}").should == @mock_response
+      end
+    end
   end
   
   describe "leaderboards" do
@@ -273,16 +294,21 @@ describe IActionable::Api do
   
   describe "notifications" do
     it "should make the correct IActionable API all" do
-      IActionable::Objects::Achievement.stub!(:new)
-      IActionable::Objects::Challenge.stub!(:new)
-      IActionable::Objects::Goal.stub!(:new)
-      IActionable::Objects::Level.stub!(:new)
-      IActionable::Objects::ProfilePoints.stub!(:new)
+      IActionable::Objects::ProfileNotifications.stub!(:new)
       @mock_connection.should_receive(:request).once.ordered.and_return(@mock_connection)
       @mock_connection.should_receive(:with_app_key).and_return(@mock_connection)
       @mock_connection.should_receive(:to).with("/#{@profile_type}/#{@id_type}/#{@id}/notifications").and_return(@mock_connection)
       @mock_connection.should_receive(:get).and_return(@mock_response)
       @api.get_profile_notifications(@profile_type, @id_type, @id)
     end
+    
+    it "should return with the corect object" do
+      @mock_connection.stub!(:request).and_return(@mock_connection)
+      @mock_connection.stub!(:with_app_key).and_return(@mock_connection)
+      @mock_connection.stub!(:to).and_return(@mock_connection)
+      @mock_connection.stub!(:get).and_return(@mock_response)
+      IActionable::Objects::ProfileNotifications.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
+      @api.get_profile_notifications(@profile_type, @id_type, @id).should == @mock_response
+    end
   end
 end

data/spec/get_achievements_api_response_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper.rb'
+
+describe "API response to get_achievements" do
+  before do
+    @sample_response = [
+        {
+            "Key" => "opinionated_gold",
+            "Description" => "Leave 25 comments.",
+            "ImageURL" => "http://iactionable.blob.core.windows.net/achievementimages/33333",
+            "Name" => "Opinionated - Gold"
+        },
+        {
+            "Key" => "opinionated_silver",
+            "Description" => "Make 10 comments.",
+            "ImageURL" => "http://iactionable.blob.core.windows.net/achievementimages/44444",
+            "Name" => "Opinionated - Silver"
+        }
+    ]
+  end
+  
+  it "should not raise error on wrapping in an object" do
+    lambda { @sample_response.map{|data| IActionable::Objects::Achievement.new(data) } }.should_not raise_error
+  end
+  
+  describe "when wrapped in an object" do
+    before do
+      @wrapped = @sample_response.map{|data| IActionable::Objects::Achievement.new(data) }
+    end
+    
+    it "should contain ar array of available achievements" do
+      @wrapped.should be_instance_of Array
+      @wrapped.first.key.should == @sample_response[0]["Key"]
+      @wrapped.first.description.should == @sample_response[0]["Description"]
+      @wrapped.first.image_url.should == @sample_response[0]["ImageURL"]
+      @wrapped.first.name.should == @sample_response[0]["Name"]
+      @wrapped.last.key.should == @sample_response[1]["Key"]
+      @wrapped.last.description.should == @sample_response[1]["Description"]
+      @wrapped.last.image_url.should == @sample_response[1]["ImageURL"]
+      @wrapped.last.name.should == @sample_response[1]["Name"]
+    end
+
+    it "should convert to a hash equal to the original" do
+      hash_including(:array => @sample_response).should == {:array => @wrapped.map{|achievement| achievement.to_hash}}
+    end
+  end
+end