msgpack-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nathan Benes
+
+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.markdown

@@ -0,0 +1,71 @@
+# MsgpackRails
+
+Uses the fast and compact [msgpack](https://github.com/msgpack/msgpack 'MessagePack') binary format to let you serialize objects.
+
+##  Installation
+
+In your Gemfile include the following line:
+
+    gem 'msgpack-rails', :git => 'git://github.com/nzifnab/msgpack-rails.git'
+
+## Usage
+
+To encode objects use [msgpack's](https://github.com/msgpack/msgpack 'MessagePack') `to_msgpack` method:
+
+    @person = Person.new(:first_name => 'bob', :last_name => 'joe')
+    @person.to_msgpack
+
+In your controller's render action (to be consumed as an API like ActiveResource):
+
+    respond_to do |format|
+        format.mpac { render :text => @person.to_msgpack, :content_type => 'application/x-mpac' }
+    end
+
+Additionally you can set up ActiveResource to accept :mpac content types:
+
+    class Animal < ActiveResource::Base
+      self.format = :mpac
+    end
+
+    # Meanwhile, across the desert...
+
+    Animal.find(1)   # =>  Expects the content to be in the msgpack format
+
+## Gotchas
+
+1. Serialization options hash
+
+    It is currently more limiting than `to_json` or `to_xml` in that the 'options' hash does not (yet) work.  If you want the equivalent of this from json:
+
+        @person.to_json(:include => [:group], :methods => [:monkey_see])
+
+    Then you have to generate it as a hash manually:
+
+        @person.serializable_hash(:include => [:group], :methods => [:monkey_see]).to_msgpack
+
+    I plan on finding a way to get this working as the other two format methods do, but for now this work-around should be fine.
+
+2. Date formats
+
+    The msgpack gem (written in C) does not natively serialize date formats.  Instead, I convert the dates to a string and send them that way.
+This is bad, because they are seen by the ActiveResource endpoint as a string and are not converted to a date.  You need to keep this in mind and may have to
+use `to_datetime` on dates in those models.
+
+## TODO
+
+1) Fix the two gotchas mentioned above
+
+2) Better render support in the controller (something like `render :mpac => @person.to_msgpack` without the `:content_type` requirement)
+
+3) Better support and testing for rails 2.3 (maybe, but low priority)
+
+## Contributing
+
+If you use or are interested in the msgpack gem (even by itself) and want to or already do use it in Rails (with or without this msgpack-rails gem) I would
+love to hear about your experiences!  What did you do to get it to work for you?
+
+If you have suggestions, ideas, or have taken a look at this gem's code and want to help improve it (fixing bugs, adding additional features, etc) then that's great!
+Fork the project, make a 'feature branch' with your suggested changes (preferably one major 'feature' per branch/pull request), and then do a pull request from that
+branch.  Feel free to discuss with me ideas etc in the issues tracker here on github.
+
+This project is licensed under the MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MsgpackRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/msgpack-rails.rb

@@ -0,0 +1,11 @@
+require 'msgpack'
+require "msgpack_rails/core_ext"
+require 'msgpack_rails/mime_type'
+if Rails::VERSION::MAJOR == 2
+  require 'msgpack_rails/2-3/msgpack-rails'
+else
+  require 'msgpack_rails/3/msgpack-rails'
+end
+
+module MsgpackRails
+end

data/lib/msgpack_rails/2-3/msgpack-rails.rb

@@ -0,0 +1,5 @@
+# For legacy purposes I've added support for rails 2.3.x object serialization.
+# Don't expect too many updates to this support, going forward all updates will be for
+# newer versions of rails.
+
+require 'msgpack_rails/2-3/msgpack_serializer'

data/lib/msgpack_rails/2-3/msgpack_serializer.rb

@@ -0,0 +1,16 @@
+module ActiveRecord
+  module Serialization
+    def to_msgpack(options = {})
+      options = {:out => options} if options.is_a?(String)
+      options[:out] ||= ''
+
+      options[:out] << MsgpackSerializer.new(self).to_s
+    end
+
+    class MsgpackSerializer < ActiveRecord::Serialization::Serializer
+      def serialize
+        MessagePack.pack(serializable_record)
+      end
+    end
+  end
+end

data/lib/msgpack_rails/3/activeresource_formats/msgpack_format.rb

@@ -0,0 +1,25 @@
+module ActiveResource
+  module Formats
+    module MsgpackFormat
+      extend self
+
+      def extension
+        "mpac"
+      end
+
+      def mime_type
+        Mime::MPAC.to_s
+      end
+
+      # Options hash currently serves no function.
+      # TODO:  Fix it, duh.  Just like the Serializer's issue
+      def encode(hash, options = nil)
+        hash.to_msgpack
+      end
+
+      def decode(mpac)
+        MessagePack.unpack(mpac)
+      end
+    end
+  end
+end

data/lib/msgpack_rails/3/activeresource_formats.rb

@@ -0,0 +1,5 @@
+module ActiveResource
+  module Formats
+    autoload :MsgpackFormat, 'msgpack_rails/3/activeresource_formats/msgpack_format'
+  end
+end

data/lib/msgpack_rails/3/msgpack-rails.rb

@@ -0,0 +1,2 @@
+require "msgpack_rails/3/msgpack_serializer"
+require 'msgpack_rails/3/activeresource_formats'

data/lib/msgpack_rails/3/msgpack_serializer.rb

@@ -0,0 +1,23 @@
+module ActiveModel
+  module Serializers
+    module Msgpack
+      def to_msgpack(options = {})
+        options = {:out => options} if options.is_a?(String)
+        options[:out] ||= ''
+
+        options[:out] << serializable_hash(options).to_msgpack
+      end
+
+      # TODO:  Test and uncomment this method
+      #def from_msgpack(msg)
+      #  MessagePack.unpack(msg)
+      #end
+    end
+  end
+end
+
+module ActiveRecord
+  module Serialization
+    include ActiveModel::Serializers::Msgpack
+  end
+end

data/lib/msgpack_rails/core_ext.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+Time.class_eval do
+  def to_msgpack(out='')
+    self.to_s.to_msgpack(out)
+  end
+end
+
+DateTime.class_eval do
+  def to_msgpack(out='')
+    self.to_s.to_msgpack(out)
+  end
+end
+
+Date.class_eval do
+  def to_msgpack(out='')
+    self.to_s.to_msgpack(out)
+  end
+end

data/lib/msgpack_rails/mime_type.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/x-mpac", :mpac

data/lib/msgpack_rails/version.rb

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

data/lib/tasks/msgpack-rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :msgpack-rails do
+#   # Task goes here
+# end

data/test/core_ext_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class TimeExtTest < Test::Unit::TestCase
+  def test_to_msgpack_renders_as_string
+    str = File.open(File.join(File.dirname(__FILE__), "msgpack_assertion_files", "time.mpac")).read
+    assert_equal str, "January 4, 2011 2:34:17 PM".to_time.utc.to_msgpack
+  end
+end
+
+class DateTimeExtTest < Test::Unit::TestCase
+  def test_to_msgpack_renders_as_string
+    str = File.open(File.join(File.dirname(__FILE__), "msgpack_assertion_files", "datetime.mpac")).read
+    assert_equal str, "February 3 2010 4:15:09 AM".to_datetime.utc.to_msgpack
+  end
+end
+
+class DateExtTest < Test::Unit::TestCase
+  def test_to_msgpack_renders_as_string
+    str = File.open(File.join(File.dirname(__FILE__), "msgpack_assertion_files", "date.mpac")).read
+    assert_equal str, "March 23 2011".to_date.to_msgpack
+  end
+end

data/test/dummy/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.com/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/endpoint/person.rb

@@ -0,0 +1,3 @@
+class Endpoint::Person < ActiveResource::Base
+  self.site = "http://www.example.com"
+end

data/test/dummy/app/models/group.rb

@@ -0,0 +1,3 @@
+class Group < ActiveRecord::Base
+  has_many :people
+end

data/test/dummy/app/models/person.rb

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  belongs_to :group
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    config.action_view.javascript_expansions[:defaults] = %w()
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!