acceptable_api 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acceptable_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Craig R Webster
+
+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,172 @@
+# AcceptableApi
+
+Build an acceptable API.
+
+HTTP is pretty darn awesome you guys. Part of HTTP - the `Accept` header -
+allows the clients of our API to tell us what representation they want to work
+with. We should probably pay attention to them, hey?
+
+This is expecially important when writing an API when you may need to deal with
+several versions of a representation. When a client asks for JSON we don't
+really know if they want JSON version 1 or 5 of our representation.
+
+At some point I'll clean up my thoughts on this and write something decent.
+Until then, more reading here:
+
+  http://barkingiguana.com/2011/12/05/principles-of-service-design-program-to-an-interface/
+
+If you know better than me, please mail at me and tell me what I did wrong:
+craig@barkingiguana.com.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acceptable_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acceptable_api
+
+## Usage
+
+Assume you have a class that you want to expose via a lovely HTTP API.
+
+    class Sandwich
+      def self.find id
+        # Look up a Sandwich by ID
+      end
+
+      attr_accessor :fillings
+      attr_accessor :bread
+      attr_accessor :name
+      attr_accessor :made_at
+    end
+
+You'd declare that you wanted to expose it via the API as `/sandwiches/123` like
+this:
+
+    class SandwichApi < AcceptableApi::Controller
+      get '/sandwiches/:id' do
+        Sandwich.find params[:id]
+      end
+    end
+
+Of course, this needs to be run somehow. An `AcceptableApi::Controller` can be
+used as a Rack application. In `config.ru` do this:
+
+    require 'acceptable_api'
+    require 'sandwich_api'
+
+    run SandwichApi
+
+You can now use `rackup` as normal to launch a web server, and `curl` to access
+your API:
+
+    $ curl -i http://localhost:9292/sandwiches/123
+    HTTP/1.1 406 Not Acceptable
+    X-Frame-Options: sameorigin
+    X-Xss-Protection: 1; mode=block
+    Content-Type: application/javascript
+    Content-Length: 21
+    Server: WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
+    Date: Sat, 21 Apr 2012 19:57:59 GMT
+    Connection: Keep-Alive
+
+    {
+      "links": [
+
+      ]
+    }
+
+We got a `406 Not Acceptable` response because AcceptableApi doesn't know how to
+respond with any of the representations we'd accept. That's fair: we haven't
+told it how to respond to /any/ representations yet. Do it like this:
+
+    AcceptableApi.register Sandwich, 'application/json' do |sandwich, request|
+      JSON.generate :id => sandwich.id
+    end
+
+Let's try requesting the resource again:
+
+    $ curl -i http://localhost:9293/sandwiches/123
+    HTTP/1.1 200 OK
+    X-Frame-Options: sameorigin
+    X-Xss-Protection: 1; mode=block
+    Content-Type: application/json
+    Content-Length: 12
+    Server: WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
+    Date: Sat, 21 Apr 2012 20:03:14 GMT
+    Connection: Keep-Alive
+
+    {"id":"123"}
+
+Ace, we got a response. What happens if we ask for a plain text response?
+
+    $ curl -H 'Accept: text/plain' -i http://localhost:9292/sandwiches/123
+    HTTP/1.1 406 Not Acceptable
+    X-Frame-Options: sameorigin
+    X-Xss-Protection: 1; mode=block
+    Content-Type: application/javascript
+    Content-Length: 146
+    Server: WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
+    Date: Sat, 21 Apr 2012 20:04:46 GMT
+    Connection: Keep-Alive
+
+    {
+      "links": [
+	{
+	  "rel": "alternative",
+	  "type": "application/json",
+	  "uri": "http://localhost:9293/sandwiches/123"
+	}
+      ]
+    }
+
+As expected, this is a `406 Not Acceptable` response, but we take the
+opportunity to provide a list of alternative representations that the client may
+want to check out. Our `application/json` is listed with the type and the URI to
+request should the client want to do so.
+
+Time passes, and a we decide that our API would be more useful if it returned
+the fillings and bread used in the sandwich, and we want to replace the database
+ID with the name of the sandwich. We want to continue supporting the old API
+because lots of people are using it. We coin a new mime type in the
+`application/vnd.*` space, something we really should have done to start with,
+which specifies the returned document:
+
+    application/vnd.acme.sandwich-v1+json
+
+    A valid JSON document containing these keys and meanings:
+
+    name:: the name of the sandwich
+    fillings:: an array of fillings in the sandwich
+    bread:: the type of bread used in the sandwich
+
+And we register the type with AcceptableApi:
+
+    AcceptableApi.register Sandwich, 'application/vnd.acme.sandwich-v1+json' do |sandwich, request|
+      JSON.generate :name => sandwich.name, :fillings => sandwich.fillings,
+        :bread => sandwich.bread
+    end
+
+And we make the request:
+
+    
+
+See `example/example.rb` for an example.
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,13 @@
+* Work out if I need to use Sinatra or if I could strip out the routing
+stuff - that's just about all I've used.
+
+* Support other HTTP verbs. How could I create a Document from a POSTed
+`application/vnd.acme.document-v1+xml`?
+
+* Better documentation.
+
+* A real test-driven codebase instead of the spike I've pulled together
+here.
+
+* Do we need to consider HATEOAS style resource links in AcceptableApi or is
+that for a different project? Is anything special needed at all for this?

data/acceptable_api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acceptable_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Craig R Webster"]
+  gem.email         = ["craig@barkingiguana.com"]
+  gem.description   = %q{HTTP lets clients sned an Accept header. We should probably use that to accept more than the bog-standard mime-types.}
+  gem.summary       = %q{Build an Acceptable API}
+  gem.homepage      = "http://barkingiguana.com/2011/12/05/principles-of-service-design-program-to-an-interface/"
+
+  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.name          = "acceptable_api"
+  gem.require_paths = ["lib"]
+  gem.version       = AcceptableApi::VERSION
+  gem.add_runtime_dependency 'rack'
+  gem.add_runtime_dependency 'rack-accept'
+  gem.add_runtime_dependency 'rack-accept-header-updater'
+  gem.add_runtime_dependency 'sinatra'
+end

data/example/.gitignore

@@ -0,0 +1,2 @@
+vendor/gems
+.bundle

data/example/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'acceptable_api'
+gem 'sinatra'
+gem 'rack'
+gem 'rack-accept-header-updater'
+gem 'rack-accept'
+gem 'rake'
+
+gem 'builder'

data/example/config.ru

@@ -0,0 +1,4 @@
+require 'acceptable_api'
+require './example'
+
+run Example

data/example/example.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+require 'json'
+require 'builder'
+
+# One of the resources we're working with.
+# For simplicity I'm faking it out using OpenStruct.
+class Sandwich < OpenStruct
+  # Look up a Sandwich by ID
+  def self.find id
+    new :fillings => %w(jam avacado anchovies), :bread => "brown",
+      :made_at => Time.now, :id => id, :name => "Bleaugh"
+  end
+end
+
+AcceptableApi.register Sandwich, 'application/json' do |sandwich, request|
+  JSON.generate :id => sandwich.id
+end
+
+AcceptableApi.register Sandwich, 'application/vnd.acme.sandwich-v1+json' do |sandwich, request|
+  JSON.generate :name => sandwich.name, :fillings => sandwich.fillings,
+    :bread => sandwich.bread
+end
+
+AcceptableApi.register Sandwich, 'application/vnd.acme.sandwich-v1+xml' do |sandwich, request|
+  xml = Builder::XmlMarkup.new
+  xml.sandwich do |s|
+    s.name sandwich.name
+    s.bread sandwich.bread
+    s.fillings do |f|
+      sandwich.fillings.each do |filling|
+        f.filling filling
+      end
+    end
+  end
+end
+
+class Example < AcceptableApi::Controller
+  get '/sandwiches/:id' do
+    Sandwich.find params[:id]
+  end
+end

data/lib/acceptable_api.rb

@@ -0,0 +1,158 @@
+require 'sinatra'
+require 'singleton'
+require 'rack/accept'
+require 'rack/accept_header_updater'
+
+require "acceptable_api/version"
+
+module AcceptableApi
+  def self.register klass, mime_type, &map_block
+    Mapper.register klass, mime_type, &map_block
+  end
+
+  class MissingMapper
+    include Singleton
+
+    def mime_type
+      'application/javascript'
+    end
+
+    def execute resource, request
+      # set the response to "no acceptable representation available"
+      mappers = Mapper.for resource.class
+      body = {
+	:links => mappers.mime_types.map do |mime_type|
+	  { :rel => "alternative", :type => mime_type, :uri => request.uri }
+	end
+      }
+      [ 406, { 'Content-Type' => 'application/javascript' }, JSON.pretty_generate(body) ]
+    end
+  end
+
+  class Mappers
+    attr_accessor :mappers
+    private :mappers=, :mappers
+
+    def initialize mappers
+      self.mappers = mappers
+    end
+
+    def to accepts
+      acceptable_mime_types = accepts.order mime_types
+      acceptable_mappers = acceptable_mime_types.map { |mt|
+	mappers.detect { |m| m.mime_type == mt }
+      }
+      return acceptable_mappers if acceptable_mappers.any?
+      [ MissingMapper.instance ]
+    end
+
+    def mime_types
+      mappers.map { |m| m.mime_type }.sort.uniq
+    end
+  end
+
+  class Mapper
+    [ :klass, :mime_type, :map_block ].each do |a|
+      attr_accessor a
+      private "#{a}="
+    end
+    private :map_block
+
+    def initialize klass, mime_type, &map_block
+      self.klass = klass
+      self.mime_type = mime_type
+      self.map_block = map_block
+    end
+
+    def execute resource, request
+      body = map_block.call resource, request
+      [ status, headers, body ]
+    end
+
+    def status
+      200
+    end
+
+    def headers
+      { 'Content-Type' => mime_type }
+    end
+
+    def self.for klass
+      klass_mappers = mappers.select { |m| m.klass == klass }
+      Mappers.new klass_mappers
+    end
+
+    class << self;
+      attr_accessor :mappers
+      protected :mappers=, :mappers
+    end
+    self.mappers = []
+
+    def self.register klass, mime_type, &map_block
+      mapper = Mapper.new klass, mime_type, &map_block
+      self.mappers << mapper
+    end
+  end
+
+  # This needs to mimic as much of the Sinatra API as we use.
+  # Probably we want to set headers and content_type, not sure what else.
+  class Response
+    attr_accessor :params
+    def initialize options = {}
+      self.params = options[:params]
+    end
+  end
+
+  class Accepts
+    attr_accessor :request
+    private :request=, :request
+
+    def initialize env
+      self.request = Rack::Accept::Request.new env
+    end
+
+    def order mime_types
+      ordered = request.media_type.sort_with_qvalues mime_types, false
+      ordered.map! { |q, mt| mt }
+      ordered
+    end
+  end
+
+  class Request
+    attr_accessor :request
+    private :request=, :request
+
+    def initialize rack_request
+      self.request = rack_request
+    end
+
+    def respond_with resource
+      accepts = Accepts.new request.env
+      mappers = Mapper.for(resource.class).to(accepts)
+      mapper = mappers[0]
+      code, headers, body = mapper.execute resource, self
+      headers["Content-Length"] = body.bytesize.to_s
+      [ code, headers, body ]
+    end
+
+    def uri
+      request.url
+    end
+  end
+
+  class Controller < Sinatra::Base
+    use Rack::AcceptHeaderUpdater
+
+    def self.get path, &block
+      super path do
+	response = Response.new :params => params
+	resource = response.instance_eval &block
+	api = Request.new request
+	s, h, body = api.respond_with resource
+	status s
+	headers h
+	body
+      end
+    end
+  end
+end

data/lib/acceptable_api/version.rb

@@ -0,0 +1,3 @@
+module AcceptableApi
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: acceptable_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Craig R Webster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70108579929200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70108579929200
+- !ruby/object:Gem::Dependency
+  name: rack-accept
+  requirement: &70108576320140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70108576320140
+- !ruby/object:Gem::Dependency
+  name: rack-accept-header-updater
+  requirement: &70108576318020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70108576318020
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70108576317600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70108576317600
+description: HTTP lets clients sned an Accept header. We should probably use that
+  to accept more than the bog-standard mime-types.
+email:
+- craig@barkingiguana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- acceptable_api.gemspec
+- example/.gitignore
+- example/Gemfile
+- example/config.ru
+- example/example.rb
+- lib/acceptable_api.rb
+- lib/acceptable_api/version.rb
+homepage: http://barkingiguana.com/2011/12/05/principles-of-service-design-program-to-an-interface/
+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.10
+signing_key: 
+specification_version: 3
+summary: Build an Acceptable API
+test_files: []