collection-json 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,134 @@
+# CollectionJSON
+
+A lightweight gem to easily build response objects with a MIME type of
+'application/vnd.collection+json'.
+
+Read http://amundsen.com/media-types/collection/ for more information about this
+media type.
+
+## Usage
+
+Use ```CollectionJSON.generate_for``` to build a response object which you can
+call ```to_json``` on.
+
+```ruby
+response = CollectionJSON.generate_for('/friends/') do |builder|
+  builder.add_link '/friends/rss', 'feed'
+  user.friends.each do |friend|
+    builder.add_item("/friends/#{friend.id}") do |item|
+      item.add_data "full-name", friend.full_name
+      item.add_data "email", friend.email
+      item.add_link "/blogs/#{friend.id}", "blog", "", "Blog"
+      item.add_link "/blogs/#{friend.id}", "avatar", "", "Avatar", "image"
+    end
+  end
+  builder.add_query("/friends/search", "search", "Search") do |query|
+    query.add_data "search"
+  end
+  builder.set_template do |template|
+    template.add_data "full-name", "", "Full Name"
+    template.add_data "email", "", "Email"
+    template.add_data "blog", "", "Blog"
+    template.add_data "avatar", "", "Avatar"
+  end
+end
+
+response.to_json
+```
+
+Sample output:
+
+```javascript
+{ "collection" :
+  {
+    "version" : "1.0",
+    "href" : "http://example.org/friends/",
+    
+    "links" : [
+      {"rel" : "feed", "href" : "http://example.org/friends/rss"}
+    ],
+    
+    "items" : [
+      {
+        "href" : "http://example.org/friends/jdoe",
+        "data" : [
+          {"name" : "full-name", "value" : "J. Doe", "prompt" : "Full Name"},
+          {"name" : "email", "value" : "jdoe@example.org", "prompt" : "Email"}
+        ],
+        "links" : [
+          {"rel" : "blog", "href" : "http://example.org/blogs/jdoe", "prompt" : "Blog"},
+          {
+            "rel" : "avatar", "href" : "http://example.org/images/jdoe",
+            "prompt" : "Avatar", "render" : "image"
+          }
+        ]
+      },
+      
+      {
+        "href" : "http://example.org/friends/msmith",
+        "data" : [
+          {"name" : "full-name", "value" : "M. Smith", "prompt" : "Full Name"},
+          {"name" : "email", "value" : "msmith@example.org", "prompt" : "Email"}
+        ],
+        "links" : [
+          {"rel" : "blog", "href" : "http://example.org/blogs/msmith", "prompt" : "Blog"},
+          {
+            "rel" : "avatar", "href" : "http://example.org/images/msmith",
+            "prompt" : "Avatar", "render" : "image"
+          }
+        ]
+      },
+      
+      {
+        "href" : "http://example.org/friends/rwilliams",
+        "data" : [
+          {"name" : "full-name", "value" : "R. Williams", "prompt" : "Full Name"},
+          {"name" : "email", "value" : "rwilliams@example.org", "prompt" : "Email"}
+        ],
+        "links" : [
+          {"rel" : "blog", "href" : "http://example.org/blogs/rwilliams", "prompt" : "Blog"},
+          {
+            "rel" : "avatar", "href" : "http://example.org/images/rwilliams",
+            "prompt" : "Avatar", "render" : "image"
+          }
+        ]
+      }      
+    ],
+    
+    "queries" : [
+      {"rel" : "search", "href" : "http://example.org/friends/search", "prompt" : "Search",
+        "data" : [
+          {"name" : "search"}
+        ]
+      }
+    ],
+    
+    "template" : {
+      "data" : [
+        {"name" : "full-name", "prompt" : "Full Name"},
+        {"name" : "email", "prompt" : "Email"},
+        {"name" : "blog", "prompt" : "Blog"},
+        {"name" : "avatar", "prompt" : "Avatar"}
+        
+      ]
+    }
+  } 
+}
+```
+
+Set the ```COLLECTION_JSON_HOST``` environment variable to automatically add
+this to the href's. Eg. ```COLLECTION_JSON_HOST=http://example.org```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'collection-json'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection-json

data/Rakefile

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

data/collection-json.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "collection-json/version"
+
+Gem::Specification.new do |s|
+  s.name        = "collection-json"
+  s.version     = CollectionJSON::VERSION
+  s.authors     = ["Sebastian Edwards"]
+  s.email       = ["sebastian@uprise.co.nz"]
+  s.homepage    = "https://github.com/sebastianedwards/collection-json"
+  s.summary     = %q{Builds Collection+JSON responses.}
+  s.description = %q{Lightweight gem for building Collection+JSON responses.}
+
+  s.rubyforge_project = "collection-json"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/collection-json.rb

