the-city-admin 0.1.0

data/lib/api/group_address.rb

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

data/lib/api/group_address_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class GroupAddressList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :group_id - The ID of the group to load the addresses for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   GroupAddressList.new({:group_id => 12345})
+    #
+    #   GroupAddressList.new({:group_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::GroupAddressListReader.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 [GroupAddress]
+    def [](index)
+      GroupAddress.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( GroupAddress.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

data/lib/api/group_checkin.rb

@@ -0,0 +1,36 @@
+module TheCity
+
+  class GroupCheckin < ApiObject
+
+    tc_attr_accessor :group,
+                     :checked_out_by_user,
+                     :special_instructions,
+                     :parent_group_name,
+                     :callboard_number,
+                     :checked_in_at,
+                     :barcode,
+                     :checked_in_user,
+                     :checked_in_user_id,
+                     :id,
+                     :checked_in_by_user,
+                     :checked_in_by_user_id,
+                     :parent_receipt_barcode,
+                     :event,
+                     :checked_in_user_notes,
+                     :checked_out_at,
+                     :parent_group_id,
+                     :pager_number
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group checkin.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/group_checkin_list.rb

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

data/lib/api/group_event_attendance.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class GroupEventAttendance < ApiObject
+
+    tc_attr_accessor :user,
+                     :created_at,
+                     :event_title,
+                     :event_id,
+                     :updated_at,
+                     :tracked_by,
+                     :id,
+                     :user_id,
+                     :attended_on,
+                     :tracked_by_user_id,
+                     :checkin_id
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group checkin.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/group_event_attendance_list.rb

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

data/lib/api/group_export.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class GroupExport < ApiObject
+
+    tc_attr_accessor :id, 
+                     :state,
+                     :authenticated_s3_url,
+                     :created_at
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group export.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/group_export_list.rb

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

data/lib/api/group_invitation.rb

@@ -0,0 +1,26 @@
+module TheCity
+
+  class GroupInvitation < ApiObject
+
+    tc_attr_accessor :created_at, 
+                     :custom_message,
+                     :email,
+                     :group_id,
+                     :id,
+                     :pending_approval,
+                     :source,
+                     :user_id
+
+
+    # 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/group_invitation_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class GroupInvitationList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :group_id - The ID of the group to load the invitations for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   GroupInvitationList.new({:group_id => 12345})
+    #
+    #   GroupInvitationList.new({:group_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::GroupInvitationListReader.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 [GroupInvitation]
+    def [](index)
+      GroupInvitation.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( GroupInvitation.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