the-city-admin 0.1.0

data/lib/auto_load.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  require THECITY_LIB_DIR + '/exceptions.rb'
+
+  api_path = THECITY_LIB_DIR + '/api/'
+  require api_path + 'api_object.rb'
+  Dir["#{api_path}/*.rb"].each { |f| require(f) }
+
+  cache_path = THECITY_LIB_DIR + '/cachers/'
+  require cache_path + 'cache_adapter.rb'
+
+  cache_file_path = THECITY_LIB_DIR + '/cachers/file/'
+  Dir["#{cache_file_path}/*.rb"].each { |f| require(f) }
+
+  readers_path = THECITY_LIB_DIR + '/readers/'
+  require readers_path + 'api_reader.rb'
+  Dir["#{readers_path}/*.rb"].each { |f| require(f) }
+
+  writers_path = THECITY_LIB_DIR + '/writers/'
+  require writers_path + 'api_writer.rb'
+  Dir["#{writers_path}/*.rb"].each { |f| require(f) }
+
+end

data/lib/cachers/cache_adapter.rb

@@ -0,0 +1,50 @@
+module TheCity
+
+  # This adapter is the standard for all caching objects.
+  class CacheAdapter
+
+    # Constructor
+    def initialize()
+    end
+
+
+    # Save data to the cache.
+    #
+    # * <b>key</b> The key to use to save the cache.
+    # * <b>data</b> The JSON data to be saved.
+    # * <b>expire_on (optional)</b> The datetime to expire the cache.
+    #
+    # Returns true on success or a string error message on false.
+    def save_data(key, data, expire_on = nil)
+      raise 'The save_data method must be implemented'
+    end
+
+
+    # Get the data from the cache.
+    #
+    # * <b>key</b> The key to use to get the cache.
+    #
+    # Returns the data for the key in the same way it was stored.
+    def get_data(key)
+      raise 'The get_data method must be implemented'
+    end       
+
+
+    # Expire the cache.
+    #
+    # * <b>key</b> The key to use to expire the cache.
+    def expire_cache!(key)
+      raise 'The expire_cache method must be implemented'
+    end
+
+
+    # Check if the cache has expired.
+    #
+    # * <b>key</b> The key to use to check if the cache has expired.
+    def is_cache_expired?(key)
+      raise 'The is_cache_expired method must be implemented'
+    end  
+
+  end
+
+end

data/lib/cachers/file/json_cache.rb

