link-middleware 0.0.2

data/LICENSE.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,76 @@
+# Rack Middleware for LINK/UNLINK
+
+Provides a simple implementation of [HTTP Link and Unlink Methods draft-snell-link-method-08](http://tools.ietf.org/html/draft-snell-link-method-08) 
+as configurable [Rack](http://rack.github.io/) middle-ware.
+ 
+The code provides an easy way to instrument any existing Rack based application with support for the 
+`LINK` and `UNLINK` HTTP Methods.
+
+## Installation
+
+Add the gem into your Gemfile:
+
+    gem 'link-middleware', :git => "git://github.com/ldodds/link-middleware.git"
+
+Or:
+
+	sudo gem install link-middleware
+
+## Basic Usage
+
+There are two separate middleware components: 
+
+* `LinkMiddleware::Filter` -- provides the basic LINK/UNLINK support
+* `LinkMiddleware::Annotator` --- provides support for annotating requests with stored links
+
+Here is a simple example see: `examples/simple.rb`
+
+	require 'sinatra'
+	require 'link-middleware'
+	
+	set :store, LinkMiddleware::MemoryStore.new
+	
+	use LinkMiddleware::Filter, :store => settings.store
+	use LinkMiddleware::Annotator, :store => settings.store
+	
+	get '/' do
+	  'Hello World'
+	end
+
+The `Filter` middleware will intercept and process `LINK` and `UNLINK` requests.
+
+The `Annotator` middleware will automatically annotate responses to `/` with any stored links.
+
+The middleware is configured to use a shared in-memory store. To make this persistent across 
+HTTP connections the store instance is cached as a Sinatra setting
+
+## Link Store Implementations
+
+* In-Memory
+* Redis (TODO)
+* RDF Triplestore (TODO)	
+
+To configure a Link Store. The following will instantiate a new instance, passing any 
+additional options to the constructor of the store class:
+
+	use LinkMiddleware::Filter, :store_impl => LinkMiddleware::MemoryStore
+
+Or, initialize the middleware with an existing object:
+
+	use LinkMiddleware::Filter, :store => LinkMiddleware::MemoryStore.new
+	
+Link Store implementations should have the following methods:
+
+	add(context_uri, header)
+	remove(context_uri, header)
+	read(context_uri)
+	
+The header parameter passed to `add` and `remove` will be an instance of `LinkHeader` from the 
+[link-header gem](https://github.com/asplake/link_header). This will have an array of links. Similarly 
+the response from `read` should be a `LinkHeader` instance.
+
+			
+	
+## Licence
+
+Placed into the public domain under the unlicence. See `LICENCE.md`	

data/lib/link-middleware.rb

@@ -0,0 +1,18 @@
+require 'rack'
+require 'link_header'
+
+require 'link-middleware/annotator'
+require 'link-middleware/filter'
+require 'link-middleware/store'
+require 'link-middleware/redis_store'
+
+class LinkHeader::Link
+  
+  def eql?(other)
+    return href == other.href && attr_pairs == other.attr_pairs
+  end
+  
+  def hash
+    return href.hash + attr_pairs.hash
+  end
+end

data/lib/link-middleware/annotator.rb

@@ -0,0 +1,33 @@
+module LinkMiddleware
+  
+  class Annotator
+    
+    def initialize(app, options={})
+      @app = app       
+      @options = options
+      if options[:store]
+        @store = options[:store]
+      elsif options[:store_impl]
+        @store = options[:store].new(options)
+      else
+        @store = LinkMiddleware::MemoryStore.new(options)
+      end
+    end                
+  
+    def call(env)      
+      status, headers, response = @app.call(env)            
+      request = Rack::Request.new( env ) 
+      stored_links = @store.read( request.url )
+      if !stored_links.links.empty?
+        link_header = stored_links.to_s
+        if headers["Link"]         
+          link_header = env["Link"] + ";" + link_header
+        end
+        headers["Link"] = link_header
+      end          
+      [status, headers, response]
+    end
+             
+  end
+  
+end

data/lib/link-middleware/filter.rb

@@ -0,0 +1,53 @@
+module LinkMiddleware
+  
+  class Filter
+    
+    def initialize(app, options={})
+      @app = app       
+      @options = options
+      if options[:store]        
+        @store = options[:store]
+      elsif options[:store_impl]
+        @store = options[:store].new(options)
+      else
+        @store = LinkMiddleware::MemoryStore.new(options)
+      end
+    end                
+  
+    def call(env)         
+      request = Rack::Request.new( env )  
+      if request.request_method == "LINK"
+        return link( request.url, env )
+      elsif request.request_method == "UNLINK"
+        return unlink( request.url, env )
+      end          
+      @app.call(env)
+    end
+         
+    def link(url, env)
+      links = LinkHeader.parse( env["HTTP_LINK"] )
+      success = @store.add(url,links)
+      headers = {}
+      if success
+        headers["Link"] = links.to_s unless links.links.empty?
+        return [200, headers, ["OK"]]
+      else
+        return [500, headers, ["Unable to add links"]]
+      end      
+    end    
+    
+    def unlink(url, env)
+      links = LinkHeader.parse( env["HTTP_LINK"] )
+      success = @store.remove(url,links)
+      headers = {}
+      if success
+        headers["Link"] = links.to_s unless links.links.empty?
+        return [200, headers, ["OK"]]
+      else
+        return [500, headers, ["Unable to add links"]]
+      end      
+    end
+    
+  end
+  
+end

data/lib/link-middleware/redis_store.rb

@@ -0,0 +1,40 @@
+module LinkMiddleware
+  class RedisStore
+    def initialize(options={})
+      if options[:store]
+        @redis = options[:store]
+      else  
+        @redis = Redis.new(options)        
+      end
+    end
+
+    def add(context_uri, header)
+      header.links.each do |link|
+        @redis.sadd context_uri, link.to_s
+      end
+      true
+    end
+
+    def remove(context_uri, header)
+      process = true
+      header.links.each do |link|
+        process = process && @redis.sismember(context_uri, link.to_s)
+      end
+      header.links.each do |link|
+        @redis.srem context_uri, link.to_s
+      end if process
+      process
+    end
+
+    def read(context_uri)
+      header = LinkHeader.new
+      links = @redis.smembers context_uri
+      links.each do |link|
+        header << LinkHeader.parse(link).links.first
+      end
+      header
+    end
+
+  end
+
+end

data/lib/link-middleware/store.rb

@@ -0,0 +1,40 @@
+module LinkMiddleware
+      
+  require 'set'
+  
+  #Use for testing only!
+  class MemoryStore    
+        
+    def initialize(options={})
+      @store = {}
+    end
+    
+    def add(context_uri, header)
+      stored_header = @store[context_uri] || LinkHeader.new
+      header.links.each do |link|
+        stored_header << link
+      end
+      @store[context_uri] = stored_header
+      return true             
+    end
+
+    def remove(context_uri, header)
+      stored_header = @store[context_uri] || LinkHeader.new
+      return true if stored_header.links.empty?
+      
+      #if there are links to remove, which aren't in the stored set, then return false
+      return false if !(header.links - stored_header.links).empty?
+      
+      #otherwise remove them
+      final = stored_header.links - header.links
+      @store[context_uri] = LinkHeader.new( final )
+      return true             
+    end
+        
+    def read(context_uri)
+      @store[context_uri] || LinkHeader.new
+    end    
+        
+  end
+  
+end

data/lib/link-middleware/version.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: link-middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Leigh Dodds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 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: '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: link_header
+  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: redis
+  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: rspec
+  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: simplecov-rcov
+  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: mock_redis
+  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: 
+email:
+- leigh@ldodds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/link-middleware.rb
+- lib/link-middleware/annotator.rb
+- lib/link-middleware/redis_store.rb
+- lib/link-middleware/filter.rb
+- lib/link-middleware/store.rb
+- lib/link-middleware/version.rb
+- LICENSE.md
+- README.md
+homepage: http://github.com/ldidds/link-middleware
+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: Implementation of LINK/UNLINK using Rack middleware
+test_files: []
+has_rdoc: