admin_module 0.1.4

data/lib/admin_module/rake/lock_tasks.rb

@@ -0,0 +1,189 @@
+##############################################################################
+# File::    lock_tasks.rb
+# Purpose:: LockTasks definition
+#
+# Author::    Jeff McAffee 2015-03-12
+#
+##############################################################################
+
+require 'admin_module'
+require 'rake/dsl_definition'
+require 'rake'
+
+module AdminModule::Rake
+
+  class LockTasks
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    attr_accessor :env
+    attr_accessor :name
+    attr_accessor :to
+    attr_accessor :path
+    attr_accessor :allow_create
+    attr_reader   :action
+    attr_reader   :valid_actions
+    attr_reader   :stop_on_exception
+
+    def initialize(task_name = 'locks_task', desc = "Modify a lock or locks")
+      @valid_actions = ['import', 'export', 'read', 'list', 'rename']
+      @task_name, @desc = task_name, desc
+
+      @stop_on_exception = true
+      @allow_create = false
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    def define_task #:nodoc:
+      desc @desc
+      task(@task_name, required_args_for_action) do |t,args|
+        set_vars args
+        commit  # Call method to perform when invoked.
+      end
+    end
+
+    def set_vars args
+      args.each do |arg,val|
+        instance_variable_set "@#{arg}", val
+      end
+
+      args
+    end
+
+    def action=(task_action)
+      raise "action must be one of #{valid_types.join(', ')}" unless valid_actions.include?(task_action.downcase)
+      @action = task_action
+    end
+
+    def stop_on_exception=(do_stop)
+      raise ArgumentError, 'Expecting true or false' unless do_stop === true || do_stop === false
+      @stop_on_exception = do_stop
+    end
+
+    def commit
+      validate_params
+
+      client = AdminModule::Client.new
+      client.env = env
+
+      if self.respond_to? action
+        self.send(action, client)
+        return
+      else
+        raise "Unknown action - #{action}"
+      end
+
+    rescue Exception => e
+      raise e if stop_on_exception == true
+    ensure
+      client.quit
+    end
+
+    def list client
+      $stdout << client.locks.list.join("\n")
+      $stdout << "\n"
+    end
+
+    def read client
+      result = {}
+      result[name] = client.locks.read(name)
+      $stdout << result.to_yaml
+    end
+
+    def import client
+      $stdout << client.locks.import(path, allow_create)
+    end
+
+    def export client
+      $stdout << client.locks.export(path)
+    end
+
+    def rename client
+      $stdout << client.locks.rename(name, to)
+    end
+
+    def validate_params
+      assert_provided env, 'Missing "env"'
+      assert_provided action, 'Missing "action"'
+
+      case action
+      when 'import'
+        assert_provided path, 'Missing "path"'
+
+      when 'export'
+        assert_provided path, 'Missing "path"'
+
+      when 'read'
+        assert_provided name, 'Missing "name"'
+
+      when 'rename'
+        assert_provided name, 'Missing "name"'
+        assert_provided to, 'Missing "to"'
+
+      end
+
+      assert_env_is_configured env
+    end
+
+    def assert_provided value, msg
+      if value.nil? || value.empty?
+        raise msg
+      end
+    end
+
+    def assert_env_is_configured arg
+      unless AdminModule.configuration.credentials.key? arg
+        init_msg = "Have you initialized your config file?\n Try: admin_module config init <filedir>"
+        env_msg = "Have you configured your environments?\n Try: admin_module config add env <envname> <url>"
+        raise "Unknown environment: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    def required_args_for_action
+      args = []
+
+      case action
+      when 'read'
+        args << :name
+
+      when 'rename'
+        args << :name
+        args << :to
+
+      when 'import'
+        args << :path
+        args << :allow_create
+
+      when 'export'
+        args << :path
+
+      else
+        # Noop
+      end
+
+      args
+    end
+
+    class << self
+      def install
+        new.install
+      end
+    end
+
+    def install
+      AdminModule.configuration.credentials.keys.each do |e|
+        valid_actions.each do |action|
+          AdminModule::Rake::LockTasks.new("am:#{e}:lock:#{action}", "#{action} #{e} lock(s)") do |t|
+            t.env = e
+            t.action = action
+          end
+        end
+      end
+    end
+  end # class
+end # module
+
+AdminModule::Rake::LockTasks.install
+

