roar 0.0.1.alpha1 → 0.8.0

data/lib/roar/representer/json.rb

@@ -0,0 +1,32 @@
+require 'roar/representer'
+require 'representable/json'
+
+
+module Roar
+  module Representer
+    class JSON < Base
+      include Representable::JSON
+      
+      def serialize
+        to_json
+      end
+      
+      def self.deserialize(json)
+        from_json(json)
+      end
+      
+      # Encapsulates a hypermedia link.
+      class Hyperlink < self
+        self.representation_name = :link
+        
+        property :rel
+        property :href
+      end
+      
+      def self.links_definition_options
+        {:as => [Hyperlink]}
+      end
+    end
+    
+  end
+end

data/lib/roar/representer/xml.rb

@@ -0,0 +1,43 @@
+require 'roar/representer'
+require 'representable/xml'
+
+
+module Roar
+  # Basic work-flow
+  # in:   * representer parses representation
+  #       * recognized elements are stored as representer attributes
+  # out:  * attributes in representer are assigned - either as hash in #to_xml, by calling #serialize(represented),
+  #         by calling representer's accessors (eg in client?) or whatever else
+  #       * representation is compiled from representer only
+  # TODO: make XML a module to include in Hyperlink < Base.
+  module Representer
+    class XML < Base
+      include Representable::XML
+      
+      def serialize
+        to_xml.serialize
+      end
+      
+      def self.deserialize(xml)
+        from_xml(xml)
+      end
+      
+      
+      # Encapsulates a hypermedia <link ...>.
+      class Hyperlink < self
+        self.representation_name = :link
+        
+        property :rel,  :from => "@rel"
+        property :href, :from => "@href"
+      end
+      
+      
+      def self.links_definition_options
+        {:tag => :link, :as => [Hyperlink]}
+      end
+      
+      require 'roar/representer/feature/hypermedia'
+      include Feature::Hypermedia
+    end
+  end
+end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.0.1.alpha1"
+  VERSION = "0.8.0"
 end

data/roar.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["apotonick@gmail.com"]
   s.homepage    = "http://rubygems.org/gems/roar"
   s.summary     = %q{Resource-oriented architectures in Ruby.}
-  s.description = %q{RESTful, resource-oriented architectures in Ruby.}
+  s.description = %q{Streamlines the development of RESTful, resource-oriented architectures in Ruby.}
 
   s.rubyforge_project = "roar"
 
@@ -18,4 +18,13 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency "representable"
+  s.add_runtime_dependency "restfulie", "~> 1.0.0"
+  s.add_runtime_dependency "hooks",     "~> 0.1.4"
+  s.add_runtime_dependency "test_xml"
+
+  s.add_development_dependency "minitest",         "~> 1.6.0"
+  s.add_development_dependency "sinatra",          "~> 1.2.6"
+  s.add_development_dependency "sinatra-reloader", "~> 0.5.0"
 end

data/test/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "sinatra"
+gem "sinatra-contrib", :path => "./sinatra-contrib"
+gem "sinatra-activerecord"
+gem "roar", :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'
+
+Rails::Application.load_tasks

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

@@ -0,0 +1,27 @@
+require 'roar/rails'
+
+class AlbumsController < ActionController::Base
+  include Roar::Rails::ControllerMethods
+  
+  respond_to :xml
+  represents Album
+  
+  def show
+    @album = Album.find(params[:id])
+    respond_with @album
+  end
+  
+  def create
+    @album = Album.create(representation)
+    
+    respond_with @album
+  end
+  
+  def update
+    @album = Album.find(params[:id])
+    @album.songs.delete_all # make PUT behave REST-compliant.
+    @album.update_attributes(representation)
+    
+    respond_with @album
+  end
+end

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

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  layout 'application'
+end

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

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

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

@@ -0,0 +1,6 @@
+class Album < ActiveRecord::Base
+  has_many :songs
+  validates_presence_of :year
+  
+  accepts_nested_attributes_for :songs, :allow_destroy => true
+end

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

@@ -0,0 +1,2 @@
+class Song < ActiveRecord::Base
+end

data/test/dummy/app/representers/representer/xml/album.rb

@@ -0,0 +1,19 @@
+module Representer
+  module XML
+    class Album < Roar::Representer::XML
+      self.representation_name= :album
+      
+      property :id
+      property :year
+      collection :songs
+      
+      link :self do
+        album_url(represented.id)
+      end
+      
+      link "album-search" do
+        album_search_url
+      end
+    end
+  end
+end

data/test/dummy/app/representers/representer/xml/song.rb

@@ -0,0 +1,9 @@
+module Representer
+  module XML
+    class Song < Roar::Representer::XML
+      self.representation_name= :song
+      
+      property :title
+    end
+  end
+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/app/views/musician/featured.html.erb

@@ -0,0 +1 @@
+<%= render_cell :bassist, :provoke %>

data/test/dummy/app/views/musician/featured_with_block.html.erb

@@ -0,0 +1,4 @@
+<% flag = false %>
+<%= render_cell :bassist, :play do |cell| 
+  flag = cell.class
+end %> from <%= flag %>

data/test/dummy/app/views/musician/hamlet.html.haml

@@ -0,0 +1 @@
+= render_cell :bassist, :provoke

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "active_record/railtie"
+
+Bundler.require
+
+
+#require "rails_app"
+
+module Dummy
+  class Application < Rails::Application
+    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,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+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!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,16 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,46 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,32 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  #config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,7 @@
+Dummy::Application.routes.draw do
+  match ':controller(/:action(/:id(.:format)))'
+  root :to => 'musician#index'
+  resources :albums
+  resources :songs
+  get "articles/starts_with/{query}", :to => "albums#search",:as => :album_search
+end

data/test/dummy/db/migrate/20110514114753_create_albums.rb

@@ -0,0 +1,14 @@
+class CreateAlbums < ActiveRecord::Migration
+  def self.up
+    create_table :albums do |t|
+      t.string :title
+      t.string :year
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :albums
+  end
+end

data/test/dummy/db/migrate/20110514121228_create_songs.rb

@@ -0,0 +1,14 @@
+class CreateSongs < ActiveRecord::Migration
+  def self.up
+    create_table :songs do |t|
+      t.string :title
+      t.integer :album_id
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :songs
+  end
+end