admin_module 0.1.4

data/lib/admin_module/command/snapshot.rb

@@ -0,0 +1,110 @@
+##############################################################################
+# File::    snapshot.rb
+# Purpose:: Snapshot command line interface
+#
+# Author::    Jeff McAffee 2015-04-05
+#
+##############################################################################
+
+module AdminModule
+  module Command
+    class Snapshot < Thor
+      include AdminModule::Command::ClientAccess
+
+      class_option :environment, :banner => "dev", :aliases => :e
+
+      desc "list",
+        "List snapshot definitions"
+      long_desc <<-LD
+        List all snapshot definitions
+
+        With -e <env>, sets the environment to work with
+      LD
+      def list
+        cl = client.snapshots
+        list = cl.list
+
+        list.each { |item| say item; }
+
+      ensure
+        client.logout
+      end
+
+      desc "import <filepath>",
+        "Import a snapshot definition file into the environment"
+      long_desc <<-LD
+        Import a snapshot definition file into the environment.
+
+        <filepath> is a path to a YAML definition file to import.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def import filepath
+        cl = client.snapshots
+        cl.import filepath
+
+      ensure
+        client.logout
+      end
+
+      desc "export <filepath>",
+        "Export a snapshot definition file from the environment"
+      long_desc <<-LD
+        Export a snapshot definition file from the environment.
+
+        <filepath> path to location YAML definition file will be exported to.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def export filepath
+        cl = client.snapshots
+        cl.export filepath
+
+      ensure
+        client.logout
+      end
+
+      desc "rename <srcname> <destname>",
+        "Rename a snapshot definition from <srcname> to <destname>"
+      long_desc <<-LD
+        Rename a snapshot definition from <srcname> to <destname>.
+
+        With -e <env>, sets the environment to work with.
+
+        This operation will fail if the source definition does not exist or
+        if the destination definition name already exists.
+      LD
+      def rename src, dest
+        cl = client.snapshots
+
+        cl.rename src, dest
+
+      rescue ArgumentError => e
+        say e.message, :red
+
+      ensure
+        client.logout
+      end
+
+      desc "read <name>",
+        "Emit a snapshot definition from the environment in YAML format"
+      long_desc <<-LD
+        Emit a snapshot's definition from the environment in YAML format.
+
+        <name> of snapshot definition to dump.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def read name
+        cl = client.snapshots
+        data = cl.read name
+        output = Hash.new
+        output[name] = data
+        $stdout << output.to_yaml
+
+      ensure
+        client.logout
+      end
+    end
+  end
+end

data/lib/admin_module/command/stage.rb

@@ -0,0 +1,131 @@
+##############################################################################
+# File::    stage.rb
+# Purpose:: Stage command line interface
+#
+# Author::    Jeff McAffee 11/15/2013
+#
+##############################################################################
+
+module AdminModule
+  module Command
+    class Stage < Thor
+      include AdminModule::Command::ClientAccess
+
+      class_option :environment, :banner => "dev", :aliases => :e
+
+      desc "rename <srcname> <destname>",
+        "Rename a stage from <srcname> to <destname>"
+      long_desc <<-LD
+        Rename a stage from <srcname> to <destname>.
+
+        With -e <env>, sets the environment to work with.
+
+        This operation will fail if the source stage does not exist or
+        if the destination stage name already exists.
+      LD
+      def rename src, dest
+        cs = client.stages
+        cs.rename src, dest
+
+      rescue ArgumentError => e
+        say e.message, :red
+
+      ensure
+        client.logout
+      end
+
+      desc "list",
+        "List all stages in the environment"
+      long_desc <<-LD
+        List all stages in the current environment.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def list
+        cs = client.stages
+        list = cs.list
+
+        list.each { |s| say s; }
+
+      ensure
+        client.logout
+      end
+
+      desc "import <filepath>",
+        "Import a stage configuration file into the environment"
+      long_desc <<-LD
+        Import a stage configuration file into the environment.
+
+        <filepath> is a path to a YAML configuration file to import.
+
+        With -e <env>, sets the environment to work with.
+
+        With -c, allow creation of new stages
+      LD
+      option :create, :type => :boolean, :default => false, :aliases => :c
+      def import filepath
+        cs = client.stages
+        cs.import filepath, options[:create]
+
+        return
+      ensure
+        client.logout
+      end
+
+      desc "export <filepath>",
+        "Export a stage configuration file from the environment"
+      long_desc <<-LD
+        Export a stage configuration file from the environment.
+
+        <filepath> path where the YAML configuration file will be exported to.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def export filepath
+        cs = client.stages
+        cs.export filepath
+
+        return
+      ensure
+        client.logout
+      end
+
+      desc "delete <name>",
+        "Delete a stage from the environment"
+      long_desc <<-LD
+        Delete a stage from the environment.
+
+        <name> of stage to delete.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def delete name
+        cs = client.stages
+        cs.delete name
+
+      ensure
+        client.logout
+      end
+
+      desc "read <name>",
+        "Emit a stage's configuration from the environment in YAML format"
+      long_desc <<-LD
+        Emit a stage's configuration from the environment in YAML format.
+
+        <name> of stage to dump.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def read name
+        cs = client.stages
+        data = cs.read(name)
+        output = Hash.new
+        output[name] = data
+        $stdout << output.to_yaml
+
+      ensure
+        client.logout
+      end
+    end # class
+  end
+end # module

data/lib/admin_module/command/task.rb