data/lib/admin_module/rake/parameter_task.rb

@@ -0,0 +1,86 @@
+##############################################################################
+# File::    parameter_task.rb
+# Purpose:: ParameterTask definition
+# 
+# Author::    Jeff McAffee 03/19/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module'
+require 'rake/dsl_definition'
+require 'rake'
+
+module AdminModule::Rake
+
+  class ParameterTask
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    attr_accessor :env
+    attr_accessor :name
+    attr_reader   :type
+    attr_reader   :decision
+    attr_reader   :order
+    attr_reader   :precision
+    attr_reader   :include
+
+    def initialize(task_name = 'save_in_xml', desc = "Set or clear a variable's Save in XML flag")
+      @task_name, @desc = task_name, desc
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    def define_task #:nodoc:
+      desc @desc
+      task @task_name do
+        update
+      end
+    end
+
+    def type=(new_type)
+      valid_types = ['Boolean', 'Date', 'DateTime', 'Money', 'Numeric', 'Percentage', 'Text']
+      raise "type must be one of #{valid_types.join(', ')}" unless valid_types.include?(new_type)
+      @type = new_type
+    end
+
+    def decision=(new_decision)
+      raise "decision must be true or false" unless (new_decision === true || new_decision === false)
+      @decision = new_decision ? 'Yes' : 'No'
+    end
+
+    def order=(new_order)
+      @order = new_order.to_i
+    end
+
+    def precision=(new_precision)
+      @precision = new_precision.to_i
+    end
+
+    def include=(new_state)
+      raise "include must be true or false" unless (new_state === true || new_state === false)
+      @include = new_state
+    end
+
+    def update(current_name = nil)
+      current_name = name if current_name.nil?
+      current_name = '' if current_name.nil?
+
+      cli = AdminModule::CLI.new
+      cli.environment = env
+      params = { :name => @name,
+                 :type => @type,
+                 :decision => @decision,
+                 :order => @order,
+                 :precision => @precision,
+                 :include => @include }
+      params.delete_if { |k,v| v.nil? }
+
+      cli.update_parameter(current_name, params)
+    ensure
+      cli.quit
+    end
+  end # class ParameterTask
+end # module AdminModule::Task
+

data/lib/admin_module/rake/ppm_tasks.rb

@@ -0,0 +1,248 @@
+##############################################################################
+# File::    ppm_tasks.rb
+# Purpose:: PpmTasks definition
+#
+# Author::    Jeff McAffee 2015-06-23
+#
+##############################################################################
+
+require 'admin_module'
+require 'rake/dsl_definition'
+require 'rake'
+
+module AdminModule::Rake
+  class PpmTasks
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    attr_accessor :env
+    attr_accessor :name
+    attr_accessor :to
+    attr_accessor :path
+    attr_reader   :action
+    attr_reader   :valid_actions
+    attr_reader   :stop_on_exception
+    attr_reader   :format
+
+    def initialize(task_name = '', desc = "")
+      @valid_actions = ['import', 'export', 'dups', 'list']
+      @task_name, @desc = task_name, desc
+
+      @stop_on_exception = true
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    def define_task #:nodoc:
+      desc @desc
+      task(@task_name, required_args_for_action) do |t,args|
+        set_vars args
+        commit  # Call method to perform when invoked.
+      end
+    end
+
+    #
+    # Add each arg passed to the task, as an instance variable of the task
+    #
+
+    def set_vars args
+      args.each do |arg,val|
+        instance_variable_set "@#{arg}", val
+      end
+
+      args
+    end
+
+    def action=(task_action)
+      raise "action must be one of #{valid_types.join(', ')}" unless valid_actions.include?(task_action.downcase)
+      @action = task_action
+    end
+
+    def stop_on_exception=(do_stop)
+      raise ArgumentError, 'Expecting true or false' unless do_stop === true || do_stop === false
+      @stop_on_exception = do_stop
+    end
+
+    def format=(output_format)
+      output_format = 'txt' if output_format.nil?
+      valid_formats = %w(txt csv)
+      raise "format must be one of #{valid_formats.join(', ')}" unless valid_formats.include?(output_format.downcase)
+      @format = output_format
+    end
+
+    #
+    # Execute the task (action)
+    #
+
+    def commit
+      validate_params
+
+      client = AdminModule::Client.new
+      client.env = env
+
+      if self.respond_to? action
+        self.send(action, client)
+        return
+      else
+        raise "Unknown action - #{action}"
+      end
+
+    rescue Exception => e
+      raise e if stop_on_exception == true
+    ensure
+      client.quit
+    end
+
+    #
+    # Actions
+    #
+
+    def list client
+      $stdout << client.ppms.list.join("\n")
+      $stdout << "\n"
+    end
+
+    def dups client
+      result = Array.new
+      result = client.ppms.dups
+      output_method = "output_as_#{@format}"
+
+      if self.respond_to? output_method
+        self.send(output_method, result)
+      else
+        $stderr << "Invalid format: #{@format}"
+      end
+    end
+
+    def import client
+      $stdout << client.ppms.import(path)
+    end
+
+    def export client
+      $stdout << client.ppms.export(path)
+    end
+
+    #
+    # Verify we have the needed parameters (arguments) to perform
+    # the task action.
+    #
+
+    def validate_params
+      assert_provided env, 'Missing "env"'
+      assert_provided action, 'Missing "action"'
+
+      case action
+      when 'import'
+        assert_provided path, 'Missing "path"'
+
+      when 'export'
+        assert_provided path, 'Missing "path"'
+
+      end
+
+      assert_env_is_configured env
+    end
+
+    def assert_provided value, msg
+      if value.nil? || value.empty?
+        raise msg
+      end
+    end
+
+    def assert_env_is_configured arg
+      unless AdminModule.configuration.credentials.key? arg
+        init_msg = "Have you initialized your config file?\n Try: admin_module config init <filedir>"
+        env_msg = "Have you configured your environments?\n Try: admin_module config add env <envname> <url>"
+        raise "Unknown environment: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    #
+    # Define the task args, based on the action.
+    # Used when programatically generating the tasks.
+    #
+
+    def required_args_for_action
+      args = []
+
+      case action
+      when 'import'
+        args << :path
+
+      when 'export'
+        args << :path
+
+      when 'dups'
+        args << :format
+
+      else
+        # Noop
+      end
+
+      args
+    end
+
+
+    def output_as_txt data
+      if data.count > 0
+        $stdout << "        Name                ID\n"
+        $stdout << '-'*79 << "\n"
+      else
+        return
+      end
+
+      data.each do |dp|
+        $stdout << "#{dp[:name]}\t#{dp[:id]}\n"
+      end
+    end
+
+    def output_as_csv data
+      if data.count > 0
+        $stdout << "Name,ID\n"
+      else
+        return
+      end
+
+      data.each do |dp|
+        $stdout << "#{dp[:name]},#{dp[:id]}\n"
+      end
+    end
+
+    #
+    # Class method to create an instance of the task generator,
+    # and call the instance's install method.
+    #
+
+    class << self
+      def install
+        new.install
+      end
+    end
+
+    #
+    # Instance method to generate the tasks;
+    # For each environment where we have configured credentials,
+    # generate a task for each available action.
+    #
+
+    def install
+      AdminModule.configuration.credentials.keys.each do |e|
+        valid_actions.each do |action|
+          AdminModule::Rake::PpmTasks.new("am:#{e}:ppm:#{action}", "#{action} #{e} ppms") do |t|
+            t.env = e
+            t.action = action
+          end
+        end
+      end
+    end
+  end # class
+end # module
+
+
+#
+# Install (generate) the tasks
+#
+
+AdminModule::Rake::PpmTasks.install
+