the-city-admin 0.1.0

data/lib/api/user_note_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class UserNoteList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :user_id - The ID of the user to load the notes for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserNoteList.new({:user_id => 12345})
+    #
+    #   UserNoteList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserNoteListReader.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
+    
+    
+    # Get the specified note.
+    #
+    # @param index The index of the note to get.
+    #
+    # @return [UserNote]
+    def [](index)
+      UserNote.new( @json_data['notes'][index] ) if @json_data['notes'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['notes'].each{ |note| yield( UserNote.new(note) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['notes'].empty?
+    end
+
+  end
+  
+end

data/lib/api/user_process.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class UserProcess < ApiObject
+
+    tc_attr_accessor :id, 
+                     :name, 
+                     :state
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the note.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_process_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class UserProcessList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :user_id - The ID of the user to load the user processes for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserProcessList.new({:user_id => 12345})
+    #
+    #   UserProcessList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserProcessListReader.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
+    
+    
+    # Get the specified processes.
+    #
+    # @param index The index of the process to get.
+    #
+    # @return [UserProcesses]
+    def [](index)   
+      UserProcess.new( @json_data['processes'][index] ) if @json_data['processes'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['processes'].each{ |process| yield( UserProcess.new(process) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['processes'].empty?
+    end
+
+  end
+  
+end

data/lib/api/user_role.rb

@@ -0,0 +1,34 @@
+module TheCity
+
+  class UserRole < ApiObject
+
+    GroupTypes = {:cg => 'CG', :service => 'Service', :campus => 'Campus'}
+
+    Titles = {:leader => 'Leader', :manager => 'Manager', 
+              :volunteer => 'Volunteer', :participant => 'Participant'}
+
+    tc_attr_accessor :user_id,
+                     :active, 
+                     :created_at, 
+                     :group_api_url, 
+                     :group_id, 
+                     :group_name, 
+                     :group_type, 
+                     :id, 
+                     :last_engaged, 
+                     :title
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the user role.
+    def initialize(json_data = nil)
+      @writer_object = UserRoleWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_role_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class UserRoleList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :user_id - The ID of the user to load the roles for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserRoleList.new({:user_id => 12345})
+    #
+    #   UserRoleList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserRoleListReader.new(options)  
+      @json_data = reader.load_feed
+
+      @user_id = options[:user_id] || nil
+      @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 user role.
+    #
+    # @param index The index of the user role to get.
+    #
+    # @return [UserRole]
+    def [](index)
+      UserRole.new( @json_data['roles'][index].merge({:user_id => @user_id}) ) if @json_data['roles'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['roles'].each{ |role| yield( UserRole.new(role.merge({:user_id => @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['roles'].empty?
+    end
+
+  end
+  
+end

data/lib/api/user_skill.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class UserSkill < ApiObject
+
+    tc_attr_accessor :user_id,
+                     :name, 
+                     :skill_id
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the user skill.
+    def initialize(json_data = nil)
+      @writer_object = UserSkillWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_skill_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class UserSkillList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :user_id - The ID of the user to load the user skills for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserSkillList.new({:user_id => 12345})
+    #
+    #   UserSkillList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserSkillListReader.new(options)  
+      @json_data = reader.load_feed
+
+      @user_id = options[:user_id] || nil
+      @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 [UserSkill]
+    def [](index)
+      UserSkill.new( @json_data['skills'][index].merge({:user_id => @user_id}) ) if @json_data['skills'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['skills'].each{ |skill| yield( UserSkill.new(skill.merge({:user_id => @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['skills'].empty?
+    end
+  
+  end
+  
+end

data/lib/api/web_hook.rb

@@ -0,0 +1,34 @@
+module TheCity
+
+  class WebHook < ApiObject
+
+    Objects = {:user => 'User', :group => 'Group', :invitation => 'Invitation',
+               :privilege => 'Privilege', :checkin => 'Checkin', :address => 'Address'}
+
+    Events = {:create => 'create', :update => 'update', :destroy => 'destroy', :expire => 'expire'}              
+
+
+    tc_attr_accessor :id,
+                     :callback_uri, 
+                     :event,
+                     :object
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the web hook.
+    def initialize(json_data = nil)
+      @writer_object = WebHookWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+
+
+    # The name of the hook based on the event and object
+    def name
+      "#{self.object}::#{self.event}"
+    end
+    
+  end
+
+end
+
+

data/lib/api/web_hook_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class WebHookList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   WebHookListReader.new
+    #
+    #   UserSkillList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::WebHookListReader.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 web_hooks in the list.
+    #
+    # @return array of web_hook names.
+    def all_web_hooks
+      return [] if @json_data['web_hooks'].nil?
+      @json_data['web_hooks'].collect { |web_hook| [web_hook['object'], web_hook['event']].join('::') }
+    end
+    alias :web_hooks :all_web_hooks
+        
+    
+    # Get the specified web hook.
+    #
+    # @param index The index of the web hook to get.
+    #
+    # @return [WebHook]
+    def [](index)
+      WebHook.new( @json_data['web_hooks'][index] ) if @json_data['web_hooks'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    #
+    # @return [WebHook]
+    def each &block
+      @json_data['web_hooks'].each{ |web_hook| yield( WebHook.new(web_hook) ) }
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['web_hooks'].empty?
+    end
+  
+  end
+  
+end