cerealizer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    cerealizer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cerealizer!
+  rspec (>= 2.9.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brad Gessler
+
+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,87 @@
+# Cerealizer
+
+Serialize and deserialize data between models and JSON.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cerealizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cerealizer
+
+## Usage
+
+Want to write a HATOAS API without a bunch of stuff between your model and the serializer? Consider the following code:
+
+```ruby
+class FruitSerializer < Cerealizer::Base
+  key :owner_href
+  hey :href
+  key :color
+  key :private_tasting_note
+
+  def href
+    "/fruits/#{object.id}"
+  end
+
+  def href=(href)
+    _, object.id = href.split('/')
+  end
+
+  def owner_href
+    "/users/#{object.owner_id}"
+  end
+
+  def owner_href=(href)
+    _, object.owner_id = href.split('/')
+  end
+
+  # Only the owner of the Fruit can change the owner key or the admin.
+  def has_writeable_owner_href?
+    object.id == scope.id or scope.is_admin?
+  end
+
+  # Only the owner of the fruit can read the private tasting note.
+  def has_readable_private_tasting_note?
+    object.id == scope.id
+  end
+end
+```
+
+Now lets use it in some app code! Lets generate some hashes that our app can convert into JSON:
+
+```ruby
+user = User.new(:id => 3)
+owner = User.new(:id => 12)
+fruit = Fruit.new(:owner_id => 12, id: => 8, color: => 'Orange')
+
+FruitSerializer.new(fruit, user).to_hash
+# => { :owner_href => '/users/12', href: => '/fruits/8', color: => 'Orange' }
+
+FruitSerializer.new(fruit, owner).to_hash
+# => { :owner_href => '/users/12', href: => '/fruits/8', color: => 'Orange', :private_tasting_note => nil }
+```
+
+Meh, its OK. Lots of libraries already do this with minimal hacking. That's not why we wrote this lib; what we need is something that can deal with *writing* attributes back into the model.
+
+```ruby
+FruitSerializer.new(fruit, user).write_keys(:owner_href => '/users/9000')
+# => BOOM! Raise a Key::UnauthorizedWrite exception
+```
+
+Now we can implement authorization logic at a key level for our resources. Nifty!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cerealizer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cerealizer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cerealizer"
+  gem.version       = Cerealizer::VERSION
+  gem.authors       = ["Brad Gessler"]
+  gem.email         = ["brad@polleverywhere.com"]
+  gem.description   = %q{Serialize and deserialize classes and JSON.}
+  gem.summary       = %q{Dive into the nitty gritty details of serializing and deserializing between objects and a hash.}
+  gem.homepage      = "http://github.com/polleverywhere/cerealizer"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '>= 2.9.0'
+end

data/lib/cerealizer/version.rb

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

data/lib/cerealizer.rb

@@ -0,0 +1,78 @@
+require "cerealizer/version"
+
+module Cerealizer
+  # Encapsulates information about keys.
+  class Key
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+  end
+
+  # Configure a serialize keys and deal with marshaling to and from JSON.
+  class Base
+    attr_reader :object, :scope
+
+    def initialize(object, scope)
+      @object, @scope = object, scope
+      self
+    end
+
+    def self.key(key)
+      keys.push Key.new(key)
+    end
+
+    def self.keys
+      @keys ||= []
+    end
+
+    # Call methods on the object that's being presented and create a flat 
+    # hash for these mofos.
+    def serializable_hash
+      self.class.keys.inject Hash.new do |hash, key|
+        hash[key.name] = proxy_reader(key.name) if readable?(key.name)
+        hash
+      end
+    end
+
+    # Update the attrs on zie model.
+    def update_attributes(attrs={})
+      attrs.each { |key, value| proxy_writer(key, value) if writeable?(key.name) }
+      self
+    end
+
+  private
+    # TODO - Should the default be writable?
+    def writeable?(key)
+      meth = "has_writable_#{key}?"
+      self.respond_to?(meth) ? self.send(meth) : true
+    end
+
+    # TODO - Should the default be writable?
+    def readable?(key)
+      meth = "has_readable_#{key}?"
+      self.respond_to?(meth) ? self.send(meth) : true
+    end
+
+    # Look for methods locally that we want to use to proxy data between
+    # the object and its JSON format.
+    def proxy_reader(key)
+      if self.respond_to? key
+        self.send(key)
+      else
+        object.send(key)
+      end
+    end
+
+    # Proxy the writer to zie object.
+    def proxy_writer(key, *args)
+      meth = "#{key}="
+      if self.respond_to? meth
+        self.send(meth, *args)
+      else
+        object.send(meth, *args)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: cerealizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Serialize and deserialize classes and JSON.
+email:
+- brad@polleverywhere.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- cerealizer.gemspec
+- lib/cerealizer.rb
+- lib/cerealizer/version.rb
+homepage: http://github.com/polleverywhere/cerealizer
+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.23
+signing_key: 
+specification_version: 3
+summary: Dive into the nitty gritty details of serializing and deserializing between
+  objects and a hash.
+test_files: []
+has_rdoc: