hypermodel 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,63 @@
+# hypermodel [![Build Status](https://secure.travis-ci.org/codegram/hypermodel.png)](http://travis-ci.org/codegram/hypermodel) [![Dependency Status](https://gemnasium.com/codegram/hypermodel.png)](http://gemnasium.com/codegram/hypermodel)
+
+A Rails Responder that renders any [Mongoid][mongoid] model to a [JSON HAL
+format][hal], suitable for Hypermedia APIs.
+
+## Install
+
+Put this in your Gemfile:
+
+    gem 'hypermodel'
+
+## Usage
+
+````ruby
+class PostsController < ApplicationController
+  respond_to :json
+
+  def show
+    @post = Post.find params[:id]
+    respond_with(@post, responder: Hypermodel::Responder)
+  end
+end
+````
+
+Now if you ask your API for a Post:
+
+    {"_id"=>"4fb648996b98c90919000012",
+     "title"=>"My post",
+     "body"=>"Foo bar baz.",
+     "author_id"=>"4fb648996b98c9091900000f",
+     "updated_at"=>"2012-05-18T13:03:21Z",
+     "created_at"=>"2012-05-18T13:03:21Z",
+     "_links"=>
+      {"self"=>{"href"=>"http://test.host/posts/4fb648996b98c90919000012"},
+       "author"=>{"href"=>"http://test.host/authors/4fb648996b98c9091900000f"},
+       "reviews"=>
+        {"href"=>"http://test.host/posts/4fb648996b98c90919000012/reviews"}},
+     "_embedded"=>
+      {"comments"=>
+        [{"_id"=>"4fb648996b98c9091900000d", "body"=>"Comment 1"},
+         {"_id"=>"4fb648996b98c9091900000e", "body"=>"Comment 2"}]}}
+
+## Contributing
+
+* [List of hypermodel contributors][contributors]
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it. This is important so we don't break it in a future
+  version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  If you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+## License
+
+MIT License. Copyright 2012 [Codegram Technologies][codegram]
+
+[mongoid]: http://mongoid.org
+[hal]: http://stateless.co/hal_specification.html
+[contributors]: https://github.com/codegram/hypermodel/contributors
+[codegram]: http://codegram.com

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'Hypermodel'
+  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/hypermodel/responder.rb

@@ -0,0 +1,29 @@
+require 'hypermodel/serializers/mongoid'
+
+module Hypermodel
+  Serializer = Serializers::Mongoid
+
+  class Responder
+    def self.call(*args)
+      controller    = args[0]
+      resource      = args[1].first
+      resource_name = controller.params["controller"]
+      action        = controller.params["action"]
+
+      responder = new resource_name, action, resource, controller
+
+      controller.render json: responder
+    end
+
+    def initialize(resource_name, action, resource, controller)
+      @resource_name = resource_name
+      @action        = action
+      @resource      = Serializer.new(resource, controller)
+    end
+
+    def to_json(*opts)
+      @resource.to_json(*opts)
+    end
+  end
+end
+

data/lib/hypermodel/serializers/mongoid.rb

@@ -0,0 +1,76 @@
+module Hypermodel
+  module Serializers
+    class Mongoid
+      def initialize(resource, controller)
+        @resource   = resource
+        @attributes = resource.attributes.dup
+        @controller = controller
+      end
+
+      def to_json(*opts)
+        attrs = @attributes.update(links).update(embedded)
+        attrs.to_json(*opts)
+      end
+
+      def links
+        hash = { self: { href: @controller.polymorphic_url(@resource) } }
+
+        referenced_relations.each do |name, metadata|
+          related = @resource.send(name)
+          relation = metadata.relation
+
+          if relation == ::Mongoid::Relations::Referenced::In
+            unless related.nil? || (related.respond_to?(:empty?) && related.empty?)
+              hash.update(name => { href: @controller.polymorphic_url(related) })
+            end
+          elsif relation == ::Mongoid::Relations::Referenced::Many
+            hash.update(name => { href: @controller.polymorphic_url([@resource, name]) })
+          else
+            raise "Referenced relation type not implemented: #{relation}"
+          end
+
+        end
+
+        { _links: hash }
+      end
+
+      def embedded
+        return {} if embedded_relations.empty?
+
+        embedded_relations.inject({ _embedded: {} }) do |acc, (name, metadata)|
+          if attributes = extract_embedded_attributes(name, metadata)
+            @attributes.delete(name)
+            acc[:_embedded][name] = attributes
+          end
+          acc
+        end
+      end
+
+      private
+
+      def extract_embedded_attributes(name, metadata)
+        relation = metadata.relation
+
+        if relation == ::Mongoid::Relations::Embedded::Many
+          @resource.send(name).map { |embedded| embedded.attributes }
+        elsif relation == ::Mongoid::Relations::Embedded::One
+          (embedded = resource.send(name)) ? embedded.attributes : nil
+        else
+          raise "Embedded relation type not implemented: #{relation}"
+        end
+      end
+
+      def embedded_relations
+        @embedded_relations ||= @resource.relations.select do |_, metadata|
+          metadata.relation.name =~ /Embedded/
+        end
+      end
+
+      def referenced_relations
+        @referenced_relations ||= @resource.relations.select do  |_, metadata|
+          metadata.relation.name =~ /Referenced/
+        end
+      end
+    end
+  end
+end

data/lib/hypermodel/version.rb

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

data/lib/hypermodel.rb

@@ -0,0 +1,5 @@
+module Hypermodel
+end
+
+require 'hypermodel/responder'
+

data/lib/tasks/hypermodel_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== 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.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.org/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
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+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. 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 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

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

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

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

@@ -0,0 +1,8 @@
+class PostsController < ApplicationController
+  respond_to :json
+
+  def show
+    @post = Post.find params[:id]
+    respond_with(@post, responder: Hypermodel::Responder)
+  end
+end

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

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

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

@@ -0,0 +1,8 @@
+class Author
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name, type: String
+
+  has_many :posts
+end

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

@@ -0,0 +1,8 @@
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :body, type: String
+
+  embedded_in :post
+end

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

@@ -0,0 +1,11 @@
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :title, type: String
+  field :body, type: String
+
+  belongs_to :author
+  has_many :reviews
+  embeds_many :comments
+end

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

@@ -0,0 +1,8 @@
+class Review
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :body, type: String
+
+  belongs_to :post
+end

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

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