ruby_uri_template 1.0.0

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 uri_template.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Paul Sadauskas
+
+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.mkd

@@ -0,0 +1,40 @@
+# UriTemplate
+
+Implements the URI Template draft spec, v7 http://tools.ietf.org/html/draft-gregorio-uritemplate-07
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uri_template'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uri_template
+
+## Usage
+
+1. `UriTemplate.new` with a UriTemplate.
+1. `#expand` the template with a hash of params to be used. Both Strings and Symbols are valid as keys.
+
+### Example:
+
+    tmpl = UriTemplate.new("http://example.com/search{?q,lang}")
+    tmpl.expand(:q => ["dogs", "cats"], "lang" => "en_US")
+    # => "http://example.com/search?q=dogs,cats&lang=en_US"
+
+See the spec for other examples.
+
+**Note:** Sometimes the spec fails on 1.8 because of hash-ordering. Use 1.9 or an ordered hash library if the order is important to you.
+
+## 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/lib/uri_template.rb

@@ -0,0 +1,167 @@
+require 'addressable/uri'
+
+__dir__ = File.dirname(__FILE__)
+require __dir__ + "/uri_template/version"
+require __dir__ + "/uri_template/parser"
+require __dir__ + "/uri_template/transformer"
+
+class UriTemplate
+  class ParseError < StandardError; end
+
+  def initialize(uri_template)
+    @uri_template = uri_template
+    tree = Parser.new.parse(@uri_template)
+    @template = Transformer.new.apply(tree)
+    rescue Parslet::ParseFailed => ex
+      raise ParseError, "invalid template: #{uri_template}"
+  end
+
+  def expand(params)
+    output = ""
+    @template.each do |part|
+      case part
+      when String then output << part
+      when Hash   then output << Expression.new(part).expand(params)
+      end
+    end
+
+    output
+  end
+
+  class Expression
+
+    def initialize(tree)
+      @tree = tree
+    end
+
+    def expand(params = {})
+      out = var_list.map do |var|
+        Var.new(self, var[:var]).value(params)
+      end.compact
+
+      return "" if out.empty?
+      first_char + out.join(separator)
+    end
+
+    def var_list
+      @tree[:var_list]
+    end
+
+    def operator
+      @tree[:operator]
+    end
+
+    def separator
+      case operator
+        when nil, "+", "#" then ","
+        when "."           then "."
+        when "/"           then "/"
+        when ";"           then ";"
+        when "?", "&"      then "&"
+      end
+    end
+
+    def first_char
+      case operator
+      when nil, "+" then ""
+      else               operator
+      end
+    end
+
+    def named?
+      [";", "?", "&"].include? operator
+    end
+
+    def str_if_empty
+      case operator
+      when "?", "&" then "="
+      else ""
+      end
+    end
+
+    def encode_set
+      set = Addressable::URI::CharacterClasses::UNRESERVED
+      set += Addressable::URI::CharacterClasses::RESERVED if ["+", "#"].include? operator
+      set
+    end
+
+  end
+
+  class Var
+    attr_reader :exp
+
+    def initialize(exp, tree)
+      @exp, @tree = exp, tree
+    end
+
+    # Algorithm taken directly from the spec.
+    # TODO: refactor to be Ruby-like
+    def value(params)
+      value = params[name] || params[name.to_sym]
+
+      out = ""
+      case value
+      when nil
+        return nil
+      when String
+        if exp.named?
+          out << "#{encode(name)}#{value.empty? ? exp.str_if_empty : "="}"
+        end
+        out << encode(trim(value))
+
+      when Array
+        if !explode?
+          if exp.named?
+            out << "#{encode(name)}#{value.empty? ? exp.str_if_empty : "="}"
+          end
+          return if value.empty?
+          out << value.map{|v| encode(v)}.join(",")
+        else
+          return if value.empty?
+          out << value.map{|v| encode(v)}.join(exp.separator)
+        end
+
+      when Hash
+        if !explode?
+          if exp.named?
+            out << "#{encode(name)}#{value.empty? ? exp.str_if_empty : "="}"
+          end
+          return if value.empty?
+          out << value.map{|k,v| [encode(k), encode(v)]}.flatten.join(",")
+        else
+          return if value.empty?
+          out << value.map{|k,v| "#{encode(k)}=#{encode(v)}"}.join(exp.separator)
+        end
+
+      end
+
+      out
+    end
+
+    protected
+
+    def name
+      @tree[:name]
+    end
+
+    def explode?
+      @tree.has_key?(:explode)
+    end
+
+    def max_length
+      @tree[:max_length]
+    end
+
+    def trim(str)
+      max_length ? str[0..(max_length-1)] : str
+    end
+
+    def encode(str)
+      Addressable::URI.encode_component(str, exp.encode_set)
+    end
+
+
+  end
+
+end
+

