action-hero 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dccea77bf4d490c1e635c2bd7f0590cad241242b
-  data.tar.gz: 4a3152a4ae1a68ab1344c5b65241bfdf786cce2c
+  metadata.gz: 37e67b912e6e03b11924e6a3f09d897843090e21
+  data.tar.gz: 723acc43431200114f1b60e8e8d449da08740724
 SHA512:
-  metadata.gz: a3f0e104b1317acdb58a9a73a25b8062d7696463cec588cc1153ee21289e1c391ce772a3a5c306c650d012d777fe488fb6a376fa3c7da539ee836695a849b6a4
-  data.tar.gz: 1798d0126def710fa8f35898a626e08c345c8aeb2db08229e037b909d6eab2048defc0ff644a270de099e0b08f0794837bf9fe81cb0c8963e08f7a61082738d0
+  metadata.gz: 14d67b3b8ace6f3b69795e38749f75fdf02fb1118b30d5bc9f2f473c1950bd98a18fbf101a04e0437bf5b8f25a53c4f7f38c6323fbbb0cd3ad660c56bdf6d4fe
+  data.tar.gz: 6bfba48f4158314467ee2aff99aebc713a15b5de70d4d19c2f993bee07085e8fdac5fd1b933ce89bae4f586f1800dc8180e88e2944cdf82a53d5db103c2cc32c

data/README.md

@@ -1,6 +1,6 @@
 # ActionHero
 
-Move actions from methods in Rails controllers to action classes.
+Move actions from methods in Rails controllers and Grape endoints to action classes.
 
 
 ## Motiviation
@@ -29,15 +29,15 @@ Or install it yourself as:
     $ gem install action-hero
 
 
-## Usage
+## Usage: Rails
 
 ### Simplest Case
 
-Include the ActionHero::Controller module in a controller.
+Include the ActionHero::Rails::Controller module in a controller.
 
     # app/controllers/things_controller.rb
     class ThingsController < ApplicationController
-      include ActionHero::Controller
+      include ActionHero::Rails::Controller
     end
 
 Define the action class.
@@ -45,7 +45,7 @@ Define the action class.
     # app/actions/things/index.rb
     module Things
       class Index
-        include ActionHero::Action
+        include ActionHero::Rails::Action
 
         def call
           expose :things, Thing.all
@@ -100,7 +100,7 @@ Ensure an implicit controller is defined.  Without configuration, the implicit c
 
     # app/controllers/implicit_controller.rb
     class ImplicitController < ApplicationController
-      include ActionHero::Controller
+      include ActionHero::Rails::Controller
     end
 
 
@@ -113,12 +113,12 @@ Define the implicit controllers.
 
     # app/controllers/implicit_controller.rb
     class ImplicitController < ApplicationController
-      include ActionHero::Controller
+      include ActionHero::Rails::Controller
     end
 
     # app/controllers/api/v1/implicit_controller.rb
     class Api::V1::ImplicitController < ApplicationController
-      include ActionHero::Controller
+      include ActionHero::Rails::Controller
     end
 
 Configure the usage.  The configuration uses regexs to match against the #controller_name and will use the first one 
@@ -136,14 +136,14 @@ matched, so order matters.
 
 You can mix and match usage of ActionHero action classes and standard Rails controller action methods.
 
-In order to unobtrusively tie in to the controller, ActionHero::Controller implements the #action_missing 
+In order to unobtrusively tie in to the controller, ActionHero::Rails::Controller implements the #action_missing 
 method.  Thus, if you implement both an aciton class and an action method, the action method will win.
 
 Define a controller with a show action method and define an action class for the index action.
 
     # app/controllers/things_controller.rb
     class ThingsController < ApplicationController
-      include ActionHero::Controller
+      include ActionHero::Rails::Controller
 
       def show
         ...
@@ -153,7 +153,7 @@ Define a controller with a show action method and define an action class for the
     # app/actions/things/index.rb
     module Things
       class Index
-        include ActionHero::Action
+        include ActionHero::Rails::Action
 
         def call
           ...
@@ -193,3 +193,60 @@ aid in debugging, etc.
     Started GET "/" for 127.0.0.1 at 2013-09-08 12:38:26 -0500                                                                                                    │
       [Action Hero] No explicit DashboardController defined, using ImplicitController
       Processing by ImplicitController#show as HTML
+
+
+## Usage: Grape
+
+### Simplest Case
+
+Unlike the ActionHero::Rails::Controller module that must be included in each controller, the
+ActionHero::Grape::Endpoint is automatically included in the Grape::Endpoint when the action-hero 
+gem is required.
+
+Define the action class.
+
+    # app/actions/api/v1/things/index.rb
+    module Api
+      module V1
+        module Things
+          class Index
+            include ActionHero::Grape::Action
+
+            def call
+              expose Thing.all
+            end
+          end
+        end
+      end
+    end
+
+Use the action class in an endpoint.
+
+    module SomeApplication
+      class ApiV1
+        class ThingsEndpoint < Grape::API
+
+          get do
+            ::Api::V1::Things::Index.new( self ).call
+          end
+
+        end
+      end
+    end
+
+
+### Endpoint Methods Available in Action Class
+
+The following methods forward from the the action class to the endpoint.
+
+* content_type
+* cookies
+* error!
+* headers
+* params
+* redirect
+* route
+* routes
+* status
+* version
+

data/lib/action_hero.rb

@@ -1,16 +1,18 @@
 require "action_hero/version"
-require "dispatcher_ext"
+require "dispatcher_ext" # TODO require for Rails only
 
 module ActionHero
 
   class ActionNotFound < StandardError #:nodoc:
   end
 
-  autoload :Action,         'action_hero/action'
   autoload :ActionResolver, 'action_hero/action_resolver'
   autoload :Configuration,  'action_hero/configuration'
-  autoload :Controller,     'action_hero/controller'
+  autoload :Grape,          'action_hero/grape'
   autoload :LogSubscriber,  'action_hero/log_subscriber'
+  autoload :MockController, 'action_hero/mock_controller'
+  autoload :ParamReader,    'action_hero/param_reader'
+  autoload :Rails,          'action_hero/rails'
 
   def self.configuration
     @configuration ||= Configuration.new
@@ -22,4 +24,5 @@ module ActionHero
 
 end
 
+# TODO for Rails only
 ActionHero::LogSubscriber.attach_to :action_controller

data/lib/action_hero/action_resolver.rb

@@ -21,7 +21,7 @@ module ActionHero
     end
 
     def action_class_file_exists?
-      File.exists?( Rails.root.join( 'app', 'actions', "#{action_class_name.underscore}.rb" ))
+      File.exists?( ::Rails.root.join( 'app', 'actions', "#{action_class_name.underscore}.rb" ))
     end
 
   protected

data/lib/action_hero/grape.rb

@@ -0,0 +1,8 @@
+module ActionHero
+  module Grape
+
+    autoload :Action,   'action_hero/grape/action'
+    autoload :Endpoint, 'action_hero/grape/endpoint'
+
+  end
+end

data/lib/action_hero/grape/action.rb

@@ -0,0 +1,59 @@
+require 'active_support/concern'
+require 'forwardable'
+
+module ActionHero
+  module Grape
+    module Action
+
+      extend ActiveSupport::Concern
+
+      included do
+
+        extend Forwardable
+        extend ActionHero::ParamReader
+
+        attr_reader :endpoint
+        protected :endpoint
+
+        def_delegators :endpoint, :content_type,
+                                  :cookies,
+                                  :error!,
+                                  :headers,
+                                  :params,
+                                  :redirect,
+                                  :route,
+                                  :routes,
+                                  :status,
+                                  :version
+
+      end
+
+      def initialize( endpoint )
+        @endpoint = endpoint
+      end
+
+      module ClassMethods
+
+        def endpoint_delegations( *method_names )
+          def_delegators :endpoint, *method_names
+        end
+
+      end
+
+    protected
+
+      def expose( *args )
+        value = args.last
+
+        if args.size > 1
+          name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+          instance_variable_set "@#{name}", value
+          self.class.send( :define_method, name, lambda { instance_variable_get "@#{name}" } )
+        end
+
+        endpoint.send :expose, *args
+      end
+
+    end
+  end
+end

data/lib/action_hero/grape/endpoint.rb

@@ -0,0 +1,18 @@
+module ActionHero
+  module Grape
+    module Endpoint
+
+      def expose( *args )
+        args.last.tap do |value|
+          if args.size > 1
+            name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+            self.class.send( :define_method, name, lambda { value } )
+          end
+
+          body( value )
+        end
+      end
+
+    end
+  end
+end

data/lib/action_hero/mock_controller.rb

@@ -0,0 +1,25 @@
+module ActionHero
+  module MockController
+
+    include Controller
+
+    def action_name( *args ); end
+    def env( *args ); end
+    def flash( *args ); end
+    def formats( *args ); end
+    def head( *args ); end
+    def headers( *args ); end
+    def params( *args ); end
+    def redirect_to( *args ); end
+    def render( *args ); end
+    def render_to_string( *args ); end
+    def request( *args ); end
+    def reset_session( *args ); end
+    def respond_with( *args ); end
+    def response( *args ); end
+    def session( *args ); end
+    def url_for( *args ); end
+    def url_options( *args ); end
+
+  end
+end

data/lib/action_hero/param_reader.rb

@@ -0,0 +1,13 @@
+module ActionHero
+  module ParamReader
+
+    def param_reader( *param_names )
+      param_names.each do |param_name|
+        define_method param_name do
+          params[param_name]
+        end
+      end
+    end
+
+  end
+end

data/lib/action_hero/rails.rb

@@ -0,0 +1,8 @@
+module ActionHero
+  module Rails
+
+    autoload :Action,     'action_hero/rails/action'
+    autoload :Controller, 'action_hero/rails/controller'
+
+  end
+end

data/lib/action_hero/rails/action.rb

@@ -0,0 +1,68 @@
+require 'active_support/concern'
+require 'forwardable'
+
+module ActionHero
+  module Rails
+    module Action
+
+      extend ActiveSupport::Concern
+
+      include ::Rails.application.routes.url_helpers
+
+      included do
+
+        extend Forwardable
+        extend ActionHero::ParamReader
+
+        attr_reader :controller
+        protected :controller
+
+        def_delegators :controller, :action_name,
+                                    :env,
+                                    :flash,
+                                    :formats,
+                                    :head,
+                                    :headers,
+                                    :params,
+                                    :redirect_to,
+                                    :render,
+                                    :render_to_string,
+                                    :request,
+                                    :reset_session,
+                                    :respond_with,
+                                    :response,
+                                    :session,
+                                    :url_for,
+                                    :url_options
+
+      end
+
+      def initialize( controller )
+        @controller = controller
+      end
+
+      module ClassMethods
+
+        def controller_delegations( *method_names )
+          def_delegators :controller, *method_names
+        end
+
+      end
+
+    protected
+
+      def expose( *args )
+        name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+        value = args.last
+        instance_variable_set "@#{name}", value
+        self.class.send( :define_method, name, lambda { instance_variable_get "@#{name}" } )
+        controller.send :expose, *args
+      end
+
+      def request_parameters
+        request.request_parameters
+      end
+
+    end
+  end
+end

data/lib/action_hero/rails/controller.rb

@@ -0,0 +1,70 @@
+require 'active_support/concern'
+
+module ActionHero
+  module Rails
+    module Controller
+
+      extend ActiveSupport::Concern
+
+    protected
+
+      def expose( *args )
+        name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+        value = args.last
+        data.merge!( name => value )
+        self.class.send( :define_method, name, lambda { data[name] } )
+        self.class.helper_method name
+        value
+      end
+
+      def action_missing( name, *args, &block )
+        begin
+          action_class
+        rescue NoMethodError
+          # protect against misidentification due to
+          # NoMethodError being descendent of NameError
+          raise
+        rescue NameError => ex
+          raise ActionNotFound,
+                "The action #{action_class_name} nor #{self.class.name}##{name} could be found",
+                ex.backtrace
+        end
+        prepend_view_path "#{::Rails.root}/app/views/#{params[:controller]}"
+        execute_action
+      end
+
+      # override _normalize_render in order to insert implied controller's view prefix
+      def _normalize_render(*args, &block)
+        options = _normalize_args(*args, &block)
+        _normalize_options(options)
+        unless options[:prefixes].include?( params[:controller] )
+          options[:prefixes].insert( 0, params[:controller] )
+        end
+        options
+      end
+
+      def data
+        @data ||= {}.with_indifferent_access
+      end
+
+      def execute_action
+        action = action_class.new( self )
+        action.call
+      end
+
+      def resolver
+        @resolver ||= ActionResolver.new( :controller_const => "#{params[:controller].classify}Controller",
+                                          :action_name => action_name )
+      end
+
+      def action_class
+        resolver.action_class
+      end
+
+      def action_class_name
+        resolver.action_class_name
+      end
+
+    end
+  end
+end

data/lib/action_hero/version.rb

@@ -1,5 +1,5 @@
 module ActionHero
 
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action-hero
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - C. Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,11 +69,17 @@ files:
 - action-hero.gemspec
 - lib/action-hero.rb
 - lib/action_hero.rb
-- lib/action_hero/action.rb
 - lib/action_hero/action_resolver.rb
 - lib/action_hero/configuration.rb
-- lib/action_hero/controller.rb
+- lib/action_hero/grape.rb
+- lib/action_hero/grape/action.rb
+- lib/action_hero/grape/endpoint.rb
 - lib/action_hero/log_subscriber.rb
+- lib/action_hero/mock_controller.rb
+- lib/action_hero/param_reader.rb
+- lib/action_hero/rails.rb
+- lib/action_hero/rails/action.rb
+- lib/action_hero/rails/controller.rb
 - lib/action_hero/version.rb
 - lib/dispatcher_ext.rb
 homepage: ''

data/lib/action_hero/action.rb

@@ -1,53 +0,0 @@
-require 'active_support/concern'
-require 'forwardable'
-
-module ActionHero
-  module Action
-
-    extend ActiveSupport::Concern
-
-    include Rails.application.routes.url_helpers
-
-    included do
-
-      extend Forwardable
-
-      attr_reader :controller
-      protected :controller
-
-      def_delegators :controller, :action_name,
-                                  :env,
-                                  :flash,
-                                  :formats,
-                                  :head,
-                                  :headers,
-                                  :params,
-                                  :redirect_to,
-                                  :render,
-                                  :render_to_string,
-                                  :request,
-                                  :reset_session,
-                                  :respond_with,
-                                  :response,
-                                  :session,
-                                  :url_for,
-                                  :url_options
-
-    end
-
-    def initialize( controller )
-      @controller = controller
-    end
-
-  protected
-
-    def expose( *args )
-      name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
-      value = args.last
-      instance_variable_set "@#{name}", value
-      self.class.send( :define_method, name, lambda { instance_variable_get "@#{name}" } )
-      controller.send :expose, *args
-    end
-
-  end
-end

data/lib/action_hero/controller.rb

@@ -1,68 +0,0 @@
-require 'active_support/concern'
-
-module ActionHero
-  module Controller
-
-    extend ActiveSupport::Concern
-
-  protected
-
-    def expose( *args )
-      name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
-      value = args.last
-      data.merge!( name => value )
-      self.class.send( :define_method, name, lambda { data[name] } )
-      self.class.helper_method name
-      value
-    end
-
-    def action_missing( name, *args, &block )
-      begin
-        action_class
-      rescue NoMethodError
-        # protect against misidentification due to
-        # NoMethodError being descendent of NameError
-        raise
-      rescue NameError => ex
-        raise ActionNotFound,
-              "The action #{action_class_name} nor #{self.class.name}##{name} could be found",
-              ex.backtrace
-      end
-      prepend_view_path "#{Rails.root}/app/views/#{params[:controller]}"
-      execute_action
-    end
-
-    # override _normalize_render in order to insert implied controller's view prefix
-    def _normalize_render(*args, &block)
-      options = _normalize_args(*args, &block)
-      _normalize_options(options)
-      unless options[:prefixes].include?( params[:controller] )
-        options[:prefixes].insert( 0, params[:controller] )
-      end
-      options
-    end
-
-    def data
-      @data ||= {}.with_indifferent_access
-    end
-
-    def execute_action
-      action = action_class.new( self )
-      action.call
-    end
-
-    def resolver
-      @resolver ||= ActionResolver.new( :controller_const => "#{params[:controller].classify}Controller",
-                                        :action_name => action_name )
-    end
-
-    def action_class
-      resolver.action_class
-    end
-
-    def action_class_name
-      resolver.action_class_name
-    end
-
-  end
-end