elastirad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95156251835b98cdd37c6609f5e11e3c22fc5887
+  data.tar.gz: 607df84376fee0048434528edc0222b1286bdda5
+SHA512:
+  metadata.gz: 64ff790b4f28a2253228e13f36a5dd21703486c361abf5b62c4e9873ccf2bf6407900329e502595c463ae81a8b827a693b2c6aa16f0428f6e55e5343c92a416d
+  data.tar.gz: 50c43595c370835210c2e232fbc7069ffec012d047a9fb0cfad0b6bd4680a3c2c2d22b46867d64fb2260c1be7c9b907c54392182f8c982e06683e5a04bb1b453

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2014-03-14**: 0.0.1
+  - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Wang
+ 
+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.md

@@ -0,0 +1,105 @@
+Elastirad: A RAD Client for Elasticsearch
+====================================================
+
+Synopsis
+--------
+
+Elastirad is a custom rapid application development (RAD) client for
+Elasticsearch's Elasticsearch::API that provides a simple interface for
+making Elasticsearch requests based on Elasticsearch's online documentation.
+
+The primary goal for Elastirad is to enable use of the Elasticsearch online
+curl-based documentation alone without needing to understand the syntax for
+the Ruby SDK.
+
+Installing
+----------
+
+Download and install elastirad with the following:
+
+  gem install elastirad
+
+#Examples
+---------
+
+    require 'elastirad'
+
+    # Defaults to http://localhost:9200
+
+    rad = Elastirad::Client.new
+
+    # All of the following arguments are optional
+    # Setting :index will enable request code to not include the index
+    # for greater flexibility when switching between deployments, e.g.
+    # dev, staging, production, etc.
+
+    rad = Elastirad::Client.new( \
+      :protocol => 'https',
+      :hostname => 'localhost',
+      :port     => 9200,
+      :index    => 'articles'
+    )
+
+    # path can be a simple string. Leading slash will over ride default :index
+
+    result_hash = rad.rad_request({ :path => '/articles/_count' })
+
+    # path can also be an array
+
+    result_hash = rad.rad_request({ :path => ['/articles/article', 1 ] })
+
+    # default index can be used without leading slash
+
+    result_hash = rad.rad_request({ :path => ['article', 1 ] })
+
+    # optional :verb can be used for non-GET requests, :get is used by default
+
+    article = { :title => 'Hello World', :by => 'John Doe' }
+
+    result_hash = rad.rad_request({ \
+      :verb => 'put',
+      :path => ['article', 1 ],
+      :body => article
+    })
+
+    # :body can be a hash or JSON string
+
+    result_hash = rad.rad_request({ \
+      :verb => 'put',
+      :path => ['article', 1 ],
+      :body => JSON.dump( article )
+    })
+
+    # :put verb can automatically be added using #rad_index method
+
+    result_has = rad.rad_index({ \
+      :path => ['article', 1 ],
+      :body => article
+    })
+
+#Documentation
+--------------
+
+This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
+
+    $ gem install yard
+    $ yard server -g
+
+#Links
+------
+
+Elasticsearch::API
+
+https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api
+
+#Copyright and License
+----------------------
+
+Elastirad © 2014 by [John Wang](mailto:johncwang@gmail.com).
+
+Elastirad is licensed under the MIT license. Please see the LICENSE document for more information.
+
+Warranty
+--------
+
+This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the JsonDoc library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+task :gendoc do
+  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+    system "yardoc"
+    system "yard stats --list-undoc"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/elastirad/client.rb

@@ -0,0 +1,128 @@
+require 'multi_json'
+require 'faraday'
+require 'elasticsearch/api'
+
+module  Elastirad
+  class Client
+    include Elasticsearch::API
+
+    def initialize(dOptions={})
+      iPort      = iPort.to_i if iPort.is_a?(String)
+      @sProtocol = dOptions.has_key?(:protocol) && dOptions[:protocol] \
+                 ? dOptions[:protocol]    : 'http'
+      @sHostname = dOptions.has_key?(:hostname) && dOptions[:hostname] \
+                 ? dOptions[:hostname]    : 'localhost'
+      @iPort     = dOptions.has_key?(:port) && dOptions[:port] \
+                 ? dOptions[:port].to_i   : 9200
+      @sIndex    = dOptions.has_key?(:index) && dOptions[:index] \
+                 ? dOptions[:index].strip : nil
+      @sUrl      = self.makeUrl(@sProtocol,@sHostname,@iPort)
+      @oFaraday  = Faraday::Connection.new url: @sUrl || 'http://localhost:9200'
+      @dVerbs    = {:put=>1,:get=>1,:post=>1,:delete=>1}
+    end
+
+    def makeUrl(sProtocol='http',sHostname='localhost',iPort=9200)
+      if sHostname.nil?
+        sHostname = 'localhost'
+      elsif sHostname.is_a?(String)
+        sHostname.strip!
+        if sHostname.length < 1
+          sHostname = 'localhost'
+        end
+      else
+        raise ArgumentError, 'E_HOSTNAME_IS_NOT_A_STRING'
+      end
+      if iPort.nil?
+        iPort = 9200
+      elsif iPort.is_a?(String) && iPort =~ /^[0-9]+$/
+        iPort = iPort.to_i
+      elsif ! iPort.kind_of?(Integer)
+        raise ArgumentError, 'E_PORT_IS_NOT_AN_INTEGER'
+      end
+      sBaseUrl   = "#{sProtocol}://#{sHostname}"
+      sBaseUrl.sub!(/\/+\s*$/,'')
+      sBaseUrl  += ':' + iPort.to_s if iPort != 80
+      return sBaseUrl
+    end
+
+    def rad_index(dEsRes={})
+      dEsRes[:verb] = :put
+      return self.request(dEsRes)
+    end
+
+    def rad_request(dEsReq={})
+      oEsRes = self.perform_request \
+        getVerbFromEsReq(dEsReq),
+        getPathFromEsReq(dEsReq),
+        nil,
+        getBodyFromEsReq(dEsReq)
+
+      dEsResBody = oEsRes.body \
+        ? MultiJson.load( oEsRes.body, :symbolize_keys => true ) : nil
+    end
+
+    def perform_request(method,path,params,body)
+      @oFaraday.run_request \
+        method.downcase.to_sym,
+        path,
+        body,
+        {'Content-Type' => 'application/json'}
+    end
+
+    private
+
+    def getVerbFromEsReq(dEsReq={})
+      sVerb = dEsReq.has_key?(:verb) ? dEsReq[:verb] : :get
+      yVerb = sVerb.downcase.to_sym
+      unless @dVerbs.has_key?( yVerb )
+        raise ArgumentError, 'E_BAD_VERB'
+      end
+      return yVerb
+    end
+
+    def getPathFromEsReq(dEsReq={})
+      aPath     = []
+      bHasIndex = false
+
+      if dEsReq.has_key?(:path)
+        if dEsReq[:path].is_a?(Array)
+          aPath.push(*dEsReq[:path])
+        elsif dEsReq[:path].is_a?(String)
+          aPath.push(dEsReq[:path])
+        end
+      else
+        if dEsReq.has_key?(:index) && dEsReq[:index].is_a?(String)
+          aPath.push(dEsReq[:index])
+          bHasIndex = true
+        end
+        if dEsReq.has_key?(:type) && dEsReq[:type].is_a?(String)
+          aPath.push(dEsReq[:type])
+        end
+        if dEsReq.has_key?(:id) && dEsReq[:id].is_a?(String)
+          aPath.push(dEsReq[:id])
+        end
+      end
+      sPath = aPath.join('/')
+      sPath.strip!
+      sPath.gsub!(/\/+/,'/')
+      if (sPath.index('/')!=0 || !bHasIndex) && ( @sIndex.is_a?(String) && @sIndex.length>0 )
+        sPath = "#{@sIndex}/#{sPath}"
+      end
+      return sPath
+    end
+
+    def getBodyFromEsReq(dEsReq={})
+      jBody = nil
+      if dEsReq.has_key?(:body)
+        if dEsReq[:body].is_a?(Hash)
+          jBody = MultiJson.dump(dEsReq[:body])
+        elsif dEsReq[:body].is_a?(String) && dEsReq[:body].length > 0
+          jBody = dEsReq[:body]
+        end
+        jBody = nil if jBody == '{}' || jBody.length < 1
+      end
+      return jBody
+    end
+
+  end
+end

data/lib/elastirad.rb

@@ -0,0 +1,3 @@
+module Elastirad
+  autoload :Client, 'elastirad/client'
+end

data/test/test_setup.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+require 'elastirad'
+
+class ElastiradTest < Test::Unit::TestCase
+  def testSetup
+
+    rad1 = Elastirad::Client.new
+
+    assert_equal 'elastirad/objects1', rad1.instance_eval{ getPathFromEsReq({:path=>"elastirad/objects1"}) }
+    assert_equal 'elastirad/objects2', rad1.instance_eval{ getPathFromEsReq({:path=>["elastirad/objects2"]}) }
+    assert_equal 'elastirad/objects3', rad1.instance_eval{ getPathFromEsReq({:path=>["elastirad/","/objects3"]}) }
+    assert_equal '{"query":{"match_all":{}}}', rad1.instance_eval{ getBodyFromEsReq({:body=>{:query=>{:match_all=>{}}}}) }
+
+    rad2 = Elastirad::Client.new(:index => 'elastirad')
+
+    assert_equal 'elastirad/objects/id', rad2.instance_eval{ getPathFromEsReq({:path=>"objects/id"}) }
+
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: elastirad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Elasticsearch client
+email: john@johnwang.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/elastirad.rb
+- lib/elastirad/client.rb
+- test/test_setup.rb
+homepage: http://johnwang.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Elastirad - a RAD Elasticsearch client supporting minimal reading of documentation
+test_files: []