collection-json 0.0.2 → 0.0.3

data/lib/collection-json.rb

@@ -6,6 +6,8 @@ require "collection-json/builder"
 COLLECTION_JSON_VERSION = "1.0"
 ROOT_NODE = 'collection'
 
+VALID_LINK_ATTRIBUTES = %w{href rel name render prompt}.map(&:to_sym)
+
 module CollectionJSON
   def self.generate_for(href, &block)
     response = Collection.new(href)

data/lib/collection-json/attributes/data.rb

@@ -0,0 +1,16 @@
+module CollectionJSON
+  class Data < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def name; self['name']; end
+    def name=(value); self['name'] = value; end
+
+    def value; self['value']; end
+    def value=(value); self['value'] = value; end
+
+    def prompt; self['prompt']; end
+    def prompt=(value); self['prompt'] = value; end
+  end
+end

data/lib/collection-json/attributes/error.rb

@@ -0,0 +1,16 @@
+module CollectionJSON
+  class Error < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def title; self['title']; end
+    def title=(value); self['title'] = value; end
+
+    def code; self['code']; end
+    def code=(value); self['code'] = value; end
+
+    def message; self['message']; end
+    def message=(value); self['message'] = value; end
+  end
+end

data/lib/collection-json/attributes/item.rb

@@ -0,0 +1,29 @@
+require_relative 'link'
+require_relative 'data'
+
+module CollectionJSON
+  class Item < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def href; self['href']; end
+    def href=(value); self['href'] = value; end
+
+    def links
+      self['links'].map {|link| Link.from_hash(link)}
+    end
+
+    def links=(array)
+      self['links'] = array
+    end
+
+    def data
+      self['data'].map {|data| Data.from_hash(data)}
+    end
+
+    def data=(array)
+      self['data'] = array
+    end
+  end
+end

data/lib/collection-json/attributes/link.rb

@@ -0,0 +1,22 @@
+module CollectionJSON
+  class Link < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def href; self['href']; end
+    def href=(value); self['href'] = value; end
+
+    def rel; self['rel']; end
+    def rel=(value); self['rel'] = value; end
+
+    def name; self['name']; end
+    def name=(value); self['name'] = value; end
+
+    def render; self['render']; end
+    def render=(value); self['render'] = value; end
+
+    def prompt; self['prompt']; end
+    def prompt=(value); self['prompt'] = value; end
+  end
+end

data/lib/collection-json/attributes/query.rb

@@ -0,0 +1,48 @@
+require_relative 'data'
+
+module CollectionJSON
+  class Query < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def href; self['href']; end
+    def href=(value); self['href'] = value; end
+
+    def rel; self['rel']; end
+    def rel=(value); self['rel'] = value; end
+
+    def name; self['name']; end
+    def name=(value); self['name'] = value; end
+
+    def prompt; self['prompt']; end
+    def prompt=(value); self['prompt'] = value; end
+
+    def data
+      self['data'].map {|data| Data.from_hash(data)}
+    end
+
+    def data=(array)
+      self['data'] = array
+    end
+
+    def build(params = {})
+      URI(href).tap do |uri|
+        uri.query = add_query_params(uri.query || '', params)
+      end.to_s.gsub(/\?$/, '')
+    end
+
+    private
+    def add_query_params(query, params)
+      query << params.keys.inject('') do |query, key|
+        query.tap do |query_string|
+          unless data.map(&name).include?(key)
+            query << '&' unless key == params.keys.first
+            query << CGI.escape(key.to_s)
+            query << "=#{CGI.escape(params[key].to_s)}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/collection-json/attributes/template.rb

@@ -0,0 +1,30 @@
+require_relative 'data'
+
+module CollectionJSON
+  class Template < Hash
+    def self.from_hash(hash)
+      self.new.merge! hash
+    end
+
+    def data
+      self['data'].map {|data| Data.from_hash(data)}
+    end
+
+    def data=(array)
+      self['data'] = array
+    end
+
+    def build(params = {})
+      self.dup.tap do |result|
+        result.data.each do |data|
+          data.select! {|k,v| %w{name value}.include?(k)}
+          data.value = params[data.name] if params[data.name]
+        end
+      end
+    end
+
+    def to_json(*args)
+      {template: Hash.new.merge!(self)}.to_json(args)
+    end
+  end
+end

data/lib/collection-json/builder.rb

@@ -16,34 +16,37 @@ module CollectionJSON
 
     def add_link(href, rel, opts = {})
       href = CollectionJSON.add_host(href)
-      collection.links << opts.merge({rel: rel, href: href})
+
+      opts.select! {|k,v| VALID_LINK_ATTRIBUTES.include? k}
+      opts.merge!({'rel' => rel, 'href' => href})
+      collection.links << Link.from_hash(opts)
     end
 
     def add_item(href, data = [], links = [], &block)
       href = CollectionJSON.add_host(href)
-      collection.items << {href: href}.tap do |item|
+      collection.items << Item.from_hash({'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
+        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)
-      collection.queries << {href: href, rel: rel}.tap do |query|
+      collection.queries << Query.from_hash({'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
+        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)
-      collection.template = Hash.new.tap do |template|
+      collection.template = Template.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
+        template.merge!({'data' => template_builder.data}) if template_builder.data.length > 0
       end
     end
   end
@@ -58,17 +61,17 @@ module CollectionJSON
 
     def add_data(name, value = '', prompt = '')
       data << {name: name}.tap do |data|
-        data.merge!({value: value}) if value != ''
-        data.merge!({prompt: prompt}) if prompt != ''
+        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 != ''
+      links << Link.from_hash({'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
@@ -81,9 +84,9 @@ module CollectionJSON
     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 != ''
+      data << Data.from_hash({'name' => name}).tap do |data|
+        data.merge!({'value' => value}) if value != ''
+        data.merge!({'prompt' => prompt}) if prompt != ''
       end
     end
   end
@@ -96,9 +99,9 @@ module CollectionJSON
     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 != ''
+      data << Data.from_hash({'name' => name}).tap do |data|
+        data.merge!({'value' => value}) if value != ''
+        data.merge!({'prompt' => prompt}) if prompt != ''
       end
     end
   end

data/lib/collection-json/collection.rb

@@ -1,7 +1,13 @@
+require_relative 'attributes/link'
+require_relative 'attributes/item'
+require_relative 'attributes/query'
+require_relative 'attributes/error'
+require_relative 'attributes/template'
+
 module CollectionJSON
   class Collection
     attr_reader :href, :links, :items, :queries, :template, :version, :error
-    attr_writer :links, :items, :queries, :template, :version, :error
+    attr_writer :version
 
     def self.from_hash(hash)
       self.new(hash[ROOT_NODE]['href']).tap do |collection|
@@ -23,6 +29,26 @@ module CollectionJSON
       @template = nil
     end
 
+    def items=(array)
+      @items = array.map {|item| Item.from_hash(item)}
+    end
+
+    def links=(array)
+      @links = array.map {|link| Link.from_hash(link)}
+    end
+
+    def queries=(array)
+      @queries = array.map {|query| Query.from_hash(query)}
+    end
+
+    def template=(template)
+      @template = Template.from_hash(template)
+    end
+
+    def error=(error)
+      @error = Error.from_hash(error)
+    end
+
     def collection
       {ROOT_NODE => body}
     end

data/lib/collection-json/version.rb

@@ -1,3 +1,3 @@
 module CollectionJSON
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/collection-json/attributes/template_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'collection-json/attributes/template'
+
+describe CollectionJSON::Template do
+  before(:all) do
+    @hash = {
+      'data' => [
+        {
+          'name' => 'full-name',
+          'prompt' => 'Full name'
+        },
+        {
+          'name' => 'email',
+          'prompt' => 'Email'
+        }
+      ]
+    }
+  end
+
+  describe :build do
+    it 'should build correctly' do
+      template = CollectionJSON::Template.from_hash(@hash)
+      result = template.build({
+        'email' => 'test@example.com',
+        'full-name' => 'Test Example'
+      })
+      json = result.to_json
+      hash = JSON.parse(json)
+      hash['template']['data'].length.should eq(2)
+    end
+  end
+end

data/spec/collection-json_spec.rb

@@ -68,15 +68,16 @@ describe CollectionJSON do
       end
 
       response.href.should eq('/friends/')
+      response.links.first.href.should eq("/friends/rss")
       response.items.length.should eq(3)
-      response.items.first[:data].length.should eq(2)
-      response.items.first[:links].length.should eq(2)
-      response.items.first[:href].class.should eq(String)
-      response.template[:data].length.should eq(4)
+      response.items.first.data.length.should eq(2)
+      response.items.first.links.length.should eq(2)
+      response.items.first.href.class.should eq(String)
+      response.template.data.length.should eq(4)
       response.queries.length.should eq(1)
-      response.queries.first[:href].should eq("/friends/search")
-      response.queries.first[:data].length.should eq(1)
-      response.queries.first[:data].first[:name].should eq('search')
+      response.queries.first.href.should eq("/friends/search")
+      response.queries.first.data.length.should eq(1)
+      response.queries.first.data.first.name.should eq('search')
     end
   end
 
@@ -84,6 +85,9 @@ describe CollectionJSON do
     before(:all) do
       json = '{"collection": {
         "href": "http://www.example.org/friends",
+        "links": [
+          {"rel": "feed", "href": "http://www.example.org/friends.rss"}
+        ],
         "items": [
           {
             "href": "http://www.example.org/m.rowe",
@@ -105,12 +109,16 @@ describe CollectionJSON do
     end
 
     it 'should handle the nested attributes' do
-      @collection.items.first['href'].should eq("http://www.example.org/m.rowe")
-      @collection.items.first['data'].count.should eq(1)
+      @collection.items.first.href.should eq("http://www.example.org/m.rowe")
+      @collection.items.first.data.count.should eq(1)
     end
 
     it 'should be able to be reserialized' do
       @collection.to_json.class.should eq(String)
     end
+
+    it 'should have the correct link' do
+      @collection.links.first.href.should eq("http://www.example.org/friends.rss")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collection-json
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70288977749200 !ruby/object:Gem::Requirement
+  requirement: &70212414111720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70288977749200
+  version_requirements: *70212414111720
 description: Lightweight gem for building Collection+JSON responses.
 email:
 - sebastian@uprise.co.nz
@@ -35,9 +35,16 @@ files:
 - Rakefile
 - collection-json.gemspec
 - lib/collection-json.rb
+- lib/collection-json/attributes/data.rb
+- lib/collection-json/attributes/error.rb
+- lib/collection-json/attributes/item.rb
+- lib/collection-json/attributes/link.rb
+- lib/collection-json/attributes/query.rb
+- lib/collection-json/attributes/template.rb
 - lib/collection-json/builder.rb
 - lib/collection-json/collection.rb
 - lib/collection-json/version.rb
+- spec/collection-json/attributes/template_spec.rb
 - spec/collection-json_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sebastianedwards/collection-json
@@ -65,5 +72,6 @@ signing_key:
 specification_version: 3
 summary: Builds Collection+JSON responses.
 test_files:
+- spec/collection-json/attributes/template_spec.rb
 - spec/collection-json_spec.rb
 - spec/spec_helper.rb