xenon-routing 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 385808aff014a3ce0b190e485996e21566ba4a96
+  data.tar.gz: 8230baa459671431db3a9728b1df184606b2a8d2
+SHA512:
+  metadata.gz: b902c768fb0dc9dfec74cef1426a1fb7eef41c5be1be85717d60d16918282a2c1fbe6ee4d8f1763f01fcb1efd6df76c8b36f295183ee10e3a0554bd1cf461508
+  data.tar.gz: fdbeec5753727366d84cf827456c09f68ee3a6d55a4cd2375fc23418ca79cf5fc5423c7952d7962a20aa12480b66b01e2234713eead71768981790e6d40d59d3

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,25 @@
+*.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

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+Dir[File.join('*', '*.gemspec')].each do |gemspec|
+  lib = gemspec.scan(/xenon-(.*)\.gemspec/).flatten.first
+  gemspec(:name => "xenon-#{lib}", development_group: lib)
+end
+
+group :development, :test do
+  gem 'rake', require: false
+  gem 'rspec', require: false
+  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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,116 @@
+# 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. As you can probably tell from the very low version number, this is in very early stages of development so I wouldn't use it anywhere close to production yet. But have a play around and let me know what you think, I'm very open to feedback.
+
+The **xenon** gem is a top-level gem that simply pulls in the other gems for convenience.
+
+## xenon-http
+
+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.
+```
+
+Yeah, it's not exciting and it's not glamorous, but if you need to parse parts of the HTTP protocol that other frameworks just don't reach, Xenon is here for you.
+
+## xenon-routing
+
+A tree-based routing approach using "directives" which gives 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 more directives!
+
+A really simple example with a custom authentication directive is shown below. You can run this from the [examples](examples/hello_world) directory!
+
+~~~ruby
+class HelloWorld < Xenon::API
+  path '/' do
+    get do
+      hello_auth do |user|
+        params :greeting do |greeting|
+          complete :ok, { greeting => user.username }
+        end
+      end
+    end
+  end
+
+  private
+
+  def hello_auth
+    @authenticator ||= Xenon::BasicAuth.new realm: 'hello world' do |credentials|
+      OpenStruct.new(username: credentials.username) # should actually auth here!
+    end
+    authenticate @authenticator do |user|
+      authorize user.username == 'greg' do
+        yield user
+      end
+    end
+  end
+end
+~~~
+
+Of course, it does all the things you'd expect like support content negotiation properly and return the correct status codes when paths or methods aren't found. For example, if you try to `POST` to the above code you'll see the error:
+
+~~~json
+{
+  "status": 405,
+  "developer_message": "Supported methods: GET"
+}
+~~~
+
+Or if you send it an `Accept` header that doesn't allow JSON (the only supported format by default) you'll see:
+
+~~~ruby
+{
+  "status": 406,
+  "developer_message": "Supported media types: application/json"
+}
+~~~
+
+## Spray
+
+Xenon is inspired by [Spray][spray], an awesome Scala framework for building RESTful APIs, and which I sorely miss while working in Ruby. However although it's inspired by it, there are some key differences.
+
+Firsly Xenon is synchronous rather than asynchronous, as that is a much more common approach to writing code in Ruby, and fits better with commonly used frameworks such as Rack and ActiveRecord. It's also much easier to write and reason about synchronous code, and you can still scale it pretty well using the process model.
+
+Secondly the directives are just methods which are composed using Ruby's usual `yield` mechanism rather than being monads composed with flat map as in Spray. This is primarily to make the framework feel natural for Ruby users where the general desire is for simplicity and "it just works". This does limit composability of directives, but for most real-world situations this doesn't seem to be a problem so I think it's the right trade-off.
+
+## 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

@@ -0,0 +1,40 @@
+# require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+task :test => :spec
+
+desc 'Do not use; use the spec task'
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Runs specifications for all gems'
+task :spec => [:'spec:http', :'spec:routing']
+namespace :spec do
+  %i[http routing].each do |lib|
+    desc "Runs specifications for the xenon-#{lib} gem"
+    task lib do
+      Dir.chdir("xenon-#{lib}") do
+        Rake::Task['rspec'].reenable
+        Rake::Task['rspec'].invoke
+      end
+    end
+  end
+end
+
+desc 'Build gems into the pkg directory'
+task :build do
+  FileUtils.rm_rf('pkg')
+  Dir[File.join('*', '*.gemspec')].each do |gemspec|
+    system "gem build #{gemspec}"
+  end
+  system "gem build xenon.gemspec"
+  FileUtils.mkdir_p('pkg')
+  FileUtils.mv(Dir['*.gem'], 'pkg')
+end
+
+desc 'Tags version, pushes to remote, and pushes gems'
+task :release => :build do
+  sh "git tag v#{File.read(File.join(__dir__, 'VERSION'))}"
+  sh "git push origin master"
+  sh "ls pkg/*.gem | xargs -n 1 gem push"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/examples/hello_world/config.ru

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

data/examples/hello_world/hello_world.rb

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

data/xenon-http/lib/xenon/auth.rb

@@ -0,0 +1,63 @@
+require 'xenon/quoted_string'
+
+module Xenon
+  class BasicCredentials
+    attr_reader :username, :password
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def token
+      Base64.strict_encode64("#{@username}:#{@password}")
+    end
+
+    def self.decode(s)
+      str = Base64.strict_decode64(s)
+      username, password = str.split(':', 2)
+      BasicCredentials.new(username, password)
+    end
+
+    def to_s
+      "Basic #{token}"
+    end
+  end
+
+  class GenericCredentials
+    using QuotedString
+
+    attr_reader :scheme, :token, :params
+
+    def initialize(scheme, token: nil, params: {})
+      @scheme = scheme
+      @token = token
+      @params = params
+    end
+
+    def to_s
+      s = @scheme.dup
+      s << ' ' << @token if @token
+      s << ' ' << @params.map { |n, v| "#{n}=#{v.quote}" }.join(', ')
+      s
+    end
+  end
+
+  class BasicAuth
+    attr_reader :auth_params
+
+    def initialize(auth_params = {}, &store)
+      @auth_params = auth_params
+      @store = store
+    end
+
+    def scheme
+      'Basic'
+    end
+
+    def call(request)
+      header = request.header('Authorization') rescue nil
+      @store.call(header.credentials) if header && header.credentials.is_a?(BasicCredentials)
+    end
+  end
+end

data/xenon-http/lib/xenon/errors.rb

@@ -0,0 +1,5 @@
+module Xenon
+  class Error < StandardError; end
+  class ParseError < Error; end
+  class ProtocolError < Error; end
+end

data/xenon-http/lib/xenon/etag.rb

@@ -0,0 +1,48 @@
+require 'xenon/parsers/header_rules'
+
+module Xenon
+  class ETag
+    attr_reader :opaque_tag
+
+  	def initialize(opaque_tag, weak: false)
+      @opaque_tag = opaque_tag
+      @weak = weak
+  	end
+
+    def self.parse(s)
+      tree = Parsers::ETag.new.etag.parse(s)
+      Parsers::ETagHeaderTransform.new.apply(tree)
+    end
+
+  	def weak?
+  	  @weak
+  	end
+
+    def strong?
+      !weak?
+    end
+
+    def strong_eq?(other)
+      strong? && other.strong? && @opaque_tag == other.opaque_tag
+    end
+
+    def weak_eq?(other)
+      @opaque_tag == other.opaque_tag
+    end
+
+    def ==(other)
+      strong? == other.strong? && @opaque_tag == other.opaque_tag
+    end
+
+    def to_s
+      s = weak? ? "W/" : ""
+      s << '"' << @opaque_tag << '"'
+    end
+  end
+
+  module Parsers
+    class ETag < Parslet::Parser
+      include ETagHeaderRules
+    end
+  end
+end