collection_json 0.0.1 → 0.0.2

data/.gitignore

@@ -7,3 +7,6 @@ vendor/gems/*
 .sass-cache/*
 *.swp
 **/*.swp
+pkg
+Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+–order rand

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,9 +1,76 @@
 # CollectionJson
 
-A gem to help with producing Hypermedia APIs with a MIME type of
+An experimental gem to help with producing Hypermedia APIs with a MIME type of
 'application/vnd.collection+json'
 
-see http://amundsen.com/media-types/collection/format/#link-relations
+see http://amundsen.com/media-types/collection/format/
+
+
+## Usage
+
+The aim is to include the gem in a Rack app to generate hypermedia APIs from
+your resources, effectively a hypermedia decorator.
+
+Here's a preview of what you should be able to do in a Rails app:
+
+
+![Spider cow](https://github.com/markburns/collection_json/raw/master/doc/spider-cow.jpg)
+
+```ruby
+class SpiderCowController < ApplicationController
+  respond_to :collection_json
+
+  def index
+    @spider_cows = SpiderCowDecorator.all do |collection, item|
+      collection.href "http://www.youtube.com/watch?v=FavUpD_IjVY"
+
+      item.links [{href: spider_cow_path(item),        rel: "self"},
+                  {href: spider_cow_path(item.father), rel: "father"}]
+    end
+
+    respond_with @spider_cows
+  end
+end
+
+class SpiderCow < ActiveRecord::Base
+  #attributes - legs, eyes, udders
+end
+
+class SpiderCowDecorator
+  extend CollectionJson::Decorator
+end
+```
+
+Sample output:
+
+```javascript
+{"collection" :
+  {
+    "version" :"1.0",
+    "href" :"http://example.org/spider_cows/",
+
+    "links" :[ {"rel" :"father", "href" :"http://example.com/spider_cows/tom"}],
+
+    "items" :
+    [
+      {"data" :
+       [{"name" :"legs", "value" :7},
+        {"name" :"eyes", "value" :8},
+        {"name" :"udders", "value" :"blue"}
+       ]
+      },
+
+      {"data" :
+       [{"name" :"legs",  "value" :6},
+        {"name" :"udders", "value" :"red"}
+       ]
+      }
+    ]
+  }
+}
+
+```
+
 
 ## Installation
 
@@ -19,26 +86,25 @@ Or install it yourself as:
 
     $ gem install collection_json
 
-## Usage
 
-This is still experimental at the moment.
-The aim is to be able to include the gem in a Rack app and make for easy
-generation of hypermedia APIs from your resources, effectively something like a
-hypermedia presenter.
+##Notes
 
-I'm not clear on the details of how the objects will be presented as
-Collection+JSON as there is an emphasis on Collections rather than individual
-items. This makes sense if you think of Rails controllers being plural.
+Collection+JSON specifies the following concepts
 
-But it is reasonably different to being used to having the primary unit of data
-being a singular model.
+Create, Read, Update, Delete, Template and Query
+which correspond to the ideas in Rails like so:
 
-```ruby
-  SingularActiveRecordObject.all
-
-  #versus:
-  PluralJsonCollection.new collection_of_objects
-```
+<table>
+  <tr>
+    <th>Verb</th><th>Rails</th><th>Collection+JSON</th>
+  </tr>
+  <tr><td>POST  </td><td>create  </td><td>create</td></tr>
+  <tr><td>GET   </td><td>show    </td><td>read</td></tr>
+  <tr><td>PUT   </td><td>update  </td><td>update</td></tr>
+  <tr><td>DELETE</td><td>destroy </td><td>delete</td></tr>
+  <tr><td>GET   </td><td>edit/new</td><td>template</td></tr>
+  <tr><td>GET   </td><td>index   </td><td>query</td></tr>
+</table>
 
 ## Contributing
 
@@ -47,3 +113,6 @@ being a singular model.
 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/collection_json.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/collection_json/version', __FILE__)
+require File.expand_path('../lib/collection_json/gem_version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Mark Burns"]
@@ -7,11 +7,24 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Help create Collection+JSON hypermedia APIs}
   gem.summary       = %q{As specified by: http://amundsen.com/media-types/collection/format/#objects}
   gem.homepage      = "https://github.com/markburns/collection_json"
+  gem.add_dependency  'virtus'
+  gem.add_dependency  'activesupport'
+  gem.add_dependency  'i18n'
+  gem.add_dependency  'draper'
+  gem.add_dependency  'funky_accessor'
+
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'growl'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'ruby-debug19'
+  gem.add_development_dependency 'ruby-debug-base19', '0.11.26'
+  gem.add_development_dependency 'linecache19',       '0.5.13'
+  gem.add_development_dependency 'awesome_print'
 
   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          = "collection_json"
   gem.require_paths = ["lib"]
-  gem.version       = CollectionJson::VERSION
+  gem.version       = CollectionJson::GEM_VERSION
 end

data/doc/hypermedia_client.js.coffee

@@ -0,0 +1,36 @@
+collection = new Collection 'api.spider-cows.com'
+
+console.log collection.response
+
+
+{"collection" :
+  {
+    "version" :"1.0",
+    "href" :"http://api.spider-cows.com/",
+
+    "links" :[ {"rel" :"boss_spider", "href" :"http://example.com/spider_cows/tom"}],
+
+    "items" :
+    [
+      {"data" :
+       [{"name" :"legs", "value" :7},
+        {"name" :"eyes", "value" :8},
+        {"name" :"udders", "value" :"blue"}
+       ]
+      },
+
+      {"data" :
+       [{"name" :"legs",  "value" :6},
+        {"name" :"udders", "value" :"red"}
+       ]
+      }
+    ]
+  }
+}
+
+
+console.log collection.links
+[{"rel" :"boss_spider", "href" :"http://example.com/spider_cows/tom"}]
+
+
+console.log collection.links

data/doc/sample.collection.json.js

@@ -0,0 +1,66 @@
+{"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://examples.org/blogs/jdoe", "prompt" : "Blog"},
+          {"rel" : "avatar", "href" : "http://examples.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://examples.org/blogs/msmith", "prompt" : "Blog"},
+          {"rel" : "avatar", "href" : "http://examples.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://examples.org/blogs/rwilliams", "prompt" : "Blog"},
+          {"rel" : "avatar", "href" : "http://examples.org/images/rwilliams", "prompt" : "Avatar", "render" : "image"}
+        ]
+      }
+    ],
+
+    "queries" : [
+      {"rel" : "search", "href" : "http://example.org/friends/search", "prompt" : "Search",
+        "data" : [
+          {"name" : "search", "value" : ""}
+        ]
+      }
+    ],
+
+    "template" : {
+      "data" : [
+        {"name" : "full-name", "value" : "", "prompt" : "Full Name"},
+        {"name" : "email", "value" : "", "prompt" : "Email"},
+        {"name" : "blog", "value" : "", "prompt" : "Blog"},
+        {"name" : "avatar", "value" : "", "prompt" : "Avatar"}
+
+      ]
+    }
+  }
+}

