xenon-routing 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 385808aff014a3ce0b190e485996e21566ba4a96
-  data.tar.gz: 8230baa459671431db3a9728b1df184606b2a8d2
+  metadata.gz: cb288967fc9c8037e293c38a4a2c2a79d8b041eb
+  data.tar.gz: 0909342647be6e9b87b7c93798807bcea0616342
 SHA512:
-  metadata.gz: b902c768fb0dc9dfec74cef1426a1fb7eef41c5be1be85717d60d16918282a2c1fbe6ee4d8f1763f01fcb1efd6df76c8b36f295183ee10e3a0554bd1cf461508
-  data.tar.gz: fdbeec5753727366d84cf827456c09f68ee3a6d55a4cd2375fc23418ca79cf5fc5423c7952d7962a20aa12480b66b01e2234713eead71768981790e6d40d59d3
+  metadata.gz: d2fbf928ab206470ec7e41d4af82cd9062ffba745d1afcad5d44bef9b9c41a9c8fe055ae59c8927358f0e4b56c1c690996bcf02530893fb9d71242c87b00329b
+  data.tar.gz: f65bec15d95854ce7be553057a5de95605b14d44149997e2718186a1328df4023b7d01e7ab02e77b5bfc36ec2b41b5a3f1cf61268adfd3b061366bfbc8d1fbac

data/{xenon-routing/lib → lib}/xenon/api.rb

@@ -14,9 +14,13 @@ module Xenon
         (@marshallers.nil? || @marshallers.empty?) ? DEFAULT_MARSHALLERS : @marshallers
       end
 
-      def select_marshaller(media_ranges)
+      def request_marshaller(content_type)
+        marshallers.find { |m| m.unmarshal?(content_type.media_type) }
+      end
+
+      def response_marshaller(media_ranges)
         weighted = marshallers.map do |marshaller|
-          media_range = media_ranges.find { |media_range| marshaller.marshal_to?(media_range) }
+          media_range = media_ranges.find { |media_range| marshaller.marshal?(media_range) }
           [marshaller, media_range ? media_range.q : 0]
         end
         weighted.select { |_, q| q > 0 }.sort_by { |_, q| q }.map { |m, _| m }.last
@@ -47,11 +51,11 @@ module Xenon
       @context = Routing::Context.new(Request.new(Rack::Request.new(env)), Response.new)
 
       accept = @context.request.header('Accept')
-      marshaller = accept ? self.class.select_marshaller(accept.media_ranges) : self.class.marshallers.first
+      response_marshaller = accept ? self.class.response_marshaller(accept.media_ranges) : self.class.marshallers.first
 
-      catch (:complete) do
+      catch :complete do
         begin
-          if marshaller
+          if response_marshaller
             self.class.routes.each do |route|
               name, args, block = route
               route_block = proc { instance_eval(&block) }
@@ -66,10 +70,15 @@ module Xenon
         end
       end
 
-      marshaller ||= self.class.marshallers.first
-      resp = @context.response.copy(
-        headers: @context.response.headers.set(Headers::ContentType.new(marshaller.content_type)),
-        body: marshaller.marshal(@context.response.body))
+      response_marshaller ||= self.class.marshallers.first
+      headers = @context.response.headers.set(Headers::ContentType.new(response_marshaller.content_type))
+      if @context.request.allow_response_body?
+        body = response_marshaller.marshal(@context.response.body)
+      else
+        # TODO: Suppress the Content-Lenth heder
+        body = []
+      end
+      resp = @context.response.copy(headers: headers, body: body)
       [resp.status, resp.headers.map { |h| [h.name, h.to_s] }.to_h, resp.body]
     end
 
@@ -97,8 +106,8 @@ module Xenon
         when :header
           fail 400, "Missing required header: #{rejection[:required]}"
         when :method
-          supported = rejections.take_while { |r| r.reason == :method }.map { |r| r[:supported].upcase }
-          fail 405, "Supported methods: #{supported.join(", ")}"
+          supported = rejections.take_while { |r| r.reason == :method }.flat_map { |r| r[:supported] }
+          fail 405, "Supported methods: #{supported.map(&:upcase).join(", ")}"
         when :unauthorized
           if rejection[:scheme]
             challenge = Headers::Challenge.new(rejection[:scheme], rejection.info.except(:scheme))

data/{xenon-routing/lib → lib}/xenon/marshallers.rb

@@ -1,25 +1,39 @@
 require 'xenon/media_type'
 
 module Xenon
-  class JsonMarshaller
-    def media_type
-      MediaType::JSON
-    end
-
+  module Marshaller
     def content_type
       media_type.with_charset(Encoding::UTF_8)
     end
 
-    def marshal_to?(media_range)
+    def unmarshal?(media_type)
+      media_type == self.media_type
+    end
+
+    def marshal?(media_range)
       media_range =~ media_type
     end
+  end
+
+  class JsonMarshaller
+    include Marshaller
+
+    def media_type
+      MediaType::JSON
+    end
 
     def marshal(obj)
       [obj.to_json]
     end
+
+    def unmarshal(body, as:)
+      as ? as.new.from_json(body.read) : JSON.load(body)
+    end
   end
 
   class XmlMarshaller
+    include Marshaller
+
     def initialize
       gem 'builder'
       require 'active_support/core_ext/array/conversions'
@@ -32,17 +46,13 @@ module Xenon
       MediaType::XML
     end
 
-    def content_type
-      media_type.with_charset(Encoding::UTF_8)
-    end
-
-    def marshal_to?(media_range)
-      media_range =~ media_type
-    end
-
     def marshal(obj)
       raise "#{obj.class} does not support #to_xml" unless obj.respond_to?(:to_xml)
       [obj.to_xml]
     end
+
+    def unmarshal(body, as:)
+      as.new.from_xml(body.read)
+    end
   end
 end

data/{xenon-routing/lib → lib}/xenon/request.rb

@@ -23,18 +23,26 @@ module Xenon
     end
 
     def header(name)
-      snake_name = name.to_s.tr('-', '_')
-      value = @rack_req.env['HTTP_' + snake_name.upcase]
+      snake_name = name.to_s.tr('-', '_').upcase
+      value = @rack_req.env['HTTP_' + snake_name] || @rack_req.env[snake_name]
       return nil if value.nil?
 
       klass = Xenon::Headers.header_class(name)
       klass ? klass.parse(value) : Xenon::Headers::Raw.new(name, value)
     end
 
+    def body
+      @rack_req.body
+    end
+
     def copy(changes = {})
       r = dup
       changes.each { |k, v| r.instance_variable_set("@#{k}", v.freeze) }
       r
     end
+
+    def allow_response_body?
+      request_method != :head
+    end
   end
 end

data/{xenon-routing/lib → lib}/xenon/routing/directives.rb

@@ -5,6 +5,7 @@ module Xenon
     module Directives
       include RouteDirectives
       include HeaderDirectives
+      include MarshallingDirectives
       include MethodDirectives
       include ParamDirectives
       include PathDirectives

data/lib/xenon/routing/marshalling_directives.rb

@@ -0,0 +1,24 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module MarshallingDirectives
+      include RouteDirectives
+
+      def body(as: nil)
+        extract_request do |request|
+          if as == IO
+            yield request.body
+          elsif as == String
+            yield request.body.read
+          else
+            content_type = request.header('Content-Type')
+            marshaller = Xenon::API.request_marshaller(content_type.content_type) # yuk
+            yield marshaller.unmarshal(request.body, as: as)
+          end
+        end
+      end
+
+    end
+  end
+end

data/{xenon-routing/lib → lib}/xenon/routing/method_directives.rb

@@ -5,17 +5,23 @@ module Xenon
     module MethodDirectives
       include RouteDirectives
 
-      def request_method(method)
+      def request_method(*methods)
         extract_request do |request|
-          if request.request_method == method
+          if methods.include?(request.request_method)
             yield
           else
-            reject Rejection.new(:method, { supported: method })
+            reject Rejection.new(:method, { supported: methods })
           end
         end
       end
 
-      %i(delete get head options patch post put).each do |method|
+      def get
+        request_method :get, :head do
+          yield
+        end
+      end
+
+      %i(delete head options patch post put).each do |method|
         define_method(method) do |&inner|
           request_method(method, &inner)
         end

data/{xenon-routing/lib → lib}/xenon/routing/security_directives.rb

@@ -15,6 +15,12 @@ module Xenon
         end
       end
 
+      def optional_authenticate(authenticator)
+        extract_request(authenticator) do |user|
+          yield user
+        end
+      end
+
       def authorize(check)
         if check.respond_to?(:call)
           extract_request(check) do |authorized|

data/{xenon-routing/xenon-routing.gemspec → xenon-routing.gemspec}

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Xenon::ROUTING_VERSION
   spec.authors       = ['Greg Beech']
   spec.email         = ['greg@gregbeech.com']
-  spec.summary       = %q{An HTTP framework for building RESTful APIs.}
-  spec.description   = %q{Provides a model for the HTTP protocol and a tree-based routing syntax.}
+  spec.summary       = %q{Tree-based routing to build RESTful APIs on Rack.}
+  spec.description   = %q{Provides tree-based routing syntax for building RESTful APIs.}
   spec.homepage      = 'https://github.com/gregbeech/xenon'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xenon-routing
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Greg Beech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,92 +30,38 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
-description: Provides a model for the HTTP protocol and a tree-based routing syntax.
+        version: 0.0.5
+description: Provides tree-based routing syntax for building RESTful APIs.
 email:
 - greg@gregbeech.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- Guardfile
