portal_module 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa176e874d96ecf9837f0c6e4b1b1bd442ac3603
+  data.tar.gz: 239dd78a8944a1c525a70cf47606f7d33e7b3b76
+SHA512:
+  metadata.gz: 0d9043d0cff5b73c8dcb9af85e800bd6122e13594f84aed49db645d12020bec3b9be254589c1aee8296c56815aa62f7f06b8955a54f871f7f6cf431edbf54b46
+  data.tar.gz: 6f6eddb6a856e9c72bc5f8e28944a8db797a2891088ddfc8df848fee7d553fc263e3a5c2adf44dc3f122f37f3c9eaafc1ad6afeaba906090f98fb7e5327ab584

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/chrome-data

data/.rspec

@@ -0,0 +1,3 @@
+--color
+#--format progress
+--format documentation

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry-byebug', :git => 'git://github.com/deivid-rodriguez/pry-byebug.git'#, :tag => 'v1.3.3'
+  gem 'pry-doc'
+  gem 'pry-docmore'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+end
+
+# Specify your gem's dependencies in admin_module.gemspec
+gemspec
+

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jeff McAffee
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff McAffee
+
+MIT License
+
+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.md

@@ -0,0 +1,240 @@
+# PortalModule
+
+PortalModule is a tool to allow maintenance and configuration of AMS
+Portal environments through the command line or Rake tasks.
+
+Because it is scriptable, it can be used to create efficient and repeatable
+migrations resulting in low risk deployments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'portal_module'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install portal_module
+
+## Usage
+
+### Command Line Help
+
+Thor's usage help is messed up related to subcommands (ie. subcommand help is
+sometimes listed without the subcommand's parent). For this reason, the 'help'
+is listed here.
+
+    $ portal_module help
+
+    Commands:
+      portal_module help [COMMAND]        # Describe available commands or one specific command
+      portal_module config [COMMAND]      # modify configuration values
+      portal_module dts [COMMAND]         # run a dts command
+      portal_module loan_entry [COMMAND]  # run a Loan Entry command
+
+
+#### Config Commands
+
+    $ portal_module config help
+
+    Commands:
+      portal_module config help [COMMAND]          # Describe subcommands or one specific subcommand
+      portal_module config defenv <envname>        # show or set the default environment
+      portal_module config download_dir <dir>      # show or set the system download directory
+      portal_module config init <filedir>          # create a configuration file
+      portal_module config timeout <seconds>       # show or set the browser timeout period
+      portal_module config show [CATEGORY]         # display configuration values for [CATEGORY]
+      portal_module config add [CATEGORY]          # add a configuration value
+      portal_module config del [CATEGORY]          # delete a configuration value for [CATEGORY]
+
+
+##### Config Show Commands
+
+    $ portal_module config show help
+
+    Commands:
+      portal_module config show help [COMMAND]         # Describe subcommands or one specific subcommand
+      portal_module config show credentials <envname>  # display configured credentials for an environment
+      portal_module config show envs                   # display configured environments
+      portal_module config show orgs                   # display configured Org Units
+
+
+##### Config Add Commands
+
+    $ portal_module config add help
+
+    Commands:
+      portal_module config add help [COMMAND]                           # Describe subcommands or one specific subcommand
+      portal_module config add credentials <envname> <username> <pass>  # add login credentials for an environment
+      portal_module config add env <envname> <url>                      # add a environment url
+      portal_module config add org <orgname> <orgid>                    # add an Org Unit and ID
+
+
+##### Config Del Commands
+
+    $ portal_module config del help
+
+    Commands:
+      portal_module config del help [COMMAND]         # Describe subcommands or one specific subcommand
+      portal_module config del credentials <envname>  # delete credentials for an environment
+      portal_module config del env <envname>          # delete an environment configuration
+      portal_module config del org <orgname>          # delete an Org Unit
+
+
+#### DTS Commands
+
+    $ portal_module dts help
+
+    Commands:
+      portal_module dts help [COMMAND]             # Describe subcommands or one specific subcommand
+      portal_module dts download <org> <filepath>  # Export a DTS configuration file from the environment
+      portal_module dts upload <org> <filepath>    # Upload a DTS configuration file into the environment
+
+    Options:
+      e, [--environment=dev]
+
+
+#### Loan Entry Commands
+
+    $ portal_module loan_entry help
+
+    Commands:
+      portal_module loan_entry help [COMMAND]             # Describe subcommands or one specific subcommand
+      portal_module loan_entry download <org> <filepath>  # Download a Loan Entry configuration file from the environment
+      portal_module loan_entry upload <org> <filepath>    # Upload a Loan Entry configuration file into the environment
+
+    Options:
+      e, [--environment=dev]
+
+
+
+
+
+
+### Tasks
+
+PortalModule provides tasks you can use in your rake file.
+
+#### DTS Tasks
+
+Add `require 'portal_module/rake/dts_tasks'` to your rake file and
+`portal_module` will add a set of `dts` tasks for each configured
+environment. All tasks are prefixed with `am:ENV_NAME:`.
+
+Task options are displayed within brackets like so: `am:dev:dts:upload[org,filepath]`.
+If the option contains spaces, surround the option, or the entire task name
+with single or double quotes:
+
+    rake am:dev:dts:upload['Some Org Name','file/path with/spaces/file.xml']
+
+    # or
+
+    rake 'am:dev:dts:upload[Some Org Name,file/path with/spaces/file.xml]'
+
+
+Tasks include:
+
+- `dts:upload` uploads a DTS configuration file
+- `dts:download` downloads a DTS configuration file
+
+#### Loan Entry Tasks
+
+Add `require 'portal_module/rake/loan_entry_tasks'` to your rake file and
+`portal_module` will add a set of `loan_entry` tasks for each configured
+environment. All tasks are prefixed with `am:ENV_NAME:`.
+
+Task options are displayed within brackets like so: `am:dev:loan_entry:upload[org,filepath]`.
+If the option contains spaces, surround the option, or the entire task name
+with single or double quotes:
+
+    rake am:dev:loan_entry:upload['Some Org Name','file/path with/spaces/file.xml']
+
+    # or
+
+    rake 'am:dev:loan_entry:upload[Some Org Name,file/path with/spaces/file.xml]'
+
+
+Tasks include:
+
+- `loan_entry:upload` uploads a Loan Entry configuration file
+- `loan_entry:download` downloads a Loan Entry configuration file
+
+
+## Scripting
+
+You can use the Client for scripting.
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your tests (you do have tests, don't you?)
+4. Write your code
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## ToDo
+
+* document CLI
+
+## Process Flow (CLI)
+
+- Command entered in console
+- `lib/portal_module/cli.rb` processes args
+- `cli.rb` hands command off to `lib/portal_module/command/dts.rb`
+- `dts.rb` validates command and hands off to `lib/portal_module/dts.rb`
+- `dts.rb` processes command and uses `lib/portal_module/page_factory.rb`
+  to get instance of web page objects needed to fulfill command request
+- `dts.rb` completes command
+
+## Process Flow (Rake Task)
+
+- Rake imports/requires `lib/portal_module/rake/dts_task.rb`
+- Rake task requires API object `lib/portal_module/dts.rb`
+- API object processes task request, gets needed page objects from `page_factory.rb`
+- API object completes task request, returns control to task
+
+## Testing
+
+All tests can be run with
+
+    bundle exec rspec spec/
+
+There's an included `Guardfile` that can be started with
+
+    bundle exec guard
+
+### Creating a Command Spec
+
+Create a new spec file `spec/lib/portal_module/command/dts_spec.rb`.
+
+Create a new Command object `lib/portal_module/command/dts.rb`.
+
+Edit `lib/portal_module/cli.rb` creating new base command pointing to new object
+(`PortalModule::Command::Dts` in this case).
+
+Create `lib/portal_module/dts.rb` which is an object that provides an API
+interface to the actual DTS (DataTransformationPage) page object.
+
+- The DataTransformationPage page object only contains functionality that the actual webpage
+  contains, ie. Activate, Save, Loan Org Unit
+- The Dts API object contains functionality that manipulates the webpage
+  object to provide results. Maybe this means it uses the page object to lookup
+  the available org units, or throw an error if a org doesn't exist.
+- The API object also hides the fact that the app may need to go to a multiple
+  pages to accomplish the request.
+
+## LICENSE
+
+PortalModule is licensed under the MIT license.
+
+See [LICENSE](https://github.com/jmcaffee/portal_module/blob/master/LICENSE) for
+details.
+

data/Rakefile

@@ -0,0 +1,101 @@
+require "bundler/gem_tasks"
+require 'ktutils/os'
+
+require 'rake/clean'
+
+# Setup common clean and clobber targets
+
+CLEAN.include("pkg/**/*.*")
+CLEAN.include("tmp/**/*.*")
+
+CLOBBER.include("pkg")
+CLOBBER.include("tmp")
+
+##############################################################################
+
+desc 'start a console'
+task :console do
+  require 'pry'
+  require 'portal_module'
+  ARGV.clear
+
+  PortalModule.configure do |config|
+    config.credentials = { :dev => [ ENV['DEV_USER'], ENV['DEV_PASSWORD'] ] }
+  end
+
+  def console_help
+    puts <<CONSOLE_HELP
+ CONSOLE HELP
+-------------
+
+'cli' returns an initialized CLI object
+
+    The default environment is :dev.
+    To interact with a different environment, add credentials
+    and activate the new environment:
+
+    Ex:
+      add_credentials ENV, USERNAME, PASSWORD
+      cli.environment = :ENV
+      cli.login
+
+    or, call 'activate_env ENV, USERNAME, PASSWORD'
+
+
+Avaliable commands/methods:
+
+  cli
+  add_credentials ENV, USERNAME, PASSWORD
+  activate_env ENV, USERNAME, PASSWORD
+  add_org ORG_NAME, ORG_ID
+  console_help
+
+CONSOLE_HELP
+  end
+
+  def cli
+    @cli ||= PortalModule::CLI.new
+    @cli
+  end
+
+  def add_credentials env, username, pwd
+    PortalModule.configure do |config|
+      config.credentials[env.to_sym] = [username, pwd]
+    end
+  end
+
+  def activate_env env, username, pwd
+    add_credentials env, username, pwd
+    cli.environment = env.to_sym
+  end
+
+  def add_org org, id
+    PortalModule.configure do |config|
+      config.orgs[org] = id
+    end
+  end
+
+  console_help
+  Pry.start
+end
+
+##############################################################################
+
+desc 'Start chrome with data dir'
+task :start_chrome do
+  user_data_dir = File.expand_path('test/chrome-data')
+  mkdirs user_data_dir unless File.exists?(user_data_dir) and File.directory?(user_data_dir)
+
+  if Ktutils::OS.windows?
+    chrome_path = '"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"'
+    win_user_data_dir = user_data_dir.gsub('/','\\')
+    cmd = chrome_path + ' --user-data-dir=' + win_user_data_dir
+
+    sh(cmd)
+  else
+    chrome = `which chromium-browser`.chomp
+
+    sh("#{chrome} --user-data-dir=#{user_data_dir}")
+  end
+end
+