krack 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+# Krack
+
+Simple JSON APIs on Rack. Like so:
+
+    # config.ru
+    
+    require 'krack'
+    
+    module Widgets
+      class Show
+        def respond
+          widget = Widget.find(params["id"])
+          {widget: widget.as_json}
+        end
+      end
+    end
+
+    run Krack::Router.new {
+      get "/widgets/:id", Widgets::Show
+    }

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :spec => :test
+

data/krack.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'krack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "krack"
+  gem.version       = Krack::VERSION
+  gem.authors       = ["Kovalo"]
+  gem.email         = ["team@kovalo.com"]
+  gem.description   = "Simple JSON APIs on Rack"
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/kovalo/krack"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rack', '~> 1.5.2'
+  gem.add_runtime_dependency 'multi_json'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+end

data/lib/krack/endpoint.rb

@@ -0,0 +1,49 @@
+module Krack
+  class Endpoint
+    attr_reader :env, :request, :response, :params
+
+    def call(env)
+      dup.call!(env)
+    end
+
+    def call!(env)
+      @env      = env
+      @request  = Rack::Request.new(env)
+      @response = Rack::Response.new([], 200, {"Content-Type" => "application/json"})
+      @params   = env["krack.params"].merge(@request.params)
+
+      on_call
+      data = begin
+        respond_or_halt
+      rescue
+        on_error($!)
+      end
+
+      @response.write(output(data))
+      @response.finish
+    end
+
+    def respond_or_halt
+      halt = catch(:halt) { return respond }
+      on_halt(halt)
+    end
+
+    def on_call; end
+
+    def on_error(error)
+      Krack::Error.new(500).respond
+    end
+
+    def on_halt(halt)
+      Krack::Error.new(halt).respond
+    end
+
+    def output(data)
+      MultiJson.dump(data, :time_format => :ruby)
+    end
+
+    def respond
+      raise "#respond method is not defined in #{self.class}"
+    end
+  end
+end

data/lib/krack/error.rb

@@ -0,0 +1,14 @@
+module Krack
+  class Error < StandardError
+
+    attr_accessor :status
+
+    def initialize(status=500)
+      @status = status
+    end
+
+    def respond
+      {error: {status: status, message: Rack::Utils::HTTP_STATUS_CODES[status]}}
+    end
+  end
+end

data/lib/krack/router.rb

@@ -0,0 +1,47 @@
+module Krack
+  class Router
+    attr_reader :routes
+
+    def initialize(&block)
+      @routes = []
+      instance_eval(&block) if block
+    end
+
+    def call(env)
+      @routes.each do |verb, route, app|
+        next unless verb == env["REQUEST_METHOD"]
+        next unless match = env["PATH_INFO"].match(route)
+
+        env["krack.params"] = Hash[match.names.zip(match.captures)]
+        return app.dup.call(env)
+      end
+      not_found
+    end
+    
+    def not_found
+      [404, {"Content-Type" => "text/plain"}, ["Not found"]]
+    end
+
+    # Defines methods for each HTTP verb. These methods just call #map
+    # with the corresponding verb argument.
+    %w[get post put delete patch].each do |verb|
+      define_method(verb) { |route, to| map(verb.upcase, route, to) }
+    end
+
+    def map(verb, route, to)
+      # Converts route params to regex named groups, like so:
+      # "/deals/:id" -> "/deals/(?<id>\w+)"
+      route.gsub!(/:\w+/) { |param| "(?<#{param[1..-1]}>\\w+)" }
+
+      # Allow optional trailing slash, add start/end tokens
+      route = "\\A#{route}\\/?\\z"
+
+      # App can be either a Rack class or an instance of such, e.g.
+      # Endpoints::Deals::Near or lambda { |env| ... }
+      # What goes into @routes is something that responds to #call
+      app = to.respond_to?(:call) ? to : to.new
+
+      @routes << [verb, Regexp.new(route), app]
+    end
+  end
+end

data/lib/krack/version.rb

@@ -0,0 +1,3 @@
+module Krack
+  VERSION = "0.0.1"
+end

data/lib/krack.rb

@@ -0,0 +1,7 @@
+require 'rack'
+require 'multi_json'
+
+require 'krack/version'
+require 'krack/error'
+require 'krack/router'
+require 'krack/endpoint'

data/spec/router_spec.rb

@@ -0,0 +1,65 @@
+require_relative 'spec_helper'
+
+describe Krack::Router do
+  before do
+    @router = Krack::Router.new {
+      get "/deals",             lambda { |env| 1 }
+      get "/deals/:id",         lambda { |env| 2 }
+      get "/deals/foo/bar",     lambda { |env| 3 }
+      post "/deals/:one/:two",  lambda { |env| 4 }
+      get "/users/best",        lambda { |env| 5 }
+      get "/users/:id",         lambda { |env| 6 }
+    }
+  end
+
+  it "should match a simple route" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/deals"}
+    @router.call(env).must_equal 1
+  end
+
+  it "should allow trailing slash" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/deals/"}
+    @router.call(env).must_equal 1
+  end
+
+  it "should match a longer simple route" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/deals/foo/bar"}
+    @router.call(env).must_equal 3
+  end
+
+  it "should not match when request method is wrong" do
+    env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/deals"}
+    @router.call(env).first.must_equal 404
+  end
+
+  it "should not allow a partial match" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/foo/deals"}
+    @router.call(env).first.must_equal 404
+  end
+
+  it "should match a route with param" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/deals/42"}
+    @router.call(env).must_equal 2
+  end
+
+  it "should populate env krack.params" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/deals/42"}
+    @router.call(env)
+    env["krack.params"].must_equal({"id" => "42"})
+  end
+
+  it "should match a route with multiple params" do
+    env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/deals/42/99"}
+    @router.call(env).must_equal 4
+  end
+
+  it "should choose the first defined route when multiple routes match" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/users/best"}
+    @router.call(env).must_equal 5
+  end
+
+  it "should allow non-integer params" do
+    env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "/users/worst"}
+    @router.call(env).must_equal 6
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require_relative '../lib/krack'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: krack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kovalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple JSON APIs on Rack
+email:
+- team@kovalo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- krack.gemspec
+- lib/krack.rb
+- lib/krack/endpoint.rb
+- lib/krack/error.rb
+- lib/krack/router.rb
+- lib/krack/version.rb
+- spec/router_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kovalo/krack
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple JSON APIs on Rack
+test_files:
+- spec/router_spec.rb
+- spec/spec_helper.rb
+has_rdoc: