cloudflock 0.6.1 → 0.7.0

data/lib/cloudflock/app.rb

@@ -0,0 +1,87 @@
+require 'optparse'
+require 'cloudflock'
+require 'console-glitter'
+
+module CloudFlock
+  # Public: The App module provides any functionality that is expected to be
+  # used by all CLI applications.
+  module App extend self
+    include ConsoleGlitter
+
+    # Public: Check if an option is set; return the value if so, otherwise
+    # prompt the user for a response.
+    #
+    # options        - Hash containing options to test against.
+    # name           - The key in the options Hash expected to contain the
+    #                  response desired.
+    # prompt         - Prompt to present to the user.
+    # prompt_options - Options to pass along to ConsoleGlitter::UI#prompt.
+    #                  (default: {})
+    #
+    # Returns the contents of the options[name] or else a String if
+    # options[name] is nil.
+    def check_option(options, name, prompt, prompt_options = {})
+      return options[name] unless options[name].nil?
+
+      options[name] = UI.prompt(prompt, prompt_options)
+    end
+
+    # Public: Check if an option is set; return the value if so, otherwise
+    # prompt the user for a response.
+    #
+    # options        - Hash containing options to test against.
+    # name           - The key in the options Hash expected to contain the
+    #                  response desired.
+    # prompt         - Prompt to present to the user.
+    # prompt_options - Options to pass along to ConsoleGlitter::UI#prompt_yn.
+    #                  (default: {})
+    #
+    # Returns true or false.
+    def check_option_yn(options, name, prompt, prompt_options = {})
+      return(options[name] ? true : false) unless options[name].nil?
+
+      options[name] = UI.prompt_yn(prompt, prompt_options)
+    end
+
+    # Public: Parse options and expose global options which are expected to be
+    # useful in any CLI application.
+    #
+    # options - Hash containing already-set options.
+    #
+    # Yields the OptionsParser object in use if a block is given.
+    #
+    # Returns a Hash.
+    def parse_options(options = {})
+      opts = OptionParser.new
+
+      yield opts if block_given?
+
+      opts.separator ''
+      opts.separator 'Global Options:'
+
+      opts.on('-c', '--config FILE', 'Specify configuration file') do |file|
+        options[:config_file] = File.expand_path(file)
+      end
+
+      opts.on_tail('--version', 'Show Version Information') do
+        puts "CloudFlock v#{CloudFlock::VERSION}"
+        exit
+      end
+
+      opts.on_tail('-?', '--help', 'Show this Message') do
+        puts opts
+        exit
+      end
+
+      opts.parse!(ARGV)
+
+      options
+    rescue OptionParser::MissingArgument, OptionParser::InvalidOption => error
+      puts error.message.capitalize
+      puts
+      ARGV.clear
+      ARGV.unshift('-?')
+      retry
+    end
+  end
+end

data/lib/cloudflock/error.rb

@@ -1,26 +1,13 @@
 module CloudFlock
-  module Remote
-    class SSH
-      class InvalidHostname < StandardError; end
-      class ConnectionFailed < StandardError; end
-      class LoginFailed < StandardError; end
-      class RootFailed < StandardError; end
+  module App
+    module Common
+      class NoRsyncAvailable < StandardError; end
     end
   end
 
-  module Target
-    module Servers
-      module Migrate
-        class LongRunFailed < StandardError; end
-      end
-
-      class Platform
-        class ValueError < StandardError; end
-        class MapUndefined < NameError; end
-      end
-
-      class Profile
-      end
+  module Remote
+    class SSH
+      class InvalidHostname < StandardError; end
     end
   end
 end

data/lib/cloudflock/errstr.rb

@@ -0,0 +1,31 @@
+module CloudFlock
+  module App
+    module Common
+      module Errstr
+        NO_RSYNC = 'Cannot find rsync on the destination host'
+      end
+    end
+  end
+
+  module Remote
+    class SSH
+      module Errstr
+        NOHOST        = 'No host specified'
+        INVALID_HOST  = 'Unable to look up host: %s'
+      end
+    end
+  end
+
+  module Target
+    module Servers
+      class Profile
+        NOT_SSH = 'SSH session expected'
+      end
+
+      class Platform
+        NOT_CPE        = 'Expected a CPE object'
+        CPE_INCOMPLETE = 'CPE must contain at least vendor and version'
+      end
+    end
+  end
+end

data/lib/cloudflock/remote/files.rb

@@ -1,28 +1,88 @@
 require 'cloudflock'
+require 'fog'
 
-# Public: Provide an interface to instantiate Fog::Storage instances, perform
-# basic sanity checking for the local provider.
-module CloudFlock::Remote::Files extend self
-  # Public: Set up and verify a data source.
-  #
-  # target - Hash containing connection details per Fog requirements, a String
-  #          containing the path to a local directory.
-  #
-  # Returns an instance of a Files subclass.
-  def connect(target)
-    target = { provider: 'local', local_root: target } if target.is_a?(String)
-    raise ArgumentError, "String or Hash expected" unless target.is_a?(Hash)
-
-    if target[:provider].downcase == 'local'
-      target_parent = File.expand_path(target[:local_root], '..')
-      unless File.exists?(target_parent)
-        raise Errno::ENOENT, "#{target_parent} does not exist"
-      end
-      unless File.directory?(target_parent)
-        raise Errno::ENOENT, "#{target_parent} is not a directory"
+module CloudFlock; module Remote
+  # Public: Provide a unified interface to instantiate various Fog::Storage
+  # objects while providing sanity checking where applicable.
+  class Files
+    # Public: Gets the location prefix for local stores
+    attr_reader :prefix
+
+    # Public: Connect via API and store the Fog instance as well as relative
+    # path information if a local store.
+    #
+    # store_spec - Hash containing data necessary to connect to an object
+    #              storage service via Fog.
+    def initialize(store_spec)
+      @local = false
+      if store_spec[:provider] == 'local'
+        @local = true
+        @prefix  = File.expand_path(store_spec[:local_root])
+        location = File.basename(store_spec[:local_root])
+        store_spec[:local_root] = File.expand_path(File.join(@prefix, '..'))
       end
+
+      @fog = Fog::Storage.new(store_spec)
+      self.directory = (location) if local?
+    end
+
+    # Public: Set the active directory for fetching/uploading files.
+    #
+    # location - String denoting a directory name to use.
+    #
+    # Returns nothing.
+    def directory=(location)
+      @files = @fog.directories.select { |dir| dir.key == location }.first
+    end
+
+    # Public: Wrap Fog::Storage#directories
+    #
+    # Returns Fog::Storage::*::Directories.
+    def directories
+      @fog.directories
+    end
+
+    # Public: Wrap Fog::Storage::Directory#each
+    #
+    # Yields Fog::Storage::File objects
+    def each_file(&block)
+      @files.files.each(&block)
+    end
+
+    # Public: Generate a list of all files in the current directory.
+    #
+    # Returns an array of Fog::Storage::File objects.
+    def file_list
+      @files.files.map(&:key)
+    end
+
+    # Public: Return the contents of a given file in the current directory.
+    #
+    # file - String containing the path to a file.
+    #
+    # Returns a String.
+    def get_file(file)
+      @files.files.get(file).body
+    end
+
+    # Public: Create a file in the current directory.
+    #
+    # file_spec - Hash containing info to create a new file:
+    #             :key  - Path under which the file should be created.
+    #             :body - Contents of the file to be created.
+    # 
+    # Returns nothing.
+    def create(file_spec)
+      @files.files.create(file_spec)
+    rescue Excon::Errors::Timeout
+      retry
     end
 
-    Fog::Storage.new(target)
+    # Public: Report whether a local store is referenced.
+    #
+    # Returns whether the store is local to the host.
+    def local?
+      @local
+    end
   end
-end
+end; end