data/lib/uri_template/parser.rb

@@ -0,0 +1,78 @@
+require 'parslet'
+
+class UriTemplate
+  class Parser < Parslet::Parser
+
+    rule(:uri_template) do
+      (literals | expression).repeat
+    end
+
+    rule(:expression) do
+      str('{') >> operator.maybe.as(:operator) >> var_list.as(:var_list) >> str('}')
+    end
+
+    rule(:operator) do
+      str("+") | str("#") | str(".") | str("/") | str(";") | str("?") | str("&")
+    end
+
+    rule(:var_list) do
+      (varspec >> ( str(",") >> varspec ).repeat).maybe.as(:array)
+    end
+
+    rule(:varspec) do
+      (varname >> modifier.maybe).as(:var)
+    end
+
+    rule(:varname) do
+      ((varchar >> (varchar | str(".")).repeat).as(:string)).as(:name)
+    end
+
+    rule(:varchar) do
+      (alphanumeric | str("_") | pct_encoded)
+    end
+
+    rule(:modifier) do
+      prefix | explode
+    end
+
+    rule(:prefix) do
+      str(':') >> number.as(:max_length)
+    end
+
+    rule(:explode) do
+      str('*').as(:explode)
+    end
+
+    rule(:literals) do
+      (unreserved | reserved | pct_encoded).repeat(1).as(:literals)
+    end
+
+    rule(:unreserved) do
+      alphanumeric | match("[-._~]")
+    end
+
+    rule(:reserved) do
+      match("[:/?#\\[\\]@!$&'()*+,;=]")
+    end
+
+    rule(:pct_encoded) do
+      str('%') >> hex >> hex
+    end
+
+    rule(:alphanumeric) do
+      match('[A-Za-z0-9]')
+    end
+
+    rule(:number) do
+      match('[0-9]').repeat(1).as(:number)
+    end
+
+    rule(:hex) do
+      match('[a-fA-F0-9]')
+    end
+
+    root(:uri_template)
+
+  end
+end
+

data/lib/uri_template/transformer.rb

@@ -0,0 +1,19 @@
+require 'parslet'
+
+class UriTemplate
+  class Transformer < Parslet::Transform
+
+    rule(:literals => simple(:l)) { l.to_s }
+    rule(:string   => simple(:s)) { s.to_s }
+
+    rule(:array => subtree(:ar)) { ar.is_a?(Array) ? ar : [ar] }
+
+    rule(:explode) { true }
+
+    #rule(:name    => simple(:name)) { name.to_s }
+
+    rule(:number => simple(:x)) { Integer(x) }
+
+  end
+end
+

data/lib/uri_template/version.rb

@@ -0,0 +1,3 @@
+class UriTemplate
+  VERSION = "1.0.0"
+end

data/spec/errors_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe UriTemplate do
+
+  describe "with good uris" do
+
+    good = [
+      "{var}",
+      "http://example.com/",
+      "http://example.com/{foo}",
+      "http://example.com/search{?q}",
+      "http://example.com/search{?q,list}"
+    ]
+
+    good.each do |tmpl|
+      it "should parse #{tmpl.inspect}" do
+        lambda { UriTemplate.new(tmpl) }.should_not raise_error(UriTemplate::ParseError)
+      end
+    end
+  end
+
+  describe "with invaldi uris" do
+
+    bad = [
+      "http://example.com/{",
+      "http://example.com/{^foo}"
+    ]
+
+    bad.each do |tmpl|
+      it "should not parse #{tmpl.inspect}" do
+        lambda { UriTemplate.new(tmpl) }.should raise_error(UriTemplate::ParseError)
+      end
+    end
+  end
+end
+

data/spec/examples_from_draft.txt

