cryx-g5k 0.1.0

data/lib/g5k/parsing/parser.rb

@@ -0,0 +1,47 @@
+module G5K
+  module Parsing
+    class UnsupportedFormat < StandardError; end
+    class Parser      
+      @@parsers = []
+      def self.add(*parsers)
+        parsers.each{ |parser| 
+          parser.dependencies
+          @@parsers << parser
+        }
+        self
+      end
+      def self.select(parser_format)
+        raise UnsupportedFormat, "The format cannot be nil." if parser_format.nil?
+        parsers = @@parsers.select{|parser| parser.supported_formats.include?(parser_format.to_sym)}
+        if parsers.empty?
+          raise UnsupportedFormat, "No parser found for '#{parser_format}' format."
+        else
+          parsers.first
+        end
+      end
+      def self.available_parsers; @@parsers; end
+    end
+
+    class JSONParser
+      def self.dependencies
+        require 'json'
+      end      
+      def self.supported_formats
+        [:json]
+      end
+      def self.dump(object, options = {:format => :pretty})
+        case options[:format]
+        when :pretty
+          JSON.pretty_generate object
+        else
+          object.to_json
+        end
+      end
+      def self.load(object)
+        JSON.parse(object)
+      end
+    end
+
+    # Parser.add(JSONParser)
+  end
+end

data/lib/g5k/parsing.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__)+'/parsing/parser.rb'
+
+module G5K
+  module Parsing
+    VERSION = 0.1
+  end
+end

data/lib/g5k/rack/accept_format.rb

@@ -0,0 +1,46 @@
+module G5K
+  module Rack
+    #
+    # A Rack middleware for automatically adding a <tt>format</tt> token at the end of the request path
+    # when there is none. It can detect formats passed in the HTTP_ACCEPT header to populate this token.
+    # 
+    # e.g.:
+    #   GET /some/resource HTTP/1.1
+    #   Accept: application/json
+    # -> 
+    #   GET /some/resource.json HTTP/1.1
+    #   Accept: application/json
+    # 
+    # You can add custom types with this kind of function (taken from sinatra):
+    #   def mime(ext, type)
+    #     ext = ".#{ext}" unless ext.to_s[0] == ?.
+    #     Rack::Mime::MIME_TYPES[ext.to_s] = type
+    #   end
+    # and then:
+    #   mime :json, 'application/json'
+    #
+    # Note: it does not take into account multiple media types in the Accept header.
+    # The first media type takes precedence over all the others.
+    #
+    # MIT-License - Cyril Rohr
+    #
+    class AcceptFormat
+      # Constants
+      DEFAULT_EXTENSION = ".html"
+
+      def initialize(app)
+        @app = app
+      end
+    
+      def call(env)
+        req = Rack::Request.new(env)
+        unless req.path_info =~ /(.*)\.(.+)/
+          accept = env['HTTP_ACCEPT'].scan(/[^;,\s]*\/[^;,\s]*/)[0] rescue ""
+          extension =  Rack::Mime::MIME_TYPES.invert[accept] || DEFAULT_EXTENSION
+          req.path_info = req.path_info+"#{extension}"
+        end
+        @app.call(env)
+      end    
+    end
+  end
+end

data/lib/g5k/rack/jsonp.rb

@@ -0,0 +1,43 @@
+module G5K
+  module Rack
+  
+    # A Rack middleware for providing JSON-P support.
+    # 
+    # Full credit to Flinn Mueller (http://actsasflinn.com/) for this contribution.
+    # 
+    class JSONP
+    
+      def initialize(app)
+        @app = app
+      end
+    
+      # Proxies the request to the application, stripping out the JSON-P callback
+      # method and padding the response with the appropriate callback format.
+      # 
+      # Changes nothing if no <tt>callback</tt> param is specified.
+      # 
+      def call(env)
+        status, headers, response = @app.call(env)
+        request = Rack::Request.new(env)
+        if request.params.include?('callback')
+          response = pad(request.params.delete('callback'), response)
+          headers['Content-Length'] = response.length.to_s
+        end
+        [status, headers, response]
+      end
+    
+      # Pads the response with the appropriate callback format according to the
+      # JSON-P spec/requirements.
+      # 
+      # The Rack response spec indicates that it should be enumerable. The method
+      # of combining all of the data into a single string makes sense since JSON
+      # is returned as a full string.
+      # 
+      def pad(callback, response, body = "")
+        response.each{ |s| body << s }
+        "#{callback}(#{body})"
+      end
+    
+    end
+  end
+end

