naudo-ruby-iactionable 0.1.1

data/lib/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/iactionable/objects/profile_points.rb

@@ -0,0 +1,29 @@
+module IActionable
+  module Objects
+    class ProfilePoints < IActionableObject
+      attr_accessor :level # not always present
+      attr_accessor :point_type
+      attr_accessor :points
+      attr_accessor :reason # not always present
+      
+      def initialize(key_values={})
+        levels = key_values.delete("Level")
+        @level = IActionable::Objects::ProfileLevel.new(levels) unless levels.nil?
+        @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/iactionable/objects/profile_summary.rb

@@ -0,0 +1,32 @@
+module IActionable
+  module Objects
+    class ProfileSummary < IActionableObject
+      attr_accessor :display_name
+      attr_accessor :identifiers
+      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)
+        @points = extract_many_as(key_values, "Points", IActionable::Objects::ProfilePoints)
+        @recent_achievements = extract_many_as(key_values, "RecentAchievements", IActionable::Objects::Achievement)
+        
+        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/iactionable/objects/progress.rb

@@ -0,0 +1,46 @@
+module IActionable
+  module Objects
+    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
+      
+      def initialize(key_values={})
+        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
+      
+      def complete?
+        Integer(@current_value) >= Integer(@required_value)
+      rescue TypeError => e
+        false
+      end
+      
+      def percent_complete
+        Integer(Float(@current_value) / Integer(@required_value) * 100)
+      rescue TypeError => e
+        0
+      end
+      
+      def condition_met_date
+        # bug in ruby 1.9.2 where Time.strptime does not support seconds-since-epoch format, but DateTime.strptime does, so we'll use that for now
+        DateTime.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/iactionable/settings.rb

@@ -0,0 +1,30 @@
+module IActionable
+  class ConfigError < StandardError
+  end
+  
+  class Settings
+    attr :settings
+    
+    def initialize(values)
+      @settings = {
+        :app_key => values.fetch(:app_key),
+        :api_key => values.fetch(:api_key),
+        :version => values.fetch(:version)
+      }
+    rescue NoMethodError, KeyError => e
+      raise ConfigError.new("IAction::Settings being initialized with invalid arguments")
+    end
+    
+    def app_key
+      @settings.fetch(:app_key)
+    end
+    
+    def api_key
+      @settings.fetch(:api_key)
+    end
+    
+    def version
+      @settings.fetch(:version)
+    end
+  end
+end

data/lib/iactionable/version.rb

@@ -0,0 +1,3 @@
+module IActionable
+  VERSION = "0.1.1"
+end

data/lib/ruby-iactionable.rb

@@ -0,0 +1,9 @@
+require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/date/conversions'
+require 'active_support/core_ext/time/calculations'
+require 'iactionable/version'
+require 'iactionable/api.rb'
+
+module IActionable
+end

