intermodal 0.0.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6819c724b038a70c2a3db2e93e971496a9cef118
+  data.tar.gz: ad9b851f517f20640f614019fa5f05e3d2179300
+SHA512:
+  metadata.gz: 92d1ef56ad8141fd0c46e9e9666d1fa4b2acc976d838957c8d804e6de8df7193c9c754715fe8f4eb384c6f41b184949e21b11ac48b962a0ef83f413dda0c114c
+  data.tar.gz: 595cc3c434619e8a50ddeb0e9d9baa9e2e7c5fd72635cab2fe4f5461a5299cc680f13ee75da44845c0b02b80ae58266ceaf9296b12ecbaf5de79b9ac902b0c22

data/.gitignore

@@ -0,0 +1,8 @@
+.*sw?
+pkg/
+.idea/ #Rubymine preferences and settings
+
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Ho-Sheng Hsiao
+Copyright (c) 2011 Sparkfly, Inc.
 
 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:
 

data/README

@@ -1,4 +1,4 @@
-Intermodal 0.0.1
+Intermodal 0.4.0
 
 === Summary ===
 
@@ -15,13 +15,15 @@ Intermodal lets you quickly put together a pure, JSON/XML-only RESTful web servi
 
 === Requirements ==
 
-Rails 3.0.x
+Rails 4.2.x
+
+Anything below that is no longer supported.
 
 === 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
+ - Reorganize controller concerns
+ - Quick-Start and HOWTO guides

data/Rakefile

@@ -1,3 +1,4 @@
+require "bundler/gem_tasks"
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
@@ -13,6 +14,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 desc 'Generate documentation for the foreigner plugin.'
+
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Intermodal'
@@ -21,6 +23,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+=begin
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
@@ -30,9 +33,12 @@ begin
     gemspec.email = "hosh@sparkfly.com"
     gemspec.homepage = "http://github.com/hosh/intermodal"
     gemspec.authors = ["Ho-Sheng Hsiao"]
+
+    gemspec.add_dependency 'will_paginate', '>=3.0.0'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end
+=end
 