-- LICENSE
-- README.md
-- Rakefile
-- VERSION
-- examples/hello_world/config.ru
-- examples/hello_world/hello_world.rb
-- xenon-http/lib/xenon/auth.rb
-- xenon-http/lib/xenon/errors.rb
-- xenon-http/lib/xenon/etag.rb
-- xenon-http/lib/xenon/headers.rb
-- xenon-http/lib/xenon/headers/accept.rb
-- xenon-http/lib/xenon/headers/accept_charset.rb
-- xenon-http/lib/xenon/headers/accept_encoding.rb
-- xenon-http/lib/xenon/headers/accept_language.rb
-- xenon-http/lib/xenon/headers/authorization.rb
-- xenon-http/lib/xenon/headers/cache_control.rb
-- xenon-http/lib/xenon/headers/content_type.rb
-- xenon-http/lib/xenon/headers/if_match.rb
-- xenon-http/lib/xenon/headers/if_modified_since.rb
-- xenon-http/lib/xenon/headers/if_none_match.rb
-- xenon-http/lib/xenon/headers/if_range.rb
-- xenon-http/lib/xenon/headers/if_unmodified_since.rb
-- xenon-http/lib/xenon/headers/user_agent.rb
-- xenon-http/lib/xenon/headers/www_authenticate.rb
-- xenon-http/lib/xenon/http.rb
-- xenon-http/lib/xenon/http_version.rb
-- xenon-http/lib/xenon/media_type.rb
-- xenon-http/lib/xenon/parsers/basic_rules.rb
-- xenon-http/lib/xenon/parsers/header_rules.rb
-- xenon-http/lib/xenon/parsers/media_type.rb
-- xenon-http/lib/xenon/quoted_string.rb
-- xenon-http/spec/spec_helper.rb
-- xenon-http/spec/xenon/etag_spec.rb
-- xenon-http/spec/xenon/headers/accept_charset_spec.rb
-- xenon-http/spec/xenon/headers/accept_encoding_spec.rb
-- xenon-http/spec/xenon/headers/accept_language_spec.rb
-- xenon-http/spec/xenon/headers/accept_spec.rb
-- xenon-http/spec/xenon/headers/authorization_spec.rb
-- xenon-http/spec/xenon/headers/cache_control_spec.rb
-- xenon-http/spec/xenon/headers/if_match_spec.rb
-- xenon-http/spec/xenon/headers/if_modified_since_spec.rb
-- xenon-http/spec/xenon/headers/if_none_match_spec.rb
-- xenon-http/spec/xenon/headers/if_range_spec.rb
-- xenon-http/spec/xenon/headers/if_unmodified_since_spec.rb
-- xenon-http/spec/xenon/headers/user_agent_spec.rb
-- xenon-http/spec/xenon/headers/www_authenticate_spec.rb
-- xenon-http/spec/xenon/media_type_spec.rb
-- xenon-http/xenon-http.gemspec
-- xenon-routing/lib/xenon/api.rb
-- xenon-routing/lib/xenon/marshallers.rb
-- xenon-routing/lib/xenon/request.rb
-- xenon-routing/lib/xenon/response.rb
-- xenon-routing/lib/xenon/routing.rb
-- xenon-routing/lib/xenon/routing/context.rb
-- xenon-routing/lib/xenon/routing/directives.rb
-- xenon-routing/lib/xenon/routing/header_directives.rb
-- xenon-routing/lib/xenon/routing/method_directives.rb
-- xenon-routing/lib/xenon/routing/param_directives.rb
-- xenon-routing/lib/xenon/routing/path_directives.rb
-- xenon-routing/lib/xenon/routing/route_directives.rb
-- xenon-routing/lib/xenon/routing/security_directives.rb
-- xenon-routing/lib/xenon/routing_version.rb
-- xenon-routing/spec/spec_helper.rb
-- xenon-routing/xenon-routing.gemspec
-- xenon.gemspec
+- lib/xenon/api.rb
+- lib/xenon/marshallers.rb
+- lib/xenon/request.rb
+- lib/xenon/response.rb
+- lib/xenon/routing.rb
+- lib/xenon/routing/context.rb
+- lib/xenon/routing/directives.rb
+- lib/xenon/routing/header_directives.rb
+- lib/xenon/routing/marshalling_directives.rb
+- lib/xenon/routing/method_directives.rb
+- lib/xenon/routing/param_directives.rb
+- lib/xenon/routing/path_directives.rb
+- lib/xenon/routing/route_directives.rb
+- lib/xenon/routing/security_directives.rb
+- lib/xenon/routing_version.rb
+- spec/spec_helper.rb
+- xenon-routing.gemspec
 homepage: https://github.com/gregbeech/xenon
 licenses:
 - MIT
@@ -136,10 +82,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: An HTTP framework for building RESTful APIs.
-test_files:
-- xenon-routing/spec/spec_helper.rb
+summary: Tree-based routing to build RESTful APIs on Rack.
+test_files: []
 has_rdoc: 

data/.codeclimate.yml

@@ -1,18 +0,0 @@
-# For more details, see here:
-# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
-
-# For a list of all available engines, see here:
-# http://docs.codeclimate.com/article/296-engines-available-engines
-
-engines:
-  rubocop:
-    enabled: true
-
-ratings:
-  paths:
-    - lib/**/*
-
-exclude_paths:
-  - examples/**/*
-  - spec/**/*
-  - vendor/**/*

data/.gitignore

@@ -1,25 +0,0 @@
-*.gem
-*.rbc
-.ruby-version
-.ruby-gemset
-Gemfile.lock
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-.ruby-gemset
-.ruby-version