hammer_cli 0.0.18 → 0.1.0

data/lib/hammer_cli/connection.rb

@@ -0,0 +1,44 @@
+module HammerCLI
+
+  class AbstractConnector
+    def initialize(params={})
+    end
+  end
+
+  class Connection
+
+    def self.drop(name)
+      connections.delete(name)
+    end
+
+    def self.drop_all()
+      connections.keys.each { |c| drop(c) }
+    end
+
+    def self.create(name, conector_params={}, options={})
+      unless connections[name]
+        Logging.logger['Connection'].debug "Registered: #{name}"
+        connector = options[:connector] || AbstractConnector
+
+        connections[name] = connector.new(conector_params)
+      end
+      connections[name]
+    end
+
+    def self.exist?(name)
+      !get(name).nil?
+    end
+
+    def self.get(name)
+      connections[name]
+    end
+
+    private
+
+    def self.connections
+      @connections_hash ||= {}
+      @connections_hash
+    end
+
+  end
+end

data/lib/hammer_cli/exception_handler.rb

@@ -16,6 +16,7 @@ module HammerCLI
         [Clamp::UsageError, :handle_usage_exception],
         [RestClient::ResourceNotFound, :handle_not_found],
         [RestClient::Unauthorized, :handle_unauthorized],
+        [ApipieBindings::DocLoadingError, :handle_apipie_docloading_error],
       ]
     end
 
@@ -49,19 +50,20 @@ module HammerCLI
 
     def log_full_error(e)
       backtrace = e.backtrace || []
-      @logger.error "\n\n#{e.class} (#{e.message}):\n    " +
+      error = "\n\n#{e.class} (#{e.message}):\n    " +
         backtrace.join("\n    ")
         "\n\n"
+      @logger.error error
     end
 
     def handle_general_exception(e)
-      print_error "Error: " + e.message
+      print_error _("Error: %s") % e.message
       log_full_error e
       HammerCLI::EX_SOFTWARE
     end
 
     def handle_usage_exception(e)
-      print_error "Error: %s\n\nSee: '%s --help'" % [e.message, e.command.invocation_path]
+      print_error _("Error: %{message}\n\nSee: '%{path} --help'") % {:message => e.message, :path => e.command.invocation_path}
       log_full_error e
       HammerCLI::EX_USAGE
     end
@@ -78,11 +80,20 @@ module HammerCLI
     end
 
     def handle_unauthorized(e)
-      print_error "Invalid username or password"
+      print_error _("Invalid username or password")
       log_full_error e
       HammerCLI::EX_UNAUTHORIZED
     end
 
+    def handle_apipie_docloading_error(e)
+      rake_command = "rake apipie:cache"
+      print_error _("Could not load API description from the server\n"\
+          "  - is your server down?\n"\
+          "  - was \"#{rake_command}\" run on the server when using apipie cache? (typical production settings))\n")
+      log_full_error e
+      HammerCLI::EX_CONFIG
+    end
+
   end
 end
 

data/lib/hammer_cli/exceptions.rb

@@ -0,0 +1,6 @@
+module HammerCLI
+
+  class OperationNotSupportedError < StandardError; end
+  class ModuleLoadingError < StandardError; end
+
+end

data/lib/hammer_cli/i18n.rb

@@ -0,0 +1,95 @@
+require 'fast_gettext'
+require 'locale'
+
+module HammerCLI
+  module I18n
+
+    module AllDomains
+      def _(key)
+        FastGettext::TranslationMultidomain.D_(key)
+      end
+
+      def n_(*keys)
+        FastGettext::TranslationMultidomain.Dn_(*keys)
+      end
+
+      def s_(key, separator=nil)
+        FastGettext::TranslationMultidomain.Ds_(key, separator)
+      end
+
+      def ns_(*keys)
+        FastGettext::TranslationMultidomain.Dns_(*keys)
+      end
+    end
+
+
+    class AbstractLocaleDomain
+
+      def available_locales
+        Dir.glob(locale_dir+'/*').select { |f| File.directory? f }.map { |f| File.basename(f) }
+      end
+
+      def translated_files
+        []
+      end
+
+      def type
+        :mo
+      end
+
+      attr_reader :locale_dir, :domain_name
+    end
+
+
+    class LocaleDomain < AbstractLocaleDomain
+
+      def translated_files
+        Dir.glob(File.join(File.dirname(__FILE__), '../**/*.rb'))
+      end
+
+      def locale_dir
+        File.join(File.dirname(__FILE__), '../../locale')
+      end
+
+      def domain_name
+        'hammer-cli'
+      end
+
+    end
+
+
+    def self.locale
+      lang_variant = Locale.current.to_simple.to_str
+      lang = lang_variant.gsub(/_.*/, "")
+
+      hammer_domain = HammerCLI::I18n::LocaleDomain.new
+      if hammer_domain.available_locales.include? lang_variant
+        lang_variant
+      else
+        lang
+      end
+    end
+
+
+    def self.domains
+      @domains ||= []
+      @domains
+    end
+
+    def self.add_domain(domain)
+      domains << domain
+      FastGettext.add_text_domain(domain.domain_name, :path => domain.locale_dir, :type => domain.type, :report_warning => false)
+    end
+
+
+    Encoding.default_external='UTF-8' if defined? Encoding
+    FastGettext.locale = locale
+
+  end
+end
+
+include FastGettext::Translation
+include HammerCLI::I18n::AllDomains
+
+HammerCLI::I18n.add_domain(HammerCLI::I18n::LocaleDomain.new)
+

