ruby-iactionable 0.0.5 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG #
 
+## 0.1.0 ##
+
+* New feature: api instance can be set to not wrap raw response within objects with: `@api.set\_object\_wrapping(false)`
+
 ## 0.0.5 ##
 
 * Fixed: IActionable::Objects::Awardable#awarded_on was stripping out time information when converting IActionable timestamp to Ruby time object

data/lib/iactionable/api.rb

@@ -6,6 +6,8 @@ module IActionable
   
   class Api
     attr :connection
+    attr :wrap_in_object
+    
     @@settings = nil
   
     def initialize
@@ -14,6 +16,7 @@ module IActionable
       else
         raise IActionable::ConfigError.new("IActionable::Api cannot be initialized without credentials being set in IActionable::Api.init_settings()")
       end
+      @wrap_in_object = true
     end
   
     def self.init_settings(values)
@@ -26,6 +29,11 @@ module IActionable
       @@settings
     end
   
+    def set_object_wrapping(bool)
+      @wrap_in_object = !!bool
+      self
+    end
+  
     # =================
     # = Event Logging =
     # =================
@@ -41,8 +49,11 @@ module IActionable
     def get_profile_summary(profile_type, id_type, id, achievement_count = nil)
       request = @connection.request.with_app_key.to("/#{profile_type}/#{id_type}/#{id}")
       request.with_params(:achievementCount => achievement_count) unless achievement_count.blank?
-      response = request.get
-      IActionable::Objects::ProfileSummary.new(response)
+      if @wrap_in_object
+        IActionable::Objects::ProfileSummary.new(request.get)
+      else
+        request.get
+      end
     end
   
     def create_profile(profile_type, id_type, id, display_name = nil)
@@ -62,14 +73,21 @@ module IActionable
   
     def get_profile_points(profile_type, id_type, id, point_type)
       response = @connection.request.with_app_key.to("/#{profile_type}/#{id_type}/#{id}/points/#{point_type}").get
-      IActionable::Objects::ProfilePoints.new(response)
+      if @wrap_in_object
+        IActionable::Objects::ProfilePoints.new(response)
+      else
+        response
+      end
     end
   
     def update_profile_points(profile_type, id_type, id, point_type, amount, reason = nil)
       request = @connection.request.with_app_key.with_api_key.to("/#{profile_type}/#{id_type}/#{id}/points/#{point_type}").with_params(:value => amount)
       request.with_params(:description => reason) unless reason.blank?
-      response = request.post
-      IActionable::Objects::ProfilePoints.new(response)
+      if @wrap_in_object
+        IActionable::Objects::ProfilePoints.new(request.post)
+      else
+        request.post
+      end
     end
   
     # =========================
@@ -86,12 +104,21 @@ module IActionable
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/achievements")
       end
-      IActionable::Objects::ProfileAchievements.new(request.get)
+      
+      if @wrap_in_object
+        IActionable::Objects::ProfileAchievements.new(request.get)
+      else
+        request.get
+      end
     end
   
     def get_achievements()
       response = @connection.request.with_app_key.to("/achievements").get
-      response.map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)}
+      if @wrap_in_object
+        response.map{|achievement_json| IActionable::Objects::Achievement.new(achievement_json)}
+      else
+        response
+      end
     rescue NoMethodError => e
       []
     end
@@ -110,12 +137,21 @@ module IActionable
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/challenges")
       end
-      IActionable::Objects::ProfileChallenges.new(request.get)
+      
+      if @wrap_in_object
+        IActionable::Objects::ProfileChallenges.new(request.get)
+      else
+        request.get
+      end
     end
   
     def get_challenges()
       response = @connection.request.with_app_key.to("/challenges").get
-      response.map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)}
+      if @wrap_in_object
+        response.map{|challenge_json| IActionable::Objects::Challenge.new(challenge_json)}
+      else
+        response
+      end
     rescue NoMethodError => e
       []
     end
@@ -134,12 +170,21 @@ module IActionable
       else
         request.to("/#{profile_type}/#{id_type}/#{id}/goals")
       end
-      IActionable::Objects::ProfileGoals.new(request.get)
+      
+      if @wrap_in_object
+        IActionable::Objects::ProfileGoals.new(request.get)
+      else
+        request.get
+      end
     end
   
     def get_goals()
       response = @connection.request.with_app_key.to("/goals").get
-      response.map{|goal_json| IActionable::Objects::Goal.new(goal_json)}
+      if @wrap_in_object
+        response.map{|goal_json| IActionable::Objects::Goal.new(goal_json)}
+      else
+        response
+      end
     rescue NoMethodError => e
       []
     end
@@ -154,8 +199,12 @@ module IActionable
       request.with_params(:pageCount => page_count) unless page_count.blank?
       request.with_params(:id => id) unless id.blank? || id_type.blank?
       request.with_params(:idType => id_type) unless id.blank? || id_type.blank?
-      response = request.get
-      IActionable::Objects::LeaderboardReport.new(response)
+      
+      if @wrap_in_object
+        IActionable::Objects::LeaderboardReport.new(request.get)
+      else
+        request.get
+      end
     end
   
     # ===================================
@@ -164,7 +213,12 @@ 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
-      IActionable::Objects::ProfileNotifications.new(response)
+
+      if @wrap_in_object
+        IActionable::Objects::ProfileNotifications.new(response)
+      else
+        response
+      end
     end
   end
 end

data/lib/iactionable/version.rb

@@ -1,3 +1,3 @@
 module IActionable
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/api_spec.rb

@@ -90,8 +90,19 @@ describe IActionable::Api do
       end
       
       it "should return the response as a ProfileSummary object" do
-        IActionable::Objects::ProfileSummary.should_receive(:new).once.with(@mock_response)
-        @api.get_profile_summary(@profile_type, @id_type, @id, nil)
+        IActionable::Objects::ProfileSummary.should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+        @api.get_profile_summary(@profile_type, @id_type, @id, nil).should == @mock_object
+      end
+      
+      describe "when told to be returned as raw json/key-values" do
+        before do
+          @api.set_object_wrapping(false)
+        end
+        
+        it "should return the data from the response un-altered" do
+          IActionable::Objects::ProfileSummary.should_not_receive(:new)
+          @api.get_profile_summary(@profile_type, @id_type, @id, nil).should == @mock_response
+        end
       end
     end
     
@@ -151,8 +162,21 @@ describe IActionable::Api do
       it "should return the response as a ProfileSummary object" do
         @mock_connection.stub!(:to).and_return(@mock_connection)
         @mock_connection.stub!(:get).and_return(@mock_response)
-        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
-        @api.get_profile_points(@profile_type, @id_type, @id, @point_type).should == @mock_response
+        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+        @api.get_profile_points(@profile_type, @id_type, @id, @point_type).should == @mock_object
+      end
+      
+      describe "when told to be returned as raw json/key-values" do
+        before do
+          @api.set_object_wrapping(false)
+        end
+        
+        it "should return the data from the response un-altered" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          @mock_connection.stub!(:get).and_return(@mock_response)
+          IActionable::Objects::ProfilePoints.should_not_receive(:new)
+          @api.get_profile_points(@profile_type, @id_type, @id, @point_type).should == @mock_response
+        end
       end
     end
     
@@ -182,8 +206,19 @@ describe IActionable::Api do
       end
       
       it "should return the response as a ProfileSummary object" do
-        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
-        @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, nil).should == @mock_response
+        IActionable::Objects::ProfilePoints.should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+        @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, nil).should == @mock_object
+      end
+      
+      describe "when told to be returned as raw json/key-values" do
+        before do
+          @api.set_object_wrapping(false)
+        end
+        
+        it "should return the data from the response un-altered" do
+          IActionable::Objects::ProfilePoints.should_not_receive(:new)
+          @api.update_profile_points(@profile_type, @id_type, @id, @point_type, @amount, nil).should == @mock_response
+        end
       end
     end
   end
@@ -237,6 +272,18 @@ describe IActionable::Api do
           @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil).should == @mock_object
         end
       end
+      
+      describe "when told to be returned as raw json/key-values" do
+        before do
+          @api.set_object_wrapping(false)
+        end
+        
+        it "should return the data from the response un-altered" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          type[1].should_not_receive(:new)
+          @api.send("get_profile_#{type[0]}", @profile_type, @id_type, @id, nil).should == @mock_response
+        end
+      end
     end
     
     describe "loading all #{type[0]} outside of a profile context" do
@@ -257,6 +304,15 @@ describe IActionable::Api do
         type[2].should_receive(:new).once.with(@mock_response_item).and_return(@mock_object)
         @api.send("get_#{type[0]}").should == @mock_response
       end
+      
+      describe "when told to be returned as raw json/key-values" do
+        it "should return the data from the response un-altered" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          type[2].should_not_receive(:new)
+          @api.set_object_wrapping(false)
+          @api.send("get_#{type[0]}").should == @mock_response
+        end
+      end
     end
   end
   
@@ -286,8 +342,22 @@ describe IActionable::Api do
         @mock_connection.stub!(:to).and_return(@mock_connection)
         @mock_connection.stub!(:with_params).and_return(@mock_connection)
         @mock_connection.stub!(:get).and_return(@mock_response)
-        IActionable::Objects::LeaderboardReport.should_receive(:new).once.with(@mock_response).and_return(@mock_response)
-        @api.get_leaderboard(@profile_type, @point_type, @leaderboard, nil, nil, nil, nil).should == @mock_response
+        IActionable::Objects::LeaderboardReport.should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+        @api.get_leaderboard(@profile_type, @point_type, @leaderboard, nil, nil, nil, nil).should == @mock_object
+      end
+      
+      describe "when told to be returned as raw json/key-values" do
+        before do
+          @api.set_object_wrapping(false)
+        end
+        
+        it "should return the data from the response un-altered" do
+          @mock_connection.stub!(:to).and_return(@mock_connection)
+          @mock_connection.stub!(:with_params).and_return(@mock_connection)
+          @mock_connection.stub!(:get).and_return(@mock_response)
+          IActionable::Objects::LeaderboardReport.should_not_receive(:new)
+          @api.get_leaderboard(@profile_type, @point_type, @leaderboard, nil, nil, nil, nil).should == @mock_response
+        end
       end
     end
   end
@@ -307,8 +377,23 @@ describe IActionable::Api do
       @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
+      IActionable::Objects::ProfileNotifications.should_receive(:new).once.with(@mock_response).and_return(@mock_object)
+      @api.get_profile_notifications(@profile_type, @id_type, @id).should == @mock_object
+    end
+    
+    describe "when told to be returned as raw json/key-values" do
+      before do
+        @api.set_object_wrapping(false)
+      end
+      
+      it "should return the data from the response un-altered" 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_not_receive(:new)
+        @api.get_profile_notifications(@profile_type, @id_type, @id).should == @mock_response
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-iactionable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000Z
+date: 2012-03-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168719120 !ruby/object:Gem::Requirement
+  requirement: &2165266560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2168719120
+  version_requirements: *2165266560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2168718700 !ruby/object:Gem::Requirement
+  requirement: &2165266140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168718700
+  version_requirements: *2165266140
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2168718240 !ruby/object:Gem::Requirement
+  requirement: &2165265680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168718240
+  version_requirements: *2165265680
 - !ruby/object:Gem::Dependency
   name: faraday-stack
-  requirement: &2168717820 !ruby/object:Gem::Requirement
+  requirement: &2165265260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168717820
+  version_requirements: *2165265260
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2168717320 !ruby/object:Gem::Requirement
+  requirement: &2165264760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168717320
+  version_requirements: *2165264760
 description: Ruby wrapper for IActionable's restful API.
 email:
 - ceberz@elctech.com