the-city-admin 0.1.0

data/lib/readers/tag_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class TagListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+
+      @class_key = "tag_list_#{page}"   
+      @url_data_path = "/tags"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/tag_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class TagReader < ApiReader
+
+    # Constructor.
+    #
+    # @param tag_id The ID of the tag to load.
+    # @param options (optional) Options for including more information.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(tag_id, options = {}, cacher = nil)
+      @class_key = "tags_#{tag_id}"   
+      @url_data_path = "/tags/#{tag_id}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/terminology_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class TerminologyListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+
+      @class_key = "terminology_list_#{page}"   
+      @url_data_path = "/terminology"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/terminology_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class TerminologyReader < ApiReader
+
+    # Constructor.
+    #
+    # @param term The name of the term to load.
+    # @param options (optional) Options for including more information.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(term, options = {}, cacher = nil)
+      @class_key = "terminology_#{term}"   
+      @url_data_path = "/terminology/#{term}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/user_address_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class UserAddressListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_addresses"   
+      @url_data_path = "/users/#{user_id}/addresses"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/user_admin_privilege_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserAdminPrivilegeListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]    
+      @class_key = "users_#{user_id}_admin_privileges_#{page}"   
+      @url_data_path = "/users/#{user_id}/admin_privileges"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_count_reader.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class UserCountReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options (optional) Options for including more information.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    #
+    # 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 = {}, cacher = nil)
+      @class_key = "users_count_#{options[:filter] || ''}"   
+      @url_data_path = "/users/count"
+
+      @url_data_params = {:filter => options[:filter] || ''}    
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/user_family_list_reader.rb

@@ -0,0 +1,24 @@
+module TheCity
+
+  class UserFamilyListReader < ApiReader
+    
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_family"   
+      @url_data_path = "/users/#{user_id}/family"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end
+
+

data/lib/readers/user_invitation_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserInvitationListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_invitations_#{page}"   
+      @url_data_path = "/users/#{user_id}/invitations"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class UserListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param page The page number to get.  Default is 1.
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      filter = options[:filter] 
+
+      @class_key = "user_list_#{page}_#{filter.to_s.downcase.gsub(' ','')}"   
+      @url_data_path = "/users"
+      @url_data_params = {:page => page}
+      @url_data_params.merge!({:filter => filter}) if filter
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_note_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserNoteListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_notes_#{page}"   
+      @url_data_path = "/users/#{user_id}/notes"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_process_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserProcessListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_processes_#{page}"   
+      @url_data_path = "/users/#{user_id}/processes"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_reader.rb

@@ -0,0 +1,24 @@
+module TheCity
+
+  class UserReader < ApiReader
+
+    # Constructor.
+    #
+    # @param user_id The ID of the user to load.
+    # @param options (optional) Options for including more information.
+    #                           'include_custom_fields' => true/false.  Default is false.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(user_id, options = {}, cacher = nil)
+      @class_key = "users_#{user_id}"   
+      @url_data_path = "/users/#{user_id}"
+      @url_data_params = {:include_custom_fields => true}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/user_role_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserRoleListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_roles_#{page}"   
+      @url_data_path = "/users/#{user_id}/roles"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/user_skill_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class UserSkillListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      @class_key = "users_#{user_id}_skills_#{page}"   
+      @url_data_path = "/users/#{user_id}/skills"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/web_hook_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class WebHookListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      @class_key = "web_hooks_#{page}"   
+      @url_data_path = "/webhooks"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/the_city_admin.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'openssl'
+require 'cgi'
+require 'Base64'
+require 'openssl'
+require 'net/http'
+require 'net/https'
+require 'typhoeus'
+require 'json'
+
+
+TCA_ENV = 'development'
+#TCA_ENV = 'staging'
+
+# The path to the lib directory.
+THECITY_LIB_DIR = File.dirname(__FILE__)
+
+# The path to the storage directory that will be used for caching data to disk.
+THECITY_STORAGE_DIR = File.dirname(__FILE__) + '/../storage/'
+
+
+
+# TODO: This needs to be moved into a config file.
+######################################################
+if TCA_ENV == 'production'
+  raise 'Admin API path not set for production' # Delete this exception when set
+  THE_CITY_ADMIN_PATH = ''
+  THE_CITY_ADMIN_API_VERSION = 'application/vnd.thecity.admin.v1+json'
+
+elsif TCA_ENV == 'development'
+  THE_CITY_ADMIN_PATH = 'http://0.0.0.0:9292'
+  THE_CITY_ADMIN_API_VERSION = 'application/vnd.thecity.admin.v1+json'
+
+elsif TCA_ENV == 'staging'
+  THE_CITY_ADMIN_PATH = 'https://api.stagethecity.org'
+  THE_CITY_ADMIN_API_VERSION = 'application/vnd.thecity.admin.v1+json'
+
+elsif TCA_ENV == 'test'
+  raise 'Admin API path not set for testing' # Delete this exception when set
+  THE_CITY_ADMIN_PATH = ''
+  THE_CITY_ADMIN_API_VERSION = 'application/vnd.thecity.admin.v1+json'
+end
+######################################################
+
+
+
+require File.dirname(__FILE__) + '/auto_load.rb'
+
+require File.dirname(__FILE__) + '/common.rb'
+
+
+# This class is meant to be a wrapper TheCity Admin API (OnTheCity.org).
+module TheCity
+
+  class AdminApi
+
+    attr_reader :api_key, :api_token
+
+
+    # Alias for calling the *new* method.
+    def self.connect(api_key, api_token)
+      self.new(api_key, api_token)
+    end
+
+
+    # Constructor.
+    #
+    # @param api_key The API key for the church.
+    # @param api_token The API token for the church.
+    def initialize(api_key, api_token)
+      raise TheCityExceptions::UnableToConnectToTheCity.new('Key and Token cannot be nil.') if api_key.nil? or api_token.nil?
+
+      # Create a constant for the churches API key.
+      TheCity::AdminApi::const_set(:API_KEY, api_key) unless defined?(API_KEY)
+
+      # Create a constant for the churches API Token.
+      TheCity::AdminApi::const_set(:API_TOKEN, api_token) unless defined?(API_TOKEN)
+    end
+
+  end
+
+end