admin_module 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c8c29c19b7d3792f8c9ca04979028f956df0583
+  data.tar.gz: 22ec04a187770d3dd9b1355b0290b511dca42dcb
+SHA512:
+  metadata.gz: efb79e23d04db36f2183b2a5e9b291af2c11140ddf327c54d1b0e04977e3bef5ea1d025bd9043fb04f488396ff1dbcf6e556f89f70ed215d504f5845ff8772ec
+  data.tar.gz: 43bcab64b34dab3222cf8522cf224ff08d67f362daa4a7c69db556810dfb7e3cce794266ba20294dc7d4a3cd560c7fd70814ecb4007abb8fd43dc612d8b6eb9a

data/.gitignore

@@ -0,0 +1,19 @@
+*.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
+.admin_module

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'activesupport'
+  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/README.md

@@ -0,0 +1,281 @@
+# AdminModule
+
+AdminModule is a tool to allow maintenance and configuration of AMS
+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 'admin_module'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install admin_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.
+
+    $ admin_module help
+
+    Commands:
+      admin_module help [COMMAND]     # Describe available commands or one specific command
+      admin_module config [COMMAND]   # modify configuration values
+      admin_module gdl [COMMAND]      # run a guideline command
+      admin_module lock [COMMAND]     # run a lock command
+      admin_module rule [COMMAND]     # run a rule command
+      admin_module ruleset [COMMAND]  # run a ruleset command
+      admin_module stage [COMMAND]    # run a stage command
+
+
+#### Config Commands
+
+    $ admin_module config help
+
+    Commands:
+      admin_module config help [COMMAND]          # Describe subcommands or one specific subcommand
+      admin_module config defcomment '<comment>'  # show or set the default comment
+      admin_module config defenv <envname>        # show or set the default environment
+      admin_module config init <filedir>          # create a configuration file
+      admin_module config timeout <seconds>       # show or set the browser timeout period
+      admin_module config show [CATEGORY]         # display configuration values for [CATEGORY]
+      admin_module config add [CATEGORY]          # add a configuration value
+      admin_module config del [CATEGORY]          # delete a configuration value for [CATEGORY]
+
+
+##### Config Show Commands
+
+    $ admin_module config show help
+
+    Commands:
+      admin_module config show help [COMMAND]         # Describe subcommands or one specific subcommand
+      admin_module config show credentials <envname>  # display configured credentials for an environment
+      admin_module config show envs                   # display configured environments
+      admin_module config show xmlmaps                # display configured xmlmaps
+
+
+##### Config Add Commands
+
+    $ admin_module config add help
+
+    Commands:
+      admin_module config add help [COMMAND]                           # Describe subcommands or one specific subcommand
+      admin_module config add credentials <envname> <username> <pass>  # add login credentials for an environment
+      admin_module config add env <envname> <url>                      # add a environment url
+      admin_module config add xmlmap <xmlfile> <gdlname>               # map an xml file name to a guideline
+
+
+##### Config Del Commands
+
+    $ admin_module config del help
+
+    Commands:
+      admin_module config del help [COMMAND]         # Describe subcommands or one specific subcommand
+      admin_module config del credentials <envname>  # delete credentials for an environment
+      admin_module config del env <envname>          # delete an environment configuration
+      admin_module config del xmlmap <xmlfile>       # delete an xml file to guideline mapping
+
+
+#### Gdl Commands
+
+    $ admin_module gdl help
+
+    Commands:
+      admin_module gdl help [COMMAND]              # Describe subcommands or one specific subcommand
+      admin_module gdl deploy <srcdir> <comments>  # Deploy all XML files in <srcdir> with version <comments>
+      admin_module gdl version <comments>          # Version guidelines with <comments>
+
+    Options:
+      e, [--environment=dev]
+
+
+#### Lock Commands
+
+    $ admin_module lock help
+
+    Commands:
+      admin_module lock help [COMMAND]               # Describe subcommands or one specific subcommand
+      admin_module lock export <filepath>            # Export a lock configuration file from the environment
+      admin_module lock import <filepath>            # Import a lock configuration file into the environment
+      admin_module lock list                         # List all locks in the environment
+      admin_module lock read <name>                  # Emit a lock's configuration from the environment in YAML format
+      admin_module lock rename <srcname> <destname>  # Rename a lock named <srcname> to <destname>
+
+    Options:
+      e, [--environment=dev]
+
+
+#### Rule Commands
+
+    $ admin_module rule help
+
+    Commands:
+      admin_module rule help [COMMAND]               # Describe subcommands or one specific subcommand
+      admin_module rule delete <rulename>            # Delete a rule named <rulename>
+      admin_module rule list                         # List all rules in the environment
+      admin_module rule rename <srcname> <destname>  # Rename a rule named <srcname> to <destname>
+
+    Options:
+      e, [--environment=dev]
+
+
+#### Ruleset Commands
+
+    $ admin_module ruleset help
+
+    Commands:
+      admin_module ruleset help [COMMAND]               # Describe subcommands or one specific subcommand
+      admin_module ruleset list                         # List all rulesets in the environment
+      admin_module ruleset rename <srcname> <destname>  # Rename a ruleset named <srcname> to <destname>
+
+    Options:
+      e, [--environment=dev]
+
+
+#### Stage Commands
+
+    $ admin_module stage help
+
+    Commands:
+      admin_module stage help [COMMAND]               # Describe subcommands or one specific subcommand
+      admin_module stage delete <name>                # Delete a stage from the environment
+      admin_module stage export <filepath>            # Export a stage configuration file from the environment
+      admin_module stage import <filepath>            # Import a stage configuration file into the environment
+      admin_module stage list                         # List all stages in the environment
+      admin_module stage read <name>                  # Emit a stage's configuration from the environment in YAML format
+      admin_module stage rename <srcname> <destname>  # Rename a stage from <srcname> to <destname>
+
+    Options:
+      e, [--environment=dev]
+
+
+
+
+### Tasks
+
+AdminModule provides tasks you can use in your rake file.
+
+#### Stage Tasks
+
+Add `require 'admin_module/rake/stage_tasks'` to your rake file and
+`admin_module` will add a set of `stage` tasks for each configured
+environment. All tasks are prefixed with `am:ENV_NAME:`.
+
+Task options are displayed within brackets like so: `am:dev:stage:read[name]`.
+If the option contains spaces, surround the option, or the entire task name
+with single or double quotes:
+
+    rake am:dev:stage:read['Some Stage Name']
+
+    # or
+
+    rake 'am:dev:stage:read[Some Stage Name]'
+
+
+Tasks include:
+
+- `stage:delete` deletes a stage
+- `stage:export` exports all stages to a yaml file
+- `stage:import` imports stage configs from a yaml file
+  - the `allow_create` flag is optional. Default: `false`. If `true`, stages can be created during import.
+- `stage:list` list all stage names
+- `stage:read` output a stage configuration in yaml format
+- `stage:rename` rename an existing stage
+
+
+## Scripting
+
+You can use the Client for scripting.
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jmcaffee/admin_module/fork )
+1. Clone it (`git clone git@github.com:[my-github-username]/admin_module.git`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create tests for your feature branch
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## ToDo
+
+* complete conversion to `thor`
+* PPM configuration specs
+* clean up (remove) old `cli` files
+* document new commands in README
+  + PPMs
+  + Tasks
+  + Snapshots
+
+
+## Process Flow (CLI)
+
+- Command entered in console
+- `lib/admin_module/cli.rb` processes args
+- `cli.rb` hands command off to `lib/admin_module/cli/gdl.rb`
+- `gdl.rb` validates command and hands off to `lib/admin_module/guideline.rb`
+- `guideline.rb` processes command and uses `lib/admin_module/page_factory.rb`
+  to get instance of web page objects needed to fulfill command request
+- `guideline.rb` completes command
+
+## Process Flow (Rake Task)
+
+- Rake imports/requires `lib/admin_module/rake/deploy_task.rb`
+- Rake task requires API object `lib/admin_module/guideline.rb`
+- API object processes task request, gets needed page objects from `page_factory.rb`
+- API object completes task request, returns control to task
+
+## Thor Conversion Process
+
+Detailing the conversion steps taken while converting to Thor CLI interface.
+
+1. Create CLI spec for new interface (`spec/lib/admin_module/cli/gdl_spec.rb`)
+2. Create new CLI object (`lib/admin_module/cli/gdl.rb`)
+3. Create API spec for API object (`spec/lib/admin_module/guideline_spec.rb`)
+4. Create new/modify existing API object (`lib/admin_module/guideline.rb`)
+5. Make tests/specs pass
+6. Delete old CLI object (`lib/admin_module/cli/cli_guideline.rb`)
+
+### Create CLI Spec
+
+Create a new spec file `spec/lib/admin_module/cli/gdl_spec.rb`.
+
+Create a new CLI object `lib/admin_module/cli/gdl.rb`.
+
+Edit `lib/admin_module/cli.rb` creating new base command pointing to new object
+(`AdminModule::Gdl` in this case).
+
+Create `lib/admin_module/guideline.rb` which is an object that provides an API
+interface to the actual Guideline page object.
+
+- The Guideline page object only contains functionality that the actual webpage
+  contains, ie. Add, Modify, Delete
+- The Guideline API object contains functionality that manipulates the webpage
+  object to provide results. Maybe this means it uses the page object to lookup
+  the available guidelines, throw an error if a guidline doesn't exist, or
+  deletes a guideline if exists.
+- The API object also hides the fact that the app needs to go to a _Guidelines_
+  page, select a guideline, then go to the _GuidelineDetails_ page before it can
+  manipulate a guideline, say, to change its name.
+
+## LICENSE
+
+AdminModule is licensed under the MIT license.
+
+See [LICENSE](https://github.com/jmcaffee/admin_module/blob/master/LICENSE) for
+details.
+

data/Rakefile

@@ -0,0 +1,98 @@
+require "bundler/gem_tasks"
+require 'ktutils/os'
+
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+# Windows Locations
+
+CHROME_PATH = '"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"'
+
+# Setup common clean and clobber targets
+
+CLEAN.include("pkg")
+CLOBBER.include("pkg")
+
+##############################################################################
+
+desc 'start a console'
+task :console do
+  require 'pry'
+  require 'admin_module'
+  ARGV.clear
+
+  AdminModule.configure do |config|
+    config.credentials = { :dev => ['admin', 'Password1*'] }
+  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
+  console_help
+
+CONSOLE_HELP
+  end
+
+  def cli
+    @cli ||= AdminModule::CLI.new
+    @cli
+  end
+
+  def add_credentials env, username, pwd
+    AdminModule.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
+
+  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?
+    user_data_dir = user_data_dir.gsub('/', '\\')
+    sh("#{CHROME_PATH} --user-data-dir=#{user_data_dir}")
+  else
+    chrome = `which chromium-browser`.chomp
+    sh("#{chrome} --user-data-dir=#{user_data_dir}")
+  end
+end
+
+#############################################################################
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  #t.rcov = true
+end
+