esnek 0.2.6 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51bd712e9e708a69ead2eb6f40485677a391f8c2
+  data.tar.gz: 4963c8831cd8c6d079ddceadcf2c5143acded2b0
+SHA512:
+  metadata.gz: cc709556d2794cf54de28aaebf388c06bf4ef69ff71c3105a45cb60418e7cef38bdd209c99c35e2d6e76d26a861dab0979ec56ccdc689982a9bc0424d2bf93d8
+  data.tar.gz: 641901f95ab9cc5400e1075fbe84e47f6e8bb9aaf163fcd23bb6c5ab1875911a66443a804133084faa328690f28251a370931225be2e2ee3c0d45139fa90ecba

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/CHANGES

@@ -2,6 +2,19 @@
 
 == Expected
 
+== 0.4.x
+* MIT License adopted
+
+== 0.4.x
+* hash post data in the block are now converted into a form post data
+* oauth support with an access token through restclient
+* json_return option controls jsonifaction of return values
+
+== 0.3.x
+* bug fixed for content type inclusions
+* custom headers are supported
+* Non Json data payloads are now supported
+
 == 0.2.x
 * tests with elasticsearch API
 * Authentication mechanisms
@@ -15,5 +28,3 @@
 == 0.0.x
 * the very initial release
 
-
-

data/Gemfile

@@ -0,0 +1,13 @@
+require './lib/esnek/version'
+RUBY_ENGINE = 'ruby' unless defined? RUBY_ENGINE
+source 'https://rubygems.org' unless ENV['QUICK']
+gemspec
+
+gem 'rake'
+if RUBY_ENGINE == "ruby" and RUBY_VERSION > '1.9.2'
+gem 'rest-client'
+gem 'json'
+gem "minitest", "~> 4.0"
+gem 'rdoc'
+end
+

data/LICENSE

@@ -1,13 +1,19 @@
-Esnek is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+Copyright (c)  Alper Akgun
 
-Esnek is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+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:
 
-You should have received a copy of the GNU General Public License
-along with Devrinim.  If not, see <http://www.gnu.org/licenses/>.
+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.rdoc

@@ -1,17 +1,34 @@
 = Esnek
 
-_Esnek_ provides a minimalistic Ruby interface for JSON  APIs, such as ElasticSearch, Google APIs, Facebook Graph API.. 
-Esnek is initially developed for _ElasticSearch_ http://www.elasticsearch.org which is based on _Lucene_ http://lucene.apache.org .
+_Esnek_ is a minimalistic client for any Web API in general and no API
+in particular. Esnek has been used in production for a few years already.
+ElasticSearch, Google APIs, Facebook Graph API, LinkedIn, Facebook,
+Twitter OAuth login integrations.
+
 
 == Installation:
 
-  gem install esnek # In april-june 2011, under development so use "gem update" frequently.
+  gem install esnek 
 
 == Quick Start
 
+===  Google URL Shortener
+  require 'esnek'  
+  gapi = Esnek.new('https://www.googleapis.com')
+  res = gapi.urlshortener.v1.url.post {{:longUrl => "http://www.resimit.com/"}}
+  # Use res.table[:id] instead of res.id, because id method already exist for Object
+  puts res.longUrl
+  puts res.inspect
+
+===  Facebook Graph API
+  require 'esnek'  
+  fb = Esnek.new('http://graph.facebook.com')
+  res = fb.send(:"http://www.resimit.com").get
+  # Notice that since "http://www.resimit.com" is a complex ruby method name, we use "send" to call it
+  puts res.shares
+
 === ElasticSearch
 
-To install ElasticSearch please follow the guides at http://www.elasticsearch.org.
 To use esnek just instantiate Esnek with the base API URL. 
   require 'esnek'  
   es = Esnek.new('http://localhost:9200')
