the-city-admin 0.1.0

data/lib/api/tag_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class TagList 
+
+    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:
+    #   TagList.new
+    #
+    #   TagList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::TagListReader.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 tag names.
+    def all_tags
+      return [] if @json_data['tags'].nil?
+      @json_data['tags'].collect { |tag| tag['name'] }
+    end
+    alias :tags :all_tags
+    
+    
+    # Get the specified tag.
+    #
+    # @param index The index of the tag to get.
+    #
+    # @return [Tag]
+    def [](index)
+      Tag.new( @json_data['tags'][index] ) if @json_data['tags'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['tags'].each{ |tag| yield( Tag.new(tag) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['tags'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/terminology.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class Terminology < ApiObject
+
+    tc_attr_accessor :term,
+                     :label
+
+
+    # Loads the terminology by the specified term.
+    #
+    # @param term The term of the Terminology to load.
+    #
+    # Returns a new {Terminology} object.
+    def self.load_by_term(term)
+      reader = TerminologyReader.new(term)
+      self.new(reader.load_feed)
+    rescue
+      nil
+    end       
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the Terminology.
+    def initialize(json_data)
+      @writer_object = TerminologyWriter
+      self.term = json_data.keys[0]
+      self.label = json_data.values[0]
+    end
+
+  end
+
+end

data/lib/api/terminology_list.rb

@@ -0,0 +1,73 @@
+module TheCity
+
+  class TerminologyList 
+
+    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:
+    #   TerminologyList.new
+    #
+    #   TerminologyList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::TerminologyListReader.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 terms in the list.
+    #
+    # @return array of term names.
+    def all_labels
+      return [] if @json_data['labels'].nil?
+      @json_data['labels'].collect { |label| label.values[0] }
+    end
+    alias :labels :all_labels
+    
+    
+    # Get the specified tag.
+    #
+    # @param index The index of the tag to get.
+    #
+    # @return [Tag]
+    def [](index)
+      Terminology.new( @json_data['labels'][index] ) if @json_data['labels'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['labels'].each{ |tag| yield( Terminology.new(tag) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['labels'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/user.rb

@@ -0,0 +1,207 @@
+module TheCity
+
+  class User < ApiObject
+    Gender = {:male => 'Male', :female => 'Female'}
+    PhoneType = {:home => 'Home', :work => 'Work', :mobile => 'Mobile'}
+    MaritalStatus = {:never_married => 'Never Married', :engaged => 'Engaged', 
+                     :married => 'Married', :separated => 'Separated', 
+                     :divorced => 'Divorced', :remarried => 'Re-Married',
+                     :widowed => 'Widowed', :cohabiting => 'Cohabiting'}
+
+    
+    tc_attr_accessor :admin_url,
+                     :api_url,
+                     :internal_url,
+                     :updated_at,
+                     :last_logged_in,
+                     :secondary_phone,
+                     :last_engaged,
+                     :title,
+                     :internal_url,
+                     :id,
+                     :first,
+                     :primary_campus_name,
+                     :last,
+                     :head_of_household,
+                     :nickname,
+                     :active,
+                     :primary_phone_type,
+                     :primary_phone,
+                     :member_since,
+                     :birthdate,
+                     :email_bouncing,
+                     :secondary_phone_type,
+                     :primary_campus_id,
+                     :contact_updated_at,
+                     :type,
+                     :staff,
+                     :created_at,
+                     :gender,
+                     :external_id_1,
+                     :external_id_2,
+                     :external_id_3,
+                     :middle,
+                     :email       
+
+
+    # Loads the user by the specified ID.
+    #
+    # @param user_id The ID of the user to load.
+    #
+    # Returns a new {User} object.
+    def self.load_by_id(user_id)
+      reader = UserReader.new(user_id)
+      self.new(reader.load_feed)
+    rescue
+      nil      
+    end       
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) The object that has the data.  This can be a {UserReader} or Hash object.
+    # @param options (optional) Options for including more information.
+    def initialize(json_data = nil, options = {})    
+      @writer_object = UserWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+
+      @address_list = nil
+      @family_list = nil
+      @note_list = nil
+      @role_list = nil
+      @skill_list = nil
+      @process_list = nil
+      @invitation_list = nil
+      @admin_privilege_list = nil
+    end
+    
+
+    # The first and last name of the user.
+    #
+    # @return A string of the full name
+    def full_name
+      use_name = self.nickname.to_s.empty? ? self.first : self.nickname
+      [use_name, self.last].compact.join(' ')
+    end
+
+
+    # Address information.
+    #
+    # @param force_reload (optional) Data is cached on first call.  If data needs to be 
+    #                                reloaded from the server on a subsequent call then 
+    #                                a force reload is need.
+    #
+    # @return [UserAddressList]
+    def addresses(force_reload = false)
+      unless force_reload
+        return @address_list unless @address_list.nil?  
+      end
+      return nil unless self.id
+         
+      @address_list = UserAddressList.new({:user_id => self.id})
+      return @address_list
+    end
+
+
+    # The family information.
+    #
+    # @return [UserFamilyList]
+    def family(force_reload = false)
+      unless force_reload
+        return @family_list unless @user_list.nil?  
+      end
+      return nil unless self.id
+  
+      @family_list = UserFamilyList.new({:user_id => self.id})
+      return @family_list
+    end
+
+
+    # The notes for this user.
+    #
+    # @return [UserNoteList]
+    def notes(force_reload = false)
+      unless force_reload
+        return @note_list unless @note_list.nil?  
+      end
+      return nil unless self.id
+  
+      @note_list = UserNoteList.new({:user_id => self.id})
+      return @note_list
+    end    
+
+
+    # The roles for this user.
+    #
+    # @return [UserRoleList]
+    def roles(force_reload = false)
+      unless force_reload
+        return @role_list unless @role_list.nil?  
+      end
+      return nil unless self.id
+  
+      @role_list = UserRoleList.new({:user_id => self.id})
+      return @role_list
+    end      
+
+
+    # The skills for this user.
+    #
+    # @return [UserSkillList]
+    def skills(force_reload = false)
+      unless force_reload
+        return @skill_list unless @skill_list.nil?  
+      end
+      return nil unless self.id
+  
+      @skill_list = UserSkillList.new({:user_id => self.id})
+      return @skill_list
+    end     
+
+
+    # The processes for this user.
+    #
+    # @return [UserProcessList]
+    def processes(force_reload = false)
+      unless force_reload
+        return @process_list unless @process_list.nil?  
+      end
+      return nil unless self.id
+ 
+      @process_list = UserProcessList.new({:user_id => self.id})
+      return @process_list
+    end   
+
+
+    # The invitations for this user.
+    #
+    # @return [UserInvitationList]
+    def invitations(force_reload = false)
+      unless force_reload
+        return @invitation_list unless @invitation_list.nil?  
+      end
+      return nil unless self.id
+ 
+      @invitation_list = UserInvitationList.new({:user_id => self.id})
+      return @invitation_list
+    end
+
+
+    # The invitations for this user.
+    #
+    # @return [UserAdminPrivilegeList]
+    def admin_privileges(force_reload = false)
+      unless force_reload
+        return @admin_privilege_list unless @admin_privilege_list.nil?  
+      end
+      return nil unless self.id
+
+      @admin_privilege_list = UserAdminPrivilegeList.new({:user_id => self.id})
+      return @admin_privilege_list
+    end
+
+  end
+
+end
+
+

data/lib/api/user_address.rb

@@ -0,0 +1,31 @@
+module TheCity
+
+  class UserAddress < ApiObject
+
+    tc_attr_accessor :city, 
+                     :created_at, 
+                     :id, 
+                     :latitude, 
+                     :location_type, 
+                     :longitude, 
+                     :privacy, 
+                     :state, 
+                     :street, 
+                     :updated_at, 
+                     :user_id, 
+                     :zipcode
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the user address.
+    def initialize(json_data = nil)
+      @writer_object = UserAddressWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_address_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class UserAddressList 
+
+    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 addresses for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserAddressList.new({:user_id => 12345})
+    #
+    #   UserAddressList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::UserAddressListReader.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 [UserAddress]
+    def [](index)
+      UserAddress.new( @json_data['addresses'][index] ) if @json_data['addresses'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['addresses'].each{ |address| yield( UserAddress.new(address) )}
+    end    
+  
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['addresses'].empty?
+    end
+  end
+  
+end