ducklink 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,96 @@
+# Ducklink #
+
+Ducklink is a super-simple way of centrally managing the format of URLs which should be used for links to other sites. Quack.
+
+## Why ##
+
+* Maybe you have an affiliate deal with a site which requires redirecting through a third-party platform
+* Maybe you need to add parameters to URLs for campaign management
+* Er..
+* Hmm.
+
+## How ##
+
+Given a URL, Ducklink will extract the host and try to match against one of its configured formats.
+
+If nothing matches, the URL is returned untouched. If a match is found, then the URL returned will be based on the format together with any run-time parameters you passed in.
+
+### Add parameters ###
+
+
+	Ducklink::Decorator.configure do
+		host 'www.example.com' do
+			format '{{url}}?extra=params&added=here'
+		end
+	end
+
+	Ducklink.decorate 'http://www.example.com/some/path'
+	=> http://www.example.com/some/path?extra=params&added=here
+
+### Redirects ###
+
+	Ducklink::Decorator.configure do
+		host 'www.example.com' do
+			format 'http://affiliate.example.com?clickref=42&url={{url}}'
+		end
+	end
+	
+	Ducklink.decorate 'http://www.example.com/some/path'
+	=> http://affiliate.example.com?clickref=42&url=http://www.example.com/some/path
+	
+If you need to, you can URLEncode the target URL explicitly:
+
+	Ducklink::Decorator.configure do
+		host 'www.example.com' do
+			format 'http://affiliate.example.com?clickref=42&url={{url}}'
+			set :url, CGI::escape(self[:url])
+		end
+	end
+	
+	Ducklink.decorate 'http://www.example.com/some/path'
+	=> http://affiliate.example.com?clickref=42&url=http%3A%2F%2Fwww.example.com%2Fsome%2Fpath
+	
+### Run-time parameters ###
+
+	Ducklink::Decorator.configure do
+		host 'www.example.com' do |context|
+			format 'http://affiliate.example.com?clickref={{reference}}&url={{url}}'
+			set :reference, context[:reference]
+		end
+	end
+	
+	Ducklink.decorate 'http://www.example.com/some/path', :reference => 100
+	=> http://affiliate.example.com?clickref=100&url=http://www.example.com/some/path
+	
+### Specify format of groups ###
+	
+	Ducklink::Decorator.configure do
+		group do
+			format 'http://affiliate.example.com?clickref={{reference}}&url={{url}}#campaign={{campaign}}'
+			host 'buy.example.com', 'shop.example.com' do |context|
+				set :campaign, 'campaign1'
+				set :reference, context[:reference]
+			end
+			host 'another.com' do |context|
+				set :campaign, 'campaign2'
+				set :reference, context[:reference]
+			end
+		end
+	end
+	
+	Ducklink.decorate 'http://shop.example.com/goodies', :reference => 100
+	=> http://affiliate.example.com?clickref=100&url=http://shop.example.com/goodies#campaign=campaign1
+	
+## TODO ##
+
+1. Tests!
+2. URL validity checks
+3. Merge parameters if url already has them
+4. Intelligently URL encode parameters
+5. Support introspection of keys expected in context so calling code knows what to provide
+
+## Licence ##
+
+Ducklink is released under the MIT Licence.
+
+Copyright © 2011 Henry Garner

data/Rakefile

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

data/ducklink.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ducklink/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ducklink"
+  s.version     = Ducklink::VERSION
+  s.authors     = ["Henry Garner"]
+  s.email       = ["henry.garner@mac.com"]
+  s.homepage    = ""
+  s.summary     = %q{Decorates URLs according to a format specification}
+  s.description = %q{}
+
+  s.rubyforge_project = "ducklink"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/ducklink.rb

@@ -0,0 +1,70 @@
+require "ducklink/version"
+require 'uri'
+require 'cgi'
+
+module Ducklink
+  def self.decorate(url)
+    Decorator.decorate(url)
+  end
+  
+  class Decorator
+    class << self
+      @@hosts = {}
+      
+      def configure(&block)
+        Params.new.instance_exec &block
+      end
+      
+      def hosts
+        @@hosts
+      end
+      
+      def host(domain, params, &block)
+        @@hosts[domain] = [params, block]
+      end
+      
+      def decorate(url, context = {})
+        params, block = hosts[URI.parse(url).host]
+        return url unless params
+      
+        params.set :url, url
+        params.instance_exec context, &block
+      
+        format = params[:format]
+        format.scan(/\{\{([a-z_]+?)\}\}/i).inject(format) do |result, matches|
+          params[matches.first] ? result.gsub("{{#{matches.first}}}", params[matches.first]) : result
+        end
+      end
+    end
+  end
+  
+  class Params
+    attr_reader :settings
+    
+    def initialize(settings = {})
+      @settings = settings
+    end
+    
+    def format(format)
+      set :format, format
+    end
+    
+    def group(&block)
+      Params.new(settings.clone).instance_exec &block
+    end
+    
+    def set(key, value)
+      @settings[key.to_s] = value.to_s
+    end
+    
+    def [](key)
+      @settings[key.to_s]
+    end
+    
+    def host(*domains, &block)
+      domains.each do |domain|
+        Ducklink::Decorator.host domain, Params.new(settings.clone), &block
+      end
+    end
+  end
+end

data/lib/ducklink/version.rb

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: ducklink
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Henry Garner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: 
+- henry.garner@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- ducklink.gemspec
+- lib/ducklink.rb
+- lib/ducklink/version.rb
+has_rdoc: true
+homepage: ""
+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: ducklink
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Decorates URLs according to a format specification
+test_files: []
+