urn 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 876d68aec7c174c18b549b705653e20e49b8c14a
-  data.tar.gz: 001402f4e00c733303f7631bdd6c1313750935ba
+  metadata.gz: f729f3390ecec4c9843f007a1be16632ca7b1516
+  data.tar.gz: b85858036290b073d73ddca76076f59fe4e9476e
 SHA512:
-  metadata.gz: d69b2ea6ebb2c5b8b99165dbcbb626caef56fa3ee13260e09b320651dec79d655c085d2b71b72b6b13036ad534003c26d98f6ab4d2fa22fe2d640b21736a3544
-  data.tar.gz: 3b4ccc977ad5f9c41001afdff892f03a67bb68c948c0c4d45c2bff0f950b7380f1b8bde314e55fcf2875b1941ca94b2e81ae1bf0612c75768ba6fde8e643e093
+  metadata.gz: 69b2624baef7186d9c1f4beea2fe468a01eb3c85134647a8b30761b46d3ce51a27bf2fa8d054744ff206a76010361a3b5eb39e6ba9e2551ef8d442da6aed82cc
+  data.tar.gz: 3ace937ef1827b479377959d3bba1b7ebf87ff31690b18ad359571a4d59c15c73e3a2edfc09f69690ec548b47fa0458cf0e84c7ecefc54e09e9e166e7cbf5e85

data/README.md

@@ -2,14 +2,15 @@
 
 Ruby library to validate and normalize URNs.
 
-Note: This Gem doesn't strictly follow the [RFC2141](https://www.ietf.org/rfc/rfc2141.txt)
+**Current version:** 0.1.3  
+**Supported Ruby versions:** 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2, 2.3
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
-gem 'urn'
+gem 'urn', '~> 0.1'
 ```
 
 And then execute:
@@ -18,7 +19,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install urn
+    $ gem install urn -v '~> 0.1'
 
 ## Usage
 
@@ -33,13 +34,54 @@ urn.normalize
 #=> "urn:namespace:Identifier"
 ```
 
+## API Documentation
+
+### `URN::PATTERN`
+
+```ruby
+text.match(/\?urn=(#{URN::PATTERN})/)
+```
+
+Return a `String` of an unanchored regular expression suitable for matching
+URNs.
+
+### `URN.new`
+
+```ruby
+urn = URN.new('urn:nid:nss')
+#=> #<URN:0xdecafbad @urn="urn:nid:nss">
+```
+
+Return a new `URN` instance with the given string.
+
+### `URN#valid?`
+
+```ruby
+URN.new('foo').valid?
+#=> false
+
+URN.new('urn:foo:bar').valid?
+#=> true
+```
+
+Returns true if the `URN` is valid according to [RFC 2141](https://www.ietf.org/rfc/rfc2141.txt).
+
+### `URN#normalize`
+
+```ruby
+URN.new('URN:FOO:BAR').normalize
+#=> "urn:foo:BAR"
+```
+
+Return a normalized `String` representation of the `URN`, normalizing the case
+of the `urn` token and namespace identifier.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/altmetric/urn.
 
-
 ## License
 
-Copyright © 2015-2016 Altmetric LLP
+Copyright © 2016 Altmetric LLP
 
 Distributed under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/urn.rb

@@ -1,8 +1,7 @@
-require 'cgi'
-
 class URN
-  PATTERN = 'urn:(?!urn:)[a-z0-9\-]{1,31}:[\S]+'.freeze
-  REGEX = /^#{PATTERN}$/i
+  PATTERN = %{(?i:urn:(?!urn:)[a-z0-9][a-z0-9\-]{1,31}:} +
+            %{(?:[a-z0-9()+,-.:=@;$_!*']|%[0-9a-f]{2})+)}.freeze
+  REGEX = /\A#{PATTERN}\z/
 
   attr_reader :urn
   private :urn
@@ -18,8 +17,10 @@ class URN
   def normalize
     return unless valid?
 
-    urn_parts = urn.split(':', 3)
+    _scheme, nid, nss = urn.split(':', 3)
+    normalized_nid = nid.downcase
+    normalized_nss = nss.gsub(/%([0-9a-f]{2})/i) { |hex| hex.downcase }
 
-    "#{urn_parts[0].downcase}:#{urn_parts[1].downcase}:#{CGI.unescape(urn_parts[2])}"
+    "urn:#{normalized_nid}:#{normalized_nss}"
   end
 end

data/spec/urn_spec.rb

@@ -1,35 +1,66 @@
+# encoding: utf-8
 require 'urn'
 
 RSpec.describe URN do
   describe '#valid?' do
-    context 'returns true' do
-      it 'if it is valid' do
-        expect(described_class.new('urn:namespace:specificstring')).to be_valid
-      end
+    it 'returns true if it is valid' do
+      expect(described_class.new('urn:namespace:specificstring')).to be_valid
+    end
 
-      it 'if namespace includes urn' do
-        expect(described_class.new('urn:urnnamespace:specificstring')).to be_valid
-      end
+    it 'returns true if namespace includes urn' do
+      expect(described_class.new('urn:urnnamespace:specificstring')).to be_valid
     end
 
-    context 'returns false' do
-      it 'if it does not start with urn' do
-        expect(described_class.new('not-urn:namespace:specificstring')).not_to be_valid
-      end
+    it 'returns false if it does not start with urn' do
+      expect(described_class.new('not-urn:namespace:specificstring')).not_to be_valid
+    end
 
-      it 'if namespace is urn' do
-        expect(described_class.new('urn:urn:specificstring')).not_to be_valid
-      end
+    it 'returns false if namespace is urn' do
+      expect(described_class.new('urn:urn:specificstring')).not_to be_valid
     end
-  end
 
-  describe '#normalize' do
-    it 'lowercases the urn and namespace identifier parts only' do
-      expect(described_class.new('URN:NameSpace:SpecificString').normalize).to eq('urn:namespace:SpecificString')
+    it 'returns false if namespace is URN' do
+      expect(described_class.new('urn:URN:specificstring')).not_to be_valid
+    end
+
+    it 'returns true if the namespace identifier is 32 characters long' do
+      nid = 'a' * 32
+
+      expect(described_class.new("urn:#{nid}:bar")).to be_valid
+    end
+
+    it 'returns false if the namespace identifier begins with a hyphen' do
+      expect(described_class.new('urn:-foo:bar')).not_to be_valid
     end
 
+    it 'returns false if the namespace specific string has invalid escaping' do
+      expect(described_class.new('urn:foo:bar%2')).not_to be_valid
+    end
+
+    it 'returns false if the namespace specific string has reserved characters' do
+      expect(described_class.new('urn:foo:café')).not_to be_valid
+    end
+  end
+
+  describe '#normalize' do
     it 'returns nil if it is not valid' do
       expect(described_class.new('urn:').normalize).to be_nil
     end
+
+    it 'lowercases the leading "urn:" token' do
+      expect(described_class.new('URN:foo:123').normalize).to eq('urn:foo:123')
+    end
+
+    it 'lowercases the namespace identifier' do
+      expect(described_class.new('urn:FOO:123').normalize).to eq('urn:foo:123')
+    end
+
+    it 'lowercases %-escaping in the namespace specific string' do
+      expect(described_class.new('urn:foo:123%2C456').normalize).to eq('urn:foo:123%2c456')
+    end
+
+    it 'does not lowercase other characters in the namespace specific string' do
+      expect(described_class.new('urn:foo:BA%2CR').normalize).to eq('urn:foo:BA%2cR')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urn
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Ana Castro
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler