the-city-admin 0.1.0

data/lib/api/role.rb

@@ -0,0 +1,43 @@
+module TheCity
+
+  class Role < ApiObject
+
+    GroupTypes = {:cg => 'CG', :service => 'Service', :campus => 'Campus'}
+
+    Titles = {:leader => 'Leader', :manager => 'Manager', 
+              :volunteer => 'Volunteer', :participant => 'Participant'}
+
+
+    tc_attr_accessor :group_name,
+                     :created_at,
+                     :group_api_url, 
+                     :title,
+                     :group_type,
+                     :user_api_url, 
+                     :id,
+                     :user_type,
+                     :group_id,
+                     :user_id,
+                     :last_engaged,
+                     :user_name,
+                     :active
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group tag.
+    def initialize(json_data)
+      @writer_object = TagWriter
+      initialize_from_json_object(json_data)
+    end
+
+    def save
+      raise 'Role does not have a save method'
+    end
+    
+    def delete
+      raise 'Role does not have a delete method'
+    end
+
+  end
+
+end

data/lib/api/role_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class RoleList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the skill list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   RoleList.new(reader, {:page => 3})
+    #
+    #   RoleList.new(reader, {:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::RoleListReader.new(options)      
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the roles in the list.
+    #
+    # @return array of role names.
+    def all_roles
+      return [] if @json_data['roles'].nil?
+      @json_data['roles'].collect { |role| role['title'] }
+    end
+    alias :roles :all_roles
+    
+    
+    # Get the specified role.
+    #
+    # @param index The index of the role to get.
+    #
+    # @return [Role]
+    def [](index)
+      Role.new( @json_data['roles'][index] ) if @json_data['roles'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['roles'].each{ |role| yield( Role.new(role) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['roles'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/skill.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class Skill < ApiObject
+
+    tc_attr_accessor :id, 
+                     :name,
+                     :created_at
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the Skill.
+    def initialize(json_data = nil)
+      @writer_object = SkillWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/skill_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class SkillList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the skill list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   SkillList.new
+    #
+    #   SkillList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::SkillListReader.new(options)
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the skills in the list.
+    #
+    # @return array of skill names.
+    def all_skills
+      return [] if @json_data['skills'].nil?
+      @json_data['skills'].collect { |skill| skill['name'] }
+    end
+    alias :skills :all_skills
+    
+    
+    # Get the specified skill.
+    #
+    # @param index The index of the skill to get.
+    #
+    # @return [Skill]
+    def [](index)
+      Skill.new( @json_data['skills'][index] ) if @json_data['skills'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['skills'].each{ |skill| yield( Skill.new(skill) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['skills'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/skilled_user_id_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class SkilledUserIdList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :skill_id - The skill ID to load the user for. (Required)
+    #   :page - The page number to get.
+    #
+    #
+    # Examples:
+    #   SkilledUserList.new
+    #
+    #   SkilledUserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::SkilledUserIdListReader.new(options)
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the user ids in the list.
+    #
+    # @return array of user ids.
+    def all_user_ids
+      return [] if @json_data['user_ids'].nil?
+      @json_data['user_ids'].collect { |user_id| user_id }
+    end
+    alias :user_ids :all_user_ids
+    
+    
+    # Get the specified skill.
+    #
+    # @param index The index of the skill to get.
+    #
+    # @return [User]
+    def [](index)
+      @json_data['user_ids'][index] if @json_data['user_ids'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['user_ids'].each{ |user_id| yield( user_id )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['user_ids'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/skilled_user_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class SkilledUserList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :skill_id - The skill ID to load the user for. (Required)
+    #   :page - The page number to get.
+    #
+    #
+    # Examples:
+    #   SkilledUserList.new
+    #
+    #   SkilledUserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::SkilledUserListReader.new(options)
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the users in the list.
+    #
+    # @return array of skill names.
+    def all_users
+      return [] if @json_data['users'].nil?
+      @json_data['users'].collect { |user| [user['first'], user['last']].join(' ') }
+    end
+    alias :users :all_users
+    
+    
+    # Get the specified skill.
+    #
+    # @param index The index of the skill to get.
+    #
+    # @return [User]
+    def [](index)
+      User.new( @json_data['users'][index] ) if @json_data['users'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['users'].each{ |user| yield( User.new(user) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['users'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/tag.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class Tag < ApiObject
+
+    tc_attr_accessor :id,
+                     :name,
+                     :created_at
+
+
+    # Loads the tag by the specified ID.
+    #
+    # @param tag_id The ID of the tag to load.
+    #
+    # Returns a new {Tag} object.
+    def self.load_by_id(tag_id)
+      reader = TagReader.new(tag_id)
+      self.new(reader.load_feed)
+    rescue
+      nil
+    end       
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the Tag.
+    def initialize(json_data = nil)
+      @writer_object = TagWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+
+  end
+
+end

data/lib/api/tag_group_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class TagGroupList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :tag_id - The tag ID to load the groups for. (Required)
+    #   :page - The page number to get.
+    #
+    #
+    # Examples:
+    #   SkilledUserList.new
+    #
+    #   SkilledUserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::TagGroupListReader.new(options)
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the tags in the list.
+    #
+    # @return array of group names.
+    def all_groups
+      return [] if @json_data['groups'].nil?
+      @json_data['groups'].collect { |group| group['name'] }
+    end
+    alias :groups :all_groups
+    
+    
+    # Get the specified tag.
+    #
+    # @param index The index of the tag to get.
+    #
+    # @return [TagGroup]
+    def [](index)
+      Group.new( @json_data['groups'][index] ) if @json_data['groups'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['groups'].each{ |group| yield( Group.new(group) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['groups'].empty?
+    end    
+  
+  end
+  
+end