sliver 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df142423f5a7c0f22884aea4f0399060f48c996d
-  data.tar.gz: d3a322be8b8ad57a96e47799b4f5fcb9f3c7b01c
+  metadata.gz: 0bdc908dcc8c917965d1acfd2b79b8f290917e7a
+  data.tar.gz: cb6fcbcbe3f42041052410562e6d9d7cf68edbd9
 SHA512:
-  metadata.gz: 3b81d54267bd062858aa75e4a8973af6e85d453f72a867a465689c4287c1311d50013676bb7f0910e2ba77c54429673eb4c7101661439969edae09b0f8e5cc9b
-  data.tar.gz: 07f226603923b2580c1f29ffe864d0d320207eb670f7bbad77b2f689832532fa9df115b1e00313ff36d0287c3cba8c4c50f8fc480d7780e3278ae83c3a9d277d
+  metadata.gz: bd4f2fb4cf61ee61a845ddeaa5c4e37ab737c152727aafc016a6379601e619a9cf802ba5fcc019987e3989d95f4e03d65ddacdf55a9a3d592ff9ea52dbaf2f80
+  data.tar.gz: 4b93baa6b44dd3eadb0914bae0e10fba15687933642cbca7b36c5f25ae352c6835bda079667362b0adc409259e2546ca6a057a8bb24eb438e4f3296c014ad11f

data/README.md

@@ -13,7 +13,7 @@ Early days of development, so things may change dramatically. Or not. Who knows.
 Add it to your Gemfile like any other gem, or install it manually.
 
 ```ruby
-gem 'sliver', '~> 0.0.5'
+gem 'sliver', '~> 0.1.0'
 ```
 
 ## Usage
