the-city-admin 0.1.0

data/lib/api/user_admin_privilege.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class UserAdminPrivilege < ApiObject
+
+    Permissions = {:api_admin => 'API Admin', :account_admin => 'Account Admin', 
+                   :designer => 'Designer', :financial_user => 'Financial User',
+                   :group_admin => 'Group Admin', :process_user => 'Process User',
+                   :reporting_user => 'Reporting User', :resource_admin => 'Resource Admin',
+                   :support_admin => 'Support Admin', :user_admin => 'User Admin'}
+
+    tc_attr_accessor :title,
+                     :user_id,
+                     :user
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the note.
+    def initialize(json_data = nil)
+      @writer_object = UserAdminPrivilegeWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_admin_privilege_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class UserAdminPrivilegeList 
+
+    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 admin privileges for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserAdminPrivilegeList.new({:user_id => 12345})
+    #
+    #   UserAdminPrivilegeList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserAdminPrivilegeListReader.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 account admin privilege.
+    #
+    # @param index The index of the admin privilege to get.
+    #
+    # @return [UserAdminPrivilege]
+    def [](index)
+      UserAdminPrivilege.new( @json_data['account_roles'][index] ) if @json_data['account_roles'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['account_roles'].each{ |account_role| yield( UserAdminPrivilege.new(account_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['account_roles'].empty?
+    end
+
+  end
+  
+end

data/lib/api/user_barcode.rb

@@ -0,0 +1,20 @@
+module TheCity
+
+  class UserBarcode < ApiObject
+
+    tc_attr_accessor :id, 
+                     :barcode,
+                     :created_at
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the user barcode.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_count.rb

@@ -0,0 +1,40 @@
+module TheCity
+
+  class UserCount < ApiObject
+
+    tc_attr_accessor :count, 
+                     :filter
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the user count.
+    # 
+    # Options:
+    #   :filter - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserCount.new
+    #
+    #   UserCount.new({:filter => :created_in_the_last_7_Days})
+    #    
+    def initialize(options = {})
+      reader = options[:reader] || TheCity::UserCountReader.new(options)
+      @json_data = reader.load_feed    
+      self.count = @json_data['count']
+      self.filter = @json_data['filter']
+    end
+
+    def save
+      raise 'User count does not have a save method'
+    end
+    
+    def delete
+      raise 'User count does not have a delete method'
+    end
+  end
+
+end
+
+

data/lib/api/user_family_list.rb

@@ -0,0 +1,71 @@
+module TheCity
+
+  class UserFamilyList 
+
+    include Enumerable
+
+    attr_reader :id, :created_at, :external_id
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :user_id - The ID of the user to load the family members for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserFamilyList.new({:user_id => 12345})
+    #
+    #   UserFamilyList.new({:user_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserFamilyListReader.new(options)
+      @json_data = reader.load_feed
+
+      @id = @json_data['id']
+      @created_at = @json_data['created_at']
+      @external_id = @json_data['external_id']
+    end
+    
+    
+    # All the famly member names in the list.
+    #
+    # @return array of names.
+    def all_names
+      @json_data['family_members'].collect { |user| user['name'] }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified family member.
+    #
+    # @param index The index of the family member to get.
+    #
+    # @return [UserFamilyMember]
+    def [](index)      
+      UserFamilyMember.new( @json_data['family_members'][index] ) if @json_data['family_members'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['family_members'].each{ |member| yield( UserFamilyMember.new(member) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['family_members'].empty?
+    end
+
+  end
+  
+end

data/lib/api/user_family_member.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class UserFamilyMember < ApiObject
+
+    tc_attr_accessor :external_id_1, 
+                     :active, 
+                     :admin_url, 
+                     :api_url, 
+                     :birthdate, 
+                     :barcodes,
+                     :email, 
+                     :family_role, 
+                     :name, 
+                     :user_id
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the family member.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_invitation.rb

@@ -0,0 +1,26 @@
+module TheCity
+
+  class UserInvitation < ApiObject
+
+    tc_attr_accessor :created_at, 
+                     :custom_message,
+                     :email,
+                     :group_id,
+                     :user_id,
+                     :id,
+                     :pending_approval,
+                     :source
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the invitation.
+    def initialize(json_data = nil)
+      @writer_object = UserInvitationWriter
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/user_invitation_list.rb

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

data/lib/api/user_list.rb

@@ -0,0 +1,72 @@
+module TheCity
+
+  class UserList 
+
+    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:
+    #   UserList.new
+    #
+    #   UserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::UserListReader.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 names (first last).
+    def all_names
+      return [] unless @json_data['users']
+      @json_data['users'].collect { |user| [user['first'], user['last']].join(' ') }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified user.
+    #
+    # @param index The index of the user to get.
+    #
+    # @return [User]
+    def [](index)  
+      User.new( @json_data['users'][index] ) if @json_data['users'] and @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/user_note.rb

@@ -0,0 +1,31 @@
+module TheCity
+
+  class UserNote < ApiObject
+
+    VisibleTo = {:api_admin => "API Admin", :account_admin => "Account Admin", 
+                 :designer => "Designer", :financial_user => "Financial User",
+                 :group_admin => "Group Admin", :process_user => "Process User", 
+                 :reporting_user => "Reporting User", :resource_admin => "Resource Admin",
+                 :support_admin => "Support Admin", :user_admin => "User Admin"}
+
+    tc_attr_accessor :author, 
+                     :author_id, 
+                     :body,
+                     :created_at, 
+                     :id, 
+                     :updated_at, 
+                     :visible_to                 
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the note.
+    def initialize(json_data = nil)
+      @writer_object = UserNoteWriter
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+