elastirad 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95156251835b98cdd37c6609f5e11e3c22fc5887
-  data.tar.gz: 607df84376fee0048434528edc0222b1286bdda5
+  metadata.gz: c9bd90ba9cbdee2c0331b5e08ff23ccdd98e6d50
+  data.tar.gz: a4c2ed447639e22bf299fe80f33b10276448b3ab
 SHA512:
-  metadata.gz: 64ff790b4f28a2253228e13f36a5dd21703486c361abf5b62c4e9873ccf2bf6407900329e502595c463ae81a8b827a693b2c6aa16f0428f6e55e5343c92a416d
-  data.tar.gz: 50c43595c370835210c2e232fbc7069ffec012d047a9fb0cfad0b6bd4680a3c2c2d22b46867d64fb2260c1be7c9b907c54392182f8c982e06683e5a04bb1b453
+  metadata.gz: 10de492cfab17e226675a470a1c9517b5b16ee7e9dc94e375609b59ef4ad14519d33677a39a428e7c992b4c890e55955a97d03d35af55b67ef4368d339bd41e2
+  data.tar.gz: ba547d13f45ffff8603de449002ddd7fcb9ea0052a9b5b3567216536112252ebd21cfb6bd15e63280ea108372faed6f44e7efdcf876dc838ce63631990ad5770

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 CHANGELOG
 ---------
+- **2014-03-15**: 0.0.2
+  - Fix bug in #rad_index
+  - Fix bug for YARD README.md formatting
+  - Add documentation of Elasticsearch::API mixin functionality
+  - Add CHANGELOG.md excerpt to README.md
+
 - **2014-03-14**: 0.0.1
   - Initial release

data/README.md

@@ -4,7 +4,7 @@ Elastirad: A RAD Client for Elasticsearch
 Synopsis
 --------
 
-Elastirad is a custom rapid application development (RAD) client for
+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.
 
@@ -12,12 +12,15 @@ 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.
 
+Elastirad::Client embeds the Elasticsearch::API and thus supports
+Elasticsearch::API methods.
+
 Installing
 ----------
 
 Download and install elastirad with the following:
 
-  gem install elastirad
+    gem install elastirad
 
 #Examples
 ---------
@@ -77,6 +80,12 @@ Download and install elastirad with the following:
       :body => article
     })
 
+    # Supports Elasticsearch::API methods
+
+    p rad.cluster.health
+    # --> GET _cluster/health {}
+    # => "{"cluster_name":"elasticsearch" ... }"
+
 #Documentation
 --------------
 
@@ -85,10 +94,26 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
     $ gem install yard
     $ yard server -g
 
+#Change Log
+-----------
+
+- **2014-03-15**: 0.0.2
+  - Fix bug in #rad_index
+  - Fix bug for YARD README.md formatting
+  - Add documentation of Elasticsearch::API mixin functionality
+  - Add CHANGELOG.md excerpt to README.md
+- **2014-03-14**: 0.0.1
+  - Initial release
+  - Custom Elasticsearch::API mixin client
+
 #Links
 ------
 
-Elasticsearch::API
+Elasticseach Reference Guide
+
+http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index.html
+
+Elasticsearch::API for Ruby
 
 https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api
 

data/lib/elastirad/client.rb

@@ -16,38 +16,14 @@ module  Elastirad
                  ? dOptions[:port].to_i   : 9200
       @sIndex    = dOptions.has_key?(:index) && dOptions[:index] \
                  ? dOptions[:index].strip : nil
-      @sUrl      = self.makeUrl(@sProtocol,@sHostname,@iPort)
+      @sUrl      = 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)
+      return self.rad_request(dEsRes)
     end
 
     def rad_request(dEsReq={})
@@ -58,7 +34,7 @@ module  Elastirad
         getBodyFromEsReq(dEsReq)
 
       dEsResBody = oEsRes.body \
-        ? MultiJson.load( oEsRes.body, :symbolize_keys => true ) : nil
+        ? MultiJson.decode( oEsRes.body, :symbolize_keys => true ) : nil
     end
 
     def perform_request(method,path,params,body)
@@ -71,6 +47,30 @@ module  Elastirad
 
     private
 
+    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 getVerbFromEsReq(dEsReq={})
       sVerb = dEsReq.has_key?(:verb) ? dEsReq[:verb] : :get
       yVerb = sVerb.downcase.to_sym
@@ -115,7 +115,7 @@ module  Elastirad
       jBody = nil
       if dEsReq.has_key?(:body)
         if dEsReq[:body].is_a?(Hash)
-          jBody = MultiJson.dump(dEsReq[:body])
+          jBody = MultiJson.encode(dEsReq[:body])
         elsif dEsReq[:body].is_a?(String) && dEsReq[:body].length > 0
           jBody = dEsReq[:body]
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastirad
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -70,7 +70,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple Elasticsearch client
+description: A RAD (Rapid Application Development) Elasticsearch client
 email: john@johnwang.com
 executables: []
 extensions: []