xenon 0.0.2 → 0.0.3

data/lib/xenon/routing/method_directives.rb

@@ -0,0 +1,26 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module MethodDirectives
+      include RouteDirectives
+
+      def request_method(method)
+        extract_request do |request|
+          if request.request_method == method
+            yield
+          else
+            reject Rejection.new(:method, { supported: method })
+          end
+        end
+      end
+
+      %i(delete get head options patch post put).each do |method|
+        define_method(method) do |&inner|
+          request_method(method, &inner)
+        end
+      end
+
+    end
+  end
+end

data/lib/xenon/routing/param_directives.rb

@@ -0,0 +1,22 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module ParamDirectives
+      include RouteDirectives
+
+      def param_hash
+        extract_request do |request|
+          yield request.param_hash
+        end
+      end
+
+      def params(*names)
+        param_hash do |hash|
+          yield *hash.slice(*names).values
+        end
+      end
+
+    end
+  end
+end

data/lib/xenon/routing/path_directives.rb

@@ -0,0 +1,37 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module PathDirectives
+      include RouteDirectives
+
+      def path_prefix(pattern)
+        extract_request do |request|
+          match = request.unmatched_path.match(pattern)
+          if match && match.pre_match == ''
+            map_request unmatched_path: match.post_match do
+              yield *match.captures
+            end
+          else
+            reject nil # path rejections are nil to allow more specific rejections to be seen
+          end
+        end
+      end
+
+      def path_end
+        path_prefix(/\Z/) do
+          yield
+        end
+      end
+
+      def path(pattern)
+        path_prefix(pattern) do |*captures|
+          path_end do
+            yield *captures
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/xenon/routing/route_directives.rb

@@ -0,0 +1,51 @@
+require 'rack/utils'
+
+module Xenon
+  module Routing
+    module RouteDirectives
+
+      def map_request(map)
+        context.branch do
+          context.request = map.respond_to?(:call) ? map.call(context.request) : context.request.copy(map)
+          yield
+        end
+      end
+
+      def map_response(map)
+        context.branch do
+          context.response = map.respond_to?(:call) ? map.call(context.response) : context.response.copy(map)
+          yield
+        end
+      end
+
+      def complete(status, body)
+        map_response complete: true, status: Rack::Utils.status_code(status), body: body do
+          throw :complete
+        end
+      end
+
+      def reject(rejection, info = {})
+        return if rejection.nil?
+        rejection = Rejection.new(rejection, info) unless rejection.is_a?(Rejection)
+        context.rejections << rejection
+      end
+
+      def fail(status, developer_message = nil)
+        body = {
+          status: status,
+          developer_message: developer_message || Rack::Utils::HTTP_STATUS_CODES[status]
+        }
+        complete status, body
+      end
+
+      def extract(lambda)
+        yield lambda.call(context)
+      end
+
+      def extract_request(lambda = nil)
+        yield lambda ? lambda.call(context.request) : context.request
+      end
+
+    end
+  end
+end

data/lib/xenon/routing/security_directives.rb

@@ -0,0 +1,20 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module SecurityDirectives
+      include RouteDirectives
+
+      def authenticate(authenticator)
+        extract_request(authenticator) do |user|
+          if user
+            yield user
+          else
+            reject :unauthorized, { scheme: authenticator.scheme }.merge(authenticator.auth_params)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/xenon/version.rb

@@ -1,3 +1,3 @@
 module Xenon
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

data/spec/xenon/etag_spec.rb

@@ -0,0 +1,19 @@
+require 'xenon/etag'
+
+describe Xenon::ETag do
+
+  describe '::parse' do
+    it 'can parse a strong etag' do
+      etag = Xenon::ETag.parse('"xyzzy"')
+      expect(etag.opaque_tag).to eq 'xyzzy'
+      expect(etag).to be_strong
+    end
+
+    it 'can parse a weak etag' do
+      etag = Xenon::ETag.parse('W/"xyzzy"')
+      expect(etag.opaque_tag).to eq 'xyzzy'
+      expect(etag).to be_weak
+    end
+  end
+
+end

data/spec/xenon/headers/if_match_spec.rb