data/lib/collection_json.rb

@@ -1,84 +1,42 @@
+require "active_support/dependencies/autoload"
+require "active_support/version"
+require "delegate"
 require 'json'
+require 'virtus'
+
+require 'active_support/lazy_load_hooks'
+require 'active_support/concern'
 require 'active_support/core_ext/string'
-require 'collection_json/version'
+require 'active_support/core_ext/hash'
+require 'collection_json/gem_version'
+require 'draper'
+
+require 'active_support/deprecation'
+require 'active_support/concern'
+require 'virtus'
+require 'virtus/attribute'
+require 'funky_accessor'
 
 #see http://amundsen.com/media-types/collection/format/#link-relations
 
 #  2.1. collection
 # The collection object contains all the "records" in the representation.
-# This is a REQUIRED object and there MUST NOT be more than one collection object in a Collection+JSON document.
+# This is a REQUIRED object and there MUST NOT be more than one collection
+# object in a Collection+JSON document.
 # It is a top-level document property.
 module CollectionJson
-  attr_writer :href, :links, :items, :queries, :template
-
-  def to_json
-    {collection: collection}.to_json
-  end
-
-  def collection
-    { version: "1.0", #The collection object SHOULD have a version property. For this release,
-      #the value of the version property MUST be set to 1.0.
-      #If there is no version property present, it should be assumed to be set to 1.0.
-
-      href: href, #The collection object SHOULD have an href property.
-      #The href property MUST contain a valid URI.
-      #This URI SHOULD represent the address used to retrieve a representation of the document.
-      #This URI MAY be used to add a new record
-
-      links: links, #The collection object MAY have an links array child property
-
-      items: items, #The collection object MAY have an items array child property.
-      #Each item in a Collection+JSONcollection has an assigned URI (via the href property) and an optional array of one or more data elements along with an optional array of one or more link elements.
-      queries: queries, #The collection object MAY have an queries array child property.
-
-      template: template, #The collection object MAY have an template object child property.
-      error: error #The collection object MAY have an error object child property.
-    }
-  end
-
-  def href
-    @href || "/#{self.class.to_s.underscore.pluralize}"
-  end
-
-  #3.4 links
-  #The links array is an OPTIONAL child property of the items array
-  def links
-    #The Collection+JSON hypermedia type has a limited set of predefined link
-    #relation values and supports additional values applied by implementors
-    #in order to better describe the application domain to which the media
-    #type is applied.
-    @links ||= []
-  end
-
-  def items
-    @items
-  end
-
-  #3.3. queries
-  #The queries array is an OPTIONAL top-level property of the Collection+JSON document.
-  def queries
-    @queries ||= []
-  end
+  extend ActiveSupport::Autoload
 
-  #The template object contains all the input elements used to add or edit collection "records." This is an OPTIONAL object and there MUST NOT be more than one template object in a Collection+JSON document. It is a top-level document property.
-  #The template object SHOULD have a data array child property.
-  def template
-    @template ||= {}
-  end
+  autoload :Rack
+  autoload :Collection
+  autoload :Link
+  autoload :Item
+  autoload :Query
+  autoload :Template
 
-  #2.2. error
-  #The error object contains addiitional information on the latest error
-  #condition reported by the server.
-  #This is an OPTIONAL object and there MUST NOT be more than one error
-  #object in a Collection+JSON document.
-  #
-  #It is a top-level document property.
-  #
-  #The following elements MAY appear as child properties of the error object:
-  #code message and title.
-  Error = Struct.new :code, :message, :title
+  autoload :InvalidJsonError, 'collection_json/exceptions'
+  autoload :InvalidUriError,  'collection_json/exceptions'
+  autoload :IncompatibleItem, 'collection_json/exceptions'
 
-  def error
-    @error
-  end
+  autoload :Decorator
 end

data/lib/collection_json/collection.rb

@@ -0,0 +1,34 @@
+module CollectionJson
+  class Collection
+    extend FunkyAccessor
+    funky_accessor :items, :version, :template, :href, :links
+
+    def initialize items
+      @version    = "1.0"
+      @items      = items.map { |i| Item.new(i) }
+      @template = @items.first.blank_template if @items.any?
+      @links = []
+    end
+
+    def representation
+      collection = {
+          version:  version,
+          href:     href,
+          links:    links,
+          items:    item_representations
+        }
+
+      collection.merge!({template: {data: template}}) if template
+
+      {collection: collection}
+    end
+
+    def to_json
+      representation.to_json
+    end
+
+    def item_representations
+      items.map &:singular_representation
+    end
+  end
+end

data/lib/collection_json/decorator.rb

@@ -0,0 +1,13 @@
+module CollectionJson::Decorator
+  def decorate object
+    klass = object.respond_to?(:each) ? CollectionJson::Collection : CollectionJson::Item
+
+    klass.new(object).tap do |o|
+      if object.respond_to? :each
+        o.items.each { |i| yield o, i } if block_given?
+      else
+        yield o if block_given?
+      end
+    end
+  end
+end

data/lib/collection_json/exceptions.rb

@@ -0,0 +1,5 @@
+module CollectionJson
+  InvalidJsonError = Class.new Exception
+  InvalidUriError  = Class.new Exception
+  IncompatibleItem = Class.new Exception
+end

data/lib/collection_json/{query.rb → gem_version.rb}

@@ -1,4 +1,3 @@
 module CollectionJson
-  module Query
-  end
+  GEM_VERSION = "0.0.2"
 end

data/lib/collection_json/item.rb

@@ -0,0 +1,60 @@
+#The collection object MAY have an items array child property.
+#Each item in a Collection+JSONcollection has an assigned URI
+#(via the href property) and an optional array of one or more data
+#elements along with an optional array of one or more link elements.
+module CollectionJson
+  class Item < SimpleDelegator
+    extend FunkyAccessor
+    funky_accessor :href, :links, :version, :object
+
+    def initialize object
+      @object  = object
+      pre_check
+      super object
+
+      @links   = []
+      @version = "1.0"
+    end
+
+    def to_json
+      representation.to_json
+    end
+
+    def blank_template
+      template.map{|h| h[:value]=""; h }
+    end
+
+    def template
+      attributes
+    end
+
+    def singular_representation
+      item = {}
+      item.merge!({href: href})       if href
+      item.merge!({data: attributes}) if attributes.any?
+    end
+
+    def representation
+      r = { version: version}
+
+      r.merge!({href:  href})         if href
+      r.merge!({links: links})        if links
+      r.merge!({items: [singular_representation]})
+
+      { collection: r }
+    end
+
+    def attributes
+      @attributes = @object.attributes || {}
+      @attributes.map{|k,v|  {name: k.to_s, value: v}}
+    end
+
+    private
+
+    def pre_check
+      unless object.respond_to? :attributes
+        raise CollectionJson::IncompatibleItem.new("Decorated items must have an attributes method")
+      end
+    end
+  end
+end

data/lib/collection_json/rack.rb

@@ -0,0 +1,6 @@
+module CollectionJson::Rack
+  extend ActiveSupport::Autoload
+
+  autoload :Parser
+  autoload :Interactions
+end

data/lib/collection_json/rack/parser.rb

@@ -0,0 +1,15 @@
+module CollectionJson::Rack
+  class Parser
+    attr_reader :json
+
+    def initialize json_string
+      @json = JSON.parse json_string
+    rescue JSON::ParserError => e
+      raise CollectionJson::InvalidJsonError.new "Couldn't parse: <#{json_string}>, #{e.message}"
+    end
+
+    def valid?
+      false
+    end
+  end
+end

data/lib/collection_json/template.rb

@@ -0,0 +1,16 @@
+#The template object contains all the input elements used to add or edit
+#collection "records." This is an OPTIONAL object and there MUST NOT be more
+#than one template object in a Collection+JSON document.
+#It is a top-level document property.
+#The template object SHOULD have a data array child property.
+module CollectionJson
+  class Template
+    def initialize *attributes
+      @attributes = attributes
+    end
+
+    def to_json
+      @attributes.map{|a| {name: a, value: ""}}.to_json
+    end
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,109 @@
+class SpiderCowDecorator ;extend CollectionJson::Decorator end
+
+describe CollectionJson::Collection do
+  def cow(id) mock 'spider_cow', link: id, attributes: {name: "cow_#{id}"} end
+
+ let(:items) {[cow(1), cow(2), cow(3)]}
+
+  let(:links) {[{rel: "next", href: "spider_cows/?page=3"}] }
+
+  #crazy archaic plural I'd never heard of, cow -> kine. Thanks ActiveSupport
+  let(:href) { "/spider_kine" }
+
+  let(:spider_cows) do
+    SpiderCowDecorator.decorate items
+  end
+
+  describe "#href" do
+    specify do
+      spider_cows.href "/spider_cows"
+      spider_cows.href.should == "/spider_cows"
+    end
+  end
+
+  describe "#links" do
+    specify do
+      spider_cows.links           %w(egg banana cheese)
+      spider_cows.links.should == %w(egg banana cheese)
+    end
+  end
+
+  describe "#representation" do
+    specify "has items" do
+      spider_cows.representation[:collection][:items].should ==
+        [{data: [{:name=>"name", :value=>"cow_1"}]},
+         {data: [{:name=>"name", :value=>"cow_2"}]},
+         {data: [{:name=>"name", :value=>"cow_3"}]}]
+    end
+
+    specify "has links" do
+      spider_cows.links links
+      spider_cows.representation[:collection][:links].should == links
+    end
+
+    specify "has href" do
+      spider_cows.href href
+      spider_cows.representation[:collection][:href].should == href
+    end
+  end
+
+  let(:banana_fish) do
+    BananaFish.new legs: 7, eyes: 8, color: "blue"
+  end
+
+  let(:banana_fish_2) do
+    BananaFish.new legs: 6, face: "red"
+  end
+
+  describe ".decorate_collection" do
+    let(:expected_2) do
+      {"collection" =>{
+        "version" => "1.0",
+        "href" => "http://example.org/banana_fish/",
+
+        "links" => [
+          {"rel" => "father", "href" => "http://example.com/bananas/tom"},
+      ],
+
+      "template" => {"data" =>
+                     [{"name"=>"legs",  "value"=>""},
+                      {"name"=>"eyes",  "value"=>""},
+                      {"name"=>"color", "value"=>""}]
+      },
+        "items" =>
+      [
+        {"data" =>
+         [{"name" => "legs", "value" => 7},
+          {"name" => "eyes", "value" => 8},
+          {"name" => "color", "value" => "blue"}
+         ]
+      },
+
+        {"data" =>
+         [{"name" => "legs",  "value" => 6},
+          {"name" => "face", "value" => "red"}
+         ]
+      }
+      ]
+      }
+      }
+    end
+    let(:collection) do
+      BananaFishDecorator.decorate [banana_fish, banana_fish_2] do |c,i|
+        c.href "http://example.org/banana_fish/"
+
+        c.links [ {"rel" => "father", "href" => "http://example.com/bananas/tom"} ]
+      end
+    end
+
+    let(:parsed) do
+      JSON[collection.to_json]
+    end
+
+    %w(version href links template).each do |a|
+      specify ", #{a} should match"do
+        parsed["collection"][a].should == expected_2["collection"][a]
+      end
+    end
+  end
+end

