portal_module 0.0.2

data/lib/portal_module/rake.rb

@@ -0,0 +1,16 @@
+##############################################################################
+# File::    rake.rb
+# Purpose:: Pull in all rake task classes
+#
+# Author::    Jeff McAffee 2015-03-29
+#
+##############################################################################
+
+require 'portal_module'
+
+module PortalModule::Rake
+end
+
+require_relative 'rake/dts_tasks'
+require_relative 'rake/loan_entry_tasks'
+

data/lib/portal_module/version.rb

@@ -0,0 +1,3 @@
+module PortalModule
+  VERSION = "0.0.2"
+end

data/lib/portal_module.rb

@@ -0,0 +1,251 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "portal_module/version"
+require 'portal_module/config_helper'
+require "portal_module/cli"
+require 'portal_module/page_factory'
+require 'portal_module/pages'
+require 'portal_module/loan_entry'
+require 'portal_module/dts'
+require 'portal_module/client'
+
+if ENV['DEBUG'].nil?
+  $debug = false
+else
+  $debug = true
+end
+
+class AuthenticationRequired < StandardError
+end
+
+class ConfigurationError < StandardError; end
+
+module PortalModule
+  CONFIG_FILE_NAME = '.portal_module'
+
+  class << self
+    attr_accessor :configuration
+    attr_accessor :client
+  end
+
+  ##
+  # Setup portal_module configuration
+  #
+  # Attempts to find and load a configuration file the first time
+  # it's requested. If a config file cannot be found on in the current
+  # directory tree (moving towards trunk, not the leaves), a default
+  # configuration object is created.
+  #
+  # If a block is provided, the configuration object is yielded to the block
+  # after the configuration is loaded/created.
+  #
+
+  def self.configure
+    if self.configuration.nil?
+      unless self.load_configuration
+        self.configuration = Configuration.new
+      end
+    end
+    yield(configuration) if block_given?
+  end
+
+  ##
+  # Walk up the directory tree from current working dir (pwd) till a file
+  # named .portal_module is found
+  #
+  # Returns file path if found, nil if not.
+  #
+
+  def self.find_config_path
+    path = Pathname(Pathname.pwd).ascend{|d| h=d+CONFIG_FILE_NAME; break h if h.file?}
+  end
+
+  ##
+  # Write configuration to disk
+  #
+  # Writes to current working dir (pwd) if path is nil
+  #
+  # Returns path of emitted file
+  #
+
+  def self.save_configuration(path = nil)
+    # If no path provided, see if we can find one in the dir tree.
+    if path.nil?
+      path = find_config_path
+    end
+
+    # Still no path? Use the current working dir.
+    if path.nil?
+      path = Pathname.pwd
+    end
+
+    unless path.to_s.end_with?('/' + CONFIG_FILE_NAME)
+      path = Pathname(path) + CONFIG_FILE_NAME
+    end
+
+    path = Pathname(path).expand_path
+    File.write(path, YAML.dump(configuration))
+
+    path
+  end
+
+  ##
+  # Load the configuration from disk
+  #
+  # Returns true if config file found and loaded, false otherwise.
+  #
+
+  def self.load_configuration(path = nil)
+    # If no path provided, see if we can find one in the dir tree.
+    if path.nil?
+      path = find_config_path
+    end
+
+    return false if path.nil?
+    return false unless Pathname(path).exist?
+
+    File.open(path, 'r') do |f|
+      self.configuration = YAML.load(f)
+      puts "configuration loaded from #{path}" if $debug
+    end
+
+    true
+  end
+
+  class Configuration
+    attr_accessor :default_environment
+    attr_accessor :credentials
+    attr_accessor :base_urls
+    attr_accessor :page_urls
+
+    # Browser timeout in seconds. Default: 360 (6 mins).
+    attr_accessor :browser_timeout
+
+    attr_accessor :orgs
+    attr_reader   :download_dir
+    attr_accessor :download_timeout
+
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @default_environment = :dev
+      @current_env = nil
+
+      @credentials = {}
+      #@credentials = { dev: [ ENV['DEV_USER'], ENV['DEV_PASSWORD'] ],
+      #               }
+
+      @base_urls   = {}
+      #@base_urls   = { dev: "http://example.com/Portal",
+      #               }
+
+      @page_urls   = { 'DataTransformationPage' => "/Admin/DataTransformation.aspx",
+                       'PrequalSetupPage'       => "/Admin/PrequalSetup.aspx",
+                    }
+
+      @browser_timeout = 360
+
+      @orgs = {}
+
+      @download_dir = ''
+      @download_timeout = 360
+    end
+
+    ##
+    # Set the current environment.
+    #
+
+    def current_env=(env)
+      env = env.to_sym
+
+      fail "Cannot set current_env to un-configured environment: #{env}" unless @base_urls.key? env
+
+      # This value is NOT included when dumping to YAML.
+      # See Configurtion#encode_with
+      @current_env = env.to_sym
+    end
+
+    ##
+    # Return the current environment.
+    # Will return the default environment if current environment is not set.
+    #
+
+    def current_env
+      return @default_environment if @current_env.nil?
+      @current_env
+    end
+
+    ##
+    # Set the download directory for the system
+    #
+
+    def download_dir=(dir)
+      @download_dir = String(dir)
+    end
+
+    def base_url
+      @base_urls[current_env]
+    end
+
+    def url page_class
+      suffix = @page_urls[page_class.to_s.split('::').last]
+      raise "Unkown page [#{page_class.to_s}]" if suffix.nil?
+      base_url + suffix
+    end
+
+    def user_credentials
+      @credentials[current_env]
+    end
+
+    ##
+    # Control which instance vars are emitted when dumped to YAML.
+    #
+
+    def encode_with(coder)
+      vars = instance_variables.map { |x| x.to_s }
+      vars = vars - ["@current_env"]
+
+      vars.each do |var|
+        var_val = eval(var)
+        coder[var.gsub('@', '')] = var_val
+      end
+    end
+  end # Configuration
+
+
+  class Runner
+    def initialize(argv, client = PortalModule::Client.new, exit_code = true)
+      @argv = argv
+      PortalModule.client = client
+      @exit_code = exit_code
+    end
+
+    def execute!
+      exit_code = begin
+
+        # Run the Thor app
+        PortalModule::CLI.start(@argv)
+
+        # Thor::Base#start does not have a return value,
+        # assume success if no exception is thrown.
+        0
+      rescue StandardError => e
+        b = e.backtrace
+        b.unshift("#{b.shift}: #{e.message} (#{e.class})")
+        puts(b.map { |s| "\tfrom #{s}"}.join("\n"))
+        1
+      end
+
+      # Return the exit code
+      exit(exit_code) if @exit_code
+    end
+  end
+end
+
+# Call configure to force creation of the configuration object.
+PortalModule.configure
+