data/lib/g5k/sinatra/helpers.rb

@@ -0,0 +1,32 @@
+module G5K
+  module Sinatra
+    module Helpers
+      def returning(thing = nil)
+        yield thing
+        thing
+      end
+
+      def provides *formats
+        if params[:format].nil? || !formats.include?(params[:format].to_sym)
+          throw :halt, [406, "The accepted types are: #{formats.join(", ")}"]
+        end
+      end
+
+      def formatted_error(http_status, options = {})
+        body = {:code => (options[:code] || http_status), :message => options[:message], :title => options[:title]}
+        format = options[:format] || params[:format] || "txt"
+        content_type format.to_sym, :charset => 'utf-8'
+        if (parser = Parser.select(format.to_sym))
+          body = parser.dump(body)
+        else
+          body.map!{|(k,v)| [k,v].join("=")}.join(";")
+        end
+        error(http_status, body)
+      end
+
+      def compute_etag(*differentiators)
+        Digest::SHA1.hexdigest(differentiators.join("."))
+      end
+    end
+  end
+end

data/lib/g5k.rb

@@ -0,0 +1,5 @@
+# Subdirs are not automatically loaded. Users must explicitly require them.
+
+module G5K
+  
+end

data/spec/g5k_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "G5k" do
+end

data/spec/parsing_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/g5k/parsing'
+
+include G5K::Parsing
+describe "Parsing" do
+  before do
+    require 'rubygems'
+  end
+  it "should add the json parser" do
+    Parser.add(JSONParser).available_parsers.should include(JSONParser)
+  end
+  it "should return an error if a parser is not available for the required format" do
+    Parser.add(JSONParser)
+    lambda{Parser.select(:xml)}.should raise_error(UnsupportedFormat)
+  end
+  it "should raise an UnsupportedFormat if the given format is nil" do
+    lambda{Parser.select(nil)}.should raise_error(UnsupportedFormat)    
+  end
+  it "should select the parser for the given format, if made available" do
+    Parser.add(JSONParser)
+    Parser.select(:json).should == JSONParser
+  end
+end
+
+describe JSONParser do
+  before do
+    require 'rubygems'
+  end
+  it "should successfully parse a json object" do
+    object = {'a' => 1, 'b' => {'c' => 2, 'd' => [3]}}
+    JSONParser.load(object.to_json).should == object
+  end
+  it "should pretty generate an object" do
+    object = {'a' => 1, 'b' => {'c' => 2, 'd' => [3]}}
+    JSON.should_receive(:pretty_generate).with(object)
+    JSONParser.dump(object, :format => :pretty)
+  end
+  it "should not pretty generate an object" do
+    object = {'a' => 1, 'b' => {'c' => 2, 'd' => [3]}}
+    JSON.should_not_receive(:pretty_generate).with(object)
+    object.should_receive(:to_json)
+    JSONParser.dump(object, :format => :raw)    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require File.dirname(__FILE__) + '/../lib/g5k'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: cryx-g5k
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cyril Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-02 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Collection of tools and libs for Grid5000 APIs.
+email: cyril.rohr@irisa.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/g5k
+- lib/g5k/parsing
+- lib/g5k/parsing/parser.rb
+- lib/g5k/parsing.rb
+- lib/g5k/rack
+- lib/g5k/rack/accept_format.rb
+- lib/g5k/rack/jsonp.rb
+- lib/g5k/schema
+- lib/g5k/sinatra
+- lib/g5k/sinatra/helpers.rb
+- lib/g5k.rb
+- spec/g5k_spec.rb
+- spec/parsing_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/cryx/g5k
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+