ghaki-account 2011.11.29.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+= Ghaki Account - Login account information.
+
+Ghaki Account is a collection of user / host login information helper objects.
+
+== Download
+
+The latest version of Ghaki Account can be found at
+
+* git@github.com:ghaki/ghaki-account.git
+
+== Installation
+
+The preferred method of installing Ghaki Account is through its GEM file.
+
+  % [sudo] gem install ghaki-account-1.0.0.gem
+
+== License
+
+Ghaki Account is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/VERSION

@@ -0,0 +1 @@
+2011.11.29.1

data/lib/ghaki/account/base.rb

@@ -0,0 +1,78 @@
+############################################################################
+require 'ghaki/account/hostname'
+require 'ghaki/account/username'
+require 'ghaki/account/password'
+require 'ghaki/account/email_address'
+
+module Ghaki   #:nodoc:
+module Account #:nodoc:
+
+class Base
+  include Hostname
+  include Username
+  include Password
+  include EMailAddress
+
+  ######################################################################
+  # CLASS METHODS
+  ######################################################################
+
+  def self.from_opts opts
+    opts[:account] || Base.new(opts)
+  end
+
+  def self.purge_opts opts
+    Hostname.purge_opts opts
+    Username.purge_opts opts
+    Password.purge_opts opts
+    EMailAddress.purge_opts opts
+    opts.delete(:account)
+    opts
+  end
+
+  ######################################################################
+  # OBJECT METHODS
+  ######################################################################
+
+  def initialize opts={}
+    _from_opts opts
+  end
+
+  def expand_opts opts={}
+    opts.delete(:account)
+    opts[:hostname] = @hostname unless @hostname.nil?
+    opts[:username] = @username unless @username.nil?
+    opts[:password] = self.passwords unless passwords.empty?
+    opts[:email_address] = @email_address unless @email_address.nil?
+    opts
+  end
+
+  def collapse_opts opts={}
+    self.class.purge_opts opts
+    opts[:account] = self
+    opts
+  end
+
+  def to_s
+    (@username || '*') + '@' + (@hostname || '*')
+  end
+
+  def ask_all opts={}
+    ask_hostname opts[:hostname_opts] || {}
+    ask_username opts[:username_opts] || {}
+    ask_password opts[:password_opts] || {}
+  end
+
+  ######################################################################
+  protected
+  ######################################################################
+
+  def _from_opts opts
+    opt_hostname opts
+    opt_username opts
+    opt_password opts
+    opt_email_address opts
+  end
+
+end
+end end

data/lib/ghaki/account/database.rb

@@ -0,0 +1,66 @@
+############################################################################
+require 'ghaki/account/base'
+require 'ghaki/account/db_name'
+require 'ghaki/account/db_port'
+require 'ghaki/account/db_driver'
+require 'ghaki/account/db_connect'
+
+############################################################################
+module Ghaki module Account
+  class Database < Base
+    include DB_Name
+    include DB_Port
+    include DB_Driver
+    include DB_Connect
+
+    ######################################################################
+    # CLASS METHODS
+    ######################################################################
+
+    #---------------------------------------------------------------------
+    def self.from_opts opts
+      opts[:account] || Database.new(opts)
+    end
+
+    #---------------------------------------------------------------------
+    def self.purge_opts opts ; super opts
+      DB_Name.purge_opts opts
+      DB_Port.purge_opts opts
+      DB_Driver.purge_opts opts
+      DB_Connect.purge_opts opts
+      opts
+    end
+
+    ######################################################################
+    # OBJECT METHODS
+    ######################################################################
+
+    #---------------------------------------------------------------------
+    def expand_opts opts={} ; super opts
+      opts[:db_name]    = @db_name    unless @db_name.nil?
+      opts[:db_port]    = @db_port    unless @db_port.nil?
+      opts[:db_driver]  = @db_driver  unless @db_driver.nil?
+      opts[:db_connect] = @db_connect unless @db_connect.nil?
+      opts
+    end
+
+    #---------------------------------------------------------------------
+    def to_s
+      @db_name + ':' + (@username || '*') + '@' + (@hostname || 'localhost')
+    end
+
+    ######################################################################
+    protected
+    ######################################################################
+
+    #---------------------------------------------------------------------
+    def _from_opts opts ; super opts
+      opt_db_name    opts
+      opt_db_port    opts
+      opt_db_driver  opts
+      opt_db_connect opts
+    end
+
+  end # class
+end end # package
+############################################################################

data/lib/ghaki/account/db_connect.rb

@@ -0,0 +1,45 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki module Account
+  module DB_Connect
+    extend SynOpts
+
+    #---------------------------------------------------------------------
+    attr_syn_opts :db_connect,
+      :db_connector, :database_connect, :database_connector
+    attr_writer   :db_connect
+
+    #---------------------------------------------------------------------
+    def db_connect
+      @db_connect ||= self.make_db_connect
+    end
+
+    #---------------------------------------------------------------------
+    def valid_db_connect? 
+      return false if @db_connect.nil?
+      return false if @db_connect.empty?
+      return true
+    end
+                     
+    ######################################################################
+    protected
+    ######################################################################
+
+    #---------------------------------------------------------------------
+    def make_db_connect
+      con = "dbi:#{@db_driver}:#{@db_name}"
+      if @hostname.nil?
+        con += ':localhost' unless @db_port.nil?
+      else
+        con += ':' + @hostname
+      end
+      con += ':' + @db_port.to_s unless @db_port.nil?
+      con
+    end
+
+  end # class
+end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/db_driver.rb

@@ -0,0 +1,22 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki module Account
+  module DB_Driver
+    extend SynOpts
+
+    ######################################################################
+    attr_syn_opts :db_driver, :database_driver
+    attr_accessor :db_driver
+
+    #---------------------------------------------------------------------
+    def valid_db_driver?
+      return false if @db_driver.nil?
+      return false if @db_driver.empty?
+      return true
+    end
+
+  end # helper
+end end # package
+############################################################################

data/lib/ghaki/account/db_name.rb

@@ -0,0 +1,22 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki module Account
+  module DB_Name
+    extend SynOpts
+
+    ######################################################################
+    attr_syn_opts :db_name, :database_name
+    attr_accessor :db_name
+
+    #---------------------------------------------------------------------
+    def valid_db_name?
+      return false if @db_name.nil?
+      return false if @db_name.empty?
+      return true
+    end
+
+  end # helper
+end end # package
+############################################################################

data/lib/ghaki/account/db_port.rb

@@ -0,0 +1,22 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki module Account
+  module DB_Port
+    extend SynOpts
+
+    ######################################################################
+    attr_syn_opts :db_port, :database_port
+    attr_accessor :db_port
+
+    #---------------------------------------------------------------------
+    def valid_db_port?
+      return true if @db_port.nil?
+      return true if @db_port.to_s =~ %r{\A\d+\z}o
+      return false
+    end
+
+  end # helper
+end end # package
+############################################################################

data/lib/ghaki/account/domain_address.rb

@@ -0,0 +1,39 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki
+  module Account
+    module DomainAddress
+
+      ######################################################################
+      extend SynOpts 
+      attr_syn_opts :domain_address
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+      attr_writer :domain_address
+
+      #---------------------------------------------------------------------
+      def domain_address
+        @domain_address ||= self.make_domain_address
+      end
+
+      ######################################################################
+      protected
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def make_domain_address
+        if @userdomain.nil?
+          @username
+        else
+          "\\\\" + @userdomain + "\\" + @username
+        end
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/email_address.rb

@@ -0,0 +1,39 @@
+############################################################################
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki
+  module Account
+    module EMailAddress
+
+      ######################################################################
+      extend SynOpts
+      attr_syn_opts :email_address, :email
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+      attr_writer :email_address
+
+      #---------------------------------------------------------------------
+      def email_address
+        @email_address ||= self.make_email_address
+      end
+
+      ######################################################################
+      protected
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def make_email_address
+        if @hostname.nil?
+          @username
+        else
+          @username + '@' + @hostname
+        end
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/errors.rb

@@ -0,0 +1,10 @@
+module Ghaki
+  module Account
+
+    class InvalidHostnameError < RuntimeError; end
+    class InvalidPasswordError < RuntimeError; end
+    class InvalidUsernameError < RuntimeError; end
+    class InvalidUserDomainError < RuntimeError; end
+
+  end
+end 

data/lib/ghaki/account/hostname.rb

@@ -0,0 +1,95 @@
+############################################################################
+require 'highline'
+require 'ghaki/account/errors'
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki
+  module Account
+    module Hostname
+
+      ######################################################################
+      # SYNONYM OPTIONS
+      ######################################################################
+      extend SynOpts
+      attr_syn_opts :hostname, :host_name, :host
+
+      ######################################################################
+      # CONSTANTS
+      ######################################################################
+      HOSTNAME_RETRY_MAX = 3
+
+      ######################################################################
+      # CLASS METHODS
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def Hostname.get_env
+        if ENV.has_key?('HOSTNAME')
+          ENV['HOSTNAME']
+        else
+          require 'socket'
+          Socket.gethostname
+        end
+      end
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+      attr_reader :hostname
+
+      #---------------------------------------------------------------------
+      def hostname= val
+        case val
+        when String
+          @hostname = val.strip
+        when :env
+          @hostname = Hostname.get_env
+        else
+          @hostname = val
+        end
+      end
+
+      #---------------------------------------------------------------------
+      def valid_hostname?
+        return false if @hostname.nil?
+        return false if @hostname.empty?
+        return false unless @hostname =~ %r{\A\S+\z}o
+        return true
+      end
+
+      #---------------------------------------------------------------------
+      def ask_hostname opts={}
+        o_prompt,r_prompt = _hostname_prompt(opts), nil
+        defval = opts[:default] || @hostname
+        defval = Hostname.get_env if defval == :env
+        (1 .. (opts[:retry_max] || HOSTNAME_RETRY_MAX) ).each do
+          self.hostname = HighLine.new.ask( r_prompt||o_prompt ) do |q|
+            q.echo = true
+            q.default = defval unless defval.nil?
+          end
+          return @hostname if valid_hostname?
+          r_prompt ||= '* TRY AGAIN * ' + o_prompt
+        end
+        raise InvalidHostnameError, "Invalid Hostname: #{@hostname}"
+      end
+
+      #=====================================================================
+      protected
+      #=====================================================================
+
+      #---------------------------------------------------------------------
+      def _hostname_prompt opts
+        prompt = 'Hostname: '
+        case opts[:prompt]
+        when nil, :default, :auto
+        else
+          prompt = opts[:prompt]
+        end
+        prompt
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################