data/portal_module.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portal_module/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "portal_module"
+  spec.version       = PortalModule::VERSION
+  spec.authors       = ["Jeff McAffee"]
+  spec.email         = ["jeff@ktechsystems.com"]
+  spec.summary       = %q{Portal Module CLI}
+  spec.description   = %q{Command line interface for Portal Module}
+  spec.homepage      = "https://github.com/jmcaffee/portal_module"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 1.3.9"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  #spec.add_development_dependency "pry-byebug", "~> 1.3.3"
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "page-object"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "ktutils"
+end

data/spec/data/dts_import.xml

@@ -0,0 +1 @@
+Dummy data

data/spec/data/le_import.xml

@@ -0,0 +1 @@
+Dummy data

data/spec/lib/portal_module/cli_spec.rb

@@ -0,0 +1,35 @@
+require 'pathname'
+require Pathname(__FILE__).ascend{|d| h=d+'spec_helper.rb'; break h if h.file?}
+
+require 'portal_module/cli'
+
+describe 'portal_module executable' do
+
+  let(:cli) { PortalModule::CLI }
+
+  it "returns help info" do
+    output = capture_output do
+      cli.start %w(help)
+    end
+
+    expect( output ).to include "help [COMMAND]"
+    expect( output ).to include "config [COMMAND]"
+    expect( output ).to include "dts [COMMAND]"
+    expect( output ).to include "loan_entry [COMMAND]"
+  end
+
+=begin
+  it "returns non-zero exit status when passed unrecognized options" do
+    pending
+    #portal_module '--invalid_argument', :exitstatus => true
+    portal_module '--invalid_argument'
+    expect(exitstatus).to_not be_zero
+  end
+
+  it "returns non-zero exit status when passed unrecognized task" do
+    pending
+    portal_module 'unrecognized-task'#, :exitstatus => true
+    expect(exitstatus).to_not be_zero
+  end
+=end
+end