@@ -26,8 +26,8 @@ array with three items: status code, headers, and body).
 So, a response can be as simple as a lambda/proc, or it can be a complex class.
 If you want to deal with classes, you can mix in `Sliver::Action` to take
 advantage of some helper methods (and it already stores environment via
-`attr_reader`), and it returns a `Sliver::Response` class which is translated to
-the standard Rack response. Each instance of a class that mixes in
+`attr_reader`), and it returns a `Sliver::Response` class which is translated
+to the standard Rack response. Each instance of a class that mixes in
 `Sliver::Action` is handling a specific API request.
 
 ```ruby

data/lib/sliver/action.rb

@@ -5,12 +5,11 @@ module Sliver::Action
 
   module ClassMethods
     def call(environment)
-      response = Sliver::Response.new
-
-      action = new(environment, response)
-      action.call unless action.skip?
+      Sliver::Runner.new(self, environment).call
+    end
 
-      response.to_a
+    def guards
+      []
     end
   end
 
@@ -18,6 +17,10 @@ module Sliver::Action
     @environment, @response = environment, response
   end
 
+  def request
+    @request ||= Rack::Request.new environment
+  end
+
   def skip?
     false
   end
@@ -26,7 +29,7 @@ module Sliver::Action
 
   attr_reader :environment, :response
 
-  def request
-    @request ||= Rack::Request.new environment
+  def path_params
+    @path_params ||= environment['sliver.path'].to_params environment
   end
 end

data/lib/sliver/api.rb

@@ -2,15 +2,13 @@ class Sliver::API
   NOT_FOUND = lambda { |environment| [404, {}, ['Not Found']] }
 
   def initialize(&block)
-    @endpoints = Hash.new { |hash, key| hash[key] = Sliver::Endpoints.new }
+    @endpoints = Sliver::Endpoints.new
 
     block.call self
   end
 
   def call(environment)
-    method   = environment['REQUEST_METHOD']
-    path     = environment['PATH_INFO']
-    endpoint = endpoints[method].find(path)
+    endpoint = endpoints.find environment
 
     endpoint.nil? ? NOT_FOUND.call(environment) : invoke(endpoint, environment)
   end
@@ -20,9 +18,7 @@ class Sliver::API
   end
 
   def connect(method, path, action)
-    method = method.to_s.upcase
-
-    endpoints[method].append path, action
+    endpoints.append Sliver::Path.new(method, path), action
   end
 
   private

data/lib/sliver/endpoints.rb

@@ -4,19 +4,15 @@ class Sliver::Endpoints
   end
 
   def append(path, action)
-    path = '/' if path == ''
-
     paths[path] = action
   end
 
-  def find(path)
-    path = '/' if path == ''
-
-    key = paths.keys.detect { |key|
-      key.is_a?(String) ? (key == path) : path[/\A#{key}\z/]
-    }
+  def find(environment)
+    key = paths.keys.detect { |key| key.matches?(environment) }
+    return nil unless key
 
-    key && paths[key]
+    environment['sliver.path'] = key
+    paths[key]
   end
 
   private

data/lib/sliver/path.rb

@@ -0,0 +1,43 @@
+class Sliver::Path
+  def initialize(http_method, string)
+    @http_method = http_method.to_s.upcase
+    @string      = normalised_path string
+  end
+
+  def matches?(environment)
+    method = environment['REQUEST_METHOD']
+    path   = normalised_path environment['PATH_INFO']
+
+    http_method == method && path[string_to_regexp]
+  end
+
+  def to_params(environment)
+    return {} unless matches?(environment)
+
+    path   = normalised_path environment['PATH_INFO']
+    values = path.scan(string_to_regexp).flatten
+
+    string_keys.each_with_index.inject({}) do |hash, (key, index)|
+      hash[key] = values[index]
+      hash
+    end
+  end
+
+  private
+
+  attr_reader :http_method, :string
+
+  def normalised_path(string)
+    string == '' ? '/' : string
+  end
+
+  def string_keys
+    @string_keys ||= string.to_s.scan(/:([\w-]+)/i).flatten
+  end
+
+  def string_to_regexp
+    @string_to_regexp ||= Regexp.new(
+      "\\A" + string.to_s.gsub(/:[\w-]+/, "([\\w-]+)") + "\\z"
+    )
+  end
+end

data/lib/sliver/runner.rb

@@ -0,0 +1,32 @@
+class Sliver::Runner
+  def initialize(klass, environment)
+    @klass, @environment = klass, environment
+  end
+
+  def call
+    guard_classes.each do |guard_class|
+      guard = guard_class.new(action)
+      return guard.response unless guard.continue?
+    end
+
+    action.call unless action.skip?
+
+    response.to_a
+  end
+
+  private
+
+  attr_reader :klass, :environment
+
+  def action
+    @action ||= klass.new environment, response
+  end
+
+  def guard_classes
+    klass.guards
+  end
+
+  def response
+    @response ||= Sliver::Response.new
+  end
+end

data/lib/sliver.rb

@@ -5,4 +5,6 @@ end
 require 'sliver/action'
 require 'sliver/api'
 require 'sliver/endpoints'
+require 'sliver/path'
 require 'sliver/response'
+require 'sliver/runner'

data/sliver.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'sliver'
-  spec.version       = '0.0.5'
+  spec.version       = '0.1.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = %q{Lightweight, simple Rack APIs}

data/spec/acceptance/class_api_spec.rb

@@ -42,6 +42,61 @@ class SkippedAction
   end
 end
 
+class MyParamGuard
+  def initialize(action)
+    @action = action
+  end
+
+  def continue?
+    action.request.params['hello'] == 'world'
+  end
+
+  def response
+    [404, {}, ['Not Found']]
+  end
+
+  private
+
+  attr_reader :action
+end
+
+class GuardedAction
+  include Sliver::Action
+
+  def self.guards
+    [MyParamGuard]
+  end
+
+  def call
+    response.status = 200
+    response.body   = ['Welcome']
+  end
+end
+
+class UnguardedAction < GuardedAction
+  def self.guards
+    super - [MyParamGuard]
+  end
+end
+
+class IdAction
+  include Sliver::Action
+
+  def call
+    response.status = 200
+    response.body = [path_params['id']]
+  end
+end
+
+class MultiPathPartAction
+  include Sliver::Action
+
+  def call
+    response.status = 200
+    response.body = ["#{path_params['first']}:#{path_params['second']}"]
+  end
+end
+
 describe 'Class-based Sliver API' do
   include Rack::Test::Methods
 
@@ -50,6 +105,10 @@ describe 'Class-based Sliver API' do
     api.connect :put, '/echo',     EchoAction
     api.connect :get, '/addition', AdditionAction
     api.connect :get, '/skip',     SkippedAction
+    api.connect :get, '/guard',    GuardedAction
+    api.connect :get, '/unguard',  UnguardedAction
+    api.connect :get, '/my/:id',   IdAction
+    api.connect :get, '/my/:first/:second', MultiPathPartAction
   end }
 
   it 'constructs responses' do
@@ -78,4 +137,39 @@ describe 'Class-based Sliver API' do
     expect(last_response.status).to eq(400)
     expect(last_response.body).to eq('Invalid')
   end
+
+  it 'blocks guarded actions if they cannot continue' do
+    get '/guard'
+
+    expect(last_response.status).to eq(404)
+    expect(last_response.body).to eq('Not Found')
+  end
+
+  it 'accepts guarded actions that meet criteria' do
+    get '/guard', 'hello' => 'world'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('Welcome')
+  end
+
+  it 'respects subclass guard changes' do
+    get '/unguard'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('Welcome')
+  end
+
+  it 'handles path parameter markers' do
+    get '/my/10'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('10')
+  end
+
+  it 'handles multiple path parameter markers' do
+    get '/my/10/foo'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('10:foo')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sliver
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -69,7 +69,9 @@ files:
 - lib/sliver/action.rb
 - lib/sliver/api.rb
 - lib/sliver/endpoints.rb
+- lib/sliver/path.rb
 - lib/sliver/response.rb
+- lib/sliver/runner.rb
 - sliver.gemspec
 - spec/acceptance/class_api_spec.rb
 - spec/acceptance/lambda_api_spec.rb