naudo-ruby-iactionable 0.1.1

data/lib/iactionable/error.rb

@@ -0,0 +1,17 @@
+module IActionable
+  module Error
+    class Error < StandardError
+      attr_accessor :response
+      
+      def initialize(response)
+        @response = response
+        super
+      end
+    end
+  
+    # http://iactionable.com/api/response-codes/
+    class BadRequest < Error; end
+    class Unauthorized < Error; end
+    class Internal < Error; end
+  end
+end

data/lib/iactionable/objects.rb

@@ -0,0 +1,27 @@
+module IActionable
+  module Objects
+  end
+end
+
+require 'iactionable/objects/i_actionable_object.rb'
+require 'iactionable/objects/progress.rb'
+require 'iactionable/objects/awardable.rb'
+
+IActionable::Objects::IActionableObject.send(:include, IActionable::Objects::Awardable)
+
+require 'iactionable/objects/achievement.rb'
+require 'iactionable/objects/challenge.rb'
+require 'iactionable/objects/goal.rb'
+require 'iactionable/objects/identifier.rb'
+require 'iactionable/objects/leaderboard.rb'
+require 'iactionable/objects/leaderboard_report.rb'
+require 'iactionable/objects/level_type.rb'
+require 'iactionable/objects/level.rb'
+require 'iactionable/objects/point_type.rb'
+require 'iactionable/objects/profile_level.rb'
+require 'iactionable/objects/profile_points.rb'
+require 'iactionable/objects/profile_summary.rb'
+require 'iactionable/objects/profile_achievements.rb'
+require 'iactionable/objects/profile_challenges.rb'
+require 'iactionable/objects/profile_goals.rb'
+require 'iactionable/objects/profile_notifications.rb'

data/lib/iactionable/objects/achievement.rb

@@ -0,0 +1,29 @@
+module IActionable
+  module Objects
+    class Achievement < IActionableObject
+      attr_accessor :key
+      attr_accessor :description
+      attr_accessor :image_url
+      attr_accessor :name
+      
+      def initialize(key_values={})
+        initialize_awardable(key_values)
+        super(key_values)
+      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/iactionable/objects/awardable.rb

@@ -0,0 +1,50 @@
+module IActionable
+  module Objects
+    module Awardable
+      def self.included(base)
+        base.extend(ClassMethods)  
+      end
+    
+      module ClassMethods
+        def awardable
+          attr_accessor :award_date
+          attr_accessor :original_award_date
+          attr_accessor :progress
+          include IActionable::Objects::Awardable::InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        def initialize_awardable(key_values={})
+          @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"
+          @original_award_date = @award_date = key_values.delete("AwardDate")
+          @award_date = IActionableObject.timestamp_to_seconds(@award_date) unless @award_date.blank?
+        end
+      
+        def complete?
+          @progress.any? && @progress.all?
+        end
+      
+        def percent_complete
+          Integer(Float(@progress.select{|p| p.complete?}.size) / @progress.size * 100)
+        rescue TypeError => e
+          0
+        end
+      
+        def awarded_on
+          # 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(@award_date, "%s%z") unless @award_date.blank?
+        end
+        
+        def awardable_hash
+          {
+            "AwardDate" => @original_award_date,
+            "Progress" => @progress.map{|prog| prog.to_hash}
+          }
+        end
+      end
+    end
+  end
+end

data/lib/iactionable/objects/challenge.rb

@@ -0,0 +1,27 @@
+module IActionable
+  module Objects
+    class Challenge < IActionableObject
+      awardable
+      
+      attr_accessor :key
+      attr_accessor :description
+      attr_accessor :name
+      
+      def initialize(key_values={})
+        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/iactionable/objects/goal.rb

@@ -0,0 +1,30 @@
+module IActionable
+  module Objects
+    class Goal < IActionableObject
+      awardable
+      
+      attr_accessor :key
+      attr_accessor :description
+      attr_accessor :name
+      attr_accessor :interval
+      
+      def initialize(key_values={})
+        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/iactionable/objects/i_actionable_object.rb

@@ -0,0 +1,40 @@
+module IActionable
+  module Objects
+    class IActionableObject
+      def initialize(key_values={})
+        key_values.each_pair do |key, value|
+          instance_variable_set "@#{key.camelize.underscore}".to_sym, value
+        end
+      end
+      
+      def self.timestamp_regexp
+        /\/Date\((\d+)((\-|\+)\d{4})\)\//
+      end
+      
+      def self.timestamp_to_seconds(timestamp)
+        milliseconds = timestamp[timestamp_regexp, 1]
+        tz = timestamp[timestamp_regexp, 2]
+        unless milliseconds.nil? || tz.nil?
+          "#{Integer(milliseconds)/1000}#{tz}"
+        else
+          nil
+        end
+      end
+      
+      private
+      
+      def extract_many_as(key_values, field, klass)
+        if key_values.fetch(field, nil).respond_to?(:inject)
+          loaded = []
+          content = key_values.delete(field)
+          content.each do |c|
+            loaded << klass.new(c)
+          end
+          loaded
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/iactionable/objects/identifier.rb

@@ -0,0 +1,17 @@
+module IActionable
+  module Objects
+    class Identifier < IActionableObject
+      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/iactionable/objects/leaderboard.rb

@@ -0,0 +1,15 @@
+module IActionable
+  module Objects
+    class Leaderboard < IActionableObject
+      attr_accessor :key
+      attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
+    end
+  end
+end

data/lib/iactionable/objects/leaderboard_report.rb

@@ -0,0 +1,30 @@
+module IActionable
+  module Objects
+    class LeaderboardReport < IActionableObject
+      attr_accessor :page_count
+      attr_accessor :page_number
+      attr_accessor :total_count
+      attr_accessor :leaderboard
+      attr_accessor :point_type
+      attr_accessor :profiles
+      
+      def initialize(key_values={})
+        @leaderboard = IActionable::Objects::PointType.new(key_values.delete("Leaderboard"))
+        @point_type = IActionable::Objects::PointType.new(key_values.delete("PointType"))
+        @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/iactionable/objects/level.rb

@@ -0,0 +1,24 @@
+module IActionable
+  module Objects
+    class Level < IActionableObject
+      attr_accessor :name
+      attr_accessor :number
+      attr_accessor :required_points
+      attr_accessor :level_type
+      
+      def initialize(key_values={})
+        @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/iactionable/objects/level_type.rb

@@ -0,0 +1,15 @@
+module IActionable
+  module Objects
+    class LevelType < IActionableObject
+      attr_accessor :key
+      attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
+    end
+  end
+end

data/lib/iactionable/objects/point_type.rb

@@ -0,0 +1,15 @@
+module IActionable
+  module Objects
+    class PointType < IActionableObject
+      attr_accessor :key
+      attr_accessor :name
+      
+      def to_hash
+        {
+          "Key" => @key,
+          "Name" => @name
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module IActionable
+  module Objects
+    class ProfileLevel < IActionableObject
+      attr_accessor :current
+      attr_accessor :next
+      
+      def initialize(key_values={})
+        @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