singleton-ruby 0.0.2 → 0.0.7

data/lib/sgtn-client/cldr/localized_time.rb

@@ -0,0 +1,27 @@
+require 'date'
+require 'time'
+
+Time.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
+          def to_full_s(locale = TwitterCldr.locale)
+             self.localize(locale).to_full_s
+          end
+        LOCALIZE
+
+Time.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
+          def to_long_s(locale = TwitterCldr.locale)
+             self.localize(locale).to_long_s
+          end
+        LOCALIZE
+
+Time.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
+          def to_medium_s(locale = TwitterCldr.locale)
+             self.localize(locale).to_medium_s
+          end
+        LOCALIZE
+
+
+Time.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
+        def to_short_s(locale = TwitterCldr.locale)
+           self.localize(locale).to_short_s
+        end
+      LOCALIZE

data/lib/sgtn-client/core/cache.rb

@@ -0,0 +1,83 @@
+require 'date'
+
+module SgtnClient::Core
+        class Cache
+            Entry = Struct.new(:expiry, :value)
+
+            def self.initialize(disabled=false, opts={})
+                $opts = opts
+                SgtnClient.logger.debug "Initialize cache......"
+                if disabled == false
+                    $data = Hash.new
+                    SgtnClient.logger.debug "Cache is enabled!"
+                else
+                    SgtnClient.logger.debug "Cache is disabled!"
+                end
+            end
+
+            def self.keys
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Get cache keys"
+                $data.keys
+            end
+
+            def self.get(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Get cache for key: " + key
+                invalidate
+                $data[key][:value] if has(key)
+            end
+
+            def self.has(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Has cache for key: " + key
+                $data.has_key? key
+            end
+
+            def self.put(key, value, ttl=nil)
+                if $data == nil
+                    return nil
+                end
+                ttl ||= @opts[:ttl]
+                # hours from new
+                SgtnClient.logger.debug "Put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
+                $data[key] = Entry.new(Time.now + ttl*60, value)
+            end
+
+            def self.delete(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Delete cache for key: " + key
+                $data.delete key
+            end
+
+            def self.clear
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Clear cache!"
+                $data = Hash.new
+            end
+
+            def self.invalidate
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Invalidating expired cache......"
+                now = Time.now
+                $data.each {
+                    |k, v|
+                        SgtnClient.logger.debug "Checking cache: key=#{k}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
+                    }
+                $data.delete_if {|k, v| v[:expiry] < now}
+            end
+        end
+
+end

data/lib/sgtn-client/core/config.rb

@@ -0,0 +1,173 @@
+require 'erb'
+require 'yaml'
+
+module SgtnClient
+  #include Exceptions
+  module Configuration
+
+    def config
+        @config ||= Config.config
+    end
+
+    def set_config(env, override_configurations = {})
+      @config =
+        case env
+        when Config
+          env
+        when Hash
+          begin
+            config.dup.merge!(env)
+          rescue Errno::ENOENT => error
+            Config.new(env)
+          end
+        else
+          Config.config(env, override_configurations)
+        end
+    end
+
+    alias_method :config=, :set_config
+
+  end
+  
+
+  class Config
+
+    attr_accessor :username, :password, :signature, :app_id, :cert_path,
+    :token, :token_secret, :subject,
+    :http_timeout, :http_proxy,
+    :device_ipaddress, :sandbox_email_address,
+    :mode, :endpoint, :merchant_endpoint, :platform_endpoint, :ipn_endpoint,
+    :rest_endpoint, :rest_token_endpoint, :client_id, :client_secret,
+    :openid_endpoint, :openid_redirect_uri, :openid_client_id, :openid_client_secret,
+    :verbose_logging, :product_name, :version, :vip_server, :bundle_mode,
+    :translation_bundle, :source_bundle, :cache_expiry_period, :disable_cache
+
+
+    # Create Config object
+    # === Options(Hash)
+    # * <tt>username</tt>   -- Username
+    # * <tt>password</tt>   -- Password
+    # * <tt>signature</tt> (Optional if certificate present) -- Signature
+    # * <tt>app_id</tt>     -- Application ID
+    # * <tt>cert_path</tt> (Optional if signature present)  -- Certificate file path
+    def initialize(options)
+      merge!(options)
+    end
+
+    # Override configurations
+    def merge!(options)
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+      self
+    end
+    
+    class << self
+
+        @@config_cache = {}
+  
+        # Load configurations from file
+        # === Arguments
+        # * <tt>file_name</tt>             -- Configuration file path
+        # * <tt>default_environment</tt> (Optional)    -- default environment configuration to load
+        # === Example
+        #   Config.load('config/paypal.yml', 'development')
+        def load(file_name, default_env = default_environment)
+          @@config_cache        = {}
+          @@configurations      = read_configurations(file_name)
+          @@default_environment = default_env
+          config
+        end
+
+
+        # Get default environment name
+        def default_environment
+          @@default_environment ||= ENV['SGTN_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development"
+        end
+
+
+        # Set default environment
+        def default_environment=(env)
+          @@default_environment = env.to_s
+        end
+
+        def configure(options = {}, &block)
+          begin
+            self.config.merge!(options)
+          rescue Errno::ENOENT
+            self.configurations = { default_environment => options }
+          end
+          block.call(self.config) if block
+          self.config
+        end
+        alias_method :set_config, :configure
+
+        # Create or Load Config object based on given environment and configurations.
+        # === Attributes
+        # * <tt>env</tt> (Optional) -- Environment name
+        # * <tt>override_configuration</tt> (Optional) -- Override the configuration given in file.
+        # === Example
+        #   Config.config
+        #   Config.config(:development)
+        #   Config.config(:development, { :app_id => "XYZ" })
+        def config(env = default_environment, override_configuration = {})
+          if env.is_a? Hash
+            override_configuration = env
+            env = default_environment
+          end
+          if override_configuration.nil? or override_configuration.empty?
+            default_config(env)
+          else
+            default_config(env).dup.merge!(override_configuration)
+          end
+        end
+  
+        def default_config(env = nil)
+          env = (env || default_environment).to_s
+          if configurations[env]
+            @@config_cache[env] ||= new(configurations[env])
+          else
+            raise SgtnClient::Exceptions::MissingConfig.new("Configuration[#{env}] NotFound")
+          end
+        end
+        
+        # Get raw configurations in Hash format.
+        def configurations
+          @@configurations ||= read_configurations
+        end
+  
+        # Set configuration
+        def configurations=(configs)
+          @@config_cache   = {}
+          @@configurations = configs && Hash[configs.map{|k,v| [k.to_s, v] }]
+        end
+
+        # Set logger
+        def logger=(logger)
+          Logging.logger = logger
+        end
+
+        # Get logger
+        def logger
+          if @@configurations[:mode] == 'live' and Logging.logger.level == Logger::DEBUG
+            Logging.logger.warn "DEBUG log level not allowed in live mode for security of confidential information. Changing log level to INFO..."
+            Logging.logger.level = Logger::INFO
+          end
+          Logging.logger
+        end
+
+        private
+        # Read configurations from the given file name
+        # === Arguments
+        # * <tt>file_name</tt> (Optional) -- Configuration file path
+        def read_configurations(file_name = "config/sgtnclient.yml")
+          erb = ERB.new(File.read(file_name))
+          erb.filename = file_name
+          YAML.load(erb.result)
+        end       
+          
+
+    end
+  end
+
+end

data/lib/sgtn-client/core/exceptions.rb

@@ -0,0 +1,112 @@
+require 'json'
+require 'pp'
+
+module SgtnClient
+  module Exceptions
+    class ConnectionError < StandardError # :nodoc:
+      attr_reader :response
+
+      def initialize(response, message = nil)
+        @response = response
+        @message  = message
+      end
+
+      def to_s
+        begin
+          response_body = JSON.parse(response.body)
+          debug_id = response["paypal-debug-id"]
+          debug_id = response["correlation-id"] if debug_id.to_s == ''
+          debug_id = response_body["debug_id"] if debug_id.to_s == ''
+        rescue
+        end
+        message = "Failed."
+        message << "  Response code = #{response.code}." if response.respond_to?(:code)
+        message << "  Response message = #{response.message}." if response.respond_to?(:message)
+        message << "  Response debug ID = #{debug_id}." if debug_id
+        message
+      end
+    end
+
+    # Raised when a Timeout::Error occurs.
+    class TimeoutError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # Raised when a OpenSSL::SSL::SSLError occurs.
+    class SSLError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # 3xx Redirection
+    class Redirection < ConnectionError # :nodoc:
+      def to_s
+        response['Location'] ? "#{super} => #{response['Location']}" : super
+      end
+    end
+
+    class MissingParam < ArgumentError # :nodoc:
+    end
+
+    class MissingConfig < StandardError # :nodoc:
+    end
+
+    # 4xx Client Error
+    class ClientError < ConnectionError # :nodoc:
+    end
+
+    # 400 Bad Request
+    class BadRequest < ClientError # :nodoc:
+    end
+
+    # 401 Unauthorized
+    class UnauthorizedAccess < ClientError # :nodoc:
+    end
+
+    # 403 Forbidden
+    class ForbiddenAccess < ClientError # :nodoc:
+    end
+
+    # 404 Not Found
+    class ResourceNotFound < ClientError # :nodoc:
+    end
+
+    # 409 Conflict
+    class ResourceConflict < ClientError # :nodoc:
+    end
+
+    # 410 Gone
+    class ResourceGone < ClientError # :nodoc:
+    end
+
+    # 422 Unprocessable Entity
+    class ResourceInvalid < ClientError # :nodoc:
+    end
+
+    # 5xx Server Error
+    class ServerError < ConnectionError # :nodoc:
+    end
+
+    # 405 Method Not Allowed
+    class MethodNotAllowed < ClientError # :nodoc:
+      def allowed_methods
+        @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
+      end
+    end
+
+    # API error: returned as 200 + "error" key in response.
+    class UnsuccessfulApiCall < RuntimeError
+      attr_reader :api_error
+
+      def initialize(api_error)
+        super(api_error['message'])
+        @api_error = api_error
+      end
+    end
+  end
+end

data/lib/sgtn-client/core/logging.rb

@@ -0,0 +1,50 @@
+require 'logger'
+
+module SgtnClient
+
+  # Include Logging module to provide logger functionality.
+  # == Configure logger
+  #   Logging.logger = Logger.new(STDERR)
+  #
+  # == Example
+  #   include Logger
+  #   logger.info "Debug message"
+  module Logging
+
+    # Get logger object
+    def logger
+      @logger ||= Logging.logger
+    end
+
+    def log_event(message, &block)
+      start_time = Time.now
+      block.call
+    ensure
+      logger.info sprintf("[%.3fs] %s", Time.now - start_time, message)
+    end
+
+    class << self
+
+      # Get or Create configured logger based on the default environment configuration
+      def logger
+        @logger ||= Logger.new(STDERR)
+      end
+
+      # Set logger directly and clear the loggers cache.
+      # === Attributes
+      # * <tt>logger</tt> -- Logger object
+      # === Example
+      #   Logging.logger = Logger.new(STDERR)
+      def logger=(logger)
+        @logger = logger
+        if Config.config.mode.eql? 'live' and @logger.level == Logger::DEBUG
+          @logger.warn "DEBUG log level not allowed in live mode for security of confidential information. Changing log level to INFO..."
+          @logger.level = Logger::INFO
+        end
+      end
+
+    end
+  end
+
+end
+