data/spec/decorator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('spec/spec_helper')
+class BananaFish < OpenStruct
+  def attributes
+    @table
+  end
+end
+
+class BananaFishDecorator
+  extend CollectionJson::Decorator
+end
+
+
+describe CollectionJson::Decorator do
+  context "with a block" do
+    class CatDecorator
+      extend CollectionJson::Decorator
+    end
+
+    before do
+      cat = {legs: 4, tail: true, id: 1}
+      attributes = cat.merge({attributes: cat})
+
+      cats = [OpenStruct.new(attributes)]
+
+      decorated = CatDecorator.decorate(cats) do |collection, item|
+        collection.links << "/cats"
+        collection.href "/cats"
+        item.links << "/cats/#{item.id}"
+        item.href "/cats/#{item.id}"
+      end
+
+      @decorated = JSON[decorated.to_json]["collection"]
+    end
+
+    specify { @decorated["links"].should == ["/cats"] }
+    specify { @decorated["href"].should == "/cats" }
+    specify { @decorated["items"][0]["href"].should == "/cats/1" }
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,28 @@
+require './spec/support/sample_mvc'
+
+describe "CollectionJson", type: :integration do
+  let(:controller) { SpiderCowController.new      }
+
+  describe "controller#index" do
+    before do
+      controller.index
+      @spider_cows = controller.instance_eval{@spider_cows}
+    end
+
+    it "assigns a collection with items" do
+      items = @spider_cows.items
+      items.should be_a Enumerable
+
+      items.each do |x|
+        x.should be_a CollectionJson::Item
+      end
+    end
+
+    it "defines the link with a block" do
+      items = @spider_cows.items
+      item = items.first
+
+      item.links.should == [{href: "/spider_cows/1", rel: "self"}]
+    end
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,103 @@
+class BananaFish < OpenStruct
+  def attributes
+    @table
+  end
+end
+
+class BananaFishDecorator
+  extend CollectionJson::Decorator
+end
+
+
+describe CollectionJson::Item do
+  let(:banana_fish) do
+    BananaFish.new legs: 7, eyes: 8, color: "blue"
+  end
+
+  let(:banana_fish_2) do
+    BananaFish.new legs: 6, face: "red"
+  end
+
+  describe ".decorate_item" do
+    let(:decorated) do
+      BananaFishDecorator.decorate banana_fish do |b|
+        b.href "http://example.org/banana_fish/1"
+        b.links [{"rel" => "father", "href" => "http://example.com/bananas/tom"},
+                 {"rel" => "mother", "href" => "http://example.com/fish/tina"}]
+      end
+
+    end
+
+    let(:decorated_2) do
+      BananaFishDecorator.decorate banana_fish_2 do |b|
+        b.href  "http://example.org/banana_fish/2"
+        b.links  [{"rel" =>  "father", "href" => "http://example.com/bananas/tom"}]
+      end
+
+    end
+    let(:expected) do
+      {"collection" =>
+       {
+         "version" => "1.0",
+         "href" => "http://example.org/banana_fish/1",
+
+         "links" => [
+           {"rel" => "father", "href" => "http://example.com/bananas/tom"},
+           {"rel" => "mother", "href" => "http://example.com/fish/tina"}],
+
+           "items" =>
+           [{
+             "href"=>"http://example.org/banana_fish/1",
+             "data" =>
+
+             [{"name" => "legs", "value" => 7},
+              {"name" => "eyes", "value" => 8},
+              {"name" => "color", "value" => "blue"}
+             ]
+           }]}
+      }
+    end
+
+    let(:expected_2) do
+      {"collection" =>
+       {
+         "version" => "1.0",
+         "href" => "http://example.org/banana_fish/2",
+
+         "links" => [
+           {"rel" => "father", "href" => "http://example.com/bananas/tom"},
+       ],
+
+       "items" =>
+       [
+         {
+         "href"=>"http://example.org/banana_fish/1",
+         "data" =>
+         [{"name" => "legs",  "value" => 6},
+          {"name" => "face", "value" => "red"}
+         ]
+       }
+       ]
+       }}
+    end
+
+    before do
+      decorated_json   = decorated.to_json
+      decorated_json_2 = decorated_2.to_json
+
+      @parsed          = JSON.parse(decorated_json  )
+      @parsed_2        = JSON.parse(decorated_json_2)
+    end
+
+    specify { @parsed.keys.should == expected.keys }
+    specify { @parsed.values.should == expected.values }
+
+    %w(version href link items).each do |a|
+      specify ", #{a} should match" do
+        @parsed[a].should == expected[a]
+        @parsed_2[a].should == expected_2[a]
+      end
+    end
+  end
+
+end

data/spec/rack/parser_spec.rb

