tag_uri 0.0.5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop

data/CHANGES.md

@@ -0,0 +1,14 @@
+# CH CH CH CHANGES #
+
+## v0.0.3 ##
+
+* Since the Github repo is called tag-uri (because a hypen is clearer in a URL) I've added tag-uri.rb and taguri.rb to the lib to require the library in case anyone uses the wrong name.
+
+## v0.0.2 ##
+
+### 27th of February 2013 ###
+
+* Changed to be a class method, as if it's mixed in to a model then the model will likely want to use that name for the field.
+* Changed the module name, it should all be uppercase so now it is.
+
+----

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tag_uri.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "yard"
+  gem "maruku"
+  gem "wirble"
+end
+
+group :test do
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Iain Barnett
+
+MIT Licence
+
+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,67 @@
+# TagUri
+
+An implementation of tag URI's.
+See http://tools.ietf.org/html/rfc4151
+
+### Build status ###
+
+Master branch:
+[![Build Status](https://travis-ci.org/yb66/tag_uri.png?branch=master)](https://travis-ci.org/yb66/tag_uri)
+
+## Why? ##
+
+Because every Atom entry must have a globally unique ID, in the `id` element. 
+
+* The ID must be a valid URI, as defined by RFC 2396.
+* The ID must be globally unique, across all Atom feeds, everywhere, for all time. This part is actually easier than it sounds.
+* The ID must never, ever change.
+
+Some people use a permalink for this, but we all know that permalinks change, so use a tag URI instead. See http://web.archive.org/web/20110514113830/http://diveintomark.org/archives/2004/05/28/howto-atom-id for more.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tag_uri'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tag_uri
+
+## Usage
+
+    require 'taguri'
+
+Given a model:
+
+    class Post < Sequel::Model # it doesn't have to be Sequel
+    end
+
+    post = Post.create title: "How to make a good ID in Atom"
+    post.slug
+    # => "howto-atom-linkblog"
+    post.created_at
+    # => 2004-05-27 00:00:00 0100
+    
+    TagURI.create prefix: "/archives/2004/05/27", host: "diveintomark.org", slug: post.slug, created_at: post.created_at
+    # => "tag:diveintomark.org,2013-02-26:/archives/2004/05/27/howto-atom-linkblog"
+
+Although you'll probably do something more like this:
+
+    TagURI.create slug: post.slug, created_at: post.created_at prefix: prefix, host: request.host
+
+or something like that.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+
+
+task :default => "spec"
+
+
+desc "(Re-) generate documentation and place it in the docs/ dir."
+task :docs => :"docs:yard"  
+namespace :docs do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/', '--no-private']
+  end
+
+  desc "Docs including private methods."
+  YARD::Rake::YardocTask.new(:all) do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/']
+  end
+    
+  desc "How to use the docs."
+  task :usage do
+    puts "Open the index.html file in the docs directory to read them. Does not include methods marked private unless you ran the 'all' version (you'll only need these if you plan to hack on the library itself)."
+  end
+end
+
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/lib/tag-uri.rb

@@ -0,0 +1 @@
+require 'tag_uri'

data/lib/tag_uri/version.rb

@@ -0,0 +1,3 @@
+module TagURI
+  VERSION = "0.0.5"
+end

data/lib/tag_uri.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+require 'addressable/uri'
+
+# Implementation of tag URI's.
+# @see http://tools.ietf.org/html/rfc4151
+module TagURI
+
+  class Error < StandardError; end
+  class ArgumentError < Error; end
+
+  DEFAULT_FAILURE_BLOCK = ->(x) {
+    fail ArgumentError, "The TagUri#tag_uri method requires a host, a slug, and a created_at time to work. Please check they're provided, as #{x} was nil."
+  }
+
+  # @param [Hash] opts
+  # @option opts [String] host The host portion e.g. http://example.com. If the host portion is not given then it is assumed that `self` will provide it.
+  # @option opts [String] slug The slugged name e.g. this-is-my-first-post. If a slug is not given then it is assumed that `self` will provide it.
+  # @option opts [String] prefix Anything you wish to tack on before the slug in the path e.g. for /posts/this-is-my-first-post pass in "prefix". If a prefix is not given then it will not be added to the string.
+  # @option opts [Time] created_at The time the resource was created. If a created_at time is not given then it is assumed that `self` will provide it.
+  # @return [String]
+  # @example
+  #   class Posts < Sequel::Model # or whatever ORM you're using.
+  #   end
+  #   post = Post.create #…
+  #   post.slug # => "this-is-my-first-post"
+  #   TagURI.create host: "http://example.com", prefix: "posts", slug: post.slug, created_at: post.created_at
+  def self.create( opts={}, &failure_block )
+    opts = opts.dup
+    opts[:created_at] ||= Time.now
+    opts[:prefix] ||= ""
+
+    # error checking
+    failure_block ||= DEFAULT_FAILURE_BLOCK
+    [:created_at,:prefix,:slug,:host].all?{|arg| opts.keys.include? arg }
+    opts.each do |k,v|
+      if v.nil?
+        failure_block.call k.to_s
+      end
+    end
+    opts[:host] = "https://#{opts[:host]}" unless opts[:host] =~ %r{^.+\://.+$} #
+    url = File.join opts[:host], opts[:prefix], opts[:slug]
+    uri = Addressable::URI.parse url
+    uri.scheme = "tag"
+    uri.host = "#{uri.host},#{opts[:created_at].strftime "%F"}:"
+    uri.to_s.sub(%r{://}, ":")
+  end
+end

data/lib/taguri.rb

@@ -0,0 +1 @@
+require 'tag_uri'

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'rspec'
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+end
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/tag_uri_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'time'
+require 'ostruct'
+require_relative "../lib/tag_uri.rb"
+
+describe "Generating a tag uri" do
+  let(:url) { "http://diveintomark.org/archives/2004/05/27/howto-atom-linkblog" }
+  let(:slug) { "howto-atom-linkblog" }
+  let(:created_at) { Time.parse "2004/05/27" }
+  let(:host) { "diveintomark.org" }
+  let(:prefix) { "/archives/2004/05/27" }
+  let(:expected) { "tag:diveintomark.org,2004-05-27:/archives/2004/05/27/howto-atom-linkblog" }
+  let(:model) { OpenStruct.new created_at: created_at, slug: slug }
+
+  context "Given arguments" do
+    context "That are valid" do
+      subject { TagURI.create prefix: prefix, host: host, created_at: model.created_at, slug: model.slug }
+      it { should == expected }
+    end
+    context "That are not valid" do
+      it "raises" do
+        expect { TagURI.create prefix: prefix, host: nil, created_at: model.created_at, slug: model.slug }.to raise_error TagURI::ArgumentError
+      end
+    end
+  end
+end

data/tag_uri.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tag_uri/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tag_uri"
+  gem.version       = TagURI::VERSION
+  gem.authors       = ["Iain Barnett"]
+  gem.email         = ["iainspeed@gmail.com"]
+  gem.description   = %q{An implementation of tag URI's.
+  See http://tools.ietf.org/html/rfc4151}
+  gem.summary       = %q{Instead of using a permalink as the id for an Atom feed entry, use a tag URI.}
+  gem.homepage      = "https://github.com/yb66/tag-uri"
+
+  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.require_paths = ["lib"]
+  gem.add_dependency("addressable")
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tag_uri
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Iain Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+description: ! "An implementation of tag URI's.\n  See http://tools.ietf.org/html/rfc4151"
+email:
+- iainspeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- lib/tag-uri.rb
+- lib/tag_uri.rb
+- lib/tag_uri/version.rb
+- lib/taguri.rb
+- spec/spec_helper.rb
+- spec/tag_uri_spec.rb
+- tag_uri.gemspec
+homepage: https://github.com/yb66/tag-uri
+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.25
+signing_key: 
+specification_version: 3
+summary: Instead of using a permalink as the id for an Atom feed entry, use a tag
+  URI.
+test_files:
+- spec/spec_helper.rb
+- spec/tag_uri_spec.rb