the-city-admin 0.1.0

data/lib/writers/api_writer.rb

@@ -0,0 +1,54 @@
+module TheCity
+
+  # This adapter is the standard for all saving objects.
+  class ApiWriter
+    attr_reader :error_messages, :response_code
+
+    # Saves this object.
+    #
+    # @return True or ID on success, otherwise false.
+    def save_object
+      @url_data_params ||= {}
+      success = true
+
+      if @updatable_fields and !@updatable_fields.empty?
+        fields_to_remove = @url_data_params.keys - @updatable_fields  
+        fields_to_remove.each { |ftr| @url_data_params.delete(ftr) }
+      end
+
+      begin
+        response = TheCity::admin_request(@url_action, @url_data_path, @url_data_params)   
+        @response_code = response.code
+        # No content but is a success
+        success = response.code == 204 ? {'success' => true} : JSON.parse(response.body)  
+      rescue Exception => e  
+        @error_messages = e.message.split(',')
+        success = false
+      end 
+
+      return success
+    end
+
+
+    # Deletes this object.
+    #
+    # @return True or ID on success, otherwise false.
+    def delete_object
+      success = true
+
+      begin
+        # @url_data_path should be the same as :put if this object is already
+        # setup and mapped to an object that exists
+        response = TheCity::admin_request(:delete, @url_data_delete_path)           
+        success = response.code == 204 ? true : false # No content but is a success
+      rescue Exception => e  
+        @error_messages = e.message.split(',')
+        success = false
+      end 
+
+      return success
+    end    
+
+  end
+
+end

data/lib/writers/family_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class FamilyWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/families/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/families"   
+      end
+      @url_data_delete_path = "/families/#{data[:id]}" 
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/group_address_writer.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class GroupAddressWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/groups/#{data[:group_id]}/addresses/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/groups/#{data[:group_id]}/addresses"   
+      end
+      @url_data_delete_path = "/groups/#{data[:group_id]}/addresses/#{data[:id]}" 
+
+      @url_data_params = data
+
+
+      @updatable_fields = [:city,
+                           :zipcode,
+                           :street,
+                           :location_type,
+                           :state]      
+    end
+    
+  end
+
+end
+
+

data/lib/writers/group_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/groups/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/groups"   
+      end
+      @url_data_delete_path = "/groups/#{data[:id]}" 
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/metric_measurement_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class MetricMeasurementWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/metrics/#{data[:metric_id]}/measurements/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/metrics/#{data[:metric_id]}/measurements"   
+      end
+      @url_data_delete_path = "/metrics/#{data[:metric_id]}/measurements/#{data[:id]}"
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/metric_writer.rb

@@ -0,0 +1,29 @@
+module TheCity
+
+  class MetricWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/metrics/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/metrics"   
+      end
+      @url_data_delete_path = "/metrics/#{data[:id]}" 
+
+      @url_data_params = data
+
+      @updatable_fields = [:name,
+                           :description,
+                           :category,
+                           :subcategory,
+                           :is_percent]         
+    end
+    
+  end
+
+end

data/lib/writers/skill_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class SkillWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/skills/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/skills"   
+      end
+      @url_data_delete_path = "/skills/#{data[:id]}" 
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/tag_writer.rb

@@ -0,0 +1,27 @@
+module TheCity
+
+  class TagWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/tags/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/tags"   
+      end
+      @url_data_delete_path = "/tags/#{data[:id]}" 
+
+      @url_data_params = data
+
+      @updatable_fields = [:name]         
+    end
+    
+  end
+
+end
+
+

data/lib/writers/terminology_writer.rb

@@ -0,0 +1,19 @@
+module TheCity
+
+  class TerminologyWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      @url_action = :put
+      @url_data_path = "/terminology/#{data[:term]}"   
+      @url_data_params = data
+      @updatable_fields = [:label]         
+    end
+    
+  end
+
+end
+
+

data/lib/writers/user_address_writer.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class UserAddressWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/users/#{data[:user_id]}/addresses/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/users/#{data[:user_id]}/addresses"   
+      end
+      @url_data_delete_path = "/users/#{data[:user_id]}/addresses/#{data[:id]}" 
+
+      @url_data_params = data
+
+
+      @updatable_fields = [:city,
+                           :zipcode,
+                           :street,
+                           :location_type,
+                           :state]      
+    end
+    
+  end
+
+end
+
+

data/lib/writers/user_admin_privilege_writer.rb

@@ -0,0 +1,24 @@
+module TheCity
+
+  class UserAdminPrivilegeWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      @url_action = :post   
+      @url_data_path = "/users/#{data[:user_id]}/admin_privileges"   
+    
+      @url_data_params = data
+    end
+    
+
+    def delete_object
+      raise TheCityExceptions::TheCityResponseError.new('Unable to delete Admin Privilege')
+    end
+
+  end
+
+end
+
+

data/lib/writers/user_invitation_writer.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserInvitationWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      @url_action = :post   
+      @url_data_path = "/users/#{data[:user_id]}/invitations"   
+      @url_data_params = data
+    end
+    
+
+    def delete_object
+      raise TheCityExceptions::TheCityResponseError.new('Unable to delete user invitation')
+    end
+
+  end
+
+end
+
+

data/lib/writers/user_note_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class UserNoteWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/users/#{data[:author_id]}/notes/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/users/#{data[:author_id]}/notes"   
+      end
+      @url_data_delete_path = "/users/#{data[:author_id]}/notes/#{data[:id]}"
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/user_role_writer.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class UserRoleWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/users/#{data[:user_id]}/roles/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/users/#{data[:user_id]}/roles"   
+      end
+      @url_data_delete_path = "/users/#{data[:user_id]}/roles/#{data[:id]}"   
+
+      # user_id is not an option to submit with this path.
+      data.delete(:user_id)
+      
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/user_skill_writer.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserSkillWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)    
+      @url_action = :post   
+      @url_data_path = "/users/#{data[:user_id]}/skills"   
+      @url_data_delete_path = "/users/#{data[:user_id]}/skills/#{data[:skill_id] || data[:name]}"   
+      
+      # user_id is not an option to submit with this path.
+      data.delete(:user_id)
+      
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/user_writer.rb

@@ -0,0 +1,46 @@
+module TheCity
+
+  class UserWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/users/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/users"   
+      end
+      @url_data_delete_path = "/users/#{data[:id]}" 
+
+      @url_data_params = data
+
+      @updatable_fields = [:title,
+                           :first,
+                           :middle,
+                           :last,
+                           :nickname,
+                           :gender,
+                           :email,
+                           :staff,
+                           :primary_campus_id,
+                           :member_since,
+                           :birthdate,
+                           :primary_phone,
+                           :primary_phone_type,
+                           :secondary_phone,
+                           :secondary_phone_type,
+                           :external_id_1,
+                           :external_id_2,
+                           :external_id_3,
+                           :marital_status,
+                           :is_an_organization]      
+    end
+    
+  end
+
+end
+
+