xenon 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c82b7b50f76ea05e462ab4969825863e27e1f51a
-  data.tar.gz: 033692599c1325d96064ee10d72ff2302b51db5f
+  metadata.gz: 667df7004abbed158847a2aba0f15151db579d8f
+  data.tar.gz: d3088dfa5b57e422c80bd682bf77dba901e8e6ff
 SHA512:
-  metadata.gz: 55964419254b71d4c37032fc6c51fb0bda9ac770b04353b0b0f6e79428b372ce723504a33b0331380440398586ba1f647171e142188d34557e144b8632409689
-  data.tar.gz: 1ff9d197b45558a4dc20ad0f5dbd8ce037ea4301384149d66ebc29d80787c05f3b4be3b5dde9ea9e2eb110af18af0834423a9edc0f3f04cbd4d0dc3d89bae391
+  metadata.gz: 6ec395fab860a41762f82b91aac705618e8a487ce38466db91a94731405157a231ccbf55abf9861b7fd4efbd6222b5d1377bfaeb9f6bd562dc0eabec1f9dd134
+  data.tar.gz: addd9426fde2c16ed7fbd073f9da3dd409288bf61722e74743cf9c7703f26c65c08d2b016ed8b48e4451e1993908e78595b0c8fe986629ac1cf0a0513d25183f

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xenon
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Greg Beech
@@ -11,156 +11,40 @@ cert_chain: []
 date: 2015-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: xenon-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: parslet
+  name: xenon-routing
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 0.0.4
 description: Provides a model for the HTTP protocol and a tree-based routing syntax.
 email:
 - greg@gregbeech.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- Guardfile
-- LICENSE
-- README.md
-- Rakefile
-- examples/hello_world/config.ru
-- examples/hello_world/hello_world.rb
-- lib/xenon.rb
-- lib/xenon/auth.rb
-- lib/xenon/errors.rb
-- lib/xenon/etag.rb
-- lib/xenon/headers.rb
-- lib/xenon/headers/accept.rb
-- lib/xenon/headers/accept_charset.rb
-- lib/xenon/headers/accept_encoding.rb
-- lib/xenon/headers/accept_language.rb
-- lib/xenon/headers/authorization.rb
-- lib/xenon/headers/cache_control.rb
-- lib/xenon/headers/content_type.rb
-- lib/xenon/headers/if_match.rb
-- lib/xenon/headers/if_modified_since.rb
-- lib/xenon/headers/if_none_match.rb
-- lib/xenon/headers/if_range.rb
-- lib/xenon/headers/if_unmodified_since.rb
-- lib/xenon/headers/user_agent.rb
-- lib/xenon/headers/www_authenticate.rb
-- lib/xenon/media_type.rb
-- lib/xenon/parsers/basic_rules.rb
-- lib/xenon/parsers/header_rules.rb
-- lib/xenon/parsers/media_type.rb
-- lib/xenon/quoted_string.rb
-- lib/xenon/routing/directives.rb
-- lib/xenon/routing/header_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/version.rb
-- spec/spec_helper.rb
-- spec/xenon/etag_spec.rb
-- spec/xenon/headers/accept_charset_spec.rb
-- spec/xenon/headers/accept_encoding_spec.rb
-- spec/xenon/headers/accept_language_spec.rb
-- spec/xenon/headers/accept_spec.rb
-- spec/xenon/headers/authorization_spec.rb
-- spec/xenon/headers/cache_control_spec.rb
-- spec/xenon/headers/if_match_spec.rb
-- spec/xenon/headers/if_modified_since_spec.rb
-- spec/xenon/headers/if_none_match_spec.rb
-- spec/xenon/headers/if_range_spec.rb
-- spec/xenon/headers/if_unmodified_since_spec.rb
-- spec/xenon/headers/user_agent_spec.rb
-- spec/xenon/headers/www_authenticate_spec.rb
-- spec/xenon/media_type_spec.rb
-- xenon.gemspec
+files: []
 homepage: https://github.com/gregbeech/xenon
 licenses:
 - MIT
@@ -185,21 +69,5 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: An HTTP framework for building RESTful APIs.
-test_files:
-- spec/spec_helper.rb
-- spec/xenon/etag_spec.rb
-- spec/xenon/headers/accept_charset_spec.rb
-- spec/xenon/headers/accept_encoding_spec.rb
-- spec/xenon/headers/accept_language_spec.rb
-- spec/xenon/headers/accept_spec.rb
-- spec/xenon/headers/authorization_spec.rb
-- spec/xenon/headers/cache_control_spec.rb
-- spec/xenon/headers/if_match_spec.rb
-- spec/xenon/headers/if_modified_since_spec.rb
-- spec/xenon/headers/if_none_match_spec.rb
-- spec/xenon/headers/if_range_spec.rb
-- spec/xenon/headers/if_unmodified_since_spec.rb
-- spec/xenon/headers/user_agent_spec.rb
-- spec/xenon/headers/www_authenticate_spec.rb
-- spec/xenon/media_type_spec.rb
+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

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---format documentation

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.3
-before_install:
-  - gem install bundler
-cache: bundler

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'guard', require: false
-  gem 'guard-rspec', require: false
-  gem 'yard', require: false
-end
-
-group :test do
-  gem "codeclimate-test-reporter", require: false
-end

data/Guardfile

@@ -1,16 +0,0 @@
-clearing :on
-
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Greg Beech
-
-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.
-

data/README.md

@@ -1,86 +0,0 @@
-# Xenon
-
-[![Gem Version][fury-badge]][fury] [![Build Status][travis-badge]][travis] [![Code Climate][cc-badge]][cc] [![Test Coverage][ccc-badge]][ccc] [![YARD Docs][docs-badge]][docs]
-
-An HTTP framework for building RESTful APIs, inspired by [Spray][spray].
-
-At the moment I probably wouldn't use this gem for anything you actually depend on because it's _very_ early in its lifecycle. However, this is a flavour of what's in here.
-
-## HTTP Model
-
-A set of model objects for the HTTP protocol which can parse and format the strings you typically get into proper objects you can work with. At the moment this covers key things like media types and the most common headers, but it will expand to cover the whole protocol. You can use the model by itself without any other parts of the library.
-
-This is how things tend to look:
-
-```ruby
-accept = Xenon::Headers::Accept.parse('application/json, application/*; q=0.5')
-accept.media_ranges.first.media_type.json? #=> true
-accept.media_ranges.last.q #=> 0.5
-# etc.
-```
-
-## Routing
-
-A tree-based routing approach based on Spray, giving you great flexibility in building APIs and without the need to write extensions, helpers, etc. because everything is a directive and you extend it by simply writing directives! This is highly unstable and in flux at the moment.
-
-This is the kind of syntax I'm aiming for which _sort of_ works, but needs a load of changes to allow composition so what's there now is really just a proof of concept of the basic syntax rather than anything close to useful.
-
-```ruby
-path_prefix 'users' do
-  path_end do
-    get do
-      complete 200, User.all
-    end
-    post do
-      body as: User do |user|
-        user.save!
-        respond_with_header 'Location' => "/users/#{user.id}" do
-          complete 201, user
-        end
-      end
-    end
-  end
-  path /[0-9]+/ do |user_id|
-    get do
-      complete 200, User.get_by_id(user_id)
-    end
-  end
-end
-```
-
-Of course, it'll do all the things you'd expect like support content negotiation properly and return the correct status codes when paths or methods aren't found.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'xenon'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install xenon
-
-## Contributing
-
-1. Fork it ( https://github.com/gregbeech/xenon/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
-
-[fury]: http://badge.fury.io/rb/xenon "Xenon at Rubygems"
-[fury-badge]: https://badge.fury.io/rb/xenon.svg "Gem Version"
-[travis]: https://travis-ci.org/gregbeech/xenon "Xenon at Travis CI"
-[travis-badge]: https://travis-ci.org/gregbeech/xenon.svg "Build Status"
-[cc]: https://codeclimate.com/github/gregbeech/xenon "Xenon Quality at Code Climate"
-[cc-badge]: https://codeclimate.com/github/gregbeech/xenon/badges/gpa.svg "Code Quality"
-[ccc]: https://codeclimate.com/github/gregbeech/xenon/coverage "Xenon Coverage at Code Climate"
-[ccc-badge]: https://codeclimate.com/github/gregbeech/xenon/badges/coverage.svg "Code Coverage"
-[docs]: http://www.rubydoc.info/github/gregbeech/xenon "YARD Docs"
-[docs-badge]: http://img.shields.io/badge/yard-docs-blue.svg "YARD Docs"
-[spray]: http://spray.io/ "spray"

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new
-
-task :default => :spec
-task :build => :spec
-task :test => :spec

data/examples/hello_world/config.ru

@@ -1,3 +0,0 @@
-require_relative 'hello_world'
-
-run HelloWorld.new

data/examples/hello_world/hello_world.rb

@@ -1,17 +0,0 @@
-require 'xenon'
-
-class HelloWorld < Xenon::API
-  authenticator = Xenon::BasicAuth.new realm: 'hello world' do |credentials|
-    credentials.username # should actually auth here!
-  end
-
-  path '/' do
-    get do
-      authenticate(authenticator) do |user|
-        params :greeting do |greeting|
-          complete :ok, { greeting => user }
-        end
-      end
-    end
-  end
-end

data/lib/xenon.rb

@@ -1,253 +0,0 @@
-require 'json'
-require 'rack'
-require 'active_support/core_ext/string'
-require 'xenon/headers'
-require 'xenon/routing/directives'
-require 'xenon/version'
-
-module Xenon
-
-  class Rejection
-    attr_reader :reason, :info
-
-    def initialize(reason, info = {})
-      @reason = reason
-      @info = info
-    end
-
-    def [](name)
-      @info[name]
-    end
-  end
-
-  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
-
-  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
-
-  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
-
-  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 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
-
-  class API
-    include Xenon::Routing::Directives
-
-    DEFAULT_MARSHALLERS = [JsonMarshaller.new]
-
-    class << self
-      def marshallers(*marshallers)
-        @marshallers = marshallers unless marshallers.nil? || marshallers.empty?
-        (@marshallers.nil? || @marshallers.empty?) ? DEFAULT_MARSHALLERS : @marshallers
-      end
-
-      def select_marshaller(media_ranges)
-        weighted = marshallers.sort_by do |m|
-          media_range = media_ranges.find { |mr| m.marshal_to?(mr) }
-          media_range ? media_range.q : 0.0
-        end
-        weighted.last
-      end
-    end
-
-    attr_reader :context
-
-    class << self
-      def routes
-        @routes ||= []
-      end
-
-      def method_missing(name, *args, &block)
-        if instance_methods.include?(name)
-          routes << [name, args, block]
-        else
-          super
-        end
-      end
-    end
-
-    def call(env)
-      dup.call!(env)
-    end
-
-    def call!(env)
-      @context = 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
-
-      catch (:complete) do
-        begin
-          if marshaller.nil?
-            @context.rejections << Rejection.new(:accept, { supported: self.class.marshallers.map(&:media_type) })
-          else
-            self.class.routes.each do |route|
-              name, args, block = route
-              route_block = proc { instance_eval(&block) }
-              send(name, *args, &route_block)
-            end
-          end
-          handle_rejections(@context.rejections)
-        rescue => e
-          handle_error(e)
-        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))
-      [resp.status, resp.headers.map { |h| [h.name, h.to_s] }.to_h, resp.body]
-    end
-
-    def handle_error(e)
-      puts "handle_error: #{e.class}: #{e}\n  #{e.backtrace.join("\n  ")}"
-      case e
-      when ParseError
-        fail 400, e.message
-      else
-        fail 500, e.message # TODO: Only if verbose errors configured
-      end
-    end
-
-    def handle_rejections(rejections)
-      puts "handle_rejections: #{rejections}"
-      if rejections.empty?
-        fail 404
-      else
-        rejection = rejections.first
-        case rejection.reason
-        when :accept
-          fail 406, "Supported media types: #{rejection[:supported].join(", ")}"
-        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(", ")}"
-        when :unauthorized
-          if rejection[:scheme]
-            challenge = Headers::Challenge.new(rejection[:scheme], rejection.info.except(:scheme))
-            respond_with_header Headers::WWWAuthenticate.new(challenge) do
-              fail 401
-            end
-          else
-            fail 401
-          end
-        else
-          fail 500
-        end
-      end
-    end
-
-  end
-
-end