Flucti-flucti-cli 0.1.16

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2008-2009 Roman Le Négrate
+
+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.mdown

@@ -0,0 +1,24 @@
+# Flucti-CLI
+
+Flucti-CLI is the command-line utility that eases installation, configuration and deployment of websites on one or several VPS('s) leased from [Flucti][].
+
+See the [documentation site][Documentation] for more information.
+
+## Status
+
+* It's fairly complete at the moment.
+* Some big features are still missing, like UNIX user management, database user management, more complete firewall configuration.
+* Unit tests still needs to be written too, but I'm still wondering how to test tasks in a clean way.
+
+## Target
+
+This utility is relevant for [Flucti][] clients only, given that it acts as a layer on top of the Flucti API which requires one to have an account there.
+
+But for what it's worth, this utility can still be of use to other people as its source code is likely to be a good usage example of the [WebService](http://github.com/Roman2K/web-service) library.
+
+## Credits
+
+Written by [Roman Le Négrate](http://roman.flucti.com) ([contact](mailto:roman.lenegrate@gmail.com)). Released under the MIT license: see the `LICENSE` file.
+
+[Flucti]: http://www.flucti.com
+[Documentation]: http://doc.flucti.com

data/Rakefile

@@ -0,0 +1,56 @@
+require 'echoe'
+
+Echoe.new('flucti-cli', '0.1.16') do |p|
+  p.description     = "Command-line interface for managing Flucti VPS's"
+  p.url             = "http://doc.flucti.com/cli"
+  p.author          = "Roman Le Négrate"
+  p.email           = "roman.lenegrate@gmail.com"
+  p.ignore_pattern  = "*.gemspec"
+  p.dependencies    = ["capistrano ~>2.5", "web-service", "capistrano-fixes"]
+  p.development_dependencies = ["mocha"]
+  p.rdoc_options    = %w(--main README.mdown --inline-source --line-numbers --charset UTF-8)
+end
+
+namespace :check do
+  task :namespacing do
+    point_out_source_files "Absence of namespacing" do |file|
+      case file.to_s.split('.').first
+      when /(\b|_)tasks$/, /_pack$/, /\bvendor\b/
+        false
+      else
+        declaration =
+          file.read.
+          split("\n").
+          reject { |line| line.strip.empty? || line =~ /^\s*(?:require\b|\$:)/ }.
+          first
+        file if declaration !~ /\Amodule Flucti$/
+      end
+    end
+  end
+  
+  task :constants do
+    point_out_source_files "Malformed constant names" do |file|
+      malformed = file.read.scan(/\bflucti\b/i).flatten - ["Flucti", "flucti"]
+      [file, *malformed] if malformed.any?
+    end
+  end
+  
+  def point_out_source_files(checking)
+    require 'pathname'
+    result =
+      Pathname.glob('lib/**/*.rb').
+        map { |file| yield file }.
+        select { |result| result }.
+        map { |file, *rest|
+          rest.any? ? "! %-30s %s" % ["#{file}:", rest.join(' ')] : "! #{file}"
+        }
+    if result.any?
+      puts(checking, *result)
+    else
+      puts "%-30s (none)" % "#{checking}:"
+    end
+  end
+end
+task :check => ['check:namespacing', 'check:constants']
+
+task :default => [:check, :test]

data/TODO.txt

@@ -0,0 +1,19 @@
+* Add a task that allows for modifying the number of instances of a certain backend, on-the-fly (without interruption of service).
+
+* Add support for one metadata file per service configuration:
+    
+    That would allow for specifying the name of a service configuration (currently inferred from the prefix *_start.sh) and most importantly, their single-instance nature.
+
+    This would be a boolean value which determines whether to allow more than 1 instance of a service to be spawned.
+  
+    For example:
+    - Rack-compatible applications like Rails and Sinatra apps can be spawned in multiple instances as nginx spreads requests across these instances.
+    - However, it doesn't make sense for PHP (FCGI) backends to have more than 1 instance since nginx only connects to 1 FCGI server.
+  
+    The NUM_INSTANCES variables can still be used by the service configuration to spawn more instances its own way. In the case of PHP, both the PHP_FCGI_CHILDREN and PHP_FCGI_MAX_REQUESTS can be set accordingly.
+
+* Add a task for configuring mail clients: once a VPS has a mail server set up (mail:server:setup) it can send mails through itself, but other VPS's still need to be configured to go through that mail server mails coming from them. Such a task would take care of it.
+
+* Add a task for changing the hostname of a VPS.
+
+* In SshDetails::AccountBinding#check_for_presence_of_ssh, fix the invalid indentation of connection details.

data/bin/flucti

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'flucti'
+Flucti::CLI.start

data/flucti-cli.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flucti-cli}
+  s.version = "0.1.16"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Le N\303\251grate"]
+  s.date = %q{2009-03-25}
+  s.default_executable = %q{flucti}
+  s.description = %q{Command-line interface for managing Flucti VPS's}
+  s.email = %q{roman.lenegrate@gmail.com}
+  s.executables = ["flucti"]
+  s.extra_rdoc_files = ["bin/flucti", "lib/flucti/api_access.rb", "lib/flucti/cli.rb", "lib/flucti/parameters.rb", "lib/flucti/resources/account.rb", "lib/flucti/resources/app_type.rb", "lib/flucti/resources/backend.rb", "lib/flucti/resources/basic_resource.rb", "lib/flucti/resources/container.rb", "lib/flucti/resources/db_server.rb", "lib/flucti/resources/domain.rb", "lib/flucti/resources/general.rb", "lib/flucti/resources/mail_client.rb", "lib/flucti/resources/mail_server.rb", "lib/flucti/resources/port_forwarding/services", "lib/flucti/resources/port_forwarding.rb", "lib/flucti/resources/ssh_details.rb", "lib/flucti/resources/webserver.rb", "lib/flucti/resources/website.rb", "lib/flucti/resources.rb", "lib/flucti/tasks/apikey_tasks.rb", "lib/flucti/tasks/apptype_tasks.rb", "lib/flucti/tasks/connect_pack.rb", "lib/flucti/tasks/db_tasks.rb", "lib/flucti/tasks/mail_tasks.rb", "lib/flucti/tasks/miscellaneous_tasks.rb", "lib/flucti/tasks/progress_tasks.rb", "lib/flucti/tasks/sshkey_tasks.rb", "lib/flucti/tasks/vps/firewall_tasks.rb", "lib/flucti/tasks/vps_tasks.rb", "lib/flucti/tasks/webserver_tasks.rb", "lib/flucti/tasks/website/apptype_tasks.rb", "lib/flucti/tasks/website/backends/instances_tasks.rb", "lib/flucti/tasks/website/backends_tasks.rb", "lib/flucti/tasks/website/capfile_tasks.rb", "lib/flucti/tasks/website/domains_tasks.rb", "lib/flucti/tasks/website_tasks.rb", "lib/flucti/tasks.rb", "lib/flucti/utilities/connection_error_handling.rb", "lib/flucti/utilities/core_ext.rb", "lib/flucti/utilities/list_displayer.rb", "lib/flucti/utilities/miscellaneous.rb", "lib/flucti/utilities/progress_bar.rb", "lib/flucti/utilities/table.rb", "lib/flucti/utilities/task_packing.rb", "lib/flucti/utilities/user_interface.rb", "lib/flucti/utilities.rb", "lib/flucti.rb", "lib/vendor/ruby-progressbar-0.9/lib/ChangeLog", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.en.rd", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.ja.rd", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.rb", "lib/vendor/ruby-progressbar-0.9/lib/test.rb", "LICENSE", "README.mdown", "TODO.txt"]
+  s.files = ["bin/flucti", "lib/flucti/api_access.rb", "lib/flucti/cli.rb", "lib/flucti/parameters.rb", "lib/flucti/resources/account.rb", "lib/flucti/resources/app_type.rb", "lib/flucti/resources/backend.rb", "lib/flucti/resources/basic_resource.rb", "lib/flucti/resources/container.rb", "lib/flucti/resources/db_server.rb", "lib/flucti/resources/domain.rb", "lib/flucti/resources/general.rb", "lib/flucti/resources/mail_client.rb", "lib/flucti/resources/mail_server.rb", "lib/flucti/resources/port_forwarding/services", "lib/flucti/resources/port_forwarding.rb", "lib/flucti/resources/ssh_details.rb", "lib/flucti/resources/webserver.rb", "lib/flucti/resources/website.rb", "lib/flucti/resources.rb", "lib/flucti/tasks/apikey_tasks.rb", "lib/flucti/tasks/apptype_tasks.rb", "lib/flucti/tasks/connect_pack.rb", "lib/flucti/tasks/db_tasks.rb", "lib/flucti/tasks/mail_tasks.rb", "lib/flucti/tasks/miscellaneous_tasks.rb", "lib/flucti/tasks/progress_tasks.rb", "lib/flucti/tasks/sshkey_tasks.rb", "lib/flucti/tasks/vps/firewall_tasks.rb", "lib/flucti/tasks/vps_tasks.rb", "lib/flucti/tasks/webserver_tasks.rb", "lib/flucti/tasks/website/apptype_tasks.rb", "lib/flucti/tasks/website/backends/instances_tasks.rb", "lib/flucti/tasks/website/backends_tasks.rb", "lib/flucti/tasks/website/capfile_tasks.rb", "lib/flucti/tasks/website/domains_tasks.rb", "lib/flucti/tasks/website_tasks.rb", "lib/flucti/tasks.rb", "lib/flucti/utilities/connection_error_handling.rb", "lib/flucti/utilities/core_ext.rb", "lib/flucti/utilities/list_displayer.rb", "lib/flucti/utilities/miscellaneous.rb", "lib/flucti/utilities/progress_bar.rb", "lib/flucti/utilities/table.rb", "lib/flucti/utilities/task_packing.rb", "lib/flucti/utilities/user_interface.rb", "lib/flucti/utilities.rb", "lib/flucti.rb", "lib/vendor/ruby-progressbar-0.9/lib/ChangeLog", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.en.rd", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.ja.rd", "lib/vendor/ruby-progressbar-0.9/lib/progressbar.rb", "lib/vendor/ruby-progressbar-0.9/lib/test.rb", "LICENSE", "Manifest", "Rakefile", "README.mdown", "test/flucti/resources_test.rb", "test/flucti/tasks_test.rb", "test/flucti/utilities/miscellaneous_test.rb", "test/flucti/utilities/table_test.rb", "test/flucti/utilities/user_interface_test.rb", "test/test_helper.rb", "TODO.txt", "flucti-cli.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://doc.flucti.com/cli}
+  s.rdoc_options = ["--main", "README.mdown", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{flucti-cli}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Command-line interface for managing Flucti VPS's}
+  s.test_files = ["test/flucti/resources_test.rb", "test/flucti/tasks_test.rb", "test/flucti/utilities/miscellaneous_test.rb", "test/flucti/utilities/table_test.rb", "test/flucti/utilities/user_interface_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_runtime_dependency(%q<web-service>, [">= 0"])
+      s.add_runtime_dependency(%q<capistrano-fixes>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_dependency(%q<web-service>, [">= 0"])
+      s.add_dependency(%q<capistrano-fixes>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, ["~> 2.5"])
+    s.add_dependency(%q<web-service>, [">= 0"])
+    s.add_dependency(%q<capistrano-fixes>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/lib/flucti.rb

@@ -0,0 +1,20 @@
+$:.unshift *Dir[File.dirname(__FILE__) + '/vendor/*/lib']
+
+require 'tmpdir'
+require 'pathname'
+require 'web_service'
+
+module Flucti
+  autoload :Utilities,  'flucti/utilities'
+  autoload :Parameters, 'flucti/parameters'
+  autoload :APIAccess,  'flucti/api_access'
+  autoload :Resources,  'flucti/resources'
+  autoload :CLI,        'flucti/cli'
+  
+  def self.boot
+    Resources.configure!
+    APIAccess.configure!
+  end
+end
+
+Flucti::Utilities::CoreExt.apply!

data/lib/flucti/api_access.rb

@@ -0,0 +1,56 @@
+module Flucti
+  module APIAccess
+    extend self
+    extend Utilities
+
+    HOST = "api.flucti.com".freeze
+
+    def site
+      site_with_api_key(Parameters.fetch(:api_key) || (api_key_tasks.switch; Parameters.fetch(:api_key)))
+    end
+
+    def site_with_api_key(key)
+      WebService::Site.new("http://#{key}@#{HOST}")
+    end
+
+    def configure!
+      if (init = Parameters.store_dir / "init.rb").file?
+        load(init)
+      end
+      Resources::BasicResource.site = site
+      Resources::BasicResource.extend DeniedAccessRescue
+    end
+
+    def solve_denied_access!
+      puts_title "Access denied"
+      puts_long <<-MSG
+        You API key seems invalid. If you reset it recently, please enter the
+        new one at the prompt below. Otherwise, please contact us at
+        #{SUPPORT_EMAIL_ADDR} so that we can sort it out.
+      MSG
+      api_key_tasks.prompt_and_store_key
+      configure!
+    end
+
+  private
+
+    def api_key_tasks
+      @api_key_tasks ||= begin
+        require "capistrano/configuration"
+        tasks = Capistrano::Configuration.new
+        tasks.extend Utilities
+        tasks.load File.dirname(__FILE__) + '/tasks/apikey_tasks.rb'
+        tasks.apikey
+      end
+    end
+
+    module DeniedAccessRescue
+      def request(*args)
+        super
+      rescue WebService::UnauthorizedAccess
+        APIAccess.solve_denied_access!
+        retry
+      end
+    end
+  end
+end

data/lib/flucti/cli.rb

@@ -0,0 +1,107 @@
+require 'capistrano/cli'
+require 'progressbar'
+
+module Flucti
+  module CLI
+    extend self
+    
+    def start
+      adjust_environment
+      reinterpret_help_option
+      Flucti.boot
+      
+      cli = Capistrano::CLI.new(ARGV)
+      cli.parse_options!
+      cli.options[:verbose] = Capistrano::Logger::INFO
+      cli.execute!
+    end
+    
+    def tasks
+      adjust_environment
+      config = Capistrano::Configuration.new
+      config.load File.dirname(__FILE__) + '/tasks.rb'
+      return config
+    end
+    
+  private
+    
+    def adjust_environment
+      expose_constants
+      fix_cap_recipe_loading
+      fix_cap_tasks_brief_descriptions
+      fix_cap_help_messages
+      allow_for_lazy_env_var_naming
+    end
+    
+    def expose_constants
+      Object.class_eval do
+        include Flucti
+        include Flucti::Resources
+        include Flucti::Utilities
+      end
+    end
+    
+    # Force Capistrano::CLI to load the needed recipe files, and only them.
+    def fix_cap_recipe_loading
+      override 'Capistrano::CLI::Execute#load_recipes' do
+        def load_recipes(config)
+          config.load(File.dirname(__FILE__) + '/tasks.rb')
+        end
+      end
+    end
+    
+    # Fix brief description of tasks to allow the first sentence to be spanned
+    # over multiple lines.
+    def fix_cap_tasks_brief_descriptions
+      override 'Capistrano::CLI::Help#output_columns' do
+        def output_columns
+          Flucti::Utilities::UserInterface.terminal_width - 3
+        end
+      end
+      override 'Capistrano::TaskDefinition#brief_description' do
+        def brief_description(max_length=nil)
+          brief = (description[/\A.*?\.(?=\s|$)/m] || description).gsub(/\n+/, ' ')
+          if max_length && brief.length > max_length
+            brief = brief[0,max_length-3] + "..."
+          end
+          brief
+        end
+      end
+    end
+    
+    # Make help messages refer to the current command instead of the hard-coded
+    # `cap' one.
+    def fix_cap_help_messages
+      override 'Capistrano::CLI::Help#puts' do
+        def puts(*lines)
+          super(*lines.map { |line| line.to_s.gsub(/\bcap\b/, Flucti::Utilities::Miscellaneous.command) })
+        end
+      end
+    end
+    
+    # Fix letter-casing for environment variable assignments.
+    def allow_for_lazy_env_var_naming
+      ARGV.each_with_index { |arg, pos| ARGV[pos] = arg.sub(/^(\w+)(=)/) { $1.upcase + $2 } }
+      ENV.each { |key, value| ENV[key.upcase] ||= value }
+    end
+    
+    # Replace the default help message with a list of tasks.
+    def reinterpret_help_option
+      if ARGV.empty? || %w(-h --help).map { |opt| ARGV.delete(opt) }.any?
+        ARGV.unshift '-vT'
+      end
+    end
+    
+  private
+  
+    def override(fqn, &block)
+      name, method = fqn.to_s.split('#', 2)
+      if mod = Object.class_eval("#{name} if defined? #{name}") and (Kernel.respond_to?(method) || [:public, :protected, :private].any? { |v| mod.send("#{v}_method_defined?", method) })
+        mod.module_eval(&block)
+      else
+        require 'capistrano/version'
+        raise "This library is incompatible with the current version of Capistrano (#{Capistrano::Version::STRING}). Failed to override `#{fqn}'."
+      end
+    end
+  end
+end

data/lib/flucti/parameters.rb

@@ -0,0 +1,37 @@
+module Flucti
+  module Parameters
+    extend self
+    extend Utilities
+
+    def store_dir
+      @store_dir ||= begin
+        options = []
+        options << Pathname(ENV['APPDATA']) / 'Flucti' if ENV['APPDATA']
+        options << Pathname(ENV['HOME']) / '.flucti' if ENV['HOME']
+        located = options.find { |dir| dir.directory? } || options.find { |dir| dir.dirname.directory? }
+        located ||= Pathname(Dir.tmpdir) / 'flucti'
+        located.mkpath
+        located
+      end
+    end
+
+    def data_store
+      @data_store ||= store_dir / 'parameters.yml'
+    end
+
+    def fetch(key)
+      cache[key.to_s]
+    end
+
+    def store(key, value)
+      cache[key.to_s] = value
+      data_store.open("w") { |f| f << YAML.dump(cache) }
+    end
+
+  private
+
+    def cache
+      @cache ||= (YAML.load_file(data_store) if data_store.exist?) || {}
+    end
+  end
+end

data/lib/flucti/resources.rb

@@ -0,0 +1,41 @@
+module Flucti
+  module Resources
+    def self.configure!
+      ENV['LOGLEVEL'] = 'debug' if ENV['DEBUG']
+      WebService.logger.level = Logger.const_get((ENV['LOGLEVEL'] || 'error').upcase)
+    end
+    
+    def self.autoload_from(name, file)
+      autoload(name, "flucti/resources/#{file}")
+    end
+    
+    autoload_from :BasicResource,     'basic_resource'
+    
+    autoload_from :Container,         'container'
+    autoload_from :VPS,               'container'
+    autoload_from :Vps,               'container'
+
+    autoload_from :PortForwarding,    'port_forwarding'
+    autoload_from :Website,           'website'
+    autoload_from :Domain,            'domain'
+    autoload_from :Webserver,         'webserver'
+    autoload_from :MailServer,        'mail_server'
+    autoload_from :MailClient,        'mail_client'
+
+    autoload_from :AppType,           'app_type'
+    autoload_from :ServiceConfig,     'app_type'
+
+    autoload_from :Backend,           'backend'
+    autoload_from :InstallError,      'backend'
+    autoload_from :RootInstallError,  'backend'
+
+    autoload_from :DbServer,          'db_server'
+    autoload_from :Database,          'db_server'
+
+    autoload_from :Account,           'account'
+    autoload_from :SshDetails,        'ssh_details'
+    autoload_from :APIKey,            'general'
+    autoload_from :Progress,          'general'
+    autoload_from :SshKey,            'general'
+  end
+end

data/lib/flucti/resources/account.rb

@@ -0,0 +1,7 @@
+module Flucti
+  module Resources
+    class Account < BasicResource
+      self.singleton = true
+    end
+  end
+end

data/lib/flucti/resources/app_type.rb

@@ -0,0 +1,18 @@
+module Flucti
+  module Resources
+    class AppType < BasicResource
+      self.attribute_for_to_s = :name
+      has_many :service_configs
+    end
+
+    class ServiceConfig < BasicResource
+      belongs_to :app_type
+
+      def to_s
+        start   = start_script  if attribute_set? :start_script
+        finish  = finish_script if attribute_set? :finish_script
+        "#{name} (start: #{start.to_s.length} bytes, finish: #{finish.to_s.length} bytes)"
+      end
+    end
+  end
+end