data/ruby_iactionable.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "iactionable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "naudo-ruby-iactionable"
+  s.version     = IActionable::VERSION
+  s.authors     = ["Chris Eberz"]
+  s.email       = ["ceberz@elctech.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for IActionable's restful API.}
+  s.description = %q{Ruby wrapper for IActionable's restful API.}
+
+  s.rubyforge_project = "ruby-iactionable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "spec"]
+
+
+  s.add_development_dependency "rspec", ">= 2.6"
+  s.add_development_dependency "yard"
+
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "faraday_middleware", '~> 0.8.7'
+  s.add_runtime_dependency "activesupport", ">= 3.0.0"
+end

data/spec/api/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

data/spec/api/get_challenges_api_response_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper.rb'
+
+describe "API response to get_challenges" do
+  before do
+    @sample_response = [
+        {
+            "Key" => "easy_challenge",
+            "Description" => "Do something easy 5 times and earn 100 points",
+            "Name" => "Easy Challenge"
+        },
+        {
+            "Key" => "hard_challenge",
+            "Description" => "Do something hard 10 times and earn 200 points",
+            "Name" => "Hard Challenge"
+        }
+    ]
+  end
+  
+  it "should not raise error on wrapping in an object" do
+    lambda { @sample_response.map{|data| IActionable::Objects::Challenge.new(data) } }.should_not raise_error
+  end
+  
+  describe "when wrapped in an object" do
+    before do
+      @wrapped = @sample_response.map{|data| IActionable::Objects::Challenge.new(data) }
+    end
+    
+    it "should contain ar array of available challenges" 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.name.should == @sample_response[0]["Name"]
+      @wrapped.last.key.should == @sample_response[1]["Key"]
+      @wrapped.last.description.should == @sample_response[1]["Description"]
+      @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{|challenge| challenge.to_hash}}
+    end
+  end
+end

data/spec/api/get_goals_api_response_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper.rb'
+
+describe "API response to get_goals" do
+  before do
+    @sample_response = [
+        {
+            "Key" => "easy_goal",
+            "Description" => "Do something easy 5 times today and earn 100 points",
+            "Name" => "Easy Goal",
+            "Interval" => "Daily"
+        },
+        {
+            "Key" => "hard_goal",
+            "Description" => "Do something hard 10 times this week and earn 200 points",
+            "Name" => "Hard Goal",
+            "Interval" => "Daily"
+        }
+    ]
+  end
+  
+  it "should not raise error on wrapping in an object" do
+    lambda { @sample_response.map{|data| IActionable::Objects::Goal.new(data) } }.should_not raise_error
+  end
+  
+  describe "when wrapped in an object" do
+    before do
+      @wrapped = @sample_response.map{|data| IActionable::Objects::Goal.new(data) }
+    end
+    
+    it "should contain ar array of available goals" 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.name.should == @sample_response[0]["Name"]
+      @wrapped.first.interval.should == @sample_response[0]["Interval"]
+      @wrapped.last.key.should == @sample_response[1]["Key"]
+      @wrapped.last.description.should == @sample_response[1]["Description"]
+      @wrapped.last.name.should == @sample_response[1]["Name"]
+      @wrapped.last.interval.should == @sample_response[1]["Interval"]
+    end
+
+    it "should convert to a hash equal to the original" do
+      hash_including(:array => @sample_response).should == {:array => @wrapped.map{|goal| goal.to_hash}}
+    end
+  end
+end

data/spec/api/get_leaderboard_api_response_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper.rb'
+
+describe "API response to get_leaderboard" do
+  before do
+    @sample_response = {
+        "Leaderboard" => {
+            "Key" => "weekly_leaderboard",
+            "Name" => "Weekly Experience Points Leaderboard"
+        },
+        "PageCount" => 10,
+        "PageNumber" => 1,
+        "PointType" => {
+            "Key" => "experience_points",
+            "Name" => "Experience Points"
+        },
+        "Profiles" => [
+            {
+                "DisplayName" => "Jimmy Dean",
+                "Identifiers" => [
+                    {
+                        "ID" => "100005",
+                        "IDHash" => "d63c48a193f960380f0ac353eddc25d4",
+                        "IDType" => "Facebook"
+                    }
+                ],
+                "Rank" => 1,
+                "Points" => 246
+            },
+            {
+                "DisplayName" => "Jason Barnes",
+                "Identifiers" => [
+                    {
+                        "ID" => "100010",
+                        "IDHash" => "d3d33fb3e33963b58f681ed2e98d835c",
+                        "IDType" => "Facebook"
+                    },
+                    {
+                        "ID" => "email@dot.com",
+                        "IDHash" => "66a1bd06edcc1a2d208953d441e1374e",
+                        "IDType" => "Email"
+                    }
+                ],
+                "Rank" => 2,
+                "Points" => 216
+            },
+            {
+                "DisplayName" => "Ben Burt",
+                "Identifiers" => [
+                    {
+                        "ID" => "600004",
+                        "IDHash" => "e567689d28abc93867955ff85324bd08",
+                        "IDType" => "Facebook"
+                    }
+                ],
+                "Rank" => 3,
+                "Points" => 50
+            }
+        ],
+        "TotalCount" => 50
+    }
+  end
+  
+  it "should not raise error on wrapping in an object" do
+    lambda { IActionable::Objects::LeaderboardReport.new(@sample_response) }.should_not raise_error
+  end
+  
+  describe "when wrapped in an object" do
+    before do
+      @wrapped = IActionable::Objects::LeaderboardReport.new(Marshal.load(Marshal.dump(@sample_response)))
+    end
+    
+    it "should convert to a hash equal to the original" do
+      hash_including(@sample_response).should == @wrapped.to_hash
+    end
+  end
+end

data/spec/api/get_profile_achievements_api_response_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper.rb'
+
+describe "API response to get_profile_achievements" do
+  before do
+    @sample_response = {
+        "Available" => [
+            {
+                "Key" => "super_user",
+                "Description" => "Post 35 Photos and make 50 Comments",
+                "ImageURL" => "http://iactionable.blob.core.windows.net/achievementimages/99999",
+                "Name" => "Super User",
+                "Progress" => [
+                    {
+                        "ConditionMetDate" => nil,
+                        "CurrentValue" => 12,
+                        "Description" => "Post 35 Photos",
+                        "RequiredValue" => "35"
+                    },
+                    {
+                        "ConditionMetDate" => nil,
+                        "CurrentValue" => 6,
+                        "Description" => "Make 50 Comments",
+                        "RequiredValue" => "50"
+                    }
+                ]
+            }
+        ],
+        "Completed" => [
+            {
+                "Key" => "you_can_talk",
+                "Description" => "Post a Comment on any blog post.",
+                "ImageURL" => "http://iactionable.blob.core.windows.net/achievementimages/99998",
+                "Name" => "You can talk!",
+                "Progress" => [
+                    {
+                        "ConditionMetDate" => "/Date(1275706032317-0600)/",
+                        "CurrentValue" => 1,
+                        "Description" => "Make 1 Comment",
+                        "RequiredValue" => "1"
+                    }
+                ],
+                "AwardDate" => "/Date(1275706032317-0600)/"
+            }
+        ]
+    }
+  end
+  
+  it "should not raise error on wrapping in an object" do
+    lambda { IActionable::Objects::ProfileAchievements.new(@sample_response) }.should_not raise_error
+  end
+  
+  describe "with a malformed AwardDate string" do
+    before do
+       @sample_response["Completed"].first["AwardDate"] = 'bogus'
+    end
+    
+    it "should not raise error on wrapping in an object" do
+      lambda { IActionable::Objects::ProfileAchievements.new(@sample_response) }.should_not raise_error
+    end
+    
+    it "should set the value of AwardDate to nil" do
+      IActionable::Objects::ProfileAchievements.new(@sample_response).completed.first.award_date.should be_nil
+    end
+  end
+  
+  describe "when wrapped in an object" do
+    before do
+      @wrapped = IActionable::Objects::ProfileAchievements.new(Marshal.load(Marshal.dump(@sample_response)))
+    end
+    
+    it "should contain ar array of available achievements" do
+      @wrapped.available.should be_instance_of Array
+      @wrapped.available.first.key.should == @sample_response["Available"][0]["Key"]
+      @wrapped.available.first.description.should == @sample_response["Available"][0]["Description"]
+      @wrapped.available.first.image_url.should == @sample_response["Available"][0]["ImageURL"]
+      @wrapped.available.first.name.should == @sample_response["Available"][0]["Name"]
+      @wrapped.available.first.award_date.should be_nil
+    end
+    
+    it "should contain an array of progresses within each available achievement" do
+      @wrapped.available.first.progress.should be_instance_of Array
+      @wrapped.available.first.progress.first.condition_met_date.should be_nil
+      @wrapped.available.first.progress.first.current_value.should == @sample_response["Available"][0]["Progress"][0]["CurrentValue"]
+      @wrapped.available.first.progress.first.description.should == @sample_response["Available"][0]["Progress"][0]["Description"]
+      @wrapped.available.first.progress.first.required_value.should == @sample_response["Available"][0]["Progress"][0]["RequiredValue"]      
+      @wrapped.available.first.progress.last.condition_met_date.should be_nil
+      @wrapped.available.first.progress.last.current_value.should == @sample_response["Available"][0]["Progress"][1]["CurrentValue"]
+      @wrapped.available.first.progress.last.description.should == @sample_response["Available"][0]["Progress"][1]["Description"]
+      @wrapped.available.first.progress.last.required_value.should == @sample_response["Available"][0]["Progress"][1]["RequiredValue"]
+    end
+    
+    it "should contain ar array of completed achievements" do
+      @wrapped.completed.should be_instance_of Array
+      @wrapped.completed.first.key.should == @sample_response["Completed"][0]["Key"]
+      @wrapped.completed.first.description.should == @sample_response["Completed"][0]["Description"]
+      @wrapped.completed.first.image_url.should == @sample_response["Completed"][0]["ImageURL"]
+      @wrapped.completed.first.name.should == @sample_response["Completed"][0]["Name"]
+      @wrapped.completed.first.award_date.should_not be_nil
+    end
+    
+    it "should contain an array of progresses within each completed achievement" do
+      @wrapped.completed.first.progress.should be_instance_of Array
+      @wrapped.completed.first.progress.first.condition_met_date.should_not be_nil
+      @wrapped.completed.first.progress.first.current_value.should == @sample_response["Completed"][0]["Progress"][0]["CurrentValue"]
+      @wrapped.completed.first.progress.first.description.should == @sample_response["Completed"][0]["Progress"][0]["Description"]
+      @wrapped.completed.first.progress.first.required_value.should == @sample_response["Completed"][0]["Progress"][0]["RequiredValue"]      
+    end
+    
+    it "should convert to a hash equal to the original" do
+      hash_including(@sample_response).should == @wrapped.to_hash
+    end
+  end
+end