collection-json 0.0.1 → 0.0.2

data/collection-json.gemspec

@@ -14,5 +14,8 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "collection-json"
 
   s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
 end

data/lib/collection-json.rb

@@ -1,13 +1,14 @@
+require 'json'
 require "collection-json/version"
-require "collection-json/response"
+require "collection-json/collection"
 require "collection-json/builder"
 
 COLLECTION_JSON_VERSION = "1.0"
-COLLECTION_JSON_HOST = ENV['COLLECTION_JSON_HOST']
+ROOT_NODE = 'collection'
 
 module CollectionJSON
   def self.generate_for(href, &block)
-    response = Response.new(href)
+    response = Collection.new(href)
     if block_given?
       builder = Builder.new(response)
       yield(builder)
@@ -17,10 +18,15 @@ module CollectionJSON
   end
 
   def self.add_host(href)
-    if COLLECTION_JSON_HOST && !href[/^http/]
-      COLLECTION_JSON_HOST + href
+    if ENV['COLLECTION_JSON_HOST'] && !href[/^http/]
+      ENV['COLLECTION_JSON_HOST'] + href
     else
       href
     end
   end
+
+  def self.parse(json)
+    hash = JSON.parse(json)
+    collection = Collection.from_hash(hash)
+  end
 end

data/lib/collection-json/builder.rb

@@ -1,27 +1,27 @@
 module CollectionJSON
   class Builder
-    attr_reader :response
+    attr_reader :collection
 
-    def initialize(response)
-      @response = response
+    def initialize(collection)
+      @collection = collection
     end
 
     def set_error(opts = {})
-      response.error = opts
+      collection.error = opts
     end
 
     def set_code(code)
-      response.code = code
+      collection.code = code
     end
 
     def add_link(href, rel, opts = {})
       href = CollectionJSON.add_host(href)
-      response.links << opts.merge({rel: rel, href: href})
+      collection.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|
+      collection.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
@@ -31,7 +31,7 @@ module CollectionJSON
 
     def add_query(href, rel, prompt = '', data = [], &block)
       href = CollectionJSON.add_host(href)
-      response.queries << {href: href, rel: rel}.tap do |query|
+      collection.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 != ''
@@ -40,7 +40,7 @@ module CollectionJSON
     end
 
     def set_template(data = [], &block)
-      response.template = Hash.new.tap do |template|
+      collection.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

data/lib/collection-json/{response.rb → collection.rb}

@@ -1,9 +1,17 @@
-require 'json'
-
 module CollectionJSON
-  class Response
+  class Collection
     attr_reader :href, :links, :items, :queries, :template, :version, :error
-    attr_writer :links, :items, :queries, :template, :version, :error    
+    attr_writer :links, :items, :queries, :template, :version, :error
+
+    def self.from_hash(hash)
+      self.new(hash[ROOT_NODE]['href']).tap do |collection|
+        %w{items links queries error template}.each do |attribute|
+          if hash[ROOT_NODE][attribute]
+            collection.send("#{attribute}=", hash[ROOT_NODE][attribute])
+          end
+        end
+      end
+    end
 
     def initialize(href)
       @href = CollectionJSON.add_host(href)
@@ -15,6 +23,15 @@ module CollectionJSON
       @template = nil
     end
 
+    def collection
+      {ROOT_NODE => body}
+    end
+
+    def to_json(*args)
+      collection.to_json(args)
+    end
+
+    private
     def body
       {href: href, version: version}.tap do |body|
         %w{items links queries}.each do |child_name|
@@ -25,13 +42,5 @@ module CollectionJSON
         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

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

data/spec/collection-json_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'collection-json'
+
+describe CollectionJSON do
+  describe :add_host do
+    before :each do
+      @href = '/friends'
+    end
+
+    context 'with COLLECTION_JSON_HOST set' do
+      it 'returns full uri' do
+        ENV['COLLECTION_JSON_HOST'] = EXAMPLE_HOST
+        uri = CollectionJSON.add_host(@href)
+        uri.should eq("http://localhost/friends")
+      end
+    end
+
+    context 'without COLLECTION_JSON_HOST set' do
+      it 'returns partial uri' do
+        ENV['COLLECTION_JSON_HOST'] = nil
+        uri = CollectionJSON.add_host(@href)
+        uri.should eq("/friends")
+      end
+    end
+  end
+
+  describe :generate_for do
+    before :each do
+      @friends = [
+        {
+          "id"        =>  "jdoe",
+          "full-name" =>  "J. Doe",
+          "email"     =>  "jdoe@example.org"
+        },
+        {
+          "id"        =>  "msmith",
+          "full-name" =>  "M. Smith",
+          "email"     =>  "msmith@example.org"
+        },
+        {
+          "id"        =>  "rwilliams",
+          "full-name" =>  "R. Williams",
+          "email"     =>  "rwilliams@example.org"
+        }
+      ]
+    end
+
+    it 'should generate an object with the attributes we expect' do
+      response = CollectionJSON.generate_for('/friends/') do |builder|
+        builder.add_link '/friends/rss', 'feed'
+        @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.href.should eq('/friends/')
+      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.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')
+    end
+  end
+
+  describe :parse do
+    before(:all) do
+      json = '{"collection": {
+        "href": "http://www.example.org/friends",
+        "items": [
+          {
+            "href": "http://www.example.org/m.rowe",
+            "data": [
+              {"name": "full-name", "value": "Matt Rowe"}
+            ]
+          }
+        ]
+      }}'
+      @collection = CollectionJSON.parse(json)
+    end
+
+    it 'should parse JSON into a Collection' do
+      @collection.class.should eq(CollectionJSON::Collection)
+    end
+
+    it 'should have correct href' do
+      @collection.href.should eq("http://www.example.org/friends")
+    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)
+    end
+
+    it 'should be able to be reserialized' do
+      @collection.to_json.class.should eq(String)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+EXAMPLE_HOST = "http://localhost"
+
+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
+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,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-15 00:00:00.000000000 Z
-dependencies: []
+date: 2012-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70288977749200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70288977749200
 description: Lightweight gem for building Collection+JSON responses.
 email:
 - sebastian@uprise.co.nz
@@ -25,8 +36,10 @@ files:
 - collection-json.gemspec
 - lib/collection-json.rb
 - lib/collection-json/builder.rb
-- lib/collection-json/response.rb
+- lib/collection-json/collection.rb
 - lib/collection-json/version.rb
+- spec/collection-json_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/sebastianedwards/collection-json
 licenses: []
 post_install_message: 
@@ -51,4 +64,6 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Builds Collection+JSON responses.
-test_files: []
+test_files:
+- spec/collection-json_spec.rb
+- spec/spec_helper.rb