@@ -0,0 +1,135 @@
+# Project::    Admin-Ruby 
+# File::       json_cache.rb
+
+require 'fileutils'
+
+
+module TheCity
+
+  # This class caches the data in a JSON file.
+  class JsonCache < CacheAdapter 
+
+    # Constructor.
+    def initialize() 
+      super
+      @cache_dir = THECITY_STORAGE_DIR + subdomain + '/';
+    end
+    
+
+    # Save data to the cache.
+    #
+    # @param string key The key to use to save the cache.
+    # @param string data The JSON data to be saved.
+    # @param string expire_in The number of seconds to pass before expiring the cache.
+    #
+    # @return mixed Returns true on success or a string error message on false. 
+    def save_data(key, data, expire_in = nil)
+      expire_in = 3600 if expire_in.nil?  # 3600 seconds = 1 hour
+      expire_in += Time.now.to_i
+
+      _create_cache_directory_if_needed
+      expire_cache!(key)
+
+      filename = "#{key}-#{expire_in}-json.cache"
+
+      begin
+        File.open(@cache_dir + filename, 'w') {|f| f.write( Marshal.dump(data) ) }
+      rescue
+        return 'Unable to write to file'
+      end
+
+      return true   
+    end
+
+
+    # Get the file name where the cache is stored.
+    #
+    # @param string $key The key used for the cache.
+    #
+    # @return mixed Returns the name of the cache file if found or false.
+    def get_cache_file(key)
+      _find_file_key(key)
+    end
+
+
+    # Get the data from the cache.
+    #
+    # @param string key The key to use to get the cache.
+    #
+    # @return JSON data.
+    def get_data(key) 
+      filename = _find_file_key(key)
+      return nil if filename.nil?
+      file = File.open(@cache_dir + filename, "rb")
+      contents = file.read
+      return Marshal.load(contents)
+    end
+
+
+    # Expire the cache.
+    #
+    # @param string key The key to use to expire the cache.
+    #
+    # @throws Exception if unable to remove cache file. 
+    def expire_cache!(key) 
+      file = _find_file_key(key)
+      unless file.nil? 
+        begin
+          File.unlink(@cache_dir + file)
+        rescue
+          raise new Exception("Unable to remove cache file: $file")
+        end
+      end
+    end
+
+
+    # Check if the cache has expired.
+    #
+    # @param string key The key to use to check if the cache has expired.
+    #
+    # @return boolean If the cache does not exist or is expired then true, otherwise false.
+    def is_cache_expired?(key)
+      time_stamp_position = 1;
+      fname = _find_file_key(key)
+      return true if fname.nil?
+
+      fname_a = fname.split('-')
+      if Time.now.to_i > fname_a[time_stamp_position].to_i
+        return true
+      end
+
+      return false;
+    end
+
+
+    private
+
+    
+    # @ignore
+    def _create_cache_directory_if_needed
+      unless File.exist?( @cache_dir ) 
+        unless FileUtils.mkdir_p( @cache_dir ) 
+          raise new Exception('Failed to create cache directory')
+        end
+      end
+    end
+    
+    
+    # @ignore
+    def _find_file_key(key) 
+      if File.exist?(@cache_dir) 
+        return Dir.entries( @cache_dir ).detect{ |f| f.include?("#{key}-") }
+      end
+      return nil
+    end
+
+
+    # @ignore
+    def _all_cache_files(key) 
+      Dir.entries( @cache_dir ).select{ |f| f.include?("-json.cache") }
+    end
+    
+  end
+
+end
+  

data/lib/common.rb

@@ -0,0 +1,124 @@
+module TheCity
+  require 'cgi'
+
+  def self.admin_request(method, path, params = {})    
+    # data_params = params.inject({}) {|h, (k,v)| h.update({k => v.nil? ? v : v.to_s})}
+    # flattened_params = self._flatten_params(data_params)
+
+    flattened_params = self._flatten_params(params)
+
+# puts "############################"
+# puts "flattened_params: #{flattened_params}"
+# puts "############################"
+
+    headers = self._build_admin_headers(method, path, flattened_params) 
+    url = THE_CITY_ADMIN_PATH+path
+
+    response = 
+    case method 
+    when :post
+      Typhoeus::Request.post(url, {:headers => headers, :params => flattened_params})
+    when :get  
+      Typhoeus::Request.get(url, {:headers => headers, :params => flattened_params})
+    when :put  
+      Typhoeus::Request.put(url, {:headers => headers, :params => flattened_params})
+    when :delete      
+      Typhoeus::Request.delete(url, {:headers => headers, :params => flattened_params})
+    end
+
+    unless response.success?
+      if response.curl_error_message != 'No error'
+        raise TheCityExceptions::UnableToConnectToTheCity.new(response.curl_error_message)
+      else
+        begin
+          error_messages = JSON.parse(response.body)['error_message']
+        rescue
+          raise TheCityExceptions::UnknownErrorConnectingToTheCity.new('Unknown error when connecting to The City')
+        else
+          raise TheCityExceptions::TheCityResponseError.new(error_messages)
+        end
+      end
+    end
+
+    response
+  end
+
+
+  def self._flatten_params(params, prefix='')
+    retval = []
+    if params.instance_of?(Array)
+      if params.empty?
+        retval << self._flatten_params('', "#{prefix.to_s}[0]")
+      else
+        params.each_with_index do |value, indx|
+          retval << self._flatten_params(value, "#{prefix.to_s}[#{indx}]")
+        end
+      end
+    elsif params.instance_of?(Hash)
+      params.each do |key, value|
+        retval << self._flatten_params(value, prefix.empty? ? key.to_s : "#{prefix}[#{key.to_s}]")
+      end
+    else # assume string
+      retval << "#{prefix}=#{params}"
+    end
+
+    if prefix.empty?
+      hvals = {}
+      retval.flatten.sort.each { |v| hvals[v.split('=')[0]] = v.split('=')[1] }
+      hvals
+    else  
+      retval.flatten.sort
+    end
+    #retval.flatten.sort
+  end
+
+
+
+  def self._build_admin_headers(method, path, params) 
+    # get_vars = '?' + params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1]}" }.join('&')
+    # get_vars = '' if get_vars == '?'
+
+
+    get_vars = '?' + params.to_a.sort.collect { |kv_pair| 
+      if kv_pair[1].class == Array
+        puts "ARRAY"
+        kv_pair[1].each_with_index do |v, indx|
+          "#{kv_pair[0]}[#{indx}]=#{v}" 
+        end
+      else
+        "#{kv_pair[0]}=#{kv_pair[1]}" 
+      end
+    }.join('&')
+    get_vars = '' if get_vars == '?'
+
+
+# puts "############################"
+# puts "params: #{params}"
+# puts '------------'
+# puts "get_vars: #{get_vars}"
+# puts "############################"
+
+    method_request = method.to_s.upcase
+    url = THE_CITY_ADMIN_PATH + path + get_vars
+    current_time = Time.now.to_i.to_s
+    string_to_sign = current_time.to_s + method_request + url
+    unencoded_hmac = OpenSSL::HMAC.digest('sha256', TheCity::AdminApi::API_KEY, string_to_sign)
+    unescaped_hmac = Base64.encode64(unencoded_hmac).chomp
+    hmac_signature = CGI.escape(unescaped_hmac)
+
+    headers = {'X-City-Sig' => hmac_signature,
+               'X-City-User-Token' => TheCity::AdminApi::API_TOKEN,
+               'X-City-Time' => current_time,
+               'Accept' => 'application/vnd.thecity.admin.v1+json'}
+
+
+    # This is causing issues.... not sure if it is needed (docs might be lieing)
+    # if [:post, :put].include?(method)
+    #   headers['Content-Type'] = 'application/json'
+    #   headers['Content-Length'] = params.to_json.length
+    # end
+
+    headers
+  end  
+
+end

data/lib/exceptions.rb

@@ -0,0 +1,5 @@
+module TheCityExceptions
+  class UnableToConnectToTheCity < StandardError; end
+  class UnknownErrorConnectingToTheCity < StandardError; end
+  class TheCityResponseError < StandardError; end
+end

data/lib/readers/address_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class AddressListReader < 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 = "address_list_#{page}"   
+      @url_data_path = "/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/address_reader.rb

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

data/lib/readers/api_reader.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  # This adapter is the standard for all loading objects.
+  class ApiReader
+
+    # Constructor
+    # def initialize
+    # end
+
+    # Loads the list
+    #
+    # @return the data loaded in a JSON object.
+    def load_feed
+      if !@cacher.nil? and !@cacher.is_cache_expired?( @class_key )
+        data = @cacher.get_data( @class_key )
+      else
+        @url_data_params ||= {}
+        response = TheCity::admin_request(:get, @url_data_path, @url_data_params) 
+        data = JSON.parse(response.body)    
+        @cacher.save_data(@class_key, data) unless @cacher.nil?  
+      end   
+
+      return data
+    end
+
+  end
+
+end

data/lib/readers/checkin_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class CheckinListReader < 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 = "checkin_list_#{page}"   
+      @url_data_path = "/checkins"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/checkin_reader.rb

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