xenon 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f05aa3e37aef60ceb5222b097b411a15d3c38874
-  data.tar.gz: 2b1c1226260313cc76c9a2768c3c761038adeedb
+  metadata.gz: c82b7b50f76ea05e462ab4969825863e27e1f51a
+  data.tar.gz: 033692599c1325d96064ee10d72ff2302b51db5f
 SHA512:
-  metadata.gz: b19aaf5f2e92fe435ed3ca6723af7484aa410578684a0fb0b6ba908ad442d9d866159912afc087eb03ddfd112a02013bca5a73c99c9d7549dfc3ad9203fb737a
-  data.tar.gz: 74594a32ddfce37b50224584a2b5a13dc869a8a5a7ffa87c50e20a0af79c1ea38cafa9b8f332e2c55e3971e752d7e62b7ddade445990e8b8340e72fd36e23c19
+  metadata.gz: 55964419254b71d4c37032fc6c51fb0bda9ac770b04353b0b0f6e79428b372ce723504a33b0331380440398586ba1f647171e142188d34557e144b8632409689
+  data.tar.gz: 1ff9d197b45558a4dc20ad0f5dbd8ce037ea4301384149d66ebc29d80787c05f3b4be3b5dde9ea9e2eb110af18af0834423a9edc0f3f04cbd4d0dc3d89bae391

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

@@ -21,3 +21,5 @@ Gemfile.lock
 ## Environment normalisation:
 /.bundle/
 /lib/bundler/man/
+.ruby-gemset
+.ruby-version

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,13 @@
 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,37 +1,5 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features)
-
-## Uncomment to clear the screen before every task
 clearing :on
 
-## Guard internally checks for changes in the Guardfile and exits.
-## If you want Guard to automatically start up again, run guard in a
-## shell loop, e.g.:
-##
-##  $ while bundle exec guard; do echo "Restarting Guard..."; done
-##
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
 guard :rspec, cmd: "bundle exec rspec" do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)

data/README.md

@@ -1,7 +1,55 @@
 # 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:
@@ -16,17 +64,23 @@ Or install it yourself as:
 
     $ gem install xenon
 
-## Usage
-
-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, feel free to have a play around, raise bugs, and contribute if you're interested.
-
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/xenon/fork )
+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/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,17 @@
+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

@@ -2,16 +2,12 @@ require 'json'
 require 'rack'
 require 'active_support/core_ext/string'
 require 'xenon/headers'
-require 'xenon/routing'
+require 'xenon/routing/directives'
 require 'xenon/version'
 
 module Xenon
 
   class Rejection
-    ACCEPT = 'ACCEPT'
-    HEADER = 'HEADER'
-    METHOD = 'METHOD'
-
     attr_reader :reason, :info
 
     def initialize(reason, info = {})
@@ -29,8 +25,7 @@ module Xenon
 
     def initialize(rack_req)
       @rack_req = rack_req
-      @unmatched_path = rack_req.path
-      freeze
+      @unmatched_path = rack_req.path.freeze
     end
 
     def request_method
@@ -38,11 +33,12 @@ module Xenon
     end
 
     def form_hash
-      @rack_req.POST
+      @form_hash ||= @rack_req.POST.with_indifferent_access.freeze
     end
 
-    def query_hash
-      @rack_req.GET
+    def param_hash
+      puts "GET = #{@rack_req.GET.inspect}"
+      @param_hash ||= @rack_req.GET.with_indifferent_access.freeze
     end
 
     def header(name)
@@ -56,13 +52,8 @@ module Xenon
 
     def copy(changes = {})
       r = dup
-      changes.each { |k, v| r.instance_variable_set("@#{k}", v) }
-      r.freeze
-    end
-
-    def freeze
-      @unmatched_path.freeze
-      super
+      changes.each { |k, v| r.instance_variable_set("@#{k}", v.freeze) }
+      r
     end
   end
 
@@ -90,14 +81,6 @@ module Xenon
       @body.freeze
       super
     end
-
-    def self.error(status, developer_message = nil)
-      body = { 
-        status: status, 
-        developer_message: developer_message || Rack::Utils::HTTP_STATUS_CODES[status]
-      }
-      Response.new.copy(complete: true, status: status, body: body)
-    end
   end
 
   class Context
@@ -156,7 +139,7 @@ module Xenon
     end
   end
 
-  class Api
+  class API
     include Xenon::Routing::Directives
 
     DEFAULT_MARSHALLERS = [JsonMarshaller.new]
@@ -178,8 +161,18 @@ module Xenon
 
     attr_reader :context
 
-    def route
-      raise NotImplementedError.new
+    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)
@@ -191,17 +184,23 @@ module Xenon
 
       accept = @context.request.header('Accept')
       marshaller = accept ? self.class.select_marshaller(accept.media_ranges) : self.class.marshallers.first
-      begin
-        if marshaller.nil?
-          @context.rejections << Rejection.new(Rejection::ACCEPT, { supported: self.class.marshallers.map(&:media_type) })
-        else
-          catch (:complete) { route }
+
+      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
-        @context.response = handle_rejections(@context.rejections) unless @context.response.complete?
-      rescue => e
-        @context.response = handle_error(e)
       end
-      @context.response = Response.error(501, 'The response was not completed') unless @context.response.complete?
 
       marshaller ||= self.class.marshallers.first
       resp = @context.response.copy(
@@ -211,26 +210,40 @@ module Xenon
     end
 
     def handle_error(e)
-      puts "handle_error: #{e}"
-      @context.response = Response.error(500)
+      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?
-        Response.error(404)
+        fail 404
       else
         rejection = rejections.first
         case rejection.reason
-        when Rejection::ACCEPT
-          Response.error(406, "Supported media types: #{rejection[:supported].join(", ")}")
-        when Rejection::HEADER
-          Response.error(400, "Missing required header: #{rejection[:required]}")
-        when Rejection::METHOD
-          supported = rejections.take_while { |r| r.reason == Rejection::METHOD }.map { |r| r[:supported].upcase }
-          Response.error(405, "Supported methods: #{supported.join(", ")}")
-        else 
-          Response.error(500)
+        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

data/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