@@ -0,0 +1,135 @@
+## 3.2.2.  Simple String Expansion: {var}
+
+       {var}              value
+       {hello}            Hello%20World%21
+       {half}             50%25
+       O{empty}X          OX
+       O{undef}X          OX
+       {x,y}              1024,768
+       {x,hello,y}        1024,Hello%20World%21,768
+       ?{x,empty}         ?1024,
+       ?{x,undef}         ?1024
+       ?{undef,y}         ?768
+       {var:3}            val
+       {var:30}           value
+       {list}             red,green,blue
+       {list*}            red,green,blue
+       {keys}             semi,%3B,dot,.,comma,%2C
+       {keys*}            semi=%3B,dot=.,comma=%2C
+
+## 3.2.3.  Reserved expansion: {+var}
+
+       {+var}                value
+       {+hello}              Hello%20World!
+       {+half}               50%25
+
+       {base}index           http%3A%2F%2Fexample.com%2Fhome%2Findex
+       {+base}index          http://example.com/home/index
+       O{+empty}X            OX
+       O{+undef}X            OX
+
+       {+path}/here          /foo/bar/here
+       here?ref={+path}      here?ref=/foo/bar
+       up{+path}{var}/here   up/foo/barvalue/here
+       {+x,hello,y}          1024,Hello%20World!,768
+       {+path,x}/here        /foo/bar,1024/here
+
+       {+path:6}/here        /foo/b/here
+       {+list}               red,green,blue
+       {+list*}              red,green,blue
+       {+keys}               semi,;,dot,.,comma,,
+       {+keys*}              semi=;,dot=.,comma=,
+
+## 3.2.4.  Fragment expansion: {#var}
+
+       {#var}             #value
+       {#hello}           #Hello%20World!
+       {#half}            #50%25
+       foo{#empty}        foo#
+       foo{#undef}        foo
+       {#x,hello,y}       #1024,Hello%20World!,768
+       {#path,x}/here     #/foo/bar,1024/here
+       {#path:6}/here     #/foo/b/here
+       {#list}            #red,green,blue
+       {#list*}           #red,green,blue
+       {#keys}            #semi,;,dot,.,comma,,
+       {#keys*}           #semi=;,dot=.,comma=,
+
+## 3.2.5.  Label expansion with dot-prefix: {.var}
+
+       {.who}             .fred
+       {.who,who}         .fred.fred
+       {.half,who}        .50%25.fred
+       www{.dom}          www.example.com
+       X{.var}            X.value
+       X{.empty}          X.
+       X{.undef}          X
+       X{.var:3}          X.val
+       X{.list}           X.red,green,blue
+       X{.list*}          X.red.green.blue
+       X{.keys}           X.semi,%3B,dot,.,comma,%2C
+       X{.keys*}          X.semi=%3B.dot=..comma=%2C
+       X{.empty_keys}     X
+       X{.empty_keys*}    X
+
+## 3.2.6.  Path segment expansion: {/var}
+
+       {/who}             /fred
+       {/who,who}         /fred/fred
+       {/half,who}        /50%25/fred
+       {/who,dub}         /fred/me%2Ftoo
+       {/var}             /value
+       {/var,empty}       /value/
+       {/var,undef}       /value
+       {/var,x}/here      /value/1024/here
+       {/var:1,var}       /v/value
+       {/list}            /red,green,blue
+       {/list*}           /red/green/blue
+       {/list*,path:4}    /red/green/blue/%2Ffoo
+       {/keys}            /semi,%3B,dot,.,comma,%2C
+       {/keys*}           /semi=%3B/dot=./comma=%2C
+
+## 3.2.7.  Path-style parameter expansion: {;var}
+
+       {;who}             ;who=fred
+       {;half}            ;half=50%25
+       {;empty}           ;empty
+       {;v,empty,who}     ;v=6;empty;who=fred
+       {;v,bar,who}       ;v=6;who=fred
+       {;x,y}             ;x=1024;y=768
+       {;x,y,empty}       ;x=1024;y=768;empty
+       {;x,y,undef}       ;x=1024;y=768
+       {;hello:5}         ;hello=Hello
+       {;list}            ;list=red,green,blue
+       {;list*}           ;red;green;blue
+       {;keys}            ;keys=semi,%3B,dot,.,comma,%2C
+       {;keys*}           ;semi=%3B;dot=.;comma=%2C
+
+## 3.2.8.  Form-style query expansion: {?var}
+
+       {?who}             ?who=fred
+       {?half}            ?half=50%25
+       {?x,y}             ?x=1024&y=768
+       {?x,y,empty}       ?x=1024&y=768&empty=
+       {?x,y,undef}       ?x=1024&y=768
+       {?var:3}           ?var=val
+       {?list}            ?list=red,green,blue
+       {?list*}           ?red&green&blue
+       {?keys}            ?keys=semi,%3B,dot,.,comma,%2C
+       {?keys*}           ?semi=%3B&dot=.&comma=%2C
+
+## 3.2.9.  Form-style query continuation: {&var}
+
+       {&who}             &who=fred
+       {&half}            &half=50%25
+       ?fixed=yes{&x}     ?fixed=yes&x=1024
+       {&x,y,empty}       &x=1024&y=768&empty=
+       {&x,y,undef}       &x=1024&y=768
+
+       {&var:3}           &var=val
+       {&list}            &list=red,green,blue
+       {&list*}           &red&green&blue
+       {&keys}            &keys=semi,%3B,dot,.,comma,%2C
+       {&keys*}           &semi=%3B&dot=.&comma=%2C
+
+

data/spec/examples_from_draft_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+# These examples are take directly from the draft spec
+# http://tools.ietf.org/html/draft-gregorio-uritemplate-07
+describe "Examples given in the Draft" do
+  let(:params) do
+    {
+      "dom"        => "example.com",
+      "dub"        => "me/too",
+      "hello"      => "Hello World!",
+      "half"       => "50%",
+      "var"        => "value",
+      "who"        => "fred",
+      "base"       => "http://example.com/home/",
+      "path"       => "/foo/bar",
+      "list"       => [ "red", "green", "blue" ],
+      "keys"       => {"semi"=>";", "dot"=>".", "comma" =>","},
+      "v"          => "6",
+      "x"          => "1024",
+      "y"          => "768",
+      "empty"      => "",
+      "empty_keys" => [],
+      "undef"      => nil
+    }
+  end
+
+  examples = {}
+  section = ""
+  File.read(File.dirname(__FILE__) + "/examples_from_draft.txt").each_line do |line|
+    next if line.strip.empty?
+    if line =~ /^##/
+      section = line.gsub('## ', '').to_s
+      examples[section] = []
+    else
+      template, expected = line.strip.split(/\s+/,2)
+      examples[section] << [template, expected]
+    end
+  end
+
+  examples.each do |section, data|
+    describe section do
+      data.each do |template, expected|
+        it "should render #{template.inspect} as #{expected.inspect}" do
+          UriTemplate.new(template).expand(params).should == expected
+        end
+      end
+    end
+  end
+
+end
+

data/spec/params_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe UriTemplate do
+
+  describe "params" do
+    let(:template) { UriTemplate.new("{foo}") }
+
+    it "should handle string keys" do
+      template.expand("foo" => "bar").should == "bar"
+    end
+
+    it "should handle symbol keys" do
+      template.expand(:foo  => "bar").should == "bar"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/uri_template")
+

data/uri_template.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/uri_template/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Sadauskas"]
+  gem.email         = ["psadauskas@gmail.com"]
+  gem.description   = %q{Expands URI Templates}
+  gem.summary       = %q{Implements the URI Template draft specification v7}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ruby_uri_template"
+  gem.require_paths = ["lib"]
+  gem.version       = UriTemplate::VERSION
+
+  gem.add_dependency "parslet"
+  gem.add_dependency "addressable"
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ruby_uri_template
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: &70344458699960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344458699960
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70344458699540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344458699540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70344458699120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70344458699120
+description: Expands URI Templates
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.mkd
+- Rakefile
+- lib/uri_template.rb
+- lib/uri_template/parser.rb
+- lib/uri_template/transformer.rb
+- lib/uri_template/version.rb
+- spec/errors_spec.rb
+- spec/examples_from_draft.txt
+- spec/examples_from_draft_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb
+- uri_template.gemspec
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Implements the URI Template draft specification v7
+test_files:
+- spec/errors_spec.rb
+- spec/examples_from_draft.txt
+- spec/examples_from_draft_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb