rufus-jig 0.1.0

data/lib/rufus/jig/http.rb

@@ -0,0 +1,351 @@
+#--
+# Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+require 'uri'
+
+require 'rufus/lru' # gem install rufus-lru
+
+require 'rufus/jig/path'
+
+
+module Rufus::Jig
+
+  # The classical helper method, does a full copy of the given object.
+  # Thanks Marshal.
+  #
+  def self.marshal_copy (o)
+
+    Marshal.load(Marshal.dump(o))
+  end
+
+  # Keeping track of the HTTP status code and of the error message.
+  #
+  class HttpError < RuntimeError
+
+    attr_reader :status
+
+    def initialize (status, message)
+
+      @status = status
+      super(message)
+    end
+  end
+
+  # The base for the Rufus::Jig::Http class.
+  #
+  class HttpCore
+
+    # mostly for debugging purposes
+    #
+    attr_reader :last_response
+
+    # the path => [ etag, decoded_body] client cache
+    #
+    attr_reader :cache
+
+    # the options for the http client
+    #
+    attr_reader :options
+
+    # host and port, vanilla
+    #
+    attr_reader :host, :port
+
+    # The class of the error that should be raised when a request is not 2xx.
+    #
+    attr_accessor :error_class
+
+    def initialize (host, port, opts)
+
+      @host = host
+      @port = port
+      @options = opts
+
+      @cache = LruHash.new((opts[:cache_size] || 35).to_i)
+
+      if pf = @options[:prefix]
+        @options[:prefix] = "/#{pf}" if (not pf.match(/^\//))
+      end
+
+      @error_class = opts[:error_class] || HttpError
+    end
+
+    def get (path, opts={})
+
+      request(:get, path, nil, opts)
+    end
+
+    def post (path, data, opts={})
+
+      request(:post, path, data, opts)
+    end
+
+    def put (path, data, opts={})
+
+      request(:put, path, data, opts)
+    end
+
+    def delete (path, opts={})
+
+      request(:delete, path, nil, opts)
+    end
+
+    protected
+
+    def from_cache (path, opts)
+
+      if et = opts[:etag]
+
+        cached = @cache[path]
+
+        if cached && cached.first != et
+          #
+          # cached version is perhaps stale
+          #
+          cached = nil
+          opts.delete(:etag)
+        end
+
+        cached
+
+      else
+
+        nil
+      end
+    end
+
+    def request (method, path, data, opts={})
+
+      raw = raw_expected?(opts)
+
+      path = add_prefix(path, opts)
+      path = add_params(path, opts)
+
+      cached = from_cache(path, opts)
+      opts.delete(:etag) if not cached
+
+      opts = rehash_options(opts)
+      data = repack_data(data, opts)
+
+      r = send("do_#{method}", path, data, opts)
+
+      @last_response = r
+
+      unless raw
+
+        return Rufus::Jig.marshal_copy(cached.last) if r.status == 304
+        return nil if method == :get && r.status == 404
+
+        raise @error_class.new(r.status, r.body) \
+          if r.status >= 400 && r.status < 600
+      end
+
+      b = decode_body(r, opts)
+
+      do_cache(method, path, r, b, opts)
+
+      raw ? r : b
+    end
+
+    def raw_expected? (opts)
+
+      raw = opts[:raw]
+
+      raw == false ? false : raw || @options[:raw]
+    end
+
+    # Should work with GET and POST/PUT options
+    #
+    def rehash_options (opts)
+
+      opts['Accept'] ||= (opts.delete(:accept) || 'application/json')
+
+      if ct = opts.delete(:content_type)
+        opts['Content-Type'] = ct
+      end
+      if opts['Content-Type'] == :json
+        opts['Content-Type'] = 'application/json'
+      end
+
+      if et = opts.delete(:etag)
+        opts['If-None-Match'] = et
+      end
+
+      opts
+    end
+
+    def add_prefix (path, opts)
+
+      elts = [ path ]
+
+      if path.match(/^[^\/]/) && prefix = @options[:prefix]
+        elts.unshift(prefix)
+      end
+
+      Path.join(*elts)
+    end
+
+    def add_params (path, opts)
+
+      if params = opts[:params]
+
+        return path if params.empty?
+
+        params = params.inject([]) { |a, (k, v)|
+          a << "#{k}=#{v}"; a
+        }.join("&")
+
+        return path.index('?') ? "#{path}&#{params}" : "#{path}?#{params}"
+      end
+
+      path
+    end
+
+    def repack_data (data, opts)
+
+      return data if data.nil? || data.is_a?(String)
+
+      return Rufus::Jig::Json.encode(data) \
+        if (opts['Content-Type'] || '').match(/^application\/json/)
+
+      data.to_s
+    end
+
+    def do_cache (method, path, response, body, opts)
+
+      if method == :delete || (opts[:cache] == false)
+        @cache.delete(path)
+      elsif et = response.headers['Etag']
+        @cache[path] = [ et, Rufus::Jig.marshal_copy(body) ]
+      end
+    end
+
+    def decode_body (response, opts)
+
+      b = response.body
+      ct = response.headers['Content-Type']
+
+      if ct && ct.match(/^application\/json/)
+        Rufus::Jig::Json.decode(b)
+      else
+        b
+      end
+    end
+  end
+end
+
+
+if defined?(Patron) # gem install patron
+
+  class Rufus::Jig::Http < Rufus::Jig::HttpCore
+
+    def initialize (host, port, opts={})
+
+      super(host, port, opts)
+
+      @patron = Patron::Session.new
+      @patron.base_url = "#{host}:#{port}"
+
+      @patron.headers['User-Agent'] =
+        opts[:user_agent] || "#{self.class} #{Rufus::Jig::VERSION}"
+    end
+
+    protected
+
+    def do_get (path, data, opts)
+
+      @patron.get(path, opts)
+    end
+
+    def do_post (path, data, opts)
+
+      @patron.post(path, data, opts)
+    end
+
+    def do_put (path, data, opts)
+
+      @patron.put(path, data, opts)
+    end
+
+    def do_delete (path, data, opts)
+
+      @patron.delete(path, opts)
+    end
+  end
+
+else
+
+  # TODO : use Net:HTTP
+
+  raise "alternative to Patron not yet integrated :(  gem install patron"
+
+end
+
+#--
+#
+# re-opening the HTTP class to add some class methods
+#
+#++
+class Rufus::Jig::Http
+
+  # Makes sense of arguments and extract an array that goes like
+  # [ http, path, payload, opts ].
+  #
+  # Typical input :
+  #
+  #   a = Rufus::Jig::Http.extract_http(false, 'http://127.0.0.1:5984')
+  #   a = Rufus::Jig::Http.extract_http(false, '127.0.0.1', 5984, '/')
+  #   a = Rufus::Jig::Http.extract_http(true, 'http://127.0.0.1:5984', :payload)
+  #
+  def self.extract_http (payload_expected, *args)
+
+    http = case args.first
+
+      when Rufus::Jig::Http
+        args.shift
+
+      when /^http:\/\//
+        u = URI.parse(args.shift)
+        args.unshift(u.path)
+        Rufus::Jig::Http.new(u.host, u.port)
+
+      else
+        Rufus::Jig::Http.new(args.shift, args.shift)
+    end
+
+    path = args.shift
+    path = '/' if path == ''
+
+    payload = payload_expected ? args.shift : nil
+
+    opts = args.shift || {}
+
+    raise(
+      ArgumentError.new("option Hash expected, not #{opts.inspect}")
+    ) unless opts.is_a?(Hash)
+
+    [ http, path, payload, opts ]
+  end
+end
+

data/lib/rufus/jig/json.rb

@@ -0,0 +1,93 @@
+#--
+# Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::Jig
+
+  #
+  # Dealing with multiple JSON libs. Favours yajl-ruby.
+  #
+  # Lifted from http://github.com/jmettraux/ruote
+  #
+  module Json
+
+    # The JSON / JSON pure decoder
+    #
+    JSON = [
+      lambda { |o| o.to_json },
+      lambda { |s| ::JSON.parse(s) }
+    ]
+
+    # The Rails ActiveSupport::JSON decoder
+    #
+    ACTIVE_SUPPORT = [
+      lambda { |o| o.to_json },
+      lambda { |s| ActiveSupport::JSON.decode(s) }
+    ]
+
+    # http://github.com/brianmario/yajl-ruby/
+    #
+    YAJL = [
+      lambda { |o| Yajl::Encoder.encode(o) },
+      lambda { |s| Yajl::Parser.parse(s) }
+    ]
+
+    # The "raise an exception because there's no backend" backend
+    #
+    NONE = [ lambda { |s| raise 'no JSON backend found' } ] * 2
+
+    @backend = if defined?(::Yajl)
+      YAJL
+    elsif defined?(::JSON)
+      JSON
+    elsif defined?(ActiveSupport::JSON)
+      ACTIVE_SUPPORT
+    else
+      NONE
+    end
+
+    # Forces a decoder JSON/ACTIVE_SUPPORT or any lambda pair that knows
+    # how to deal with JSON.
+    #
+    def self.backend= (b)
+
+      @backend = b
+    end
+
+    # Encodes the given object to JSON.
+    #
+    def self.encode (o)
+
+      @backend[0].call(o)
+    end
+
+    # Decodes the given JSON string.
+    #
+    def self.decode (s)
+
+      @backend[1].call(s)
+    end
+  end
+end
+

data/lib/rufus/jig/path.rb

@@ -0,0 +1,99 @@
+#--
+# Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::Jig
+
+  #
+  # Some helper methods for URI paths.
+  #
+  module Path
+
+    # Given a path and a hash of options, ...
+    #
+    #   p Rufus::Jig::Path.add_params('/toto', :q => 'nada')
+    #     # => "/toto?q=nada"
+    #
+    #   p Rufus::Jig::Path.add_params('/toto?rev=2', :q => 'nada')
+    #     # => "/toto?rev=2&q=nada"
+    #
+    #   p Rufus::Jig::Path.add_params('/toto', :q => 'nada', 'x' => 2)
+    #     # => "/toto?q=nada&x=2"
+    #
+    def self.add_params (path, h)
+
+      params = h.collect { |k, v| "#{k}=#{v}" }.join('&')
+
+      sep = path.index('?') ? '&' : '?'
+
+      params.length > 0 ? "#{path}#{sep}#{params}" : path
+    end
+
+    # Joins paths into a '/' prefixed path.
+    #
+    #   p Rufus::Jig::Path.join('division', 'customer', :restricted => true)
+    #     # => '/division/customer?restricted=true'
+    #
+    def self.join (*elts)
+
+      elts, params = if elts.last.is_a?(Hash)
+        [ elts[0..-2], elts.last ]
+      else
+        [ elts, {} ]
+      end
+
+      r = elts.collect { |e|
+
+        e = to_path(e)
+
+        if m = e.match(/^(.*)\/$/)
+          m[1]
+        else
+          e
+        end
+      }.join
+
+      add_params(r, params)
+    end
+
+    # Makes sure there is a forward slash in the given string.
+    #
+    def self.to_path (s)
+
+      s.match(/^\//) ? s : "/#{s}"
+    end
+
+    # Removes any forward slashes at the beginning of the given string.
+    #
+    def self.to_name (s)
+
+      if m = s.match(/^\/+(.+)$/)
+        m[1]
+      else
+        s
+      end
+    end
+  end
+end
+

data/lib/rufus/jig.rb

@@ -0,0 +1,38 @@
+#--
+# Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Rufus
+module Jig
+
+  require 'rufus/jig/http'
+  require 'rufus/jig/json'
+
+  VERSION = '0.0.1'
+
+  autoload :Couch, 'rufus/jig/couch'
+  autoload :CouchError, 'rufus/jig/couch'
+end
+end
+

data/lib/rufus-jig.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/jig'
+

data/put.txt

@@ -0,0 +1,25 @@
+
+$ curl -vX PUT 'http://localhost:5984/nada/doc3' -d '{"ok":"surf"}'
+* About to connect() to localhost port 5984 (#0)
+*   Trying 127.0.0.1... connected
+* Connected to localhost (127.0.0.1) port 5984 (#0)
+> PUT /nada/doc3 HTTP/1.1
+> User-Agent: curl/7.19.6 (i386-apple-darwin10.0.0) libcurl/7.19.6 zlib/1.2.3
+> Host: localhost:5984
+> Accept: */*
+> Content-Length: 13
+> Content-Type: application/x-www-form-urlencoded
+> 
+< HTTP/1.1 201 Created
+< Server: CouchDB/0.10.0 (Erlang OTP/R13B)
+< Location: http://localhost:5984/nada/doc3
+< Etag: "1-34de3386a65dc370c7989ec08155a4d2"
+< Date: Sun, 01 Nov 2009 05:43:35 GMT
+< Content-Type: text/plain;charset=utf-8
+< Content-Length: 67
+< Cache-Control: must-revalidate
+< 
+{"ok":true,"id":"doc3","rev":"1-34de3386a65dc370c7989ec08155a4d2"}
+* Connection #0 to host localhost left intact
+* Closing connection #0
+

data/test/test.rb

@@ -0,0 +1,28 @@
+
+#
+# testing rufus-jig
+#
+# Sat Oct 31 22:44:08 JST 2009
+#
+
+def load_tests (prefix)
+
+  dp = File.dirname(__FILE__)
+
+  Dir.new(dp).entries.select { |e|
+    e.match(/^#{prefix}\_.*\.rb$/)
+  }.sort.each { |e|
+    load("#{dp}/#{e}")
+  }
+end
+
+set = if ARGV.include?('--all')
+  %w[ ut ct ]
+elsif ARGV.include?('--couch')
+  %w[ ct ]
+else
+  %w[ ut ]
+end
+
+set.each { |prefix| load_tests(prefix) }
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rufus-jig
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-09 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: "\n    Json Internet Get.\n\n    An HTTP client, greedy with JSON content, GETting conditionally.\n\n    Uses Patron and Yajl-ruby whenever possible.\n  "
+email: jmettraux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.txt
+- CREDITS.txt
+- LICENSE.txt
+files: 
+- lib/rufus/jig/couch.rb
+- lib/rufus/jig/http.rb
+- lib/rufus/jig/json.rb
+- lib/rufus/jig/path.rb
+- lib/rufus/jig.rb
+- lib/rufus-jig.rb
+- CHANGELOG.txt
+- CREDITS.txt
+- LICENSE.txt
+- TODO.txt
+- delete.txt
+- put.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jmettraux/rufus-jig
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rufus
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An HTTP client, greedy with JSON content, GETting conditionally.
+test_files: 
+- test/test.rb