collection_json 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+log/**/*
+tmp/**/*
+bin/*
+vendor/gems/*
+!vendor/gems/cache/
+.sass-cache/*
+*.swp
+**/*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in collection_json.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Burns
+
+MIT License
+
+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,49 @@
+# CollectionJson
+
+A 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
+
+## 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
+
+## 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.
+
+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.
+
+But it is reasonably different to being used to having the primary unit of data
+being a singular model.
+
+```ruby
+  SingularActiveRecordObject.all
+
+  #versus:
+  PluralJsonCollection.new collection_of_objects
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/collection_json.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/collection_json/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Burns"]
+  gem.email         = ["markthedeveloper@gmail.com"]
+  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.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
+end

data/lib/collection_json/crud_operations.rb

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

data/lib/collection_json/query.rb

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

data/lib/collection_json/version.rb

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

data/lib/collection_json.rb

@@ -0,0 +1,84 @@
+require 'json'
+require 'active_support/core_ext/string'
+require 'collection_json/version'
+
+#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.
+# 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
+
+  #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
+
+  #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
+
+  def error
+    @error
+  end
+end

data/spec/lib/collection_json_spec.rb

@@ -0,0 +1,97 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+Dir['./lib/**/*.rb'].each {|r| require r}
+
+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

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: collection_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-25 00:00:00.000000000 Z
+dependencies: []
+description: Help create Collection+JSON hypermedia APIs
+email:
+- markthedeveloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- collection_json.gemspec
+- 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
+- spec/spec_helper.rb
+homepage: https://github.com/markburns/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: 
+rubygems_version: 1.8.15
+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/spec_helper.rb