@@ -0,0 +1,23 @@
+describe CollectionJson::Rack::Parser do
+  let(:parser) do
+    CollectionJson::Rack::Parser.new '{"a": 1, "c": "1"}'
+  end
+
+  describe "#initialize" do
+    specify do
+      ->{CollectionJson::Rack::Parser.new ""}.should raise_error CollectionJson::InvalidJsonError
+    end
+  end
+
+  describe "#json" do
+    specify do
+      parser.json.should == {"a" => 1, "c" => "1"}
+    end
+  end
+
+  describe "#valid?" do
+    specify do
+      parser.should_not be_valid
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,10 +4,11 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-Dir['./lib/**/*.rb'].each {|r| require r}
+require 'collection_json'
+require 'ruby-debug'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  #config.filter_run :focus
 end

data/spec/support/sample_mvc.rb

@@ -0,0 +1,38 @@
+class SpiderCowController
+  def index
+    spider_cows = SpiderCow.all
+
+    @spider_cows = SpiderCowDecorator.decorate(spider_cows) do |collection, item|
+      item.links [{href: spider_cow_path(item), rel: "self"}]
+    end
+  end
+
+  #in real life this method will be made available
+  #rather than defined here
+  def spider_cow_path cow
+    "/spider_cows/#{cow.id}"
+  end
+end
+
+class SpiderCow
+  attr_accessor :id
+
+  def self.all
+    [SpiderCow.new(1), SpiderCow.new(2), SpiderCow.new(3)]
+  end
+
+  def attributes
+    {id: @id}
+  end
+
+  def initialize id
+    @id = id
+  end
+end
+
+
+class SpiderCowDecorator
+  include CollectionJson::Decorator
+end
+
+

data/spec/template_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('spec/spec_helper')
+
+describe CollectionJson::Template do
+  let(:template) {CollectionJson::Template.new(:legs, :eyes)}
+
+  specify do
+    template.to_json.should == [
+      {name: :legs, value: ""},
+      {name: :eyes, value: ""},
+    ].to_json
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collection_json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,140 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
-dependencies: []
+date: 2012-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &70360322207560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360322207560
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70360322206980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360322206980
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70360322206380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360322206380
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: &70360322205860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360322205860
+- !ruby/object:Gem::Dependency
+  name: funky_accessor
+  requirement: &70360322205100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360322205100
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70360322204500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360322204500
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70360322203700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360322203700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70360322203080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360322203080
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70360322202340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360322202340
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-base19
+  requirement: &70360322201460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.11.26
+  type: :development
+  prerelease: false
+  version_requirements: *70360322201460
+- !ruby/object:Gem::Dependency
+  name: linecache19
+  requirement: &70360322200520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.13
+  type: :development
+  prerelease: false
+  version_requirements: *70360322200520
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70360322199440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360322199440
 description: Help create Collection+JSON hypermedia APIs
 email:
 - markthedeveloper@gmail.com
@@ -19,17 +151,36 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - collection_json.gemspec
+- doc/hypermedia_client.js.coffee
+- doc/sample.collection.json.js
+- doc/spider-cow.jpg
+- doc/spider-pig.gif
 - lib/collection_json.rb
-- lib/collection_json/crud_operations.rb
-- lib/collection_json/query.rb
-- lib/collection_json/version.rb
-- spec/lib/collection_json_spec.rb
+- lib/collection_json/collection.rb
+- lib/collection_json/decorator.rb
+- lib/collection_json/exceptions.rb
+- lib/collection_json/gem_version.rb
+- lib/collection_json/item.rb
+- lib/collection_json/rack.rb
+- lib/collection_json/rack/parser.rb
+- lib/collection_json/template.rb
+- spec/collection_spec.rb
+- spec/decorator_spec.rb
+- spec/integration_spec.rb
+- spec/item_spec.rb
+- spec/rack/parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/sample_mvc.rb
+- spec/template_spec.rb
+- temp_gems_for_ruby_debug_with_1.9.3/linecache19-0.5.13.gem
+- temp_gems_for_ruby_debug_with_1.9.3/ruby-debug-base19-0.11.26.gem
 homepage: https://github.com/markburns/collection_json
 licenses: []
 post_install_message: 
@@ -50,10 +201,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: ! 'As specified by: http://amundsen.com/media-types/collection/format/#objects'
 test_files:
-- spec/lib/collection_json_spec.rb
+- spec/collection_spec.rb
+- spec/decorator_spec.rb
+- spec/integration_spec.rb
+- spec/item_spec.rb
+- spec/rack/parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/sample_mvc.rb
+- spec/template_spec.rb
+has_rdoc: 

data/lib/collection_json/crud_operations.rb

@@ -1,4 +0,0 @@
-module CollectionJson
-  module CrudOperations
-  end
-end

data/lib/collection_json/version.rb

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

data/spec/lib/collection_json_spec.rb

@@ -1,97 +0,0 @@
-require File.expand_path('spec/spec_helper')
-
-
-class HerdOfSpiderCows
-  include CollectionJson
-  extend CollectionJson::CrudOperations
-  extend CollectionJson::Query
-
-  def initialize items, links=[], queries=[], template={}
-    @items, @links, @queries, @template = items, links, queries, template
-  end
-end
-
-#see http://amundsen.com/media-types/collection/format/#link-relations
-describe CollectionJson do
-  let(:spider_cows) { HerdOfSpiderCows.new [1,2,3],
-                      ['/spider_cow/1', '/spider_cow/2', 'spider_cow/3'] }
-
-
-  describe "#href" do
-    specify {spider_cows.href.should == "/herd_of_spider_cows" }
-
-    specify do
-      spider_cows.href= "/gathering_of_spider_cows"
-      spider_cows.href.should == "/gathering_of_spider_cows"
-    end
-  end
-
-  describe "#links" do
-   specify "has links" do
-      spider_cows.links.should ==
-        ['/spider_cow/1', '/spider_cow/2', 'spider_cow/3']
-    end
-
-   specify do
-     spider_cows.links = %w[egg banana cheese]
-     spider_cows.links.should == %w[egg banana cheese]
-   end
-  end
-
-  describe "#collection" do
-    specify do
-      spider_cows.collection.should be_a Hash
-    end
-
-    specify "has items" do
-      spider_cows.collection[:items].should == [1,2,3]
-    end
-
-    specify "has links" do
-      spider_cows.collection[:links].should ==
-        ['/spider_cow/1', '/spider_cow/2', 'spider_cow/3']
-    end
-  end
-end
-
-
-describe CollectionJson::CrudOperations do
-  describe ".create" do
-    #1.1.2. Adding an Item
-    #To create a new item in the collection, the client first uses the template object to compose a valid item representation and then uses HTTP POST to send that representation to the server for processing.
-
-    #If the item resource was created successfully, the server responds with a status code of 201 and a Location header that contains the URI of the newly created item resource.
-  end
-
-
-  describe ".read" do
-    #1.1.3. Reading an Item
-    #Clients can retrieve an existing item resource by sending an HTTP GET request to the URI of an item resource.
-    #If the request is valid, the server will respond with a representation of that item resource.
-  end
-
-  describe ".update" do
-    #1.1.4. Updating an Item
-    #To update an existing resource, the client uses the template object as a guide to composing a replacement item representation and then uses HTTP PUT to send that representation to the server.
-    #If the update is successful, the server will respond with HTTP status code 200 and possibly a representation of the updated item resource representation.
-
-
-  end
-
-  describe ".delete" do
-    #1.1.5. Deleting an Item
-    #Clients can delete existing resources by sending an HTTP DELETE request to the URI of the item resource.
-
-    #If the delete request is successful, the server SHOULD respond with an HTTP status code of 204.
-
-
-  end
-end
-
-#1.2. Query Templates
-#Clients that support the Collection+JSON media type SHOULD be able to recognize and parse query templates found within responses. Query templates consist of a data array associated with an href property. The queries array supports query templates.
-
-#For query templates, the name/value pairs of the data array set are appended to the URI found in the href property associated with the queries array (with a question-mark ["?"] as separator) and this new URI is sent to the processing agent.
-describe CollectionJson::Query do
-
-end