@@ -0,0 +1,110 @@
+##############################################################################
+# File::    task.rb
+# Purpose:: Task command line interface
+#
+# Author::    Jeff McAffee 2014-06-28
+#
+##############################################################################
+
+module AdminModule
+  module Command
+    class Task < Thor
+      include AdminModule::Command::ClientAccess
+
+      class_option :environment, :banner => "dev", :aliases => :e
+
+      desc "rename <srcname> <destname>",
+        "Rename a task named <srcname> to <destname>"
+      long_desc <<-LD
+        Rename a task with the name <srcname> to <destname>.
+
+        With -e <env>, sets the environment to work with.
+
+        This operation will fail if the source task does not exist or
+        if the destination task name already exists.
+      LD
+      def rename(src, dest)
+        cl = client.tasks
+
+        cl.rename src, dest
+
+      rescue ArgumentError => e
+        say e.message, :red
+
+      ensure
+        client.logout
+      end
+
+      desc "list",
+        "List all tasks in the environment"
+      long_desc <<-LD
+        List all tasks in the current environment.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def list
+        cl = client.tasks
+        list = cl.list
+
+        list.each { |r| say r; }
+
+      ensure
+        client.logout
+      end
+
+      desc "import <filepath>",
+        "Import a task configuration file into the environment"
+      long_desc <<-LD
+        Import a task configuration file into the environment.
+
+        <filepath> is a path to a YAML configuration file to import.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def import filepath
+        cl = client.tasks
+        cl.import filepath
+
+      ensure
+        client.logout
+      end
+
+      desc "export <filepath>",
+        "Export a task configuration file from the environment"
+      long_desc <<-LD
+        Export a task configuration file from the environment.
+
+        <filepath> path where the YAML configuration file will be exported to.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def export filepath
+        cl = client.tasks
+        cl.export filepath
+
+      ensure
+        client.logout
+      end
+
+      desc "read <name>",
+        "Emit a task's configuration from the environment in YAML format"
+      long_desc <<-LD
+        Emit a task's configuration from the environment in YAML format.
+
+        <name> of task to dump.
+
+        With -e <env>, sets the environment to work with.
+      LD
+      def read name
+        cl = client.tasks
+        data = cl.read(name)
+        output = Hash.new
+        output[name] = data
+        $stdout << output.to_yaml
+
+      ensure
+        client.logout
+      end
+    end # Task
+  end
+end # AdminModule

data/lib/admin_module/config_helper.rb

@@ -0,0 +1,33 @@
+##############################################################################
+# File::    config_helper.rb
+# Purpose:: Configuration object wrapper
+# 
+# Author::    Jeff McAffee 07/01/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+module AdminModule
+  class ConfigHelper
+
+    def self.env=(env)
+      @env = env.to_sym
+    end
+
+    def self.env
+      @env ||= AdminModule.configuration.default_environment
+    end
+
+    def self.page_factory=(factory)
+      @page_factory = factory
+    end
+
+    def self.page_factory
+      @page_factory ||= PageFactory.new
+    end
+
+    def self.credentials
+      AdminModule.configuration.credentials[env]
+    end
+  end
+end # AdminModule

data/lib/admin_module/dc.rb

@@ -0,0 +1,133 @@
+##############################################################################
+# File::    dc.rb
+# Purpose:: Interface to DataClearing functionality in admin module1
+#
+# Author::    Jeff McAffee 04/01/2015
+##############################################################################
+
+require 'admin_module/pages'
+
+module AdminModule
+
+  class DC
+    attr_reader :page_factory
+
+    def initialize page_factory
+      @page_factory = page_factory
+    end
+
+    def list
+      dc_page.get_definitions
+    end
+
+    def rename src, dest
+      src = assert_definition_exists src
+      dest = assert_definition_does_not_exist dest
+
+      dc_page
+        .modify(src)
+        .set_name(dest)
+        .save
+    end
+
+    def import file_path
+      assert_file_exists file_path
+
+      defns = {}
+      File.open(file_path, 'r') do |f|
+        # Read array of definition hashes
+        defns = YAML.load(f)
+      end
+
+      existing_defns = list
+
+      defns.each do |name, data|
+        if existing_defns.include?(name)
+          update(data)
+        else
+          create(data)
+        end
+      end
+    end
+
+    def export file_path
+      defns = list
+      export_data = {}
+
+      defns.each do |defn|
+        export_data[defn] = read defn
+      end
+
+      File.open(file_path, 'w') do |f|
+        f.write export_data.to_yaml
+      end
+
+    rescue Exception => e
+      if e.message.include? 'No such file or directory'
+        raise IOError, "No such directory - #{file_path}"
+      else
+        raise e
+      end
+    end
+
+    def read name
+      name = assert_definition_exists name
+
+      dc_page
+        .modify(name)
+        .get_definition_data
+    end
+
+  private
+
+    def dc_page
+      page_factory.dc_definitions_page
+    end
+
+    def assert_definition_exists name
+      unless list.include? name
+        fail ArgumentError.new("A data clearing definition named '#{name}' does not exist")
+      end
+
+      name
+    end
+
+    def assert_definition_does_not_exist name
+      if list.include? name
+        fail ArgumentError.new("A data clearing definition named '#{name}' already exists")
+      end
+
+      name
+    end
+
+    def assert_file_exists file_path
+      raise IOError, "File not found: #{file_path}" unless File.exists?(file_path)
+    end
+
+    def update data
+      name = assert_definition_exists( extract_defn_name(data) )
+
+      dc_page
+        .modify(name)
+        .set_definition_data(data)
+        .save
+    end
+
+    def create data
+      name = assert_definition_does_not_exist( extract_defn_name(data) )
+
+      dc_page
+        .add
+        .set_definition_data(data)
+        .save
+    end
+
+    def extract_defn_name data
+      name = if data.is_a? Hash
+               data[:name]
+             else
+               String(data)
+             end
+    end
+  end
+end # module