data/spec/lib/portal_module/client_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe PortalModule::Client do
+
+  before(:each) do
+    PortalModule.configure do |config|
+      config.reset
+      config.credentials[:dev] = ['devuser', 'devpass']
+    end
+  end
+
+  let(:client) do
+    obj = PortalModule::Client.new
+    obj.page_factory = mock_page_factory
+    obj
+  end
+
+  let(:login_page) { client.page_factory.login_page }
+
+  context "#env=" do
+
+    before(:each) do
+      PortalModule.configure do |config|
+        config.reset
+        config.credentials[:sit] = ['user', 'pass']
+        config.base_urls[:sit] = 'http://example.com/Portal'
+      end
+    end
+
+    it "sets environment to use" do
+      expect{ client.env = 'sit' }.to_not raise_exception
+      expect( client.env ).to eq :sit
+    end
+
+    it "raises exception if environment is not configured" do
+      expect{ client.env = :test }.to raise_exception
+    end
+  end
+
+  context "#env" do
+    it "returns default environment if not set" do
+      expect( client.env ).to eq PortalModule.configuration.default_environment
+    end
+  end
+
+  context "#dts" do
+    it "logs into the current env and returns a pre-configured Dts object" do
+
+      expect(login_page)
+        .to receive(:login_as)
+        .with('testuser', 'testpass')
+
+      client.user = 'testuser'
+      client.password = 'testpass'
+
+      expect( client.dts ).to_not be nil
+    end
+  end
+
+  context "#loan_entry" do
+    it "logs into the current env and returns a pre-configured LoanEntry object" do
+
+      expect(login_page)
+        .to receive(:login_as)
+        .with('testuser', 'testpass')
+
+      client.user = 'testuser'
+      client.password = 'testpass'
+
+      expect( client.loan_entry ).to_not be nil
+    end
+  end
+
+  context "#login" do
+    context "credentials not passed" do
+
+      before(:each) do
+        PortalModule.configure do |config|
+          config.reset
+          config.credentials[:dev] = ['devuser', 'devpass']
+          config.base_urls[:dev] = 'http://example.com/Portal'
+        end
+      end
+
+      let(:client) do
+        obj = PortalModule::Client.new
+        obj.page_factory = mock_page_factory
+        obj
+      end
+
+      it "uses credentials from configuration data" do
+        expect(login_page)
+          .to receive(:login_as)
+          .with('devuser', 'devpass')
+
+        client.env = :dev
+        client.login
+      end
+
+      it "credentials set on client override configuration data credentials" do
+        expect(login_page)
+          .to receive(:login_as)
+          .with('clientuser', 'clientpass')
+
+        client.env = :dev
+        client.user = 'clientuser'
+        client.password = 'clientpass'
+        client.login
+      end
+
+      it "raises AuthenticationRequired when no credentials are available" do
+        PortalModule.configure do |config|
+          config.credentials.delete :dev
+        end
+
+        client.env = :dev
+        client.user = nil
+        client.password = nil
+
+        expect{ client.login }.to raise_exception AuthenticationRequired
+      end
+    end
+
+  end
+end
+