stretch 0.0.0 → 0.1.0

data/.gitignore

@@ -6,6 +6,7 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
+bin/
 coverage
 doc/
 lib/bundler/man
@@ -14,4 +15,5 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+vendor/gems
 tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+script: "./script/test"
+gemfile: "this/does/not/exist"
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0.0"

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing Guidelines
+
+Tests are run with `script/test`.
+
+Test against the following Ruby versions:
+
+* 1.8.7
+* 1.9.3
+* 2.0.0
+
+Always work on a fork, on a feature branch.
+
+Submit Pull Requests, with new tests for any changes.
+Make sure the tests pass.

data/README.md

@@ -1,6 +1,10 @@
 # Stretch
 
-Shhh -- a secret!
+[![Build Status](https://travis-ci.org/wfarr/stretch.png?branch=master)](https://travis-ci.org/wfarr/stretch)
+[![Code Climate Status](https://codeclimate.com/github/wfarr/stretch.png)](https://codeclimate.com/github/wfarr/stretch)
+
+Elasticsearch client library written for people who like understandable
+documentation and understandable code.
 
 ## Installation
 
@@ -18,12 +22,39 @@ Or install it yourself as:
 
 ## Usage
 
-You obviously can't use this yet.
+### Establishing a connection:
+
+``` ruby
+$stretch = Stretch::Client.new :url => "http://127.0.0.1:9200/"
+```
+
+### Cluster and Index Health
+
+``` ruby
+$stretch.cluster.health :timeout => '10s'
+$stretch.index('tweets').health :wait_for_status => 'green'
+```
+
+### Cluster State
+
+``` ruby
+$stretch.cluster.state
+$stretch.cluster.state :filter_nodes => true
+```
+
+### Cluster and Index Settings
+
+``` ruby
+$stretch.cluster.settings :persistent => {
+  "cluster.routing.allocation.node_concurrent_recoveries" => 4
+}
+
+$stretch.index('foo').settings :index => { :number_of_replicas => 2 }
+```
 
-## Contributing
+### Opening and Closing Indices
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+``` ruby
+$stretch.index('foo').open!
+$stretch.index('bar').close!
+```

data/lib/stretch.rb

@@ -1,5 +1,7 @@
+require "stretch/client"
 require "stretch/version"
 
 module Stretch
-  # Your code goes here...
+  class InvalidScope < StandardError; end
+  class UnsupportedRequestMethod < StandardError; end
 end

data/lib/stretch/client.rb

@@ -0,0 +1,83 @@
+require "stretch/connection"
+require "stretch/uri_builder"
+
+module Stretch
+  class Client
+    attr_reader :connection, :scope
+
+    def initialize options = {}
+      self.tap do
+        @scope = {
+          :cluster => false,
+          :index   => nil
+        }
+
+        @connection = Stretch::Connection.new options
+      end
+    end
+
+    # Chainable methods
+    def cluster
+      self.tap do
+        scope[:cluster] = true
+        scope[:index] = nil
+      end
+    end
+
+    def index name
+      self.tap do
+        scope[:cluster] = false
+        scope[:index]   = name
+      end
+    end
+
+    # End points
+    def health options = {}
+      with_scopes :cluster, :index do
+        connection.get build_path("/health"), options
+      end
+    end
+
+    def state options = {}
+      with_scopes :cluster do
+        connection.get build_path("/state"), options
+      end
+    end
+
+    def settings options = {}
+      with_scopes :cluster, :index do
+        if options.any?
+          connection.put build_path("/settings"), options
+        else
+          connection.get build_path("/settings")
+        end
+      end
+    end
+
+    def open!
+      with_scopes :index do
+        connection.post build_path("/_open")
+      end
+    end
+
+    def close!
+      with_scopes :index do
+        connection.post build_path("/_close")
+      end
+    end
+
+    private
+    def build_path path
+      Stretch::URIBuilder.build_from_scope scope, path
+    end
+
+    def with_scopes *scopes, &block
+      if scopes.any? {|s| scope.has_key?(s) && scope[s] }
+        yield
+      else
+        raise InvalidScope,
+          "Requires one of the following scopes: #{scopes.inspect}. #{scope.inspect} given."
+      end
+    end
+  end
+end

data/lib/stretch/connection.rb

@@ -0,0 +1,67 @@
+require "faraday"
+require "multi_json"
+
+module Stretch
+  class Connection
+    attr_reader :connection
+
+    REQUEST_METHODS = [ :get, :post, :put, :delete ].freeze
+
+    def initialize options = {}
+      @connection = Faraday.new(options)
+    end
+
+    def get path, options = {}
+      request :get, path, options
+    end
+
+    def post path, options = {}
+      request :post, path, options
+    end
+
+    def put path, options = {}
+      request :put, path, options
+    end
+
+    def delete path, options = {}
+      request :delete, path, options
+    end
+
+    private
+    def request method, path, options = {}
+      validate_request_method method
+
+      response = connection.send(method) do |request|
+        request.headers["Accept"] = "application/json"
+        request.path = path
+
+        case method
+        when :get
+          options.each { |k,v| request.params[k] = v }
+        when :post, :put
+          request.body = MultiJson.dump(options)
+        end
+      end
+
+      handle_response response
+    end
+
+    def validate_request_method method
+      unless REQUEST_METHODS.member? method
+        raise Stretch::UnsupportedRequestMethod, "#{method} is not supported!"
+      end
+    end
+
+    def handle_response response
+      if response.success?
+        if response.body.empty?
+          request :get, path
+        else
+          MultiJson.load response.body
+        end
+      else
+        response.error!
+      end
+    end
+  end
+end

data/lib/stretch/uri_builder.rb

@@ -0,0 +1,13 @@
+module Stretch
+  class URIBuilder
+    def self.build_from_scope scope, path
+      path.gsub!(/\A\//, '')
+
+      if scope[:cluster]
+        "/_cluster/#{path}"
+      elsif scope[:index]
+        "/#{scope[:index]}/#{path}"
+      end
+    end
+  end
+end

data/lib/stretch/version.rb

@@ -1,3 +1,3 @@
 module Stretch
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+bundle install --path .bundle --binstubs .bundle/binstubs "$@"

data/script/test

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+
+root=$(cd "$(dirname $0)"/.. && pwd)
+
+echo "Bundling..."
+script/bootstrap
+
+ruby -I"${root}/.bundle" -I"${root}/test" -e \
+  "(ARGV.empty? ? Dir['${root}/test/**/*_test.rb'] : ARGV).each { |f| load f }"

data/stretch.gemspec

@@ -8,9 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = Stretch::VERSION
   spec.authors       = ["Will Farrington"]
   spec.email         = ["wfarr@github.com"]
-  spec.description   = %q{Shh, it's a secret}
-  spec.summary       = %q{Still seriously a secret}
-  spec.homepage      = ""
+  spec.description   = %q{An Elasticsearch client library}
+  spec.summary       = %q{It's not anywhere near complete at this time, but
+    the code is pretty all right allegedly.
+  }
+  spec.homepage      = "https://github.com/wfarr/stretch"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +20,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_dependency "faraday",    "~> 0.8.7"
+  spec.add_dependency "multi_json", "~> 1.7.2"
+
+  spec.add_development_dependency "bundler",  "~> 1.2"
+  spec.add_development_dependency "minitest", "~> 4.0"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
 end

data/test/stretch/client_test.rb

@@ -0,0 +1,153 @@
+require "test_helper"
+
+require "stretch/client"
+
+describe Stretch::Client do
+  let(:instance) { described_class.new }
+  let(:connection) { MiniTest::Mock.new }
+
+  describe ".new" do
+    describe "scope defaults" do
+      it "index to nil" do
+        assert_nil instance.scope[:index]
+      end
+
+      it "cluster to false" do
+        refute instance.scope[:cluster]
+      end
+    end
+  end
+
+  it "can chain index" do
+    assert instance.index("foo").is_a?(Stretch::Client)
+    assert_equal "foo", instance.scope[:index]
+  end
+
+  it "can chain cluster" do
+    assert instance.cluster.is_a?(Stretch::Client)
+    assert instance.scope[:cluster]
+  end
+
+  describe "#health" do
+    it "requires either a cluster scope or an index scope" do
+      instance.stub :scope, { :cluster => false, :index => nil } do
+        assert_raises Stretch::InvalidScope do
+          instance.health
+        end
+      end
+    end
+
+    it "requests cluster health if the scope is cluster" do
+      instance.stub :connection, connection do
+        connection.expect :get, { "status" => "ok" }, ["/_cluster/health", {}]
+        instance.cluster.health
+
+        connection.verify
+      end
+    end
+
+    it "requests index health if the scope is an index" do
+      instance.stub :connection, connection do
+        connection.expect :get, { "status" => "ok" }, ["/foo/health", {}]
+        instance.index("foo").health
+
+        connection.verify
+      end
+    end
+  end
+
+  describe "#state" do
+    it "requires a cluster scope" do
+      instance.stub :scope, { :cluster => false } do
+        assert_raises Stretch::InvalidScope do
+          instance.state
+        end
+      end
+    end
+
+    it "can return the state of a cluster" do
+      instance.connection.stub :get, { "status" => "ok" } do
+        assert_equal "ok", instance.cluster.state["status"]
+      end
+    end
+  end
+
+  describe "#settings" do
+    it "requires either a cluster scope or an index scope" do
+      instance.stub :scope, { :cluster => false, :index => nil } do
+        assert_raises Stretch::InvalidScope do
+          instance.settings
+        end
+      end
+    end
+
+    describe "no options given" do
+      it "performs a get request for the settings" do
+        response = { "persistent" => { "foo" => 1 } }
+
+        instance.stub :connection, connection do
+          connection.expect :get, response, ["/_cluster/settings"]
+          assert_equal 1, instance.cluster.settings["persistent"]["foo"]
+
+          connection.verify
+        end
+      end
+    end
+
+    describe "options given" do
+      it "performs a put request with options for the settings" do
+        params   = { :index => { :refresh_interval => -1 } }
+        response = { "index" => {"refresh_interval" => -1} }
+
+        instance.stub :connection, connection do
+          connection.expect :put, response, ["/foo/settings", params]
+          assert_equal -1, instance.index("foo").settings(params)["index"]["refresh_interval"]
+
+          connection.verify
+        end
+      end
+    end
+  end
+
+  describe "#open!" do
+    it "requires the index scope" do
+      instance.stub :scope, { :cluster => true, :index => nil } do
+        assert_raises Stretch::InvalidScope do
+          instance.open!
+        end
+      end
+    end
+
+    it "performs a post request to open the index" do
+      response = { "ok" => true, "acknowledged" => true }
+
+      instance.stub :connection, connection do
+        connection.expect :post, response, ["/foo/_open"]
+        assert_equal true, instance.index("foo").open!["ok"]
+
+        connection.verify
+      end
+    end
+  end
+
+  describe "#close!" do
+    it "requires the index scope" do
+      instance.stub :scope, { :cluster => true, :index => nil } do
+        assert_raises Stretch::InvalidScope do
+          instance.close!
+        end
+      end
+    end
+
+    it "performs a post request to close the index" do
+      response = { "ok" => true, "acknowledged" => true }
+
+      instance.stub :connection, connection do
+        connection.expect :post, response, ["/foo/_close"]
+        assert_equal true, instance.index("foo").close!["ok"]
+
+        connection.verify
+      end
+    end
+  end
+end

data/test/stretch/connection_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+require "stretch/connection"
+
+describe Stretch::Connection do
+  let(:instance) { described_class.new }
+  let(:response) do
+    Struct.new :response do
+      def body
+        MultiJson.dump({ "status" => "ok" })
+      end
+
+      def success?
+        true
+      end
+    end.new
+  end
+
+  it "accepts get requests" do
+    instance.connection.stub :get, response do
+      instance.get "/foo"
+    end
+  end
+
+  it "accepts post requests" do
+    instance.connection.stub :post, response do
+      instance.post "/foo"
+    end
+  end
+
+  it "accepts put requests" do
+    instance.connection.stub :put, response do
+      instance.put "/foo"
+    end
+  end
+
+  it "accepts delete requests" do
+    instance.connection.stub :delete, response do
+      instance.delete "/foo"
+    end
+  end
+end

data/test/stretch_test.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+require "stretch"
+
+describe Stretch do
+  it "is a defined module name" do
+    assert defined?(Stretch)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "bundler/setup"
+
+require "minitest/spec"
+require "minitest/autorun"
+
+class MiniTest::Spec
+  def described_class
+    @described_class ||= self.class.ancestors.select { |c|
+      c.respond_to? :desc
+    }[-2].desc
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stretch
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -18,7 +50,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +74,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +107,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Shh, it's a secret
+description: An Elasticsearch client library
 email:
 - wfarr@github.com
 executables: []
@@ -51,14 +115,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/stretch.rb
+- lib/stretch/client.rb
+- lib/stretch/connection.rb
+- lib/stretch/uri_builder.rb
 - lib/stretch/version.rb
+- script/bootstrap
+- script/test
 - stretch.gemspec
-homepage: ''
+- test/stretch/client_test.rb
+- test/stretch/connection_test.rb
+- test/stretch_test.rb
+- test/test_helper.rb
+homepage: https://github.com/wfarr/stretch
 licenses:
 - MIT
 post_install_message: 
@@ -71,16 +146,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3712832259908765
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3712832259908765
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Still seriously a secret
-test_files: []
+summary: It's not anywhere near complete at this time, but the code is pretty all
+  right allegedly.
+test_files:
+- test/stretch/client_test.rb
+- test/stretch/connection_test.rb
+- test/stretch_test.rb
+- test/test_helper.rb