data/lib/hammer_cli/logger.rb

@@ -19,13 +19,13 @@ module HammerCLI
     pattern         = "[%5l %d %c] %m\n"
     COLOR_LAYOUT    = Logging::Layouts::Pattern.new(:pattern => pattern, :color_scheme => 'bright')
     NOCOLOR_LAYOUT  = Logging::Layouts::Pattern.new(:pattern => pattern, :color_scheme => nil)
-    DEFAULT_LOG_DIR = '/var/log/foreman'
+    DEFAULT_LOG_DIR = '/var/log/hammer'
 
     log_dir = File.expand_path(HammerCLI::Settings.get(:log_dir) || DEFAULT_LOG_DIR)
     begin
       FileUtils.mkdir_p(log_dir, :mode => 0750)
     rescue Errno::EACCES => e
-      puts "No permissions to create log dir #{log_dir}"
+      puts _("No permissions to create log dir %s") % log_dir
     end
 
     logger   = Logging.logger.root
@@ -40,7 +40,7 @@ module HammerCLI
       # set owner and group (it's ignored if attribute is nil)
       FileUtils.chown HammerCLI::Settings.get(:log_owner), HammerCLI::Settings.get(:log_group), filename
     rescue ArgumentError => e
-      puts "File #{filename} not writeable, won't log anything to file!"
+      puts _("File %s not writeable, won't log anything to the file!") % filename
     end
 
     logger.level = HammerCLI::Settings.get(:log_level)

data/lib/hammer_cli/main.rb

@@ -4,15 +4,16 @@ module HammerCLI
 
   class MainCommand < AbstractCommand
 
-    option ["-v", "--verbose"], :flag, "be verbose"
-    option ["-c", "--config"], "CFG_FILE", "path to custom config file"
+    option ["-v", "--verbose"], :flag, _("be verbose"), :context_target => :verbose
+    option ["-d", "--debug"], :flag, _("show debugging output "), :context_target => :debug
+    option ["-c", "--config"], "CFG_FILE", _("path to custom config file")
 
-    option ["-u", "--username"], "USERNAME", "username to access the remote system",
+    option ["-u", "--username"], "USERNAME", _("username to access the remote system"),
       :context_target => :username
-    option ["-p", "--password"], "PASSWORD", "password to access the remote system",
+    option ["-p", "--password"], "PASSWORD", _("password to access the remote system"),
       :context_target => :password
 
-    option "--version", :flag, "show version" do
+    option "--version", :flag, _("show version") do
       puts "hammer (%s)" % HammerCLI.version
       HammerCLI::Modules.names.each do |m|
         module_version = HammerCLI::Modules.find_by_name(m).version
@@ -21,21 +22,21 @@ module HammerCLI
       exit(HammerCLI::EX_OK)
     end
 
-    option ["--show-ids"], :flag, "Show ids of associated resources",
+    option ["--show-ids"], :flag, _("Show ids of associated resources"),
       :context_target => :show_ids
-    option ["--interactive"], "INTERACTIVE", "Explicitly turn interactive mode on/off",
+    option ["--interactive"], "INTERACTIVE", _("Explicitly turn interactive mode on/off"),
       :format => HammerCLI::Options::Normalizers::Bool.new,
       :context_target => :interactive
 
-    option ["--csv"], :flag, "Output as CSV (same as --output=csv)"
-    option ["--output"], "ADAPTER", "Set output format. One of [%s]" %
+    option ["--csv"], :flag, _("Output as CSV (same as --output=csv)")
+    option ["--output"], "ADAPTER", _("Set output format. One of [%s]") %
       HammerCLI::Output::Output.adapters.keys.join(', '),
       :context_target => :adapter
-    option ["--csv-separator"], "SEPARATOR", "Character to separate the values",
+    option ["--csv-separator"], "SEPARATOR", _("Character to separate the values"),
       :context_target => :csv_separator
 
 
-    option "--autocomplete", "LINE", "Get list of possible endings" do |line|
+    option "--autocomplete", "LINE", _("Get list of possible endings") do |line|
       # get rid of word 'hammer' on the line
       line = line.to_s.gsub(/^\S+/, '')
 

data/lib/hammer_cli/modules.rb

@@ -4,7 +4,22 @@ module HammerCLI
   class Modules
 
     def self.names
-      HammerCLI::Settings.get(:modules) || []
+
+      # legacy modules config
+      modules = HammerCLI::Settings.get(:modules) || []
+      logger.warn _("Legacy configuration of modules detected. Check section about configuration in user manual") unless modules.empty?
+
+      HammerCLI::Settings.dump.inject(modules) do |names, (mod_name, mod_config)|
+        if mod_config.kind_of?(Hash) && !mod_config[:enable_module].nil?
+          mod = ["hammer_cli_#{mod_name}"]
+          if mod_config[:enable_module]
+            names += mod
+          else
+            names -= mod # disable when enabled in legacy config
+          end
+        end
+        names
+      end
     end
 
     def self.find_by_name(name)
@@ -22,13 +37,11 @@ module HammerCLI
     def self.load!(name)
       begin
         require_module(name)
-      rescue LoadError => e
-        logger.error "Module #{name} not found"
-        raise e
       rescue Exception => e
         logger.error "Error while loading module #{name}"
-        logger.error e
-        puts "Warning: An error occured while loading module #{name}"
+        puts _("Warning: An error occured while loading module %s") % name
+        # with ModuleLoadingError we assume the error is already logged by the issuer
+        logger.error e unless e.is_a?(HammerCLI::ModuleLoadingError)
         raise e
       end
 

data/lib/hammer_cli/options/normalizers.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module HammerCLI
   module Options
     module Normalizers
@@ -21,7 +23,7 @@ module HammerCLI
       class KeyValueList < AbstractNormalizer
 
         def description
-          "Comma-separated list of key=value."
+          _("Comma-separated list of key=value.")
         end
 
         def format(val)
@@ -30,7 +32,7 @@ module HammerCLI
           val.split(",").inject({}) do |result, item|
             parts = item.split("=")
             if parts.size != 2
-              raise ArgumentError, "value must be defined as a comma-separated list of key=value"
+              raise ArgumentError, _("value must be defined as a comma-separated list of key=value")
             end
             result.update(parts[0] => parts[1])
           end
@@ -41,7 +43,7 @@ module HammerCLI
       class List < AbstractNormalizer
 
         def description
-          "Comma separated list of values."
+          _("Comma separated list of values.")
         end
 
         def format(val)
@@ -53,7 +55,7 @@ module HammerCLI
       class Bool < AbstractNormalizer
 
         def description
-          "One of true/false, yes/no, 1/0."
+          _("One of true/false, yes/no, 1/0.")
         end
 
         def format(bool)
@@ -63,7 +65,7 @@ module HammerCLI
           elsif bool.downcase.match(/^(false|f|no|n|0)$/i)
             return false
           else
-            raise ArgumentError, "value must be one of true/false, yes/no, 1/0"
+            raise ArgumentError, _("value must be one of true/false, yes/no, 1/0")
           end
         end
 
@@ -90,6 +92,23 @@ module HammerCLI
         end
       end
 
+      class JSONInput < File
+
+        def format(val)
+          # The JSON input can be either the path to a file whose contents are
+          # JSON or a JSON string.  For example:
+          #   /my/path/to/file.json
+          # or
+          #   '{ "units":[ { "name":"zip", "version":"9.0", "inclusion":"false" } ] }')
+          json_string = ::File.exist?(::File.expand_path(val)) ? super(val) : val
+          ::JSON.parse(json_string)
+
+        rescue ::JSON::ParserError => e
+          raise ArgumentError, _("Unable to parse JSON input")
+        end
+
+      end
+
 
       class Enum < AbstractNormalizer
 
@@ -98,14 +117,14 @@ module HammerCLI
         end
 
         def description
-          "One of %s" % quoted_values
+          _("One of %s") % quoted_values
         end
 
         def format(value)
           if @allowed_values.include? value
             value
           else
-            raise ArgumentError, "value must be one of '%s'" % quoted_values
+            raise ArgumentError, _("value must be one of '%s'") % quoted_values
           end
         end
 
@@ -120,6 +139,22 @@ module HammerCLI
         end
       end
 
+
+      class DateTime < AbstractNormalizer
+
+        def description
+          _("Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format")
+        end
+
+        def format(date)
+          raise ArgumentError unless date
+          ::DateTime.parse(date).to_s
+        rescue ArgumentError
+          raise ArgumentError, _("'%s' is not a valid date") % date
+        end
+      end
+
+
     end
   end
 end

data/lib/hammer_cli/options/option_definition.rb

@@ -59,8 +59,8 @@ module HammerCLI
         ].compact
 
         str = ""
-        str += "Can be specified multiple times. " if multivalued?
-        str += "Default: " + default_sources.join(", or ") unless default_sources.empty?
+        str += _("Can be specified multiple times. ") if multivalued?
+        str += _("Default: ") + default_sources.join(_(", or ")) unless default_sources.empty?
         str
       end
 

data/lib/hammer_cli/output.rb

@@ -5,4 +5,5 @@ require File.join(File.dirname(__FILE__), 'output/adapter')
 require File.join(File.dirname(__FILE__), 'output/definition')
 require File.join(File.dirname(__FILE__), 'output/dsl')
 require File.join(File.dirname(__FILE__), 'output/record_collection')
+require File.join(File.dirname(__FILE__), 'output/field_filter')