@@ -37,23 +54,6 @@ In order to post a JSON data simply pass a block (do...end) which returns a hash
     {"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
-
-===  Facebook Graph API
-  require 'esnek'  
-  fb = Esnek.new('http://graph.facebook.com')
-  res = fb.send(:"http://www.wsirussia.ru").get
-Notice that since "http://www.wsirussia.ru" is an invalid ruby method name, we use "send" to call it
-  puts res.shares
 
 == Advanced
 With Esnek you make a chained method call where each method is a directory in the URL 
@@ -88,7 +88,8 @@ If you append a block and the block returns a hash, the hash is converted into a
   end
 
 === Return Values
-Esnek converts the returned JSON into an Ostruct object.
+Esnek converts the returned JSON into an Ostruct object. You may use
+the returned object's inspect method to see how it works for a given API.
   
   res.my_field # access as if it is an object's attrribute
   res.table[:my_field]  # For field names such as "id", you may use the "table" attribute.
@@ -113,4 +114,5 @@ variable to avoid modifying the code (in this case you can use a file name, "std
 
 == Notes
 
-Esnek was initially developed using Redcar under Ubuntu Linux 10.10.
+Esnek was initially developed using Emacs under Ubuntu Linux. 
+

data/Rakefile

@@ -1,28 +1,8 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esnek/version'
 require 'rake/testtask'
-require './lib/esnek/version'
-
-
-spec = eval(File.read('esnek.gemspec'))
-    
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = false
-  p.need_zip = false
-end
-
-Rake::RDocTask.new do |rdoc|
-  files =['README.rdoc', 'LICENSE','CHANGES', 'AUTHORS', 'lib/**/*.rb', 'test/**/*.rb']
-  rdoc.rdoc_files.add(files)
-  rdoc.main = "README"
-  rdoc.title = "Esnek Documentation"
-  rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.options
-end
+require "bundler/gem_tasks"
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*.rb']

data/esnek.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esnek/version'
+
+Gem::Specification.new do |s|
+  s.name = 'esnek'
+  s.version = ESNEK_VERSION
+  #s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc', 'LICENSE','CHANGES','AUTHORS']
+  s.summary = 'Esnek provides a minimalistic Ruby interface for JSON  APIs, such as ElasticSearch'
+  s.description = s.summary
+  s.authors = ['Alper Akgun']
+  s.email = 'esnek@sayarus.com'
+  s.homepage = "https://github.com/sayarus/esnek"
+  s.license       = "MIT"
+  s.files = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.bindir = "bin"
+  s.add_dependency("json", ">= 1.4")
+  s.add_dependency("rest-client", ">= 1.6.1")
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake", "~> 10.0"
+end
+
+
+
+
+
+

data/lib/esnek/base.rb

@@ -1,14 +1,21 @@
 require 'rest_client'
 require 'json'
-require 'ostruct'
 
 # _Esnek_ provides a quick Ruby interface for JSON  APIs, such as _ElasticSearch_ (http://www.elasticsearch.org); a scalable, fast, distributed, 
 # 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)
-    @url_root = url_root
-    @chain = []
+  #attr_accessor :esnek_chain, :esnek_url_root, :esnek_params, :esnek_url
+  def initialize(esnek_url_root,options={:json_api=>true,:json_return=>true, :header=>{}})
+    @esnek_url_root = esnek_url_root
+    @esnek_chain = []
+    @json_api = options[:json_api].nil? ? true : options[:json_api]
+    @json_return = options[:json_return].nil? ? @json_api : options[:json_return]
+    @header= options[:header] || {}
+    if options[:oauth] # Esnek assumes that oauth ruby gem is installed
+      options[:oauth][:scheme] ||= :header
+      consumer = OAuth::Consumer.new(options[:oauth][:consumer_key],options[:oauth][:consumer_secret], {:site => options[:oauth][:site], :scheme => options[:oauth][:scheme]})
+      @access_token = OAuth::AccessToken.from_hash(consumer, {:oauth_token => options[:oauth][:oauth_token], :oauth_token_secret => options[:oauth][:oauth_token_secret]} )
+    end
   end
 
   def parse_json(resp)
@@ -19,39 +26,64 @@ class Esnek
       class << r;def table;@table;end;end
       r
     when j.is_a?(Array)
-      j.map{|e| r=OpenStruct.new(e);class << r;def table;@table;end;end;r}
+      j.map{|e| r= if e.is_a?(Hash)
+        OpenStruct.new(e)
+        class<<r;def table;@table;end;end;
+        else
+          e
+        end        
+        r}
     else
       j
     end
   end
   def method_missing(method_sym, *args, &block)
-    if [:get, :put, :post, :delete].include?(method_sym)
-      @chain << {:method => nil, :arg => (args.empty? ? {} : args[0]) }
-      url = @url_root.gsub(/\/$/,'') + '/' + @chain.map{|e| e[:method]}.compact.join('/')
-      params = @chain.inject({}){|s,e| s.merge!(e[:arg] || {}) if e[:arg].is_a?(Hash)}
-      if block_given?
-        data = block.call.to_json rescue nil
+    if [:get, :put, :post, :delete, :patch, :head].include?(method_sym)
+      @esnek_chain << {:method => nil, :arg => (args.empty? ? {} : args[0]) }
+      @esnek_url = @esnek_url_root.gsub(/\/$/,'') + '/' + @esnek_chain.map{|e| e[:method]}.compact.join('/')
+      @esnek_params = @esnek_chain.inject({}){|s,e| s.merge!(e[:arg] || {}) if e[:arg].is_a?(Hash)}
+      @esnek_chain = []
+      heades = {:params => @esnek_params}.merge(@header)
+      data = block_given? ? block.call : nil #rescue nil
+
+      # if a JSON api is set in initializer both the payload data and the result will be un/jsonized
+      if @json_api
+        heades.merge!({:content_type => :json, :accept => :json})
+        data = data.to_json if data #rescue nil
+      elsif data.is_a? Hash
+        data = data.map{|k,v| "#{CGI::escape(k)}=#{CGI::escape(v)}"}.join('&')
+      end
+      # if a oauth token exist, use it; unfortunately restclient does not allow a proper
+      RestClient.reset_before_execution_procs
+      RestClient.add_before_execution_proc do |req, par|
+        @access_token.sign! req
+      end if @access_token
+      resp =  if [:put, :post,:patch].include?(method_sym)                
+                RestClient.send(method_sym, @esnek_url, data, heades)
+              else
+                RestClient.send(method_sym, @esnek_url, heades)
+              end
+      
+      if @json_return
+        parse_json(resp)
+      else
+        resp
       end
-      @chain = []      
-      resp = block_given? ? RestClient.send(method_sym, url, data,:params => params,:content_type => :json, :accept => :json) :
-            RestClient.send(method_sym, url,:params => params,:content_type => :json, :accept => :json)
-            
-      resp.headers[:content_type].include?('application/json') ? parse_json(resp) : resp
     else      
-      @chain << {:method => method_sym.to_s.gsub(/^__/,''), :arg => (args.empty? ? {} : args[0]) }
+      @esnek_chain << {:method => method_sym.to_s.gsub(/^__/,''), :arg => (args.empty? ? {} : args[0]) }
       self
     end
   rescue
-    @chain = []
+    @esnek_chain = []
     raise $!
   end
-    
+  
   def respond_to?(method_sym)
-    if [:get, :put, :post, :delete].include?(method_sym)
+    if [:head,:get, :put, :post,:patch, :delete].include?(method_sym)
       true
     else
       super
     end
   end
-    
-end
+  
+end

data/lib/esnek/version.rb

@@ -1 +1 @@
-ESNEK_VERSION='0.2.6'
+ESNEK_VERSION='0.5.0'

data/test/base.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'rubygems'
+require './lib/esnek'
+require 'minitest/autorun'
+
+describe Esnek do
+  before do      
+  end
+
+  describe "When I query Google URL Shortener API" do
+   it "should return a shortened URL" do
+     gapi = Esnek.new('https://www.googleapis.com')
+     res = gapi.urlshortener.v1.url.post {{:longUrl => "http://www.resimit.com/"}}
+     puts res.inspect
+   end
+  end 
+
+  describe "When I query Facebook graph API to count the # of shares of url" do
+    it "should return an object which responds to :shares" do
+      fb = Esnek.new('http://graph.facebook.com')
+      res = fb.send(:"http://www.resimit.com").get
+      assert res.respond_to?(:shares)
+      puts res.inspect
+    end
+  end
+
+end

metadata

@@ -1,106 +1,117 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: esnek
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 6
-  version: 0.2.6
+version: !ruby/object:Gem::Version
+  version: 0.5.0
 platform: ruby
-authors: 
+authors:
 - Alper Akgun
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 6
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.6.1
   type: :runtime
-  version_requirements: *id002
-description: Esnek provides a minimalistic Ruby interface for JSON  APIs, such as ElasticSearch
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Esnek provides a minimalistic Ruby interface for JSON  APIs, such as
+  ElasticSearch
 email: esnek@sayarus.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - LICENSE
 - CHANGES
 - AUTHORS
-files: 
+files:
+- ".gitignore"
+- AUTHORS
+- CHANGES
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- AUTHORS
-- CHANGES
+- esnek.gemspec
+- lib/esnek.rb
 - lib/esnek/base.rb
 - lib/esnek/version.rb
-- lib/esnek.rb
+- test/base.rb
 homepage: https://github.com/sayarus/esnek
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Esnek provides a minimalistic Ruby interface for JSON  APIs, such as ElasticSearch
-test_files: []
-
+test_files:
+- test/base.rb