esnek 0.1.2 → 0.2.0

data/CHANGES

@@ -1,9 +1,17 @@
 = Esnek Change Log
 
 == Expected
+
+== 0.2.x
+* tests with elasticsearch API
 * Authentication mechanisms
+* proxy
+
+== 0.1.x
+* first working version
+* documentation
 
-== 0.0.1
+== 0.0.x
 * the very initial release
 
 

data/README.rdoc

@@ -10,26 +10,67 @@ highly-available, real time search RESTful search engine communicating by JSON o
 
 For the installation of elasticsearch please follow the guides at http://www.elasticsearch.org
   
-== Usage:
+== Usage 
 
+=== ElasticSearch
+
+To use esnek just instantiate Esnek with the base API URL.
   require 'esnek'  
-  es = Esnek.new('http://localhost:9200',true)
-  
+  es = Esnek.new('http://localhost:9200')
+
+Make a chained method call where each method is a directory in the URL for the JSON API.Your method chain must end with get, post, put or delete.
+For example assuming elastic search is running at port 9200 on your localhost, the following code gets the state of the cluster.
+
   #curl -XGET 'http://localhost:9200/_cluster/state'
   es._cluster.state.get
 
+
+You may pass options as a hash parameter for each directory in your URL.
   #curl -XGET http://localhost:9200/twitter/tweet/_search?q=user:kimchy
   es.twitter.tweet._search(:q => 'good').get
-  
+
+For literals such as 1,  use __1; esnek simply omits __ (2 underscores)
   #curl -XGET 'http://localhost:9200/twitter/tweet/1'
   es.twitter.tweet.__1.get
 
-  #curl -XPUT http://localhost:9200/twitter/tweet/2 -d '{ "user": "kimchy", "post_date": "2009-11-15T14:12:12", "message": "You know, for Search"}'
+In order to post a JSON data simply pass a block (do...end)
+  #curl -XPUT http://localhost:9200/twitter/tweet/2 -d '{
+  # "user": "kimchy", "post_date": "2009-11-15T14:12:12", "message": "You know, for Search"
+  # }'
   es.twitter.tweet.__2.put do
     {"user" => "alper", "post_date" => "2011-11-15T14:12:12", "message" => "For esnek"}
   end
-  
+
+===  Google Translate API
+  require 'esnek'  
+  gapi = Esnek.new('https://www.googleapis.com')
+  gapi.language.translate.v2.get :q => "hello world", :source => :en, :target => :tr, :key => INSERT_YOUR_KEY
+
+===  Google URL Shortener
+  require 'esnek'  
+  gapi = Esnek.new('https://www.googleapis.com')
+  res = gapi.urlshortener.v1.url.post {{:longUrl => "http://www.sayarus.com/"}}
+  puts res.longUrl # Use res.table[:id] instead of res.id, because id method already exist for Object
+
+== Proxy
+
+Esnek will use the proxy specified by RestClient.proxy:
+
+  RestClient.proxy = "http://proxy.example.com/"
+or the proxy url is set in an environment variable   
+  RestClient.proxy = ENV['http_proxy']
+
+== Logging
+
+To enable logging you can
+
+* set RestClient.log with a ruby Logger
+* or set an environment variable to avoid modifying the code (in this case you can use a file name, "stdout" or "stderr"):
+
+   $ RESTCLIENT_LOG=stdout path/to/my/program
+   $ RESTCLIENT_LOG=stdout irb
+
+
 == Notes
 
 Esnek was initially developed using Redcar under Ubuntu Linux 10.10.
-

data/lib/esnek/base.rb

@@ -6,9 +6,8 @@ require 'ostruct'
 # highly-available, real time search RESTful search engine communicating by JSON over HTTP, based on _Lucene_ (http://lucene.apache.org). 
 class Esnek
   attr_accessor :chain, :url_root
-  def initialize(url_root, debug=false)
+  def initialize(url_root)
     @url_root = url_root
-    @debug = debug
     @chain = []
   end
 
@@ -20,18 +19,19 @@ class Esnek
       if block_given?
         data = block.call.to_json rescue nil
       end
-      if @debug
-        puts url
-        puts data.inspect 
-        puts @chain.inspect 
-      end
       @chain = []
       
-      resp = block_given? ? RestClient.send(method_sym, url, data, :params => params) :
+      resp = block_given? ? RestClient.send(method_sym, url, data,:params => params,:content_type => :json, :accept => :json) :
             RestClient.send(method_sym, url,:params => params)
             
       if resp.headers[:content_type].include?('application/json')
-        OpenStruct.new JSON.parse resp
+        r = OpenStruct.new JSON.parse resp
+        class << r
+          def table
+            @table
+          end
+        end
+        r
       else
         resp
       end

data/lib/esnek/version.rb

@@ -1 +1 @@
-ESNEK_VERSION='0.1.2'
+ESNEK_VERSION='0.2.0'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: esnek
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alper Akgun
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 Z
+date: 2011-04-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json