@@ -0,0 +1,26 @@
+require "collection-json/version"
+require "collection-json/response"
+require "collection-json/builder"
+
+COLLECTION_JSON_VERSION = "1.0"
+COLLECTION_JSON_HOST = ENV['COLLECTION_JSON_HOST']
+
+module CollectionJSON
+  def self.generate_for(href, &block)
+    response = Response.new(href)
+    if block_given?
+      builder = Builder.new(response)
+      yield(builder)
+    end
+
+    response
+  end
+
+  def self.add_host(href)
+    if COLLECTION_JSON_HOST && !href[/^http/]
+      COLLECTION_JSON_HOST + href
+    else
+      href
+    end
+  end
+end

data/lib/collection-json/builder.rb

@@ -0,0 +1,105 @@
+module CollectionJSON
+  class Builder
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def set_error(opts = {})
+      response.error = opts
+    end
+
+    def set_code(code)
+      response.code = code
+    end
+
+    def add_link(href, rel, opts = {})
+      href = CollectionJSON.add_host(href)
+      response.links << opts.merge({rel: rel, href: href})
+    end
+
+    def add_item(href, data = [], links = [], &block)
+      href = CollectionJSON.add_host(href)
+      response.items << {href: href}.tap do |item|
+        item_builder = ItemBuilder.new(data, links)
+        yield(item_builder) if block_given?
+        item.merge!({data: item_builder.data}) if item_builder.data.length > 0
+        item.merge!({links: item_builder.links}) if item_builder.links.length > 0
+      end
+    end
+
+    def add_query(href, rel, prompt = '', data = [], &block)
+      href = CollectionJSON.add_host(href)
+      response.queries << {href: href, rel: rel}.tap do |query|
+        query_builder = QueryBuilder.new(data)
+        yield(query_builder) if block_given?
+        query.merge!({prompt: prompt}) if prompt != ''
+        query.merge!({data: query_builder.data}) if query_builder.data.length > 0
+      end
+    end
+
+    def set_template(data = [], &block)
+      response.template = Hash.new.tap do |template|
+        template_builder = TemplateBuilder.new(data)
+        yield(template_builder) if block_given?
+        template.merge!({data: template_builder.data}) if template_builder.data.length > 0
+      end
+    end
+  end
+
+  class ItemBuilder
+    attr_reader :data, :links
+
+    def initialize(data, links)
+      @data = data
+      @links = links
+    end
+
+    def add_data(name, value = '', prompt = '')
+      data << {name: name}.tap do |data|
+        data.merge!({value: value}) if value != ''
+        data.merge!({prompt: prompt}) if prompt != ''
+      end
+    end
+
+    def add_link(href, rel, name = '', prompt = '', render = '')
+      href = CollectionJSON.add_host(href)
+      links << {href: href, rel: rel}.tap do |link|
+        link.merge!({name: name}) if name != ''
+        link.merge!({prompt: prompt}) if prompt != ''
+        link.merge!({render: render}) if render != ''
+      end
+    end
+  end
+
+  class QueryBuilder
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def add_data(name, value = '', prompt = '')
+      data << {name: name}.tap do |data|
+        data.merge!({value: value}) if value != ''
+        data.merge!({prompt: prompt}) if prompt != ''
+      end
+    end
+  end
+
+  class TemplateBuilder
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def add_data(name, value = '', prompt = '')
+      data << {name: name}.tap do |data|
+        data.merge!({value: value}) if value != ''
+        data.merge!({prompt: prompt}) if prompt != ''
+      end
+    end
+  end
+end

data/lib/collection-json/response.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module CollectionJSON
+  class Response
+    attr_reader :href, :links, :items, :queries, :template, :version, :error
+    attr_writer :links, :items, :queries, :template, :version, :error    
+
+    def initialize(href)
+      @href = CollectionJSON.add_host(href)
+      @version = COLLECTION_JSON_VERSION
+      @items = []
+      @links = []
+      @queries = []
+      @error = nil
+      @template = nil
+    end
+
+    def body
+      {href: href, version: version}.tap do |body|
+        %w{items links queries}.each do |child_name|
+          child = send(child_name)
+          body.merge!({child_name => child}) if child.length > 0
+        end
+        body.merge!({error: error}) if error
+        body.merge!({template: template}) if template
+      end
+    end
+
+    def collection
+      {collection: body}
+    end
+
+    def to_json(*args)
+      collection.to_json(args)
+    end
+  end
+end

data/lib/collection-json/version.rb

@@ -0,0 +1,3 @@
+module CollectionJSON
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: collection-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-15 00:00:00.000000000 Z
+dependencies: []
+description: Lightweight gem for building Collection+JSON responses.
+email:
+- sebastian@uprise.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- collection-json.gemspec
+- lib/collection-json.rb
+- lib/collection-json/builder.rb
+- lib/collection-json/response.rb
+- lib/collection-json/version.rb
+homepage: https://github.com/sebastianedwards/collection-json
+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: collection-json
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Builds Collection+JSON responses.
+test_files: []