sliver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 606c72d36976f690024b04140c2c47b4d537ad19
+  data.tar.gz: 692fbe6fa8ffb13ddcc4a5bd0d0598ede82302ca
+SHA512:
+  metadata.gz: b319b0442c56ca705818f2248d1a8aa18fd06e019826dfedf887246e60d745f1f76776ca84840fd593b6b8783bc8962cfa483d18bc9c0ceaeebbc3d09cffec0e
+  data.tar.gz: 210a95f4674840b127ac01e4d05b37d70434749cefc7dd1bf38656748683692b0a0107f7c777b21fa8233529bb74232844588b4a187ef5446cfacc505909664a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: bundle exec rspec spec
+cache: bundler
+rvm:
+  - 2.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pat Allan
+
+MIT License
+
+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,103 @@
+# Sliver
+
+A super simple, extendable Rack API.
+
+## Installation
+
+Add it to your Gemfile like any other gem, or install it manually.
+
+```ruby
+gem 'sliver', '~> 0.0.1'
+```
+
+## Usage
+
+Create a new API (a Rack app, of course), and specify paths with corresponding
+responses. Responses can be anything that responds to `call` with a single
+argument (the request environment) and returns a standard Rack response (an
+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
+`Sliver::Action` is handling a specific API request.
+
+```ruby
+app = Sliver::API.new do |api|
+  #Endpoints can be namespaced by a path - for example, a version.
+  api.path = '/v1'
+
+  # GET /v1/
+  api.connect :get, '/', lambda { |environment|
+    [200, {}, ['How dare the Premier ignore my invitations?']]
+  }
+
+  # PUT /v1/change
+  api.connect :put, '/change', ChangeAction
+end
+
+class ChangeAction
+  include Sliver::Action
+
+  def call
+    # Change the status:
+    response.status = 404
+
+    # Add to the response headers:
+    response.headers['Content-Type'] = 'text/plain'
+
+    # Add a response body - let's provide an array, like Rack expects:
+    response.body = [
+      "How dare the Premier ignore my invitations?",
+      "He'll have to go",
+      "So, to the bunch he luncheons with",
+      "It's second on my list of things to do"
+    ]
+
+    # Access the request environment:
+    self.environment
+
+    # Access to a Rack::Request object built from that environment:
+    self.request
+  end
+end
+```
+
+If you want all responses to API requests to share some behaviour - say, for
+example, you are always returning JSON - then you can create your own base class
+for this purpose:
+
+```ruby
+class JSONAction
+  include Sliver::Action
+
+  def call
+    response.headers['Content-Type'] = 'application/json'
+    response.body = [JSON.generate(response.body)]
+  end
+end
+
+class ChangeAction < JSONAction
+  def call
+    response.status = 200
+    response.body   = {'status' => 'OK'}
+
+    super
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/pat/sliver/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
+
+## Licence
+
+Copyright (c) 2014, Sliver is developed and maintained by Pat Allan, and is
+released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sliver/action.rb

@@ -0,0 +1,22 @@
+module Sliver::Action
+  def self.included(base)
+    base.extend Sliver::Action::ClassMethods
+  end
+
+  module ClassMethods
+    def call(environment)
+      response = Sliver::Response.new
+      new(environment, response).call
+
+      response.to_a
+    end
+  end
+
+  def initialize(environment, response)
+    @environment, @response = environment, response
+  end
+
+  private
+
+  attr_reader :environment, :response
+end

data/lib/sliver/api.rb

@@ -0,0 +1,29 @@
+class Sliver::API
+  attr_accessor :path
+
+  def initialize(&block)
+    @endpoints = {}
+    @path      = ''
+
+    block.call self
+  end
+
+  def call(environment)
+    method    = environment['REQUEST_METHOD']
+    path_info = environment['PATH_INFO'].gsub(/\A#{path}/, '')
+    endpoint  = endpoints[method][path_info]
+
+    endpoint ? endpoint.call(environment) : [404, {}, ['Not Found']]
+  end
+
+  def connect(method, path, action)
+    method = method.to_s.upcase
+
+    endpoints[method]     ||= {}
+    endpoints[method][path] = action
+  end
+
+  private
+
+  attr_reader :endpoints
+end

data/lib/sliver/response.rb

@@ -0,0 +1,11 @@
+class Sliver::Response
+  attr_accessor :status, :headers, :body
+
+  def initialize
+    @headers = {}
+  end
+
+  def to_a
+    [status, headers, body]
+  end
+end

data/lib/sliver.rb

@@ -0,0 +1,7 @@
+module Sliver
+  #
+end
+
+require 'sliver/action'
+require 'sliver/api'
+require 'sliver/response'

data/sliver.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'sliver'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = %q{Lightweight, simple Rack APIs}
+  spec.description   = %q{A super simple, object-focused extendable Rack API.}
+  spec.homepage      = 'https://github.com/pat/sliver'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack', '>= 1.5.2'
+
+  spec.add_development_dependency 'rack-test', '>= 0.6.2'
+  spec.add_development_dependency 'rspec',     '>= 3.0.0.beta2'
+end

data/spec/acceptance/class_api_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class GetAction
+  include Sliver::Action
+
+  def call
+    response.status  = 200
+    response.headers = {'Content-Type' => 'text/plain'}
+    response.body    = ['foo']
+  end
+end
+
+class EchoAction
+  include Sliver::Action
+
+  def call
+    response.status = 200
+    response.body   = environment['rack.input'].read
+  end
+end
+
+describe 'Class-based Sliver API' do
+  include Rack::Test::Methods
+
+  let(:app) { Sliver::API.new do |api|
+    api.connect :get, '/',     GetAction
+    api.connect :put, '/echo', EchoAction
+  end }
+
+  it 'constructs responses' do
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers['Content-Type']).to eq('text/plain')
+    expect(last_response.body).to eq('foo')
+  end
+
+  it 'allows use of environment' do
+    put '/echo', 'baz'
+
+    expect(last_response.body).to eq('baz')
+  end
+end

data/spec/acceptance/lambda_api_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe 'Basic Sliver API' do
+  include Rack::Test::Methods
+
+  let(:app) { Sliver::API.new do |api|
+    api.connect :get, '/', lambda { |environment|
+      [200, {'Content-Type' => 'text/plain'}, ['foo']]
+    }
+
+    api.connect :get, '/bar', lambda { |environment|
+      [200, {'Content-Type' => 'text/plain'}, ['baz']]
+    }
+
+    api.connect :post, '/', lambda { |environment|
+      [200, {'Content-Type' => 'text/plain'}, ['qux']]
+    }
+  end }
+
+  it 'responds to GET requests' do
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers['Content-Type']).to eq('text/plain')
+    expect(last_response.body).to eq('foo')
+  end
+
+  it 'delegates to the appropriate endpoint' do
+    get '/bar'
+
+    expect(last_response.body).to eq('baz')
+  end
+
+  it 'responds to POST requests' do
+    post '/'
+
+    expect(last_response.body).to eq('qux')
+  end
+
+  it 'responds to unknown endpoints with a 404' do
+    get '/missing'
+
+    expect(last_response.status).to eq(404)
+    expect(last_response.body).to eq('Not Found')
+  end
+end
+
+describe 'Basic lambda API with a path prefix' do
+  include Rack::Test::Methods
+
+  let(:app) { Sliver::API.new do |api|
+    api.path = '/v1'
+
+    api.connect :get, '/', lambda { |environment|
+      [200, {'Content-Type' => 'text/plain'}, ['foo']]
+    }
+  end }
+
+  it 'responds to GET requests' do
+    get '/v1/'
+
+    expect(last_response.body).to eq('foo')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sliver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-03 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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+description: A super simple, object-focused extendable Rack API.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sliver.rb
+- lib/sliver/action.rb
+- lib/sliver/api.rb
+- lib/sliver/response.rb
+- sliver.gemspec
+- spec/acceptance/class_api_spec.rb
+- spec/acceptance/lambda_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pat/sliver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lightweight, simple Rack APIs
+test_files:
+- spec/acceptance/class_api_spec.rb
+- spec/acceptance/lambda_api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: