intermodal 0.0.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Ho-Sheng Hsiao
+
+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

@@ -0,0 +1,27 @@
+Intermodal 0.0.1
+
+=== Summary ===
+
+Intermodal lets you quickly put together a pure, JSON/XML-only RESTful web service.
+
+=== Features ===
+
+ - Declarative DSL for top-level, nested, and linked CRUD resource endpoints, producing dynamically generated resource controllers
+ - Override resource controller behavior
+ - Declarative DSL for Presenters (remap ORM to JSON/XML)
+ - Declarative DSL for Acceptors (remap and filter incoming data)
+ - Authentication mechanism using HTTP X- headers (similar to Rackspace Cloud API)
+ - API versioning
+
+=== Requirements ==
+
+Rails 3.0.x
+
+=== TODO ===
+
+ - Fix known bug with class reloading in development mode
+ - Not everything is packaged well
+ - Should include standardized paging
+ - Integration as Rails 3.1 Engine for versioning endpoints
+ - Cross-account authorization
+ - Override stock Rails 3.0 error handling to produce JSON/XML instead of HTML traces

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  #t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  #t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate documentation for the foreigner plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Intermodal'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "intermodal"
+    gemspec.summary = "Intermodal lets you quickly put together a pure, JSON/XML-only RESTful web service."
+    gemspec.description = "Declarative DSL for top-level, nested, linked CRUD resource endpoints; DSL for Presenters and Acceptors; API Versioning"
+    gemspec.email = "hosh@sparkfly.com"
+    gemspec.homepage = "http://github.com/hosh/intermodal"
+    gemspec.authors = ["Ho-Sheng Hsiao"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/intermodal/base.rb

@@ -0,0 +1,13 @@
+module Intermodal
+  class Base
+    include Intermodal::Mapping::DSL
+    extend Intermodal::DeclareControllers
+    class_inheritable_accessor :routes
+
+    def self.inherited(klass)
+      ActiveSupport.on_load(:after_initialize) do
+        klass.load_presentations!
+      end
+    end
+  end
+end

data/lib/intermodal/declare_controllers.rb

@@ -0,0 +1,102 @@
+module Intermodal
+  module DeclareControllers
+    attr_accessor :controller_definitions
+
+    def controllers(&blk)
+      self.controller_definitions = blk
+    end
+
+    def resources(name, &blk)
+      controller_name = _controller_name(name)
+      _create_controller(name, controller_name, blk, :ancestor => ResourceController, :api => self)
+    end
+
+    def nested_resources(parent_name, name, options = {}, &blk)
+      _parent_model = options[:parent_model]
+      _parent_resource = parent_name.to_s.singularize.to_sym
+      _namespace = _module(parent_name)
+      controller_name = _controller_name(name)
+
+      _create_controller(name, controller_name, blk, 
+                         :ancestor => NestedResourceController, 
+                         :namespace => _namespace,
+                         :model => options[:model],
+                         :parent_resource => _parent_resource,
+                         :parent_model => _parent_model,
+                         :api => self) 
+    end
+
+    def link_resources_from(parent_name, options = {}, &blk)
+      _model = options[:model]
+      _parent_model = options[:parent_model]
+      _parent_resource = parent_name.to_s.singularize.to_sym
+      _target_resource = options[:to]
+      _namespace = _module(parent_name)
+      controller_name = _controller_name(_target_resource)
+
+      customize_linking_resource = proc do
+        let(:model) { _model }
+        let(:target_ids) { params[_target_resource] }
+      end
+
+      controller = _create_controller(name, controller_name, customize_linking_resource, 
+                                      :ancestor => LinkingResourceController, 
+                                      :namespace => _namespace,
+                                      :model => _model,
+                                      :parent_resource => _parent_resource,
+                                      :parent_model => _parent_model) 
+      controller.instance_eval(&blk) if blk
+    end
+
+    def load_controllers!
+      self.controller_definitions.call
+    end
+
+    # API: private
+    def _create_controller(resource_name, controller_name, customizations, options = {},  &blk)
+      _ancestor = options[:ancestor] || ApplicationController
+      _namespace = options[:namespace] || Object
+
+      _unload_controller_if_exists(controller_name, _namespace)
+      controller = Class.new(_ancestor)
+      _namespace.const_set(controller_name, controller)
+      Rails.logger.warn "Creating new resource controller: #{_namespace}::#{controller}"
+
+      controller.resource = resource_name
+      controller.model = options[:model] if options[:model]
+      controller.parent_resource = options[:parent_resource] if options[:parent_resource]
+      controller.parent_model = parent_model if options[:parent_model]
+      controller.class_eval(&customizations) if customizations
+      controller.api = options[:api] if options[:api]
+
+      Rails.logger.info "New class: #{controller.inspect}: #{controller.controller_name}"
+      controller
+    end
+
+    def _controller_name(name)
+      case name
+      when String then name.to_s
+      when Symbol then "#{name.to_s.camelize}Controller"
+      else
+        raise "resources require String or Symbol"
+      end
+    end
+
+    def _module(module_name)
+      module_name = module_name.to_s.camelize
+      if Object.const_defined?(module_name)
+        module_name.constantize
+      else
+        Object.const_set(module_name, Module.new)
+      end
+    end
+
+    def _unload_controller_if_exists(controller_name, _namespace = Object)
+      begin
+        _namespace.send(:remove_const, controller_name) if _namespace.const_defined?(controller_name) # Unload existing class
+      rescue Exception => err
+        Rails.logger.warn "Unable to unload #{controller_name}: #{err.inspect}"
+      end
+    end
+  end
+end

data/lib/intermodal/mapping/acceptor.rb

@@ -0,0 +1,22 @@
+module Intermodal
+  module Mapping
+    class Acceptor < Mapper
+
+      self._mapping_strategy = EXCLUDE_NILS
+
+      class << self
+        alias exclude_from_acceptance exclude_properties 
+
+        # Convenience alias to maps
+        # Examples:
+        #
+        #  accepts :name
+        #  accepts :name, :as => lambda { |o| o.name.camelize }
+        #  accepts :name, :as => [ :first_name, :last_name, :suffix, :prefix ]
+        #
+        alias accepts maps
+      end
+    end
+
+  end
+end

data/lib/intermodal/mapping/dsl.rb

@@ -0,0 +1,76 @@
+module Intermodal
+  module Mapping
+    module DSL
+      extend ActiveSupport::Concern
+
+      included do
+        class_inheritable_accessor :_presentation_description, :_presenters, :_acceptors
+      end
+
+      module ClassMethods
+        # DSL
+        def map_data(&blk)
+          self._presentation_description = blk
+        end
+
+        def presentation_for(resource, &customizations)
+          model = resource.to_s.camelize.constantize
+
+          model.send(:include, Models::Presentation)
+          presenter_template = Class.new(Presenter)
+          presenter_template._property_mapping = []
+          presenter_template.instance_eval(&customizations)
+          presenters[resource.to_sym] = presenter_template
+        end
+
+        def acceptance_for(resource, &customizations)
+          model = resource.to_s.camelize.constantize
+
+          #model.send(:include, Models::Acceptance)
+          acceptor = Class.new(Acceptor)
+          acceptor._property_mapping = []
+          acceptor.instance_eval(&customizations)
+          acceptors[resource.to_sym] = acceptor
+        end
+
+        # Setup
+        def load_presentations!
+          self._presentation_description.call
+        end
+
+        # Accessors
+        def presenters
+          self._presenters ||= {}
+        end
+
+        def presenter_for(model)
+          presenters[model_name(model)]
+        end
+
+        def acceptors
+          self._acceptors ||= {}
+        end
+
+        def acceptor_for(model)
+          acceptors[model_name(model)]
+        end
+
+        def model_name(model)
+          model.name.underscore.to_sym
+        end
+
+        def resource_name(resource)
+          model_name(resource.class)
+        end
+
+        def presents_resource(resource) 
+          presenters[resource_name(resource)].call(resource)
+        end
+
+        def accepts_resource(resource) 
+          accepts[resource_name(resource)].call(resource)
+        end
+      end
+    end
+  end
+end

data/lib/intermodal/mapping/mapper.rb

@@ -0,0 +1,49 @@
+module Intermodal
+  module Mapping
+    class Mapper
+      class_inheritable_accessor :_exclude_properties, :_property_mapping, :_mapping_strategy
+
+      INCLUDE_NILS = lambda { |h, resource, mapped_from, mapped_to| h[mapped_from] = map_attribute(resource, mapped_to) }
+      EXCLUDE_NILS = lambda { |h, resource, mapped_from, mapped_to| a = map_attribute(resource, mapped_to); h[mapped_from] = a if a }
+
+      class << self
+        def exclude_properties(*args)
+          (self._exclude_properties ||= []).push *(args.map(&:to_s))
+        end
+
+        def property_mapping
+          self._property_mapping ||= []
+        end
+
+        # Examples:
+        #
+        #  maps :name
+        #  maps :name, :as => lambda { |o| o.name.camelize }
+        #  maps :name, :as => [ :first_name, :last_name, :suffix, :prefix ]
+        #
+        def maps(property, opts = {})
+          property_mapping.push [property, (opts[:as] ? opts[:as] : property)]
+        end
+
+        def map_attributes(resource)
+          self._property_mapping.inject({}) { |m, p|
+            m.tap { |h| self._mapping_strategy[h, resource, p[0], p[1]] }
+          }.except(*self._exclude_properties)
+        end
+
+        def map_attribute(resource, mapped_to)
+          case mapped_to
+          when Symbol then resource[mapped_to]
+          when Proc then mapped_to[resource]
+          when Array then mapped_to.inject({}) { |m, _element| m.tap { |_m| _m[_element] = map_attribute(resource, _element) } }
+          end
+        end
+
+        def call(resource)
+          map_attributes(resource)
+        end
+      end
+    end
+
+  end
+end

data/lib/intermodal/mapping/presenter.rb

@@ -0,0 +1,30 @@
+module Intermodal
+  module Mapping
+    class Presenter < Mapper
+
+      self._mapping_strategy = INCLUDE_NILS
+
+      class << self
+        alias exclude_from_presentation exclude_properties 
+
+        # Convenience alias for maps
+        # Examples:
+        #
+        #  presents :name
+        #  presents :name, :as => lambda { |o| o.name.camelize }
+        #  presents :name, :as => [ :first_name, :last_name, :suffix, :prefix ]
+        #  
+        alias presents maps
+
+        def model_name(resource)
+          resource.class.name.demodulize.underscore
+        end
+
+        def call(resource)
+          { model_name(resource) => map_attributes(resource) }
+        end
+      end
+    end
+
+  end
+end

data/lib/intermodal/mapping.rb

@@ -0,0 +1,4 @@
+require 'intermodal/mapping/mapper'
+require 'intermodal/mapping/presenter'
+require 'intermodal/mapping/acceptor'
+require 'intermodal/mapping/dsl'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: intermodal
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ho-Sheng Hsiao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Declarative DSL for top-level, nested, linked CRUD resource endpoints; DSL for Presenters and Acceptors; API Versioning
+email: hosh@sparkfly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/intermodal/base.rb
+- lib/intermodal/declare_controllers.rb
+- lib/intermodal/mapping.rb
+- lib/intermodal/mapping/acceptor.rb
+- lib/intermodal/mapping/dsl.rb
+- lib/intermodal/mapping/mapper.rb
+- lib/intermodal/mapping/presenter.rb
+has_rdoc: true
+homepage: http://github.com/hosh/intermodal
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Intermodal lets you quickly put together a pure, JSON/XML-only RESTful web service.
+test_files: []
+