desi 0.1.0 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Guardfile

@@ -3,3 +3,9 @@
 guard 'yard' do
   watch(%r{lib/.+\.rb})
 end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -13,7 +13,7 @@ It can:
 It can be used both as a command-line tool and as a library.
 
 
-## Usage
+## Usage (command-line)
 
     $ desi list                  # List locally installed ElasticSearch releases
     $ desi releases              # List all upstream Elastic Search releases (latest 5 by default)
@@ -25,14 +25,14 @@ It can be used both as a command-line tool and as a library.
 
     $ 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
+    $ desi indices "bar$" --empty  # Remove all records from the matching indices
 
-## Examples
+## Examples (command-line and Ruby)
 
-### Currently installed releases
+### Get the list of locally installed releases
 
-The current version is the one symlinked to `$HOME/elasticsearch/current`
+The current version is the one symlinked to `$HOME/elasticsearch/current`, that
+will be spun up by (`desi start`)
 
   * command-line
 
@@ -52,6 +52,54 @@ The current version is the one symlinked to `$HOME/elasticsearch/current`
   ```
 
 
+### List and delete some indices
+
+  * command-line
+
+  ```shell
+  $ # List all local indices
+  $ desi indices
+    Indices from host http://127.0.0.1:9200 matching the pattern /.*/
+
+    foo
+    bar
+    baz
+
+  $ # List all indices on remote cluster 129.168.1.42, reachable on port 9800
+  $ desi indices --host 129.168.1.42:9800 foo
+    Indices from host http://192.168.1.42:9800 matching the pattern /foo/
+
+    remotefoo1
+    remotefoo2
+
+  $ # Remove all indices whose name starts with "ba"
+  $ desi indices --delete "^ba"
+  The following indices from host http://127.0.0.1:9200 are now deleted
+   * bar
+   * baz
+  ```
+
+
+  * library
+
+  ```ruby
+  # All local indices
+  Desi::IndexManager.new.list #=> ["foo", "bar", "baz"]
+
+  # All local indices whose name starts with `b`
+  Desi::IndexManager.new.list("^b") #=> ["bar", "baz"]
+
+  # All indices from distant cluster
+  Desi::IndexManager.new(host: "192.168.1.42:9800").list #=> ["remotefoo1", "remotefoo2"]
+
+  # Delete all local indices whose name starts with `ba`
+  Desi::IndexManager.new.delete!("^ba") #=> nil
+
+  # The indices actually disappeared
+  Desi::IndexManager.new.list #=> ["foo"]
+  ```
+
+
 
 ## Installation
 
@@ -69,7 +117,7 @@ Or install it yourself as:
 
 ## TODO
 
-  * add tests, dammit!
+  * add more tests
 
   * `desi upgrade` (Upgrade to latest version and migrate data)
   * `desi switch VERSION` (Switch currently active ES version to VERSION)

data/desi.gemspec

@@ -15,6 +15,9 @@ an Elastic Search local install for development purposes.}
   gem.add_dependency "cocaine"
   gem.add_dependency "addressable"
 
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "guard-yard"
   gem.add_development_dependency "redcarpet"
   gem.add_development_dependency "rb-inotify"

data/lib/desi/downloader.rb

@@ -11,7 +11,7 @@ module Desi
     def initialize(opts = {})
       @destination_dir = Pathname(opts.fetch(:destination_dir, Desi::LocalInstall.new))
       @host = URI(opts.fetch(:host, 'http://cloud.github.com/'))
-      @client = Desi::HttpClient.new(@host)
+      @client = opts.fetch(:http_client_factory, Desi::HttpClient).new(@host)
       @verbose = opts[:verbose]
     end
 

data/lib/desi/http_client.rb

@@ -8,8 +8,6 @@ module Desi
 
   class HttpClient
 
-    attr_reader :uri
-
     def initialize(host_string)
       @uri = to_uri(host_string)
 

data/lib/desi/index_manager.rb

@@ -10,19 +10,24 @@ module Desi
 
     # 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
+    # @param       [#to_hash]  opts                             Hash of extra opts
     #
+    # @option opts [#to_s]     :host ('http://127.0.0.1:9200')  Host to manage indices for
+    # @option opts [Boolean]   :verbose   (nil) Whether to output the actions' result
+    #                                           on STDOUT
+    # @option opts [#new]      :http_client_factory (Desi::HttpClient) HTTP transport class
+    #                                                                  to use
+    #
+    # @note The +:http_client_factory+ should return an instance that responds
+    #       to #get and #delete
     # @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)
+      @outputter = opts.fetch(:outputter, Kernel)
+      @client = opts.fetch(:http_client_factory, Desi::HttpClient).new(@host)
     end
 
 
@@ -32,8 +37,8 @@ module Desi
     # 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
+    # @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
@@ -45,10 +50,10 @@ module Desi
     def list(pattern = '.*')
       pattern = Regexp.new(pattern || '.*')
 
-      puts "Indices from host #{@client.uri} matching the pattern #{pattern.inspect}\n\n" if @verbose
+      @outputter.puts "Indices from host #{@host} matching the pattern #{pattern.inspect}\n\n" if @verbose
 
       list = indices(pattern).sort
-      list.each {|i| puts i } if @verbose
+      list.each {|i| @outputter.puts i } if @verbose
       list
     end
 
@@ -69,11 +74,11 @@ module Desi
     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
+      @outputter.puts "The following indices from host #{@host} are now deleted" if @verbose
 
       indices(Regexp.new(pattern)).each do |index|
         @client.delete(index)
-        puts " * #{index}" if @verbose
+        @outputter.puts " * #{index}" if @verbose
       end
     end
 
@@ -94,11 +99,11 @@ module Desi
     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
+      @outputter.puts "The following indices from host #{@host} are now emptied" if @verbose
 
       indices(Regexp.new(pattern)).each do |index|
         @client.delete("#{index}/_query?q=*")
-        puts " * #{index}" if @verbose
+        @outputter.puts " * #{index}" if @verbose
       end
     end
 

data/lib/desi/process_manager.rb

@@ -13,7 +13,7 @@ module Desi
       @host = opts.fetch(:host, 'http://127.0.0.1:9200')
       @verbose = opts[:verbose]
       @local_install = LocalInstall.new
-      @client = Desi::HttpClient.new(@host)
+      @client = opts.fetch(:http_client_factory, Desi::HttpClient).new(@host)
     end
 
     def start
@@ -50,7 +50,7 @@ module Desi
       if version = running_version
         msg = "OK. Elastic Search cluster '#{cluster_health.cluster_name}' (v#{version}) is running on #{cluster_health.number_of_nodes} node(s) with status #{cluster_health.status}"
       else
-        msg = "KO. No Elastic Search instance was found running on #{@client.uri}"
+        msg = "KO. No Elastic Search instance was found running on #{@host}"
       end
       puts msg if @verbose
       msg

data/lib/desi/upstream.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require "desi/http_client"
+require "json"
 
 module Desi
   class Upstream
@@ -11,8 +12,8 @@ module Desi
       end
     end
 
-    def initialize
-      @client = Desi::HttpClient.new('https://api.github.com/')
+    def initialize(opts = {})
+      @client = opts.fetch(:http_client_factory, Desi::HttpClient).new('https://api.github.com/')
     end
 
     def releases

data/lib/desi/version.rb

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

data/spec/desi/index_manager_spec.rb

@@ -0,0 +1,134 @@
+# encoding: utf-8
+
+require "spec_helper"
+require "desi/index_manager"
+require "json"
+
+describe Desi::IndexManager do
+
+  subject { described_class.new(http_client_factory: http_client_factory) }
+
+  let(:http_client_factory) { double(new: http_client) }
+  let(:http_client) { double('http_client') }
+
+  def stub_request(method, path, payload)
+    http_client.stub(method).with(path).and_return(
+      mock("response", body: JSON.unparse(payload))
+    )
+  end
+
+  def stub_indices(*names)
+    stub_request(:get, '_status', {"indices" => Hash[Array(names).zip]})
+  end
+
+  before do
+    stub_indices('foo', 'bar')
+  end
+
+  describe "#list" do
+    context "with no specified pattern" do
+      it "returns the names of all indices" do
+        subject.list.should == %w[bar foo]
+      end
+    end
+
+    context "with a pattern" do
+      it "returns the matching indices" do
+        subject.list('oo').should == %w[foo]
+      end
+    end
+
+    context "when verbose is on" do
+      let(:outputter) { double("outputter") }
+
+      subject do
+        described_class.new(
+          http_client_factory: http_client_factory,
+          outputter: outputter,
+          verbose: true)
+      end
+
+      it "also outputs on STDOUT" do
+        outputter.should_receive(:puts).at_least(:once)
+        subject.list('oo')
+      end
+    end
+  end
+
+  describe "#delete!" do
+    context "when the mandatory pattern is not specified" do
+      it "raises an ArgumentError" do
+        expect { subject.delete! }.to raise_error(ArgumentError)
+      end
+    end
+
+    it "deletes all matching indices" do
+      http_client.should_receive(:delete).with("foo")
+      http_client.should_not_receive(:delete).with("bar")
+
+      subject.delete!('f.*')
+    end
+
+    context "when verbose is on" do
+      let(:outputter) { double("outputter") }
+
+      subject do
+        described_class.new(
+          http_client_factory: http_client_factory,
+          outputter: outputter,
+          verbose: true)
+      end
+
+      it "also outputs on STDOUT" do
+        http_client.stub(:delete)
+
+        outputter.should_receive(:puts).at_least(:once)
+        subject.delete!('f.*')
+      end
+    end
+  end
+
+  describe "#empty!" do
+    context "when the mandatory pattern is not specified" do
+      it "raises an ArgumentError" do
+        expect { subject.empty! }.to raise_error(ArgumentError)
+      end
+    end
+
+    it "deletes all matching indices" do
+      http_client.should_receive(:delete).with("foo/_query?q=*")
+      http_client.should_not_receive(:delete).with("bar")
+
+      subject.empty!('f.*')
+    end
+
+    context "when verbose is on" do
+      let(:outputter) { double("outputter") }
+
+      subject do
+        described_class.new(
+          http_client_factory: http_client_factory,
+          outputter: outputter,
+          verbose: true)
+      end
+
+      it "also outputs on STDOUT" do
+        http_client.stub(:delete)
+
+        outputter.should_receive(:puts).at_least(:once)
+        subject.empty!('f.*')
+      end
+    end
+  end
+
+  context "when given another host" do
+    let(:factory_for_remote_host) { double("http_client_factory") }
+
+    it "sends the other host's url to initialize the client" do
+      factory_for_remote_host.should_receive(:new).with("http://foobar.com")
+
+      described_class.new(host: "http://foobar.com", http_client_factory: factory_for_remote_host)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: desi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,6 +59,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: guard-rspec
+  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: guard-yard
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +167,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .yardopts
 - Gemfile
 - Guardfile
@@ -138,6 +187,8 @@ files:
 - lib/desi/runner.rb
 - lib/desi/upstream.rb
 - lib/desi/version.rb
+- spec/desi/index_manager_spec.rb
+- spec/spec_helper.rb
 - tasks/yard.rake
 homepage: https://github.com/AF83/desi/
 licenses: []
@@ -151,17 +202,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1725098947325688636
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1725098947325688636
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A developer tool to quickly set up an Elastic Search local install.
-test_files: []
+test_files:
+- spec/desi/index_manager_spec.rb
+- spec/spec_helper.rb
 has_rdoc: