desi 0.0.2 → 0.1.0

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md LICENSE

data/Guardfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end

data/README.md

@@ -2,8 +2,56 @@
 
 Desi (Developper ElasticSearch Installer) is very simple tool to quickly set up
 an [Elastic Search](http://www.elasticsearch.org/) local install for
-development purposes. It will download and install ElasticSearch (the latest
-version by default) and let you start/stop/restart it.
+development purposes.
+
+It can:
+
+  * download and install ElasticSearch (the latest release by default)
+  * start/stop/restart it.
+  * do basic indices management (list, delete, empty a given set of indices)
+
+It can be used both as a command-line tool and as a library.
+
+
+## Usage
+
+    $ desi list                  # List locally installed ElasticSearch releases
+    $ desi releases              # List all upstream Elastic Search releases (latest 5 by default)
+    $ desi install [VERSION]     # Install a specific version (latest by default)
+    $ desi start                 # Start a local 1-node cluster (noop if active)
+    $ desi restart               # (Re)start cluster (even if active)
+    $ desi stop                  # Stop cluster
+    $ desi status [--host HOST]  # Show running cluster info
+
+    $ desi indices "^foo"          # List all indices whose name match /^foo/
+    $ desi indices "^foo" --delete # Delete all matching indices
+    $ desi indices "bar$" --empty  # Remove all records from the matching
+                                   #  indices
+
+## Examples
+
+### Currently installed releases
+
+The current version is the one symlinked to `$HOME/elasticsearch/current`
+
+  * command-line
+
+  ```shell
+  $ desi list
+  Local ES installs (current one is tagged with '*'):
+    * elasticsearch-0.19.9 (/home/me/elasticsearch/elasticsearch-0.19.9)
+    - elasticsearch-0.19.8 (/home/me/elasticsearch/elasticsearch-0.19.8)
+  ```
+
+
+  * library
+
+  ```ruby
+  Desi::LocalInstall.new.releases.map(&:name) #=> ["elasticsearch-0.19.8", "elasticsearch-0.19.9"]
+  Desi::LocalInstall.new.releases.detect(&:current?).version #=> "0.19.9"
+  ```
+
+
 
 ## Installation
 
@@ -19,21 +67,10 @@ Or install it yourself as:
 
     $ gem install desi
 
-## Usage
-
-    $ desi list                # List locally installed ElasticSearch versions
-    $ desi releases            # List all upstream Elastic Search releases (latest 5 by default)
-    $ desi install [VERSION]   # Install a specific version (latest by default)
-    $ desi start               # Start a local 1-node cluster (noop if active)
-    $ desi restart             # (Re)start cluster (even if active)
-    $ desi stop                # Stop cluster
-    $ desi status              # Show running cluster info
-
 ## TODO
 
   * add tests, dammit!
 
-  * index management (list, create, delete ES indices)
   * `desi upgrade` (Upgrade to latest version and migrate data)
   * `desi switch VERSION` (Switch currently active ES version to VERSION)
   * plugin management ? (list, install, remove ES plugins)

data/Rakefile

@@ -1,2 +1,4 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/desi.gemspec

@@ -13,6 +13,11 @@ an Elastic Search local install for development purposes.}
 
   gem.add_dependency "boson"
   gem.add_dependency "cocaine"
+  gem.add_dependency "addressable"
+
+  gem.add_development_dependency "guard-yard"
+  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "rb-inotify"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/desi.rb

@@ -1,11 +1,12 @@
 require "desi/version"
 
 module Desi
-  autoload :Downloader,       'desi/downloader'
-  autoload :HttpClient,       'desi/http_client'
-  autoload :LocalInstall,     'desi/local_install'
-  autoload :Upstream,         'desi/upstream'
-  autoload :Installer,        'desi/installer'
-  autoload :ProcessManager,   'desi/process_manager'
+  require 'desi/downloader'
+  require 'desi/http_client'
+  require 'desi/local_install'
+  require 'desi/upstream'
+  require 'desi/installer'
+  require 'desi/process_manager'
+  require 'desi/index_manager'
 end
 

data/lib/desi/http_client.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 require "net/https"
-require "uri"
+require "addressable/uri"
 require "json"
 
 module Desi
@@ -10,8 +10,8 @@ module Desi
 
     attr_reader :uri
 
-    def initialize(uri)
-      @uri = URI(uri)
+    def initialize(host_string)
+      @uri = to_uri(host_string)
 
       case @uri.scheme
       when 'https'
@@ -39,6 +39,31 @@ module Desi
           raise response.error!
       end
     end
+
+    def delete(uri)
+      response = @http.request(Net::HTTP::Delete.new(uri))
+
+      case response
+        when Net::HTTPSuccess
+          response
+        else
+          raise response.error!
+      end
+    end
+
+    private
+
+    def to_uri(host_string)
+      scheme, host, port = ['http', '127.0.0.1', 9200]
+
+      %r{(?<scheme>(https?|))(?:\:\/\/|)(?<host>[^:]*?):?(?<port>\d*)/?$}.match(host_string) do |m|
+        scheme = m[:scheme] unless m[:scheme].empty?
+        host = m[:host] unless m[:host].empty?
+        port = m[:port] unless m[:port].empty?
+      end
+
+      Addressable::URI.new(scheme: scheme, host: host, port: port)
+    end
   end
 
 end

data/lib/desi/index_manager.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+require "desi/http_client"
+
+module Desi
+
+  # Performs some simple index-related operations on a local or distance
+  # Elastic Search cluster
+  class IndexManager
+
+    # Initializes a Desi::IndexManager instance
+    #
+    # @param       [#to_hash]  opts      Hash of extra opts
+    # @option opts [#to_s]     :host     Host to manage indices for
+    #                                    (default: 'http://127.0.0.1:9200')
+    # @option opts [Boolean]   :verbose  Whether to output the actions' result
+    #                                    on STDOUT
+    #
+    # @return [undefined]
+    #
+    # @api public
+    def initialize(opts = {})
+      @host = opts.fetch(:host, 'http://127.0.0.1:9200')
+      @verbose = opts[:verbose]
+      @client = Desi::HttpClient.new(@host)
+    end
+
+
+    # List index names for the specified cluster
+    #
+    # You can restrict the list using a regular expression pattern. (The default
+    # pattern being +/.*/+, all releases will be returned if you do not
+    # specify anything.)
+    #
+    # @param   [#to_s]          pattern  Regexp pattern used to restrict the selection
+    # @return  [Array<String>]           List of index names of the ES cluster
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @example List all indices whose name begins with "foo"
+    #    Desi::IndexManager.new.list('^foo') #=> ["foo1", "foo2", "foo3"]
+    #
+    # @api  public
+    def list(pattern = '.*')
+      pattern = Regexp.new(pattern || '.*')
+
+      puts "Indices from host #{@client.uri} matching the pattern #{pattern.inspect}\n\n" if @verbose
+
+      list = indices(pattern).sort
+      list.each {|i| puts i } if @verbose
+      list
+    end
+
+    # Delete all indices matching the specified pattern
+    #
+    # @param   [#to_s]          pattern  Regexp pattern used to restrict the selection
+    # @return  [undefined]
+    #
+    # @note No confirmation is needed, so beware!
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @example Delete all indices whose name begins with "test"
+    #    Desi::IndexManager.new.delete!('^test') #=> nil
+    #
+    # @api  public
+    def delete!(pattern)
+      warn "You must provide a pattern" and exit if pattern.nil?
+
+      puts "The following indices from host #{@client.uri} are now deleted" if @verbose
+
+      indices(Regexp.new(pattern)).each do |index|
+        @client.delete(index)
+        puts " * #{index}" if @verbose
+      end
+    end
+
+    # Empty (remove all records) from indices matching the specified pattern
+    #
+    # @param   [#to_s]          pattern  Regexp pattern used to restrict the selection
+    # @return  [undefined]
+    #
+    # @note No confirmation is needed, so beware!
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @example Empty all indices whose name begins with "log"
+    #    Desi::IndexManager.new.empty!('^log') #=> nil
+    #
+    # @api  public
+    def empty!(pattern)
+      warn "You must provide a pattern" and exit if pattern.nil?
+
+      puts "The following indices from host #{@client.uri} are now emptied" if @verbose
+
+      indices(Regexp.new(pattern)).each do |index|
+        @client.delete("#{index}/_query?q=*")
+        puts " * #{index}" if @verbose
+      end
+    end
+
+    private
+
+    def indices(pattern)
+      JSON.parse(@client.get('_status').body)["indices"].keys.select {|i|
+              i =~ pattern
+      }
+    end
+
+  end
+end

data/lib/desi/local_install.rb

@@ -1,9 +1,56 @@
 # encoding: utf-8
 
+require "pathname"
+
 module Desi
   class LocalInstall
     DEFAULT_DIR = '~/elasticsearch'
 
+    class Release
+      def self.all_in(workdir)
+        Dir[workdir.join('*')].
+          select {|subdir| File.directory?(subdir) && File.basename(subdir) =~ /^elasticsearch\-\d+\.\d+\.\d+/ }.
+          map {|dirname| new(dirname, workdir) }
+      end
+
+      def initialize(dirname, workdir)
+        @dirname = Pathname.new(dirname)
+        @workdir = workdir
+      end
+
+      def name
+        @name ||= File.basename(@dirname)
+      end
+
+      def current?
+        current_symlink? && current_symlink.realpath == @dirname
+      end
+
+      def version
+        @version ||= /^elasticsearch\-(?<version>.*)$/.match(name.to_s)[:version]
+      end
+
+      def to_s
+        current_mark = current? ? '*' : '-'
+
+        " #{current_mark} #{name} (#{@dirname})"
+      end
+
+      def <=>(other)
+        name <=> other.name
+      end
+
+      private
+
+      def current_symlink
+        @current_symlink ||= Pathname(@workdir).join('current')
+      end
+
+      def current_symlink?
+        current_symlink.exist?
+      end
+    end
+
     def initialize(workdir = nil)
       @workdir = Pathname(File.expand_path(workdir || DEFAULT_DIR))
     end
@@ -20,8 +67,8 @@ module Desi
       FileUtils.mkdir_p @workdir
     end
 
-    def versions
-      Dir[@workdir.join('*')].select {|subdir| File.directory?(subdir) && File.basename(subdir) =~ /^elasticsearch\-\d+\.\d+\.\d+/ }
+    def releases
+      Release.all_in(@workdir)
     end
 
     def to_path

data/lib/desi/process_manager.rb

@@ -3,14 +3,17 @@
 require "json"
 require "cocaine"
 require "ostruct"
+require "desi/http_client"
+require "desi/local_install"
 
 module Desi
   class ProcessManager
 
     def initialize(opts = {})
+      @host = opts.fetch(:host, 'http://127.0.0.1:9200')
       @verbose = opts[:verbose]
       @local_install = LocalInstall.new
-      @client = Desi::HttpClient.new('http://localhost:9200/')
+      @client = Desi::HttpClient.new(@host)
     end
 
     def start

data/lib/desi/runner.rb

@@ -13,9 +13,9 @@ module Desi
     desc "List locally installed Elastic Search releases"
     verbosity_option
     def list(options = {})
-      puts "Local ES installs:" unless quiet?(options)
-      Desi::LocalInstall.new.versions.each do |v|
-        puts "* #{v}"
+      puts "Local ES installs (current one is tagged with '*'):" unless quiet?(options)
+      Desi::LocalInstall.new.releases.sort.reverse.each do |v|
+        puts v
       end
     end
 
@@ -31,7 +31,7 @@ module Desi
         releases
       else
         puts "Here are #{limit == 0 ? 'all the' : "the #{limit} latest"} releases"
-        releases.each {|rel| puts " * #{rel.name} (#{rel.release_date})" }
+        releases.each {|rel| puts " - #{rel.name} (#{rel.release_date})" }
       end
     end
 
@@ -71,8 +71,26 @@ module Desi
 
     desc "Show current status"
     verbosity_option
+    option "--host", type: :string, desc: "Elastic Search cluster URL", default: '127.0.0.1:9200'
     def status(options = {})
-      Desi::ProcessManager.new(verbose: !quiet?(options)).status
+      Desi::ProcessManager.new(verbose: !quiet?(options), host: options[:host]).status
+    end
+
+    desc "List indices"
+    verbosity_option
+    option "--host", type: :string, desc: "Elastic Search cluster URL", default: '127.0.0.1:9200'
+    option "--delete", type: :boolean, desc: "Delete the specified indices (You've been warned!)", default: false
+    option "--empty", type: :boolean, desc:  "Delete all documents from the specified indices", default: false
+    def indices(pattern = nil, options = {})
+      index_manager = Desi::IndexManager.new(verbose: !quiet?(options), host: options[:host])
+
+      if options[:delete]
+        index_manager.delete!(pattern)
+      elsif options[:empty]
+        index_manager.empty!(pattern)
+      else
+        index_manager.list(pattern)
+      end
     end
 
     # desc "Upgrade to latest ElasticSearch version"

data/lib/desi/version.rb

@@ -1,3 +1,3 @@
 module Desi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/tasks/yard.rake

@@ -0,0 +1,9 @@
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: desi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Desi (Developper ElasticSearch Installer) is very simple tool to quickly
   set up
 
@@ -55,7 +119,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -65,12 +131,14 @@ files:
 - lib/desi.rb
 - lib/desi/downloader.rb
 - lib/desi/http_client.rb
+- lib/desi/index_manager.rb
 - lib/desi/installer.rb
 - lib/desi/local_install.rb
 - lib/desi/process_manager.rb
 - lib/desi/runner.rb
 - lib/desi/upstream.rb
 - lib/desi/version.rb
+- tasks/yard.rake
 homepage: https://github.com/AF83/desi/
 licenses: []
 post_install_message: