opi 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d5fda4ffbb7acce5d6c4a7f0f0fcc91d9c1cd2f
-  data.tar.gz: 1e27c75791cd7020ae3e94657dca5b42eedeebd6
+  metadata.gz: c83ed04de99dfd5352546b0548455cd791b4434c
+  data.tar.gz: 436349cc1d191ae3d38447f991fdac2f64ef26c2
 SHA512:
-  metadata.gz: 3628bf167bae180b00fc035355e8841b0840eeed852c4e7d040563198fb3b24ac531c637066d40937b1b39692b6ea96954c8a635378e03dc5c39b968a240984c
-  data.tar.gz: 12ebe8eb10d4f4144f841051d03d8a11d6331363d47d8332f4d54e98b61c64ebe44f3bb3bf0b2a734ad210ea52b14a4ee8de8c6a948b97e9d7f20d98d4a68f94
+  metadata.gz: 9d446295c4c31a858d8d0a1795c4fc87e864fb47bad18b143349f3a20b7138165fda6669ed1d04f3ea512ba730464eeb81152bc8722dda339b2e006c812a59d2
+  data.tar.gz: 25f21eae30b44928e3af096159e39bda11f7d0ee2d098d1873e4337a8b6ef56f2df2dc191876ac84fcf008569fad7f55b84bec0c10be42b0cac43afc7875fd88

data/{README.textile → README.md}

@@ -1,10 +1,10 @@
-h1. Opi - The very opinionated API service library
+# Opi - The very opinionated API service library
 
-h2. Install the gem
+## Install the gem
 
 gem 'opi'
 
-h2. About
+## About
 
 Opi is a very opinionated rack-compliant API service library.  In fact, it is
 so opinionated it is very likely to offend.  But that is alright.
@@ -12,64 +12,75 @@ so opinionated it is very likely to offend.  But that is alright.
 Opi was born out of frustration with writing too much boilerplate code for api
 services.
 
-*JSON-only*.  The server CANNOT respond with anything else other than JSON.
+**JSON-only**.  The server CANNOT respond with anything else other than JSON.
 All error responses are JSON out of the box.  You CANNOT respond with HTML.
 The response content type is hardcoded to JSON.
 
-*No Controllers*.  Well.. there are route blocks which are the equivalent
+**No Controllers**.  Well.. there are route blocks which are the equivalent
 of the controller but you are strongly encouraged to only ever execute actions
 in these blocks (the server is looking out for those actions as responses).
 The only role of the 'controller' here is to map HTTP inputs to Action inputs.
 
-*Action-based*.  All logic is an action.  Actions validate their own inputs
+**Action-based**.  All logic is an action.  Actions validate their own inputs
 and have no access to anything HTTP-related.  These are domain-specific actions
 that can be pulled out and used anywhere.
 
-*No Sessions or Cookies*.  None.
+**No Sessions or Cookies**.  None.
 
 But this has its advantages.  It is *fast* and *simple*.
 
-h2. Example
+## Example
 
 This simple example doesn't really go into the detail of Actions but it does
 demonstrate the routes, responses, before filters and helpers.
 
 <code>api.rb</code>
 
-<pre><code>module Example
+```ruby
+module Example
   class API < Opi::API
 
     before :authorize!
 
+    get '/boom', :skip => :authorize! do
+      raise 'boom'
+    end
+
     get '/ping', :skip => :authorize! do
       {:pong => Time.now.to_i}
     end
 
-    get '/meaning' do
+    get '/users/:id' do
+      params
+    end
+
+    post '/meaning' do
       {:answer => 42}
     end
 
     helpers do
       def authorize!
-        error!('401 Unauthorized', 401) unless params['secret'] == '1234'
+        error!('401 Unauthorized', 401) unless params[:secret] == '1234'
       end
     end
 
   end
 end
-</code></pre>
+```
 
 <code>config.ru</code>
 
-<pre><code>require 'opi'
+```ruby
+require 'opi'
 
 load './api.rb'
 run Example::API.new
-</code></pre>
+```
 
 <code>output</code>
 
-<pre><code>$ curl -i http://0.0.0.0:9292/ping
+```bash
+$ curl -i http://0.0.0.0:9292/ping
 HTTP/1.1 200 OK
 Content-Type: application/json
 Transfer-Encoding: chunked
@@ -90,10 +101,24 @@ Transfer-Encoding: chunked
 
 {"answer":42}
 
+$ curl -i http://0.0.0.0:9292/users/1?secret=1234
+HTTP/1.1 200 OK
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"secret":"1234","id":"1"}
+
 $ curl -i http://0.0.0.0:9292/nonexistant
 HTTP/1.1 404 Not Found
 Content-Type: application/json
 Transfer-Encoding: chunked
 
 {"error":"404 Not Found"}
-</code></pre>
+
+$ curl -i http://0.0.0.0:9292/boom
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"error":"500 Internal Server Error", "message":"boom"}
+```

data/lib/opi.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'mutations'
 
 require_relative './opi/version'
+require_relative './opi/router'
 require_relative './opi/api'
 require_relative './opi/request'
 require_relative './opi/response'
@@ -12,5 +13,4 @@ require_relative './opi/context'
 require_relative './opi/loader'
 
 module Opi
-  VERSION = '1.0'
 end

data/lib/opi/api.rb

@@ -2,6 +2,9 @@ module Opi
   class API
 
     class << self
+
+      puts "* Opi Version: #{Opi::VERSION}".green
+
       def get(path, options={}, &block)
         route 'GET', path, options, block
       end
@@ -20,7 +23,7 @@ module Opi
 
       def route(method, path, options={}, block)
         # TODO: remove&replace existing routes (on reload)
-        routes.unshift({:method => method, :path => path, :options => options, :block => block})
+        router.routes.unshift({:method => method, :path => path, :options => options, :block => block})
       end
 
       def before(method)
@@ -39,8 +42,8 @@ module Opi
         @after_filters ||= []
       end
 
-      def routes
-        @routes ||= []
+      def router
+        @router ||= Router.new
       end
 
       def helpers(&block)
@@ -57,7 +60,9 @@ module Opi
 
         request = Request.new(env)
 
-        route = self.class.routes.detect{|x| x[:method] == request.method and x[:path] == request.path}
+        route, params = self.class.router.route(request.method, request.path)
+        request.params.merge!(params) if params and params.is_a? Hash
+        request.params.merge!('splat' => params.join(',')) if params and params.is_a? Array
 
         return [404, {'Content-Type' => 'application/json'}, ["{\"error\":\"404 Not Found\"}", "\n"]] unless route
 

data/lib/opi/context.rb

@@ -14,7 +14,7 @@ module Opi
     end
 
     def params
-      @request.params
+      {}.tap {|h| @request.params.each{|x| h[x.first.to_sym] = x.last}}
     end
 
     def error!(message, status)
@@ -43,7 +43,7 @@ module Opi
       # before filters must have succeeded
       action = instance_eval &route[:block]
 
-      if action.is_a? Opi::Action
+      if action.kind_of? Opi::Action or action.kind_of? Mutations::Outcome
         if action.success?
           response.status = 200
           response.body = [action.result.to_json, "\n"]

data/lib/opi/router.rb

@@ -0,0 +1,32 @@
+class Router
+  attr_accessor :routes
+
+  WILDCARD_PATTERN = /\/\*/
+  NAMED_SEGMENTS_PATTERN = /\/:([^$\/]+)/
+  NAMED_SEGMENTS_REPLACEMENT_PATTERN = /\/:([^$\/]+)/
+
+  def initialize(routes=[])
+    @routes = routes
+  end
+
+  def route(method, path)
+    method_routes = self.routes.find_all{|x| x[:method] == method}
+    method_routes.each do |route|
+      if route[:path] =~ WILDCARD_PATTERN
+        src = "\\A#{route[:path].gsub('*','(.*)')}\\Z"
+        if match = path.match(Regexp.new(src))
+          return [route, match[1].split('/')]
+        end
+      elsif route[:path] =~ NAMED_SEGMENTS_PATTERN
+        src = "\\A#{route[:path].gsub(NAMED_SEGMENTS_REPLACEMENT_PATTERN, '/(?<\1>[^$/]+)')}\\Z"
+        if match = path.match(Regexp.new(src))
+          return [route, Hash[match.names.zip(match.captures)]]
+        end
+      elsif path == route[:path]
+        return [route]
+      end
+    end
+    nil
+  end
+
+end

data/lib/opi/version.rb

@@ -1,3 +1,3 @@
 module Opi
-  VERSION = "0.1"
-end
+  VERSION = "0.2"
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: opi
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Richard Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: mutations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
 description: The very opinionated API service library.
@@ -72,8 +72,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.textile
 - LICENSE
+- README.md
 - lib/opi.rb
 - lib/opi/action.rb
 - lib/opi/api.rb
@@ -81,29 +81,30 @@ files:
 - lib/opi/loader.rb
 - lib/opi/request.rb
 - lib/opi/response.rb
+- lib/opi/router.rb
 - lib/opi/version.rb
 homepage: http://github.com/moomerman/opi
 licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --inline-source
-- --charset=UTF-8
+- "--inline-source"
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: opi
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: The very opinionated API service library.