intermodal 0.0.1 → 0.4.0

data/lib/intermodal/api/configuration.rb

@@ -0,0 +1,40 @@
+require 'rails/railtie/configuration'
+
+
+# Modified from Rails 4.2 rails/engine/configuration.rg
+module Intermodal
+  class API
+    class Configuration < ::Rails::Railtie::Configuration
+      attr_writer :middleware
+
+      def initialize
+        super()
+        @generators = app_generators.dup
+      end
+
+      # Returns the middleware stack for the engine.
+      def middleware
+        @middleware ||= Rails::Configuration::MiddlewareStackProxy.new
+      end
+
+      # Holds generators configuration:
+      #
+      #   config.generators do |g|
+      #     g.orm             :data_mapper, migration: true
+      #     g.template_engine :haml
+      #     g.test_framework  :rspec
+      #   end
+      #
+      # If you want to disable color in console, do:
+      #
+      #   config.generators.colorize_logging = false
+      #
+      def generators #:nodoc:
+        @generators ||= Rails::Configuration::Generators.new
+        yield(@generators) if block_given?
+        @generators
+      end
+
+    end
+  end
+end

data/lib/intermodal/api/railties.rb

@@ -0,0 +1,21 @@
+module Rails
+  class Engine < Railtie
+    class Railties
+      include Enumerable
+      attr_reader :_all
+
+      def initialize
+        @_all ||= ::Rails::Railtie.subclasses.map(&:instance) +
+          ::Rails::Engine.subclasses.map(&:instance)
+      end
+
+      def each(*args, &block)
+        _all.each(*args, &block)
+      end
+
+      def -(others)
+        _all - others
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/acceptors/named_resource.rb

@@ -0,0 +1,12 @@
+module Intermodal
+  module Acceptors
+    module NamedResource
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Acceptors::Resource
+        accepts :name
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/acceptors/resource.rb

@@ -0,0 +1,12 @@
+module Intermodal
+  module Acceptors
+    module Resource
+      extend ActiveSupport::Concern
+
+      # Explicit blacklist
+      included do
+        exclude_from_acceptance :id, :created_at, :updated_at, :account_id
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/accountability.rb

@@ -0,0 +1,17 @@
+require 'intermodal/concerns/controllers/authenticatable'
+
+module Intermodal
+  module Controllers
+
+    # This concern builds on top of Intermodal::Controllers::Authenticatable
+    # by requiring authentication for all controller actions.
+    module Accountability
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Controllers::Authenticatable
+        before_filter :authentication
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/anonymous.rb

@@ -0,0 +1,24 @@
+module Intermodal
+  module Controllers
+    module Anonymous
+      extend ActiveSupport::Concern
+
+      protected
+
+      # Hacks to get anonymous controllers working
+      def reloadable?(app)
+        false
+      end
+
+      module ClassMethods
+        def anonymous?
+          true
+        end
+
+        def controller_path
+          'anonymous_web_service'
+        end
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/authenticatable.rb

@@ -0,0 +1,24 @@
+require 'warden'
+
+module Intermodal
+  module Controllers
+    # This concern adds an interface for warden, allowing access to
+    # the warden user as well as exposing a method to ask warden
+    # for authentication.
+    module Authenticatable
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Let
+
+        let(:account) { env['warden'].user }
+      end
+
+      protected
+
+      def authentication
+        throw(:warden) unless env['warden'].authenticate?
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/paginated_collection.rb

@@ -0,0 +1,25 @@
+module Intermodal
+  module Controllers
+    module PaginatedCollection
+      extend ActiveSupport::Concern
+
+      included do
+        let(:collection)      { raise 'You must define collection' }
+        let(:collection_name) { self.class.collection_name.to_s } # TODO: This might already be defined in Rails 3.x
+        let(:presented_collection) { collection.paginate :page => params[:page], :per_page => per_page }
+
+        let(:per_page) do
+          if params[:per_page]
+            params[:per_page].to_i <= api.max_per_page ? params[:per_page] : api.max_per_page
+          else
+            api.default_per_page
+          end
+        end
+      end
+
+      def index
+        respond_with presented_collection, :presentation_root => collection_name, :presentation_scope => presentation_scope_for_index
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/presentation.rb

@@ -0,0 +1,17 @@
+module Intermodal
+  module Controllers
+    module Presentation
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Let
+
+        let(:api) { self.class.api }
+        let(:presenter) { api.presenters[model_name] }
+        let(:acceptor) { api.acceptors[model_name] }
+        let(:accepted_params) { acceptor.call(params || {}) }
+      end
+
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/resource.rb

@@ -0,0 +1,51 @@
+module Intermodal
+  module Controllers
+    module Resource
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Controllers::Accountability
+        include Intermodal::Controllers::Anonymous
+        include Intermodal::Controllers::PaginatedCollection
+
+        respond_to :json
+
+        class_attribute :model, :collection_name, :api
+
+        let(:resource) { raise 'You must define resource' }
+
+        let(:model) { self.class.model || self.class.collection_name.to_s.classify.constantize }
+        let(:resource_name) {collection_name.singularize }
+        let(:model_name) { model.name.underscore.to_sym }
+
+        # Wrap JSON with root key?
+        let(:presentation_root) { nil }
+        let(:presentation_scope) { nil } # Will default to :default scope
+        let(:presentation_scope_for_index) { nil }
+        let(:always_nest_collections) { false }
+      end
+
+      # Actions
+
+      # index defined in PaginatedCollection
+
+      def show
+        respond_with resource
+      end
+
+      def create
+        respond_with model.create(create_params)
+      end
+
+      def update
+        resource.update_attributes(update_params)
+        respond_with resource
+      end
+
+      def destroy
+        resource.destroy
+        respond_with resource
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/controllers/resource_linking.rb

@@ -0,0 +1,58 @@
+module Intermodal
+  module Controllers
+    module ResourceLinking
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :api
+
+        include Intermodal::Controllers::Accountability
+        include Intermodal::Controllers::Anonymous
+
+        respond_to :json
+        self.responder = ResourceResponder
+
+        let(:parent_id) { params[:id] }
+        let(:collection_name) { self.class.collection_name.to_s } # TODO: This might already be defined in Rails 3.x
+        let(:collection) { model.get(:all, :parent_id => parent_id).to_target_ids }
+
+        # :target_element_name: Params key for list of linked resource ids
+        let(:target_element_name) { "#{target_resource_name.to_s.singularize}_ids" }
+
+        # :accepted_params: All attribute and values for resource
+        let(:accepted_params) { params[parent_resource_name] || {} }
+
+        # :target_ids: List of ids extracted from params
+        let(:target_ids) { accepted_params[target_element_name] }
+
+        let(:presentation_root) { parent_resource_name }
+        let(:presentation_scope) { nil } # Will default to :default scope
+        let(:presented_collection) do
+          Intermodal::Proxies::LinkingResources.new presentation_root,
+            :to => target_resource_name,
+            :with => collection,
+            :parent_id => parent_id
+        end
+      end
+
+      def index
+        respond_with presented_collection
+      end
+
+      def create
+        return head :status => 422 unless target_ids
+        respond_with model.replace(params[:id], target_ids, :account => account), :location => nil
+      end
+
+      def update
+        return head :status => 422 unless target_ids
+        respond_with(model.append(params[:id], target_ids, :account => account))
+      end
+
+      def destroy
+        return head :status => 422 unless target_ids
+        respond_with(model.remove(params[:id], target_ids, :account => account))
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/let.rb

@@ -0,0 +1,21 @@
+# Ripped from Rspec 2.0 beta.12
+module Intermodal
+  module Let
+    extend ActiveSupport::Concern
+
+    private
+
+    def __memoized # :nodoc:
+      @__memoized ||= {}
+    end
+
+    module ClassMethods
+      def let(name, &block)
+        define_method(name) do
+          __memoized[name] ||= instance_eval(&block)
+        end
+        protected(name)
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/models/access_credential.rb

@@ -0,0 +1,28 @@
+require 'active_model/secure_password'
+
+module Intermodal
+  module Models
+    module AccessCredential
+      extend ActiveSupport::Concern
+
+      included do
+        include Intermodal::Models::Accountability
+        include ActiveModel::SecurePassword
+
+        has_secure_password
+
+        # Validations
+        validates_uniqueness_of :identity
+
+        # Associations
+        belongs_to :account
+
+        def self.authenticate!(identity, key)
+          access = self.find_by(identity: identity).try(:authenticate, key)
+          return false unless access
+          access.account
+        end
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/models/account.rb

@@ -0,0 +1,16 @@
+module Intermodal
+  module Models
+    module Account
+      extend ActiveSupport::Concern
+
+      included do
+        # Validations
+        validates_presence_of :name
+
+        # Associations
+        has_many :access_tokens
+        has_many :access_credentials
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/models/accountability.rb

@@ -0,0 +1,47 @@
+module Intermodal
+  module Models
+    module Accountability
+      extend ActiveSupport::Concern
+
+      included do
+        # TODO: This might not be necessary
+        include Intermodal::Models::Presentation
+
+        # Validations
+        validates_presence_of :account_id
+
+        # Associations
+        belongs_to :account
+
+        # Scopes
+        scope :by_account_id, lambda { |a_id| where(:account_id => a_id) }
+        scope :by_account, lambda { |a| by_account_id(a.id) }
+
+        extend Get
+      end
+
+      module Get
+        # API: overrideable
+        # Use this to extend Get
+        def build_get_query(_query, opts)
+          _query = _query.by_account(opts[:account]) if opts[:account]
+          _query = _query.by_account_id(opts[:account_id]) if opts[:account_id]
+          return _query
+        end
+
+        def get(_id, opts = {})
+          # Rails 4 no longer has .scoped, and where(nil) is the actual replacement
+          # always returning a relation
+          # See: http://stackoverflow.com/a/18199294/313193
+          _query = build_get_query(self.where(nil), opts)
+          return _query if _id == :all
+
+          # Force false on readonly
+          _resource = _query.where(:id => _id).limit(1).readonly(false).first
+          raise ActiveRecord::RecordNotFound, "Could not find resource" unless _resource
+          return _resource
+        end
+      end
+    end
+  end
+end

data/lib/intermodal/concerns/models/db_access_token.rb

@@ -0,0 +1,29 @@
+module Intermodal
+  module Models
+    module DbAccessToken
+      extend ActiveSupport::Concern
+
+      included do
+        TOKEN_SIZE = 32
+
+        # Validations
+        validates_uniqueness_of :token
+
+        # Associations
+        belongs_to :account
+
+        def self.authenticate!(token)
+          ::Account.joins(:access_tokens).where(:access_tokens => { :token => token }).limit(1).first
+        end
+
+        def self.generate!(account)
+          token = new(:account_id => account.id)
+          begin
+            token.token = SecureRandom.hex(TOKEN_SIZE)
+          end until token.valid?
+          return token.token if token.save
+        end
+      end
+    end
+  end
+end