flatpack_core 1.0.pre

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,17 @@
+# FlatpackCore
+
+FlatpackCore provides serialization / de-serialization support to FlatPack client libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flatpack_core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flatpack_core

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+
+desc "Run tests"
+task :test do
+  puts `bundle exec rspec spec`
+end

data/flatpack_core.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flatpack/core/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joe Stelmach"]
+  gem.email         = ["joe@getperka.com"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "flatpack_core"
+  gem.require_paths = ["lib"]
+  gem.version       = Flatpack::Core::VERSION
+  gem.add_dependency('json', '~> 1.7')
+  gem.add_dependency('uuidtools', '~> 2.1')
+  gem.add_dependency('i18n', '~> 0.6')
+  gem.add_dependency('activesupport', "~> 3.0")
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/lib/flatpack/core/base_has_uuid.rb

@@ -0,0 +1,57 @@
+require 'uuidtools'
+
+module Flatpack
+  module Core
+    class BaseHasUuid
+      include MapInitialize
+      
+      PROPERTY_NAMES = [:uuid]
+        
+      attr_accessor *PROPERTY_NAMES
+      
+      # returns this entity's assigned uuid. If no uuid has been assigned,
+      # a new uuid will be generated and assigned before returning.
+      def uuid 
+        @uuid = @uuid || UUIDTools::UUID.random_create
+      end
+      
+      # returns an array of all flatpack property names for this entity
+      def property_names
+        names = []
+        klass=self.class
+        while (klass)
+          names += klass::PROPERTY_NAMES if defined? klass::PROPERTY_NAMES
+          klass = klass.superclass
+        end
+        names
+      end
+      
+      # returns a hash of all flatpack property names => non-nil values for this entity
+      def properties
+        map = {}
+        property_names.each do |name|
+          value = self.send(name)
+          map[name] = value unless value == nil
+        end
+        map
+      end
+      
+      # returns the flatpack entity name for this entity
+      def entity_name
+        name = self.class.name.gsub(/^.*::/,'')
+        name[0,1].downcase + name[1..-1]
+      end
+      
+      def class_for_property(property)
+        klass=self.class
+        result = nil
+        while (klass and !result)
+          result = klass::TYPE_MAP[property.to_sym] if defined? klass::TYPE_MAP
+          klass = klass.superclass
+        end
+        result
+      end
+      
+    end
+  end
+end

data/lib/flatpack/core/flatpack.rb

@@ -0,0 +1,16 @@
+module Flatpack
+  module Core
+    class Flatpack
+      
+      include MapInitialize
+      
+      attr_reader :packer, :unpacker, :configuration
+      
+      def initialize(map={})
+        set_properties(map)
+        @packer = Packer.new(map)
+        @unpacker = Unpacker.new(map)
+      end
+    end
+  end
+end

data/lib/flatpack/core/map_initialize.rb

@@ -0,0 +1,22 @@
+module Flatpack
+  module Core
+    
+    module MapInitialize
+      
+      def initialize(map={})
+        set_properties(map)
+      end
+      
+      def set_properties(map)
+        map.each do |key, value|
+          method_key = "#{key}="
+          if(self.respond_to?(method_key))
+            self.send(method_key, value)
+          end
+        end
+        self
+      end
+      
+    end
+  end
+end

data/lib/flatpack/core/packer.rb

@@ -0,0 +1,104 @@
+require 'active_support/inflector'
+require 'json'
+
+module Flatpack
+  module Core
+    class Packer
+      
+      include MapInitialize
+      
+      attr_accessor :verbose, :pretty
+      
+      # Generate a FlatPack JSON string from the given entity
+      def pack(entity)
+        return {} unless entity
+          
+        @uuid_stack = []
+        @all_entities = {}
+        @data = {}
+          
+        recursive_pack(entity)
+        
+        json = {
+          :data => @data,
+          :value => entity.uuid
+        }
+        json = @pretty ? JSON.pretty_generate(json) : json.to_json
+        
+        if(@verbose)
+          puts "*** Serializing #{entity.entity_name} to FlatPack ***"
+          puts json
+        end
+        
+        json
+      end
+      
+      private
+      
+      def recursive_pack(entity)
+        # we only proceed if the entity has a uuid property, 
+        # and we haven't seen it before
+        uuid = entity.uuid
+        return if !entity.respond_to?(:uuid) or @all_entities.keys.include?(uuid)
+        
+        @all_entities[uuid] = entity
+        parent_uuid = @uuid_stack.length > 0 ? @uuid_stack.last : nil
+        @uuid_stack.push(uuid)
+        
+        # walk through our properties
+        json = entity.properties
+        json.keys.each do |name|
+          camelName = name.to_s().camelcase(:lower)
+          value = json[name]
+          uuid_name = "#{camelName}Uuid"
+          
+          # The name we're working with will be replaced with a 
+          # properly cased name or uuid reference
+          json.delete(name)
+          
+          # property is another entity
+          if(value.respond_to?(:uuid))
+            recursive_pack(value)
+            json[uuid_name] = value.uuid
+          
+          # property is a collection of (potentially) other entities
+          elsif(value.is_a?(Array))
+            
+            # we'll recurse down to each referenced value
+            value.each do |referenced_value|
+              recursive_pack(referenced_value)
+              referenced_value.uuid
+            end
+            
+            # and add our uuid reference
+            json[uuid_name] = value.map {|v| v.uuid}
+            
+          # property is a plain old property
+          else
+            # TODO how to handle local..At dates?  
+            # Pass a timezone into the pack function as an option?
+            
+            json[camelName] = value
+          end
+        end
+        
+        # add our parent uuid reference if neccessary
+        if parent_uuid
+          parent = @all_entities[parent_uuid]
+          json["#{parent.entity_name}Uuid"] = parent_uuid
+        end
+        
+        # add the resulting json to the correct bucket in our data hash
+        bucket = @data[entity.entity_name]
+        if(!bucket)
+          bucket = []
+          @data[entity.entity_name] = bucket
+        end
+        bucket.push(json)
+        
+        @uuid_stack.pop
+      end
+      
+    end
+  end
+end

data/lib/flatpack/core/unpacker.rb

@@ -0,0 +1,141 @@
+require 'active_support/inflector'
+
+module Flatpack
+  module Core
+    class Unpacker
+      
+      include MapInitialize
+      
+      attr_accessor :verbose, :entity_module
+
+      # Returns a Reified FlatPack entity from the given JSON data
+      def unpack(json_map)
+        @all_entities = {}
+        
+        if(@verbose)
+          puts "** Deserializing entity from FlatPack **"
+          puts JSON.pretty_generate(json_map)
+        end
+        
+        # Make a first pass through the data to ensure stub entities exist
+        uuid_to_data = {}
+        (json_map['data'] || []).each do |entity_name, entities|
+          if(entities.is_a?(Array))
+            entities.each do |entity_data|
+              uuid = entity_data['uuid']
+              if(allocate_or_get_entity(entity_name, uuid))
+                uuid_to_data[uuid] = entity_data
+              end
+            end
+          end
+        end
+        
+        # Then ingest
+        uuid_to_data.each { |uuid, data| ingest_item(uuid, data) }
+          
+        # Return the unpacked entities corresponding to those in the value section
+        value = json_map['value']
+        value.is_a?(Array) ? value.map{|v| @all_entities[v]} : @all_entities[value]
+      end
+      
+      private
+      
+      # ingests the given data into the entity associated with the given uuid
+      def ingest_item(uuid, data)
+        entity = @all_entities[uuid]
+        collection_key = entity.entity_name.underscore.pluralize
+        reified_properties = {}
+          
+        data.each do |key, value|
+            
+          # fooBarsUuid -> foo_bars
+          key = key.underscore
+          
+          # If the key name ends in _date or _at, we assume this is a date property
+          if(key.end_with?('_date') or key.end_with?('_at'))
+            reified_properties[key] = Time.parse(value).utc
+          end
+          
+          # The value is referencing another entity or collection of entities
+          if(key.end_with?('uuid'))
+            
+            # foo_bar_uuid -> foo_bar
+            key = key[0..-6]
+            
+            if(value.is_a?(Array))
+              reified_properties[key] = value.map { |uuid| @all_entities[uuid] }
+                
+            else
+              referent = @all_entities[value]
+             
+              # If the referent doesn't exist, it's because the server has sent us a sparse
+              # payload with a dangling fooUuid reference.  We'll attempt to unpack this 
+              # reference using the type informtion encoded within each entity description
+              unless referent
+                referent_class = entity.class_for_property(key)
+                referent = referent_class.new(:uuid => value) if referent_class
+              end
+             
+              # If a referent was not included in the payload, and no type information exists
+              # for this property name, we simply drop the property
+              next unless referent
+              
+              reified_properties[key] = referent
+             
+              # Find or create a collection in the referent to establish a bidirectional mapping.
+              # For example a foo.bar property should contain a bar.foos collection.
+              if(referent.respond_to?(collection_key))
+                collection = referent.send(collection_key)
+                unless collection
+                  collection = []
+                  collection_setter = "#{collection_key}="
+                  if(referent.respond_to?(collection_setter))
+                    referent.send(collection_setter, collection)
+                  end
+                end
+                collection.push(entity)
+              end
+            end
+            
+          # The value is just a plain old property
+          else
+            reified_properties[key] = value
+          end
+        end
+        
+        entity.set_properties(reified_properties)
+      end
+      
+      # Finds the existing entity associated with the given uuid in the local
+      # entity store, or stores and returns a new one
+      def allocate_or_get_entity(entity_name, uuid)
+        entity = @all_entities[uuid]
+        return entity if entity
+        
+        klass = entity_class_for_name(entity_name)
+        if(klass != nil)
+          @all_entities[uuid] = klass.new({:uuid => uuid})
+        end
+        klass
+      end
+      
+      # Finds the Ruby class associated with the given entity name
+      def entity_class_for_name(name)
+        class_name = "#{name[0,1].capitalize}#{name[1..-1]}"
+        if @entity_module
+          class_name = "#{@entity_module}::#{class_name}"
+        end
+
+        result = nil
+        begin
+          result = class_name.constantize
+
+        rescue NameError
+          puts "could not create class for name #{class_name}"
+        end
+
+        result 
+      end
+    end
+  end
+end

data/lib/flatpack/core/version.rb

@@ -0,0 +1,5 @@
+module Flatpack
+  module Core
+    VERSION = "1.0.pre"
+  end
+end

data/lib/flatpack_core.rb

@@ -0,0 +1,5 @@
+require "flatpack/core/map_initialize"
+require "flatpack/core/base_has_uuid"
+require "flatpack/core/flatpack"
+require "flatpack/core/packer"
+require "flatpack/core/unpacker"

data/spec/core_spec.rb

@@ -0,0 +1,195 @@
+require 'flatpack_core'
+
+class TestEntity < Flatpack::Core::BaseHasUuid
+  PROPERTY_NAMES = [
+    :one,
+    :two,
+    :test_sub_entities,
+    :test_entities,
+    :test_entity
+  ]
+  attr_accessor *PROPERTY_NAMES
+end
+
+class TestSubEntity < TestEntity
+  PROPERTY_NAMES = [
+    :three
+  ]
+  attr_accessor *PROPERTY_NAMES
+end
+
+describe Flatpack::Core do
+  
+  before(:all) do
+    @flatpack = Flatpack::Core::Flatpack.new({
+      :pretty => true, 
+      :verbose => true 
+    })
+  end
+  
+  it "serializes a simple entity" do
+      
+    root = TestEntity.new({
+      :one => 'first',
+      :two => 'second'
+    })
+    
+    json = @flatpack.packer.pack(root)
+    
+    map = JSON.parse(json)
+    map['data'].keys.length.should eq(1)
+    entities = map['data']['testEntity']
+    entities.length.should eq(1)
+    entity = entities[0]
+    
+    entity.keys.length.should eq(3)
+    entity['one'].should eq('first')
+    entity['two'].should eq('second')
+    entity['uuid'].should be_true
+  end
+  
+  it "serializes an entity with forward references" do
+      
+    root = TestEntity.new({
+      :one => 'first',
+      :two => [
+        TestSubEntity.new({:one => 'first', :three => 'third'}), 
+        TestSubEntity.new({:one => 'first', :three => 'third'})
+      ]
+    })
+    
+    json = @flatpack.packer.pack(root)
+    
+    map = JSON.parse(json)
+    
+    map['data'].keys.length.should eq(2)
+      
+    # we should have 1 TestEntity at our root
+    root_entities = map['data']['testEntity']
+    root_entities.length.should eq(1)
+    root_entity = root_entities[0]
+    root_entity['one'].should eq('first')
+    
+    # our collection reference at :two should have been flattened away
+    root_entity['two'].should be_nil
+    root_entity_uuid = root_entity['uuid']
+    
+    # two TestSubEntities under our root
+    sub_entities = map['data']['testSubEntity']
+    sub_entities.length.should eq(2)
+    sub_entity_one = sub_entities[0]
+    sub_entity_two = sub_entities[1]
+    
+    # sub entities should have a reference to the parent
+    sub_entity_one['testEntityUuid'].should eq(root_entity_uuid)
+    sub_entity_two['testEntityUuid'].should eq(root_entity_uuid)
+      
+    # and 3 additional properties
+    sub_entity_one.length.should eq(4)
+    sub_entity_one['one'].should eq('first')
+    sub_entity_one['three'].should eq('third')
+    sub_entity_one['two'].should be_nil
+    
+    sub_entity_two.length.should eq(4)
+    sub_entity_two['one'].should eq('first')
+    sub_entity_two['three'].should eq('third')
+    sub_entity_two['two'].should be_nil
+  end
+  
+  it "serializes an entity with back reference" do
+    
+    sibling_one = TestEntity.new({
+      :one => 'first_sibling'
+    })
+    
+    sibling_two = TestEntity.new({
+      :one => 'second_sibling',
+      :two => sibling_one
+    })
+    
+    json = @flatpack.packer.pack(sibling_two)
+    
+    map = JSON.parse(json)
+    
+    map['data'].keys.length.should eq(1)
+    entities = map['data']['testEntity']
+    entities.each do |e|
+      if(e['uuid'].eql?(sibling_one.uuid.to_s)) 
+        e['testEntityUuid'].should eq(sibling_two.uuid.to_s)
+      else
+        e['testEntityUuid'].should be_nil
+      end
+    end
+      
+  end
+  
+  it "de-serializes a simple entity" do
+    
+    json = '{'\
+      '"value": "b2197fc8-42df-4d8c-9890-0f37a4f99fc7",'\
+      '"data": {'\
+        '"unknownEntity": [{"uuid":"b2197fc8-42df-4d8c-9890-0f37a4f998ae"}],'\
+        '"testEntity": ['\
+          '{'\
+            '"one": "first",'\
+            '"two": "second",'\
+            '"uuid": "b2197fc8-42df-4d8c-9890-0f37a4f99fc7"'\
+          '}'\
+       ']'\
+      '}'\
+    '}'
+    
+    # the unpacking should succeed even when an unknown
+    # entity type (unknownEntity) is present
+    entity = @flatpack.unpacker.unpack(JSON.parse(json))
+    
+    entity.one.should eq('first')
+    entity.two.should eq('second')
+    entity.uuid.should eq('b2197fc8-42df-4d8c-9890-0f37a4f99fc7')
+    
+  end
+  
+  it "de-serializes an entity with a collection reference" do
+    json = '{'\
+      '"value": "d1c958ba-e6ea-4b12-8335-347289e404ac",'\
+      '"data": {'\
+        '"testEntity": ['\
+          '{'\
+            '"uuid": "d1c958ba-e6ea-4b12-8335-347289e404ac",'\
+            '"one": "first"'\
+          '}'\
+        '],'\
+        '"testSubEntity": ['\
+          '{'\
+            '"three": "third",'\
+            '"uuid": "ae90cb47-5638-4529-9223-049ec89b6162",'\
+            '"testEntityUuid": "d1c958ba-e6ea-4b12-8335-347289e404ac",'\
+            '"one": "first"'\
+          '},'\
+          '{'\
+            '"three": "third",'\
+            '"uuid": "4f00da0c-6427-4d87-b691-bedad45329d7",'\
+            '"testEntityUuid": "d1c958ba-e6ea-4b12-8335-347289e404ac",'\
+            '"one": "first"'\
+          '}'\
+        ']'\
+      '}'\
+    '}'\
+    
+    entity = @flatpack.unpacker.unpack(JSON.parse(json))
+    
+    entity.uuid.should eq('d1c958ba-e6ea-4b12-8335-347289e404ac')
+    entity.one.should eq('first')
+    
+    # entity should have both sub entities within the test_entities property
+    entity.test_sub_entities.length.should eq(2)
+    entity.test_sub_entities[0].three.should eq('third')
+    entity.test_sub_entities[0].one.should eq('first')
+    entity.test_sub_entities[1].three.should eq('third')
+    entity.test_sub_entities[1].one.should eq('first')
+    
+    entity.test_sub_entities[0].test_entity.uuid.should eq('d1c958ba-e6ea-4b12-8335-347289e404ac')
+    
+  end
+  
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: flatpack_core
+version: !ruby/object:Gem::Version 
+  hash: 737972668
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - pre
+  version: 1.0.pre
+platform: ruby
+authors: 
+- Joe Stelmach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-27 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id005
+description: Write a gem description
+email: 
+- joe@getperka.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flatpack_core.gemspec
+- lib/flatpack/core/base_has_uuid.rb
+- lib/flatpack/core/flatpack.rb
+- lib/flatpack/core/map_initialize.rb
+- lib/flatpack/core/packer.rb
+- lib/flatpack/core/unpacker.rb
+- lib/flatpack/core/version.rb
+- lib/flatpack_core.rb
+- spec/core_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files: 
+- spec/core_spec.rb