data/intermodal.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "intermodal/version"
+
+Gem::Specification.new do |s|
+  s.name = "intermodal"
+  s.version = Intermodal::VERSION
+  s.authors = ["Ho-Sheng Hsiao"]
+  s.email = %w{talktohosh@gmail.com}
+
+  s.date = %q{2011-08-26}
+
+  s.rubygems_version = %q{1.3.7}
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.homepage = %q{http://github.com/intermodal/intermodal}
+  s.summary = %q{Intermodal lets you quickly put together a pure, JSON-only RESTful web service.}
+  s.description = %q{DSL for top-level, nested, linked CRUD resource endpoints; DSL for Presenters and Acceptors; API Versioning}
+  s.rubyforge_project = "intermodal"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.extra_rdoc_files = %w(LICENSE README)
+  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 = %w(lib)
+
+
+  s.add_runtime_dependency 'rails', '~> 4.2.0'
+  s.add_runtime_dependency 'responders', '~> 2.1.0'
+  s.add_runtime_dependency 'will_paginate', '>= 3.0.0'
+  s.add_runtime_dependency 'warden'
+  s.add_runtime_dependency 'bcrypt'
+  s.add_runtime_dependency 'rlet', '~> 0.6.1'
+
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'multi_json'
+  s.add_development_dependency 'yajl-ruby'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'machinist', '>= 2.0.0.beta2'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'forgery'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'redis'
+
+end

data/lib/generators/intermodal_generator.rb

@@ -0,0 +1,8 @@
+# Sets up Intermodal on Rails
+class IntermodalGenerator < Rails::Generators::Base
+  def create_initializer_file
+    generate "model", "account name:string --timestamps"
+    generate "model", "access_token account_id:integer token:string" # Needs foreign key
+    generate "model", "access_credential account_id:integer identity:string password_digest:string" # Needs foreign key
+  end
+end

data/lib/intermodal.rb

@@ -0,0 +1,122 @@
+require 'intermodal/version'
+require 'active_support'
+require 'will_paginate'
+require 'rlet/functional'
+
+module Intermodal
+  # Core
+  autoload :API,                'intermodal/api'
+  autoload :Configuration,      'intermodal/configuration'
+
+  module DSL
+    autoload :Controllers,         'intermodal/dsl/controllers'
+    autoload :Mapping,             'intermodal/dsl/mapping'
+    autoload :PresentationHelpers, 'intermodal/dsl/presentation_helpers'
+  end
+
+  module Mapping
+    autoload :Mapper,    'intermodal/mapping/mapper'
+    autoload :Presenter, 'intermodal/mapping/presenter'
+    autoload :Acceptor,  'intermodal/mapping/acceptor'
+  end
+
+  # Controller Templates
+  autoload :APIController,             'intermodal/controllers/api_controller'
+  autoload :ResourceController,        'intermodal/controllers/resource_controller'
+  autoload :NestedResourceController,  'intermodal/controllers/nested_resource_controller'
+  autoload :LinkingResourceController, 'intermodal/controllers/linking_resource_controller'
+
+  autoload :ResourceResponder,         'intermodal/responders/resource_responder'
+  autoload :LinkingResourceResponder,  'intermodal/responders/linking_resource_responder'
+
+  # Authentication
+  # TOOD: Make this more configurable. Not everyone wants X-Auth-Token auth
+  module Rack
+    autoload :Auth,       'intermodal/rack/auth'
+    autoload :Rescue,     'intermodal/rack/rescue'
+    autoload :DummyStore, 'intermodal/rack/dummy_store'
+  end
+
+  # Authentication currently require two models
+  # Credentials are like passwords.
+  # Tokens are like cookie sessions. It currently stores against Redis
+  module Models
+    autoload :Account,          'intermodal/concerns/models/account'
+    autoload :AccessCredential, 'intermodal/concerns/models/access_credential'
+    autoload :AccessToken,      'intermodal/concerns/models/access_token'
+  end
+
+  # Concerns
+  autoload :Let, 'intermodal/concerns/let'
+
+  module Models
+    autoload :Accountability,    'intermodal/concerns/models/accountability'
+    autoload :HasParentResource, 'intermodal/concerns/models/has_parent_resource'
+    autoload :ResourceLinking,   'intermodal/concerns/models/resource_linking'
+    autoload :Presentation,      'intermodal/concerns/models/presentation'
+
+    autoload :SanitizeHTML,      'intermodal/concerns/models/sanitize_html'
+  end
+
+  module Controllers
+    autoload :Accountability,      'intermodal/concerns/controllers/accountability'
+    autoload :Anonymous,           'intermodal/concerns/controllers/anonymous'
+    autoload :Presentation,        'intermodal/concerns/controllers/presentation'
+    autoload :PaginatedCollection, 'intermodal/concerns/controllers/paginated_collection'
+    autoload :Resource,            'intermodal/concerns/controllers/resource'
+    autoload :ResourceLinking,     'intermodal/concerns/controllers/resource_linking'
+  end
+
+  module Validators
+    autoload :AccountValidator,          'intermodal/validators/account_validator'
+    autoload :DifferentAccountValidator, 'intermodal/validators/different_account_validator'
+  end
+
+  module Acceptors
+    autoload :Resource,      'intermodal/concerns/acceptors/resource'
+    autoload :NamedResource, 'intermodal/concerns/acceptors/named_resource'
+  end
+
+  module Presenters
+    autoload :Resource,      'intermodal/concerns/presenters/resource'
+    autoload :NamedResource, 'intermodal/concerns/presenters/named_resource'
+  end
+
+  module Proxies
+    autoload :LinkingResources, 'intermodal/proxies/linking_resources'
+  end
+
+  # Exceptions
+  BadRequest = Class.new(Exception)
+
+  # Extensions
+  ActiveSupport.on_load(:after_initialize) do
+    # Make sure this loads after Will Paginate loads
+    require 'intermodal/proxies/will_paginate'
+
+    ::WillPaginate::Collection.send(:include, Intermodal::Proxies::WillPaginate::Collection)
+  end
+
+  Functional = RLet::Functional
+
+  # Rspec Macros
+  module RSpec
+    # Models
+    autoload :Accountability,    'intermodal/rspec/models/accountability'
+    autoload :HasParentResource, 'intermodal/rspec/models/has_parent_resource'
+    autoload :ResourceLinking,   'intermodal/rspec/models/resource_linking'
+    autoload :Sanitization,      'intermodal/rspec/models/sanitization'
+    autoload :Validators,        'intermodal/rspec/validators'
+
+    # Requests
+    autoload :Rack,                  'intermodal/rspec/requests/rack'
+    autoload :HTTP,                  'intermodal/rspec/requests/rfc2616_status_codes'
+    autoload :AuthenticatedRequests, 'intermodal/rspec/requests/authenticated_requests'
+    autoload :PaginatedCollection,   'intermodal/rspec/requests/paginated_collection'
+    autoload :RequestValidations,    'intermodal/rspec/requests/request_validations'
+    autoload :Resources,             'intermodal/rspec/requests/resources'
+    autoload :LinkedResources,       'intermodal/rspec/requests/linked_resources'
+  end
+end
+
+require 'intermodal/config'

data/lib/intermodal/api.rb

@@ -0,0 +1,246 @@
+require 'rails/railtie'
+require 'intermodal/api/railties'
+require 'intermodal/rack/rescue'
+
+require 'active_support/core_ext/module/delegation'
+
+# Modified from Rail 4.2 rails/engine.rb
+module Intermodal
+  class API < Rails::Railtie
+    autoload :Configuration, "intermodal/api/configuration"
+
+    include Intermodal::DSL::Mapping
+    include Intermodal::DSL::Controllers
+    include Intermodal::DSL::PresentationHelpers
+
+    class_attribute :max_per_page, :default_per_page
+
+    class << self
+      attr_accessor :called_from
+
+      alias :api_name    :railtie_name
+      alias :engine_name :railtie_name
+
+      delegate :eager_load!, to: :instance
+
+      def inherited(base)
+        unless base.abstract_railtie?
+          Rails::Railtie::Configuration.eager_load_namespaces << base
+
+          base.called_from = begin
+            call_stack = if Kernel.respond_to?(:caller_locations)
+              caller_locations.map { |l| l.absolute_path || l.path }
+            else
+              # Remove the line number from backtraces making sure we don't leave anything behind
+              caller.map { |p| p.sub(/:\d+.*/, '') }
+            end
+
+            File.dirname(call_stack.detect { |p| p !~ %r[railties[\w.-]*/lib/rails|rack[\w.-]*/lib/rack] })
+          end
+
+          # Add another initializer each time this has been inherited
+          # This covers a bug here, where the initializers declared in the API itself doesn't
+          # seem to run for whatever reason.
+          initializer "intermodal.load_#{base.name}", before: 'build_middleware_stack' do |app|
+            base.generate_api!
+          end
+        end
+
+        super
+      end
+
+      def endpoint(endpoint = nil)
+        @endpoint ||= nil
+        @endpoint = endpoint if endpoint
+        @endpoint
+      end
+
+      def routes(&blk)
+        if block_given?
+          instance.routes(&blk)
+        else
+          instance.routes
+        end
+      end
+
+      # Setup presenters, acceptors, and controllers
+      def generate_api!
+        self.load_presentations!
+        self.load_controllers!
+      end
+
+    end
+
+    delegate :middleware,  to: :config
+    delegate :engine_name, to: :class
+    delegate :api_name,    to: :class
+
+    def initialize
+      @app                 = nil
+      @config              = nil
+      @env_config          = nil
+      @helpers             = nil
+      @routes              = nil
+      super
+    end
+
+    # Load console and invoke the registered hooks.
+    # Check <tt>Rails::Railtie.console</tt> for more info.
+    def load_console(app=self)
+      require "rails/console/app"
+      require "rails/console/helpers"
+      run_console_blocks(app)
+      self
+    end
+
+    # Load Rails runner and invoke the registered hooks.
+    # Check <tt>Rails::Railtie.runner</tt> for more info.
+    def load_runner(app=self)
+      run_runner_blocks(app)
+      self
+    end
+
+    # Load Rake, railties tasks and invoke the registered hooks.
+    # Check <tt>Rails::Railtie.rake_tasks</tt> for more info.
+    def load_tasks(app=self)
+      require "rake"
+      run_tasks_blocks(app)
+      self
+    end
+
+    # Load Rails generators and invoke the registered hooks.
+    # Check <tt>Rails::Railtie.generators</tt> for more info.
+    def load_generators(app=self)
+      require "rails/generators"
+      run_generators_blocks(app)
+      Rails::Generators.configure!(app.config.generators)
+      self
+    end
+
+    # Eager load the application by loading all ruby
+    # files inside eager_load paths.
+    def eager_load!
+      self.load_presentations!
+      self.class.load_controllers!
+      return
+    end
+
+    def railties
+      @railties ||= Railties.new
+    end
+
+    # Returns a module with all the helpers defined for the engine.
+    def helpers
+      # returns empty module (for now)
+      @helpers ||= begin
+        Module.new
+      end
+    end
+
+    # Returns the underlying rack application for this engine.
+    def app
+      @app ||= begin
+        config.middleware = config.middleware.merge_into(default_middleware_stack)
+        config.middleware.build(endpoint)
+      end
+    end
+
+    # Returns the endpoint for this engine. If none is registered,
+    # defaults to an ActionDispatch::Routing::RouteSet.
+    def endpoint
+      self.class.endpoint || routes
+    end
+
+    # Define the Rack API for this engine.
+    def call(env)
+      env.merge!(env_config)
+      if env['SCRIPT_NAME']
+        env["ROUTES_#{routes.object_id}_SCRIPT_NAME"] = env['SCRIPT_NAME'].dup
+      end
+      app.call(env)
+    end
+
+    # Defines additional Rack env configuration that is added on each call.
+    def env_config
+      @env_config ||= {
+        'action_dispatch.routes' => routes
+      }
+    end
+
+    # Defines the routes for this engine. If a block is given to
+    # routes, it is appended to the engine.
+    def routes
+      @routes ||= ActionDispatch::Routing::RouteSet.new
+      @routes.append(&Proc.new) if block_given?
+      @routes
+    end
+
+    # Define the configuration object for the engine.
+    def config
+      @config ||= API::Configuration.new
+    end
+
+    initializer :add_routing_paths do |app|
+      app.routes_reloader.route_sets << routes if routes?
+    end
+
+    # This code, especially running under Rspec, is simply not thread-safe.
+    initializer 'intermodal.disable_concurrency', before: 'build_middleware_stack' do |app|
+      app.config.allow_concurrency = false
+    end
+
+    initializer 'intermodal.strip_middleware', after: 'build_middleware_stack' do |app|
+      app.config.middleware.delete 'Rack::Lock'             # Run this in a multi-process server, not multithreaded
+      app.config.middleware.delete 'ActionDispatch::Flash'
+      # Use our own parsing code and responses, or drop this after Intermodal::Rack::Rescue
+      app.config.middleware.delete 'ActionDispatch::ParamsParser'
+    end
+
+    initializer 'intermodal.load_x_auth_token_warden', :before => 'build_middleware_stack' do |app|
+      Warden::Strategies.add(:x_auth_token) do
+        def valid?
+          env['HTTP_X_AUTH_TOKEN']
+        end
+
+        def authenticate!
+          a = AccessToken.authenticate!(env['HTTP_X_AUTH_TOKEN'])
+          a.nil? ? fail!("Could not log in") : success!(a)
+        end
+      end
+    end
+
+    initializer :engines_blank_point do
+      # We need this initializer so all extra initializers added in engines are
+      # consistently executed after all the initializers above across all engines.
+    end
+
+    def routes? #:nodoc:
+      @routes
+    end
+
+    protected
+
+    def default_middleware_stack
+      ActionDispatch::MiddlewareStack.new.tap do |middleware|
+        middleware.use ::Intermodal::Rack::Rescue
+
+        # TODO: Find a way to patch Warden so this is not necessary
+        # middleware.use config.session_store, config.session_options
+        # Use random secret for now until we can get rid of this.
+        middleware.use Intermodal::Rack::DummyStore
+        #middleware.use ::ActionDispatch::Flash
+        middleware.use Warden::Manager do |manager|
+          manager.default_strategies :x_auth_token #, :basic
+          manager.failure_app = proc do
+            Intermodal::Rack::Auth::UNAUTHORIZED
+          end
+        end
+
+        middleware.use ::ActionDispatch::ParamsParser
+        middleware.use ::Rack::MethodOverride
+      end
+    end
+
+
+  end
+end