ghaki-account 2011.11.29.1

data/lib/ghaki/account/password.rb

@@ -0,0 +1,101 @@
+############################################################################
+require 'highline'
+require 'ghaki/account/errors'
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki    #:nodoc:
+module Account  #:nodoc:
+
+module Password
+
+  ######################################################################
+  # SYNONYM OPTIONS
+  ######################################################################
+  extend SynOpts
+  attr_syn_opts :password, :passwords
+
+  # overrides autogenerated
+  def opt_password opts
+    val = Password.parse_opts( opts )
+    self.passwords = val
+  end
+
+  ######################################################################
+  # CONSTANTS
+  ######################################################################
+  ASK_PASSWORD_RETRY_MAX = 3
+
+  ######################################################################
+  # OBJECT METHODS
+  ######################################################################
+
+  def password
+    @cur_password ||= _try_passwords.first
+  end
+  def passwords
+    @all_passwords ||= []
+  end
+
+  def passwords= pass
+    @cur_passwords = nil
+    @all_passwords = if pass.nil? then [] else [pass].flatten end
+  end
+  alias_method :password=, :passwords=
+
+  def reset_passwords
+    @try_passwords = nil
+    @bad_passwords = nil
+    @cur_password = nil
+  end
+  def fail_password
+    _bad_passwords.push _try_passwords.shift unless _try_passwords.empty?
+  end
+  def retry_password?
+    !_try_passwords.empty?
+  end
+
+  def valid_password?
+    !passwords.empty?
+  end
+
+  def failed_passwords?
+    !_bad_passwords.empty?
+  end
+
+  def ask_password opts={}
+    f_ques,r_ques = _password_prompt( opts ), nil
+    (1..(opts[:retry_max] || ASK_PASSWORD_RETRY_MAX)).each do
+      self.password = HighLine.new.ask( r_ques || f_ques ) do |q|
+        q.echo = '*'
+      end
+      return self.password if valid_password?
+      r_ques ||= '* TRY AGAIN * ' + f_ques
+    end
+    raise InvalidPasswordError, 'Invalid Password Specified'
+  end
+
+  protected
+
+  def _try_passwords
+    @try_passwords ||= self.passwords.clone
+  end
+  def _bad_passwords
+    @bad_passwords ||= []
+  end
+
+  def _password_prompt opts
+    prompt = 'Password: '
+    case opts[:prompt]
+    when nil, :default
+    when :auto
+      unless @username.nil? and @hostname.nil?
+        prompt = '(' + (@username || '*') +
+          '@' + (@hostname || '*') +
+          ') ' + prompt
+      end
+    end
+    prompt
+  end
+
+end end end

data/lib/ghaki/account/syn_opts.rb

@@ -0,0 +1,42 @@
+############################################################################
+module Ghaki
+  module Account
+    module SynOpts
+
+      #---------------------------------------------------------------------
+      def attr_syn_opts token, *syn_list
+        klass = self.to_s.split('::').last
+        konst = klass.upcase
+        module_eval <<-"END"
+        
+          #{konst}_LIST = syn_list
+
+          def #{klass}.parse_opts opts
+            return opts[ :#{token} ] if opts.has_key?( :#{token} )
+            #{konst}_LIST.each do |name|
+              return opts[name] if opts.has_key?(name)
+            end
+            return opts[:account].#{token} if opts.has_key?(:account)
+            nil
+          end
+
+          def #{klass}.purge_opts opts
+             opts.delete( :#{token} )
+            #{konst}_LIST.each do |name|
+              opts.delete(name)
+            end
+            opts
+          end
+
+          def opt_#{token} opts
+            val = #{klass}.parse_opts( opts )
+            @#{token} = val unless val.nil?
+          end
+
+        END
+      end
+
+    end # helper
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/userdomain.rb

@@ -0,0 +1,88 @@
+############################################################################
+require 'highline'
+require 'ghaki/account/errors'
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki
+  module Account
+    module UserDomain
+
+      ######################################################################
+      extend SynOpts
+      attr_syn_opts :userdomain, :user_domain
+
+      ######################################################################
+      # CONSTANTS
+      ######################################################################
+      USERDOMAIN_RETRY_MAX = 3
+
+      ######################################################################
+      # CLASS METHODS
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def UserDomain.get_env
+        ENV['USERDOMAIN']
+      end
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+      attr_reader :userdomain
+
+      #---------------------------------------------------------------------
+      def userdomain= val
+        case val
+        when :env
+          @userdomain = UserDomain.get_env
+        when String
+          @userdomain = val.strip
+        else
+          @userdomain = val
+        end
+      end
+
+      #---------------------------------------------------------------------
+      def valid_userdomain?
+        return false if @userdomain.nil?
+        return false if @userdomain.empty?
+        return false unless @userdomain =~ %r{\A\w+\z}o
+        return true
+      end
+
+      #---------------------------------------------------------------------
+      def ask_userdomain opts={}
+        o_prompt,r_prompt = _userdomain_prompt(opts), nil
+        defval = opts[:default] || @userdomain
+        defval = UserDomain.get_env if defval == :env
+        (1 .. (opts[:retry_max] || USERDOMAIN_RETRY_MAX) ).each do
+          self.userdomain = HighLine.new.ask( r_prompt||o_prompt ) do |q|
+            q.echo = true
+            q.default = defval unless defval.nil?
+          end
+          return @userdomain if valid_userdomain?
+          r_prompt ||= '* TRY AGAIN * ' + o_prompt
+        end
+        raise InvalidUserDomainError, "Invalid User Domain: #{@userdomain}"
+      end
+
+      ######################################################################
+      protected
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def _userdomain_prompt opts
+        prompt = 'User Domain: '
+        case opts[:prompt]
+        when nil, :default, :auto
+        else
+          prompt = opts[:prompt]
+        end
+        prompt
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/username.rb

@@ -0,0 +1,93 @@
+############################################################################
+require 'etc'
+require 'highline'
+require 'ghaki/account/errors'
+require 'ghaki/account/syn_opts'
+
+############################################################################
+module Ghaki
+  module Account
+    module Username
+
+      ######################################################################
+      extend SynOpts
+      attr_syn_opts :username, :user_name, :user
+
+      ######################################################################
+      # CONSTANTS
+      ######################################################################
+      USERNAME_RETRY_MAX = 3
+
+      ######################################################################
+      # CLASS METHODS
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def Username.get_env
+        Etc.getlogin
+      end
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+      attr_reader :username
+
+      #---------------------------------------------------------------------
+      def username= val
+        case val
+        when String
+          @username = val.strip
+        when :env
+          @username = Username.get_env
+        else
+          @username = val
+        end
+      end
+
+      #---------------------------------------------------------------------
+      def valid_username?
+        return false if @username.nil?
+        return false if @username.empty?
+        return false unless @username =~ %r{\A\S+\z}o
+        return true
+      end
+
+      #---------------------------------------------------------------------
+      def ask_username opts={}
+        f_ques,r_ques = _username_prompt(opts), nil
+        defval = opts[:default] || @username
+        defval = Username.get_env if defval == :env
+        (1 .. (opts[:retry_max] || USERNAME_RETRY_MAX) ).each do
+          @username = HighLine.new.ask( r_ques || f_ques ) do |q|
+            q.echo = true
+            q.default = defval unless defval.nil?
+          end
+          return @username if valid_username?
+          r_ques ||= '* TRY AGAIN * ' + f_ques
+        end
+        raise InvalidUsernameError, "Invalid Username: #{@username}"
+      end
+
+      ######################################################################
+      protected
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def _username_prompt opts
+        prompt = 'Username: '
+        case opts[:prompt]
+        when nil, :default
+        when :auto
+          unless @hostname.nil?
+            '(' + @hostname + ') ' + prompt
+          end
+        else
+          prompt = opts[:prompt]
+        end
+        prompt
+      end
+
+    end # helper
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/account/windos.rb

@@ -0,0 +1,58 @@
+############################################################################
+require 'ghaki/account/base'
+require 'ghaki/account/userdomain'
+require 'ghaki/account/domain_address'
+
+############################################################################
+module Ghaki
+  module Account
+    class WinDos < Base
+      include UserDomain
+      include DomainAddress
+
+      ######################################################################
+      # CLASS METHODS
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def self.from_opts opts
+        opts[:account] || WinDos.new(opts)
+      end
+
+      #---------------------------------------------------------------------
+      def self.purge_opts opts ; super opts
+        UserDomain.purge_opts opts
+        DomainAddress.purge_opts opts
+        opts
+      end
+
+      ######################################################################
+      # OBJECT METHODS
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def expand_opts opts={} ; super opts
+        opts[:userdomain]     = @userdomain     unless @userdomain.nil?
+        opts[:domain_address] = @domain_address unless @domain_address.nil?
+        opts
+      end
+
+      #---------------------------------------------------------------------
+      def to_s
+        "\\\\" + (@userdomain || '*') + "\\" + (@username || '*')
+      end
+
+      ######################################################################
+      protected
+      ######################################################################
+
+      #---------------------------------------------------------------------
+      def _from_opts opts ; super opts
+        opt_userdomain opts
+        opt_domain_address opts
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################

data/spec/ghaki/account/base_spec.rb

@@ -0,0 +1,121 @@
+require 'ghaki/account/base'
+
+module Ghaki module Account module BaseTesting
+describe Base do
+
+  ########################################################################
+  # CONSTANTS
+  ########################################################################
+  OPTS_HOS = { :hostname => 'host' }
+  OPTS_USR = { :username => 'user' }
+  OPTS_PAS = { :password => ['secret'] }
+  OPTS_EML = { :email_address => 'user@host' }
+  OPTS_H_U = OPTS_HOS.merge(OPTS_USR)
+  OPTS_ALL = OPTS_H_U.merge(OPTS_PAS).merge(OPTS_EML)
+  EXTRA_OPTS = { :extra => true }
+
+  ########################################################################
+  # EIGEN TESTS
+  ########################################################################
+  context 'eigen class' do
+    specify { Base.ancestors.should include(Hostname) }
+    specify { Base.ancestors.should include(Username) }
+    specify { Base.ancestors.should include(Password) }
+    specify { Base.ancestors.should include(EMailAddress) }
+    subject { Base }
+    it { should respond_to :from_opts }
+    it { should respond_to :purge_opts }
+
+    #---------------------------------------------------------------------
+    describe '#from_opts' do
+      it 'accepts separate login parts' do
+        acc = Base.from_opts(OPTS_ALL)
+        acc.hostname.should == 'host'
+        acc.username.should == 'user'
+        acc.password.should == 'secret'
+      end
+      it 'passes thru account object' do
+        acc = Base.from_opts(OPTS_ALL)
+        opts = { :account => acc }
+        Base.from_opts(opts).should == acc
+      end
+    end
+
+    #---------------------------------------------------------------------
+    describe '#purge_opts' do
+      it 'removes separate login parts' do
+        Base.purge_opts(OPTS_ALL.merge(EXTRA_OPTS)).should eql(EXTRA_OPTS)
+      end
+    end
+
+  end
+
+  ########################################################################
+  # INSTANCE TESTS
+  ########################################################################
+  context 'object instance' do
+    subject { Base.new }
+
+    it { should respond_to :ask_all }
+
+    #---------------------------------------------------------------------
+    it { should respond_to :to_s }
+    describe '#to_s' do
+      it 'creates from hostname only' do
+        Base.new(OPTS_HOS).to_s.should == '*@host'
+      end
+      it 'creates from username only' do
+        Base.new(OPTS_USR).to_s.should == 'user@*'
+      end
+      it 'creates from username and hostname' do
+        Base.new(OPTS_H_U).to_s.should == 'user@host'
+      end
+    end
+
+    #---------------------------------------------------------------------
+    describe '#email_address' do
+      it 'defaults with username only' do
+        Base.new(OPTS_USR).email_address.should == 'user'
+      end
+      it 'defaults with username and hostname' do
+        Base.new(OPTS_H_U).email_address.should == 'user@host'
+      end
+      it 'accepts full email address' do
+        Base.new(OPTS_EML).email_address.should == 'user@host'
+      end
+    end
+
+    #---------------------------------------------------------------------
+    it { should respond_to :collapse_opts }
+    describe '#collapse_opts' do
+      before(:each) do
+        @base = Base.new(OPTS_ALL)
+        @opts = { :account => @base }
+      end
+      it 'generates account pair' do
+        @base.collapse_opts.should eql(@opts)
+      end
+      it 'ignores extra hash pairs' do
+        @base.collapse_opts(EXTRA_OPTS).should eql(@opts.merge(EXTRA_OPTS))
+      end
+    end
+
+    #---------------------------------------------------------------------
+    it { should respond_to :expand_opts }
+    describe '#expand_opts' do
+      before(:each) do
+        @base = Base.new(OPTS_ALL)
+      end
+      it 'generates separate login pairs' do
+        @base.expand_opts.should eql(OPTS_ALL)
+      end
+      it 'ignores extra hash pairs' do
+        @base.expand_opts(EXTRA_OPTS).should eql(OPTS_ALL.merge(EXTRA_OPTS))
+      end
+    end
+
+  end
+
+end
+end end end
+############################################################################