the-city-admin 0.1.0

data/lib/api/address.rb

@@ -0,0 +1,51 @@
+module TheCity
+
+  class Address < ApiObject
+
+    tc_attr_accessor :city, 
+                     :created_at, 
+                     :id, 
+                     :latitude, 
+                     :location_type, 
+                     :longitude, 
+                     :privacy, 
+                     :state, 
+                     :street, 
+                     :updated_at, 
+                     :group_id, 
+                     :zipcode
+
+
+    # Loads the address by the specified ID.
+    #
+    # @param address_id The ID of the address to load.
+    #
+    # Returns a new {Address} object.
+    def self.load_by_id(address_id)
+      reader = AddressReader.new(address_id)
+      self.new(reader.load_feed)
+    rescue
+      nil
+    end   
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the address.
+    def initialize(json_data = nil)
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+    def save
+      raise 'Address does not have a save method'
+    end
+    
+    def delete
+      raise 'Address does not have a delete method'
+    end
+
+  end
+
+end
+
+

data/lib/api/address_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class AddressList 
+
+    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:
+    #   AddressList.new
+    #
+    #   AddressList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::AddressListReader.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 [Address]
+    def [](index)
+      Address.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( Address.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/api_object.rb

@@ -0,0 +1,100 @@
+module TheCity
+
+  # This class is the base class for all TheCity objects and is meant to be inherited.
+  #
+  class ApiObject
+    attr_reader :error_messages, :marked_for_destruction
+    
+
+    # Used to specify a list of getters and setters.
+    def self.tc_attr_accessor(*vars)
+      @__tc_attributes ||= []
+      @__tc_attributes.concat(vars)
+      attr_accessor(*vars)
+    end
+
+
+    # A list of tc_attr_accessors that have been specified.
+    def self.__tc_attributes
+      @__tc_attributes
+    end
+
+    # Initializes the current object from the JSON data that was loaded into the Hash
+    #
+    # @param object_attributes A Hash of values to load into the current object.
+    def initialize_from_json_object(object_attributes)
+      if object_attributes.is_a?( Hash )
+        object_attributes.each do |key, value| 
+          method_to_call = "#{key.to_s.downcase.gsub(' ', '_')}="
+          if respond_to?(method_to_call)
+            self.send(method_to_call, value) 
+          else
+            # puts method_to_call  # Show the missing methods
+          end
+        end
+      end     
+    end
+
+
+    # Returns the status of the current object.
+    def is_deleted?
+      @_deleted ||= false
+    end
+    
+    # Gets the current object's attributes in a Hash.
+    #
+    # @return A hash of all the attributes.
+    def to_attributes 
+      vals = {}
+      vals = {:marked_for_destruction => self.is_deleted?} if self.is_deleted?
+      self.class.__tc_attributes.each do |tca| 
+        rep = self.send(tca)               
+        if rep.class == Array   
+          rep.collect! { |r| r.respond_to?(:to_attributes) ? r.to_attributes : r }
+        end
+        vals[tca] = rep
+      end
+      vals
+    end
+
+
+    # Sets the current object's attributes from a hash
+    def set_attributes(attribute_data)
+      attribute_data.each { |key, value| self.send("#{key}=", value) if self.respond_to?("#{key}=") }
+    end
+
+
+    # Save this object.
+    #
+    # @return True on success, otherwise false.
+    def save
+      writer = @writer_object.new(self.to_attributes) 
+      result = writer.save_object
+      if result === false
+        @error_messages = writer.error_messages
+      else
+        self.set_attributes(result)
+      end
+      result === false ? false : true
+    end
+
+
+    # Delete this object.
+    #
+    # @return True on success, otherwise false.
+    def delete
+      writer = @writer_object.new(self.to_attributes) 
+      result = writer.delete_object
+      if result === false
+        @error_messages = writer.error_messages
+      else
+        @_deleted = true
+      end
+      result === false ? false : true
+    end    
+
+  end
+
+end
+
+

data/lib/api/barcode.rb

@@ -0,0 +1,43 @@
+module TheCity
+
+  class Barcode < ApiObject
+
+    tc_attr_accessor :user_id, 
+                     :user_name, 
+                     :id, 
+                     :created_at, 
+                     :barcode
+
+    # Loads the barocde by the specified ID.
+    #
+    # @param barcode_id The ID of the barcode to load.
+    #
+    # Returns a new {Barcode} object.
+    def self.load_by_id(barcode_id)
+      reader = BarcodeReader.new(barcode_id)
+      self.new(reader.load_feed)
+    rescue
+      nil
+    end
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the barcode.
+    def initialize(json_data = nil)
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+    def save
+      raise 'Barcode does not have a save method'
+    end
+    
+    def delete
+      raise 'Barcode does not have a delete method'
+    end
+
+  end
+
+end
+
+

data/lib/api/checkin.rb

@@ -0,0 +1,37 @@
+module TheCity
+
+  class Checkin < 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 (optional) JSON data of the Checkin.
+    def initialize(json_data = nil)
+      @writer_object = CheckinWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/checkin_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class CheckinList 
+
+    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:
+    #   CheckinList.new
+    #
+    #   CheckinList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::CheckinListReader.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 checkin to get.
+    #
+    # @return [Checkin]
+    def [](index)
+      Checkin.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( Checkin.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/family.rb

@@ -0,0 +1,47 @@
+module TheCity
+
+  class Family < ApiObject
+
+    tc_attr_accessor :id,
+                     :external_id,
+                     :created_at,
+                     :family_members
+
+
+    # Loads the family by the specified ID.
+    #
+    # @param family_id The ID of the family to load.
+    #
+    # Returns a new {Family} object.
+    def self.load_by_id(family_id)
+      reader = FamilyReader.new(family_id)
+      self.new(reader.load_feed)
+    rescue
+      nil
+    end      
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the Family.
+    def initialize(json_data = nil)
+      @family_members = []
+      @writer_object = FamilyWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+
+
+    # Alias family_members
+    def members
+      @family_members
+    end
+
+
+    def add_family_member(member)
+      @family_members << member
+    end
+
+  end
+
+end
+
+

data/lib/api/family_member.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class FamilyMember < ApiObject
+
+    Roles = {:spouse => 'Spouse', :child => 'Child', :temp_child => 'TempChild', :legal_child => 'LegalChild'}
+
+    tc_attr_accessor :name,
+                     :admin_url,
+                     :external_id_1,
+                     :birthdate,
+                     :user_id,
+                     :barcodes,
+                     :family_role,
+                     :api_url,
+                     :active,
+                     :email
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the Family member.
+    def initialize(json_data = nil)
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+  end
+
+end
+
+

data/lib/api/group.rb

@@ -0,0 +1,162 @@
+module TheCity
+
+  class Group < ApiObject
+    tc_attr_accessor :admin_url, 
+                     :api_url, 
+                     :created_at, 
+                     :external_description, 
+                     :group_type, 
+                     :id, 
+                     :internal_url, 
+                     :name, 
+                     :nickname, 
+                     :parent_id, 
+                     :plaza_url, 
+                     :smart_large_profile_pic, 
+                     :started_as_seed
+
+
+    # Loads the group by the specified ID.
+    #
+    # @param group_id The ID of the group to load.
+    #
+    # Returns a new {Group} object.
+    def self.load_group_by_id(group_id)
+      group_reader = GroupReader.new(group_id)
+      self.new(group_reader)
+    end       
+
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data.  This can be a {GroupReader} or Hash object.
+    def initialize(reader = nil)
+      if reader.is_a?(GroupReader)
+        initialize_from_json_object(reader.load_feed) 
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      end
+
+      @address_list = nil
+      @checkin_list = nil
+      @event_attendance_list = nil
+      @export_list = nil
+      @invitations = nil
+      @role_list = nil
+      @tag_list = nil
+    end
+
+
+    # The address information.
+    #
+    # @return [GroupAddressList]
+    def addresses(force_reload = false)
+      unless force_reload
+        return @address_list unless @address_list.nil?  
+      end
+      return nil unless self.id
+
+      @address_list = GroupAddressList.new({:group_id => self.id})
+      return @address_list
+    end
+    
+
+    # The checkin information.
+    #
+    # @return [GroupCheckinList]
+    def checkins(force_reload = false)
+      unless force_reload
+        return @checkin_list unless @checkin_list.nil?  
+      end
+      return nil unless self.id
+
+      @checkin_list = GroupCheckinList.new({:group_id => self.id})
+      return @checkin_list
+    end
+
+
+    # The checkin information.
+    #
+    # @return [GroupExportList]
+    def exports(force_reload = false)
+      unless force_reload
+        return @export_list unless @export_list.nil?  
+      end
+      return nil unless self.id
+
+      @export_list = GroupExportList.new({:group_id => self.id})
+      return @export_list
+    end  
+
+
+    # The checkin information.
+    #
+    # @return [GroupEventAttendanceList]
+    def event_attendances(force_reload = false)
+      unless force_reload
+        return @event_attendance_list unless @event_attendance_list.nil?  
+      end
+      return nil unless self.id
+
+      @event_attendance_list = GroupEventAttendanceList.new({:group_id => self.id})
+      return @event_attendance_list
+    end    
+
+
+    # The invitations for this group.
+    #
+    # @return [GroupInvitationList]
+    def invitations(force_reload = false)
+      unless force_reload
+        return @invitation_list unless @invitation_list.nil?  
+      end
+      return nil unless self.id
+ 
+      @invitation_list = GroupInvitationList.new({:group_id => self.id})
+      return @invitation_list
+    end
+
+
+    # The roles for this group.
+    #
+    # @return [GroupRoleList]
+    def roles(force_reload = false)
+      unless force_reload
+        return @role_list unless @role_list.nil?  
+      end
+      return nil unless self.id
+ 
+      @role_list = GroupRoleList.new({:group_id => self.id})
+      return @role_list
+    end     
+
+
+    # The tags for this group.
+    #
+    # @return [GroupTagList]
+    def tags(force_reload = false)
+      unless force_reload
+        return @tag_list unless @tag_list.nil?  
+      end
+      return nil unless self.id
+  
+      @tag_list = GroupTagList.new({:group_id => self.id})
+      return @tag_list
+    end     
+
+
+
+    # Save this object.
+    #
+    # @return True on success, otherwise false.
+    def save
+      writer = GroupWriter.new(self.to_attributes) 
+      writer.save_feed
+    end
+
+  end
+
+end
+
+