@@ -0,0 +1,73 @@
+require 'xenon/headers/if_match'
+
+describe Xenon::Headers::IfMatch do
+
+  context '::parse' do
+    it 'can parse a single etag' do
+      header = Xenon::Headers::IfMatch.parse('"xyzzy"')
+      expect(header.etags.size).to eq(1)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+    end
+
+    it 'can parse multiple etags' do
+      header = Xenon::Headers::IfMatch.parse('"xyzzy", "r2d2xxxx", "c3piozzzz"')
+      expect(header.etags.size).to eq(3)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+      expect(header.etags[1]).to eq(Xenon::ETag.new('r2d2xxxx'))
+      expect(header.etags[2]).to eq(Xenon::ETag.new('c3piozzzz'))
+    end
+
+    it 'can parse a wildcard header' do
+      header = Xenon::Headers::IfMatch.parse('*')
+      expect(header.etags.size).to eq(0)
+    end
+  end
+
+  context '#merge' do
+    it 'can merge two headers and maintain etag order' do
+      h1 = Xenon::Headers::IfMatch.parse('"xyzzy", "r2d2xxxx"')
+      h2 = Xenon::Headers::IfMatch.parse('"c3piozzzz"')
+      header = h1.merge(h2)
+      expect(header.etags.size).to eq(3)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+      expect(header.etags[1]).to eq(Xenon::ETag.new('r2d2xxxx'))
+      expect(header.etags[2]).to eq(Xenon::ETag.new('c3piozzzz'))
+    end
+
+    it 'raises a protocol error when trying to merge into a wildcard header' do
+      h1 = Xenon::Headers::IfMatch.parse('*')
+      h2 = Xenon::Headers::IfMatch.parse('"c3piozzzz"')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+
+    it 'raises a protocol error when trying to merge a wildcard into a header' do
+      h1 = Xenon::Headers::IfMatch.parse('"xyzzy"')
+      h2 = Xenon::Headers::IfMatch.parse('*')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+
+    it 'raises a protocol error when trying to merge two wildcard headers' do
+      h1 = Xenon::Headers::IfMatch.parse('*')
+      h2 = Xenon::Headers::IfMatch.parse('*')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+  end
+
+  context '#to_s' do
+    it 'returns the string representation a single etag' do
+      header = Xenon::Headers::IfMatch.parse('"xyzzy"')
+      expect(header.to_s).to eq('"xyzzy"')
+    end
+
+    it 'returns the string representation of multiple etags' do
+      header = Xenon::Headers::IfMatch.parse('"xyzzy", "r2d2xxxx", "c3piozzzz"')
+      expect(header.to_s).to eq('"xyzzy", "r2d2xxxx", "c3piozzzz"')
+    end
+
+    it 'returns the string representation of a wildcard header' do
+      header = Xenon::Headers::IfMatch.wildcard
+      expect(header.to_s).to eq('*')
+    end
+  end
+
+end

data/spec/xenon/headers/if_modified_since_spec.rb

@@ -0,0 +1,19 @@
+require 'xenon/headers/if_modified_since'
+
+describe Xenon::Headers::IfModifiedSince do
+
+  context '::parse' do
+    it 'can parse an http date' do
+      header = Xenon::Headers::IfModifiedSince.parse('Sat, 29 Oct 1994 19:43:31 GMT')
+      expect(header.date).to eq(Time.utc(1994, 10, 29, 19, 43, 31))
+    end
+  end
+
+  context '#to_s' do
+    it 'returns the http date format' do
+      header = Xenon::Headers::IfModifiedSince.new(Time.utc(1994, 10, 29, 19, 43, 31))
+      expect(header.to_s).to eq('Sat, 29 Oct 1994 19:43:31 GMT')
+    end
+  end
+
+end

data/spec/xenon/headers/if_none_match_spec.rb

@@ -0,0 +1,79 @@
+require 'xenon/headers/if_none_match'
+
+describe Xenon::Headers::IfNoneMatch do
+
+  context '::parse' do
+    it 'can parse a single strong etag' do
+      header = Xenon::Headers::IfNoneMatch.parse('"xyzzy"')
+      expect(header.etags.size).to eq(1)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+    end
+
+    it 'can parse a single weak etag' do
+      header = Xenon::Headers::IfNoneMatch.parse('W/"xyzzy"')
+      expect(header.etags.size).to eq(1)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy', weak: true))
+    end
+
+    it 'can parse multiple etags' do
+      header = Xenon::Headers::IfNoneMatch.parse('"xyzzy", W/"r2d2xxxx", "c3piozzzz"')
+      expect(header.etags.size).to eq(3)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+      expect(header.etags[1]).to eq(Xenon::ETag.new('r2d2xxxx', weak: true))
+      expect(header.etags[2]).to eq(Xenon::ETag.new('c3piozzzz'))
+    end
+
+    it 'can parse a wildcard header' do
+      header = Xenon::Headers::IfNoneMatch.parse('*')
+      expect(header.etags.size).to eq(0)
+    end
+  end
+
+  context '#merge' do
+    it 'can merge two headers and maintain etag order' do
+      h1 = Xenon::Headers::IfNoneMatch.parse('"xyzzy", W/"r2d2xxxx"')
+      h2 = Xenon::Headers::IfNoneMatch.parse('"c3piozzzz"')
+      header = h1.merge(h2)
+      expect(header.etags.size).to eq(3)
+      expect(header.etags[0]).to eq(Xenon::ETag.new('xyzzy'))
+      expect(header.etags[1]).to eq(Xenon::ETag.new('r2d2xxxx', weak: true))
+      expect(header.etags[2]).to eq(Xenon::ETag.new('c3piozzzz'))
+    end
+
+    it 'raises a protocol error when trying to merge into a wildcard header' do
+      h1 = Xenon::Headers::IfNoneMatch.parse('*')
+      h2 = Xenon::Headers::IfNoneMatch.parse('"c3piozzzz"')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+
+    it 'raises a protocol error when trying to merge a wildcard into a header' do
+      h1 = Xenon::Headers::IfNoneMatch.parse('"xyzzy"')
+      h2 = Xenon::Headers::IfNoneMatch.parse('*')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+
+    it 'raises a protocol error when trying to merge two wildcard headers' do
+      h1 = Xenon::Headers::IfNoneMatch.parse('*')
+      h2 = Xenon::Headers::IfNoneMatch.parse('*')
+      expect { h1.merge(h2) }.to raise_error(Xenon::ProtocolError)
+    end
+  end
+
+  context '#to_s' do
+    it 'returns the string representation a single etag' do
+      header = Xenon::Headers::IfNoneMatch.parse('"xyzzy"')
+      expect(header.to_s).to eq('"xyzzy"')
+    end
+
+    it 'returns the string representation of multiple etags' do
+      header = Xenon::Headers::IfNoneMatch.parse('"xyzzy", W/"r2d2xxxx", "c3piozzzz"')
+      expect(header.to_s).to eq('"xyzzy", W/"r2d2xxxx", "c3piozzzz"')
+    end
+
+    it 'returns the string representation of a wildcard header' do
+      header = Xenon::Headers::IfNoneMatch.wildcard
+      expect(header.to_s).to eq('*')
+    end
+  end
+
+end

data/spec/xenon/headers/if_range_spec.rb

@@ -0,0 +1,45 @@
+require 'xenon/headers/if_range'
+
+describe Xenon::Headers::IfRange do
+
+  context '::parse' do
+    it 'can parse an http date' do
+      header = Xenon::Headers::IfRange.parse('Sat, 29 Oct 1994 19:43:31 GMT')
+      expect(header.date).to eq(Time.utc(1994, 10, 29, 19, 43, 31))
+    end
+
+    it 'can parse an obsolete RFC 850 date' do
+      header = Xenon::Headers::IfRange.parse('Sunday, 06-Nov-94 08:49:37 GMT')
+      expect(header.date).to eq(Time.utc(1994, 11, 6, 8, 49, 37))
+    end
+
+    it 'can parse an obsolete asctime date' do
+      header = Xenon::Headers::IfRange.parse('Sun Nov  6 08:49:37 1994')
+      expect(header.date).to eq(Time.utc(1994, 11, 6, 8, 49, 37))
+    end
+
+    it 'can parse a strong etag' do
+      header = Xenon::Headers::IfRange.parse('"xyzzy"')
+      expect(header.etag).to_not be_nil
+      expect(header.etag.opaque_tag).to eq 'xyzzy'
+      expect(header.etag).to be_strong
+    end
+
+    it 'should raise a ProtocolError if the etag is weak' do
+      expect { Xenon::Headers::IfRange.parse('W/"xyzzy"') }.to raise_error Xenon::ProtocolError
+    end
+  end
+
+  context '#to_s' do
+    it 'returns the http date format for dates' do
+      header = Xenon::Headers::IfRange.new(Time.utc(1994, 10, 29, 19, 43, 31))
+      expect(header.to_s).to eq('Sat, 29 Oct 1994 19:43:31 GMT')
+    end
+
+    it 'returns the etag format for etags' do
+      header = Xenon::Headers::IfRange.new(Xenon::ETag.new('xyzzy'))
+      expect(header.to_s).to eq('"xyzzy"')
+    end
+  end
+
+end

data/spec/xenon/headers/if_unmodified_since_spec.rb

@@ -0,0 +1,19 @@
+require 'xenon/headers/if_unmodified_since'
+
+describe Xenon::Headers::IfUnmodifiedSince do
+
+  context '::parse' do
+    it 'can parse an http date' do
+      header = Xenon::Headers::IfUnmodifiedSince.parse('Sat, 29 Oct 1994 19:43:31 GMT')
+      expect(header.date).to eq(Time.utc(1994, 10, 29, 19, 43, 31))
+    end
+  end
+
+  context '#to_s' do
+    it 'returns the http date format' do
+      header = Xenon::Headers::IfUnmodifiedSince.new(Time.utc(1994, 10, 29, 19, 43, 31))
+      expect(header.to_s).to eq('Sat, 29 Oct 1994 19:43:31 GMT')
+    end
+  end
+
+end

data/spec/xenon/headers/user_agent_spec.rb

@@ -0,0 +1,67 @@
+require 'xenon/headers/user_agent'
+
+describe Xenon::Headers::UserAgent do
+
+  context '::parse' do
+    it 'can parse a user agent with a product name' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla')
+      expect(header.products.size).to eq(1)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to be_nil
+      expect(header.products[0].comment).to be_nil
+    end
+
+    it 'can parse a user agent with a product name and version' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla/5.0')
+      expect(header.products.size).to eq(1)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to eq('5.0')
+      expect(header.products[0].comment).to be_nil
+    end
+
+    it 'can parse a user agent with a product name and comment' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla (Macintosh; Intel Mac OS X 10_10_2)')
+      expect(header.products.size).to eq(1)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to be_nil
+      expect(header.products[0].comment).to eq('Macintosh; Intel Mac OS X 10_10_2')
+    end
+
+    it 'can parse a user agent with a product name, version and comment' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2)')
+      expect(header.products.size).to eq(1)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to eq('5.0')
+      expect(header.products[0].comment).to eq('Macintosh; Intel Mac OS X 10_10_2')
+    end
+
+    it 'can parse a user agent with multiple comments' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla/5.0 (Macintosh) (Intel Mac OS X 10_10_2)')
+      expect(header.products.size).to eq(2)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to eq('5.0')
+      expect(header.products[0].comment).to eq('Macintosh')
+      expect(header.products[1].name).to be_nil
+      expect(header.products[1].version).to be_nil
+      expect(header.products[1].comment).to eq('Intel Mac OS X 10_10_2')
+    end
+
+    it 'can parse a typical Chrome user agent' do
+      header = Xenon::Headers::UserAgent.parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36')
+      expect(header.products.size).to eq(4)
+      expect(header.products[0].name).to eq('Mozilla')
+      expect(header.products[0].version).to eq('5.0')
+      expect(header.products[0].comment).to eq('Macintosh; Intel Mac OS X 10_10_2')
+      expect(header.products[1].name).to eq('AppleWebKit')
+      expect(header.products[1].version).to eq('537.36')
+      expect(header.products[1].comment).to eq('KHTML, like Gecko')
+      expect(header.products[2].name).to eq('Chrome')
+      expect(header.products[2].version).to eq('41.0.2272.89')
+      expect(header.products[2].comment).to be_nil
+      expect(header.products[3].name).to eq('Safari')
+      expect(header.products[3].version).to eq('537.36')
+      expect(header.products[3].comment).to be_nil
+    end
+  end
+
+end