xenon-routing 0.0.4

data/xenon-routing/lib/xenon/marshallers.rb

@@ -0,0 +1,48 @@
+require 'xenon/media_type'
+
+module Xenon
+  class JsonMarshaller
+    def media_type
+      MediaType::JSON
+    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)
+      [obj.to_json]
+    end
+  end
+
+  class XmlMarshaller
+    def initialize
+      gem 'builder'
+      require 'active_support/core_ext/array/conversions'
+      require 'active_support/core_ext/hash/conversions'
+    rescue Gem::LoadError
+      raise 'Install the "builder" gem to enable XML.'
+    end
+
+    def media_type
+      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
+  end
+end

data/xenon-routing/lib/xenon/request.rb

@@ -0,0 +1,40 @@
+require 'xenon/headers'
+
+module Xenon
+  class Request
+    attr_accessor :unmatched_path
+
+    def initialize(rack_req)
+      @rack_req = rack_req
+      @unmatched_path = rack_req.path.freeze
+    end
+
+    def request_method
+      @rack_req.request_method.downcase.to_sym
+    end
+
+    def form_hash
+      @form_hash ||= @rack_req.POST.with_indifferent_access.freeze
+    end
+
+    def param_hash
+      puts "GET = #{@rack_req.GET.inspect}"
+      @param_hash ||= @rack_req.GET.with_indifferent_access.freeze
+    end
+
+    def header(name)
+      snake_name = name.to_s.tr('-', '_')
+      value = @rack_req.env['HTTP_' + snake_name.upcase]
+      return nil if value.nil?
+
+      klass = Xenon::Headers.header_class(name)
+      klass ? klass.parse(value) : Xenon::Headers::Raw.new(name, value)
+    end
+
+    def copy(changes = {})
+      r = dup
+      changes.each { |k, v| r.instance_variable_set("@#{k}", v.freeze) }
+      r
+    end
+  end
+end

data/xenon-routing/lib/xenon/response.rb

@@ -0,0 +1,29 @@
+require 'xenon/headers'
+
+module Xenon
+  class Response
+    attr_reader :status, :headers, :body
+
+    def initialize
+      @headers = Headers.new
+      @complete = false
+      freeze
+    end
+
+    def complete?
+      @complete
+    end
+
+    def copy(changes = {})
+      r = dup
+      changes.each { |k, v| r.instance_variable_set("@#{k}", v) }
+      r.freeze
+    end
+
+    def freeze
+      @headers.freeze
+      @body.freeze
+      super
+    end
+  end
+end

data/xenon-routing/lib/xenon/routing.rb

@@ -0,0 +1,6 @@
+require 'xenon/routing_version'
+require 'xenon/marshallers'
+require 'xenon/request'
+require 'xenon/response'
+require 'xenon/routing/context'
+require 'xenon/routing/directives'

data/xenon-routing/lib/xenon/routing/context.rb

@@ -0,0 +1,35 @@
+module Xenon
+  module Routing
+    class Rejection
+      attr_reader :reason, :info
+
+      def initialize(reason, info = {})
+        @reason = reason
+        @info = info
+      end
+
+      def [](name)
+        @info[name]
+      end
+    end
+
+    class Context
+      attr_accessor :request, :response, :rejections
+
+      def initialize(request, response)
+        @request = request
+        @response = response
+        @rejections = []
+      end
+
+      def branch
+        original_request = @request
+        original_response = @response
+        yield
+      ensure
+        @request = original_request
+        @response = original_response unless @response.complete?
+      end
+    end
+  end
+end

data/xenon-routing/lib/xenon/routing/directives.rb

@@ -0,0 +1,14 @@
+Dir[File.join(__dir__, '*_directives.rb')].each { |f| require f }
+
+module Xenon
+  module Routing
+    module Directives
+      include RouteDirectives
+      include HeaderDirectives
+      include MethodDirectives
+      include ParamDirectives
+      include PathDirectives
+      include SecurityDirectives
+    end
+  end
+end

data/xenon-routing/lib/xenon/routing/header_directives.rb

@@ -0,0 +1,32 @@
+require 'xenon/routing/route_directives'
+
+module Xenon
+  module Routing
+    module HeaderDirectives
+      include RouteDirectives
+
+      def optional_header(name)
+        extract_request do |request|
+          yield request.header(name)
+        end
+      end
+
+      def header(name)
+        optional_header(name) do |value|
+          if value
+            yield value
+          else
+            reject Rejection.new(:header, { required: name })
+          end
+        end
+      end
+
+      def respond_with_header(header)
+        map_response -> r { r.copy(headers: r.headers.add(header)) } do
+          yield
+        end
+      end
+
+    end
+  end
+end

data/xenon-routing/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/xenon-routing/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/xenon-routing/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/xenon-routing/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/xenon-routing/lib/xenon/routing/security_directives.rb

@@ -0,0 +1,34 @@
+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
+
+      def authorize(check)
+        if check.respond_to?(:call)
+          extract_request(check) do |authorized|
+            authorize(authorized) do
+              yield
+            end
+          end
+        elsif check
+          yield
+        else
+          reject :forbidden
+        end
+      end
+
+    end
+  end
+end

data/xenon-routing/lib/xenon/routing_version.rb

@@ -0,0 +1,3 @@
+module Xenon
+  ROUTING_VERSION = File.read(File.join(__dir__, '..', '..', '..', 'VERSION'))
+end

data/xenon-routing/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+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
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end