sweet_actions 0.1.4

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sweet_actions"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rails/actions_generator.rb

@@ -0,0 +1,21 @@
+module Rails
+  module Generators
+    class ActionsGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_actions_folder
+        template 'collect.rb.erb', File.join('app/actions', plural_name, 'collect.rb')
+        template 'create.rb.erb', File.join('app/actions', plural_name, 'create.rb')
+        template 'destroy.rb.erb', File.join('app/actions', plural_name, 'destroy.rb')
+        template 'show.rb.erb', File.join('app/actions', plural_name, 'show.rb')
+        template 'update.rb.erb', File.join('app/actions', plural_name, 'update.rb')
+      end
+
+      private
+
+      def module_name
+        plural_name.classify.pluralize
+      end
+    end
+  end
+end

data/lib/generators/rails/resource_override.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+require 'rails/generators/rails/resource/resource_generator'
+
+module Rails
+  module Generators
+    class ResourceGenerator
+      hook_for :decanter, default: true, boolean: true
+    end
+  end
+end

data/lib/generators/rails/templates/collect.rb.erb

@@ -0,0 +1,11 @@
+module <%= module_name %>
+  class Collect < CollectAction
+    # def set_resource
+    #   resource_class.all
+    # end
+
+    # def authorized?
+    #   can?(:read, resource) # resource can be a collection
+    # end
+  end
+end

data/lib/generators/rails/templates/create.rb.erb

@@ -0,0 +1,15 @@
+module <%= module_name %>
+  class Create < CreateAction
+    # def set_resource
+    #   resource_class.new(resource_params)
+    # end
+
+    # def authorized?
+    #   can?(:create, resource)
+    # end
+
+    # def save
+    #   resource.save
+    # end
+  end
+end

data/lib/generators/rails/templates/destroy.rb.erb

@@ -0,0 +1,15 @@
+module <%= module_name %>
+  class Destroy < DestroyAction
+    # def set_resource
+    #   resource_class.find(params[:id])
+    # end
+
+    # def authorized?
+    #   can?(:destroy, resource)
+    # end
+
+    # def destroy
+    #   resource.destroy
+    # end
+  end
+end

data/lib/generators/rails/templates/show.rb.erb

@@ -0,0 +1,11 @@
+module <%= module_name %>
+  class Show < ShowAction
+    # def set_resource
+    #   resource_class.find(params[:id])
+    # end
+
+    # def authorized?
+    #   can?(:read, resource)
+    # end
+  end
+end

data/lib/generators/rails/templates/update.rb.erb

@@ -0,0 +1,11 @@
+module <%= module_name %>
+  class Update < UpdateAction
+    # def set_resource
+    #   resource_class.find(params[:id])
+    # end
+
+    # def authorized?
+    #   can?(:update, resource)
+    # end
+  end
+end

data/lib/generators/sweet_actions/install_generator.rb

@@ -0,0 +1,18 @@
+module SweetActions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Creates a Sweet Actions initializer in your application.'
+
+      def copy_initializer
+        copy_file 'initializer.rb', 'config/initializers/sweet_actions.rb'
+        copy_file 'collect_action.rb', 'app/actions/collect_action.rb'
+        copy_file 'create_action.rb', 'app/actions/create_action.rb'
+        copy_file 'destroy_action.rb', 'app/actions/destroy_action.rb'
+        copy_file 'show_action.rb', 'app/actions/show_action.rb'
+        copy_file 'update_action.rb', 'app/actions/update_action.rb'
+      end
+    end
+  end
+end

data/lib/generators/sweet_actions/templates/collect_action.rb

@@ -0,0 +1,10 @@
+class CollectAction < SweetActions::CollectAction
+  def set_resource
+    resource_class.all
+  end
+
+  def authorized?
+    # can?(:read, resource)
+    false
+  end
+end

data/lib/generators/sweet_actions/templates/create_action.rb

@@ -0,0 +1,14 @@
+class CreateAction < SweetActions::CreateAction
+  def set_resource
+    resource_class.new(resource_params)
+  end
+
+  def authorized?
+    # can?(:create, resource)
+    false
+  end
+
+  def save
+    resource.save
+  end
+end

data/lib/generators/sweet_actions/templates/destroy_action.rb

@@ -0,0 +1,14 @@
+class DestroyAction < SweetActions::DestroyAction
+  def set_resource
+    resource_class.find(params[:id])
+  end
+
+  def authorized?
+    # can?(:destroy, resource)
+    false
+  end
+
+  def destroy
+    resource.destroy
+  end
+end

data/lib/generators/sweet_actions/templates/initializer.rb

@@ -0,0 +1,9 @@
+class SweetActionsController < ApplicationController
+  include SweetActions::ControllerConcerns
+end
+
+SweetActions.config do |config|
+  # REST actions must implement `authorize` method
+  # setting to true is the most secure
+  config.authorize_rest_requests = true
+end

data/lib/generators/sweet_actions/templates/show_action.rb

@@ -0,0 +1,10 @@
+class ShowAction < SweetActions::ShowAction
+  def set_resource
+    resource_class.find(params[:id])
+  end
+
+  def authorized?
+    # can?(:read, resource)
+    false
+  end
+end

data/lib/generators/sweet_actions/templates/update_action.rb

@@ -0,0 +1,10 @@
+class UpdateAction < SweetActions::UpdateAction
+  def set_resource
+    resource_class.find(params[:id])
+  end
+
+  def authorized?
+    # can?(:update, resource)
+    false
+  end
+end

data/lib/sweet_actions.rb

@@ -0,0 +1,42 @@
+module SweetActions
+  class << self
+    def configuration
+      @config ||= SweetActions::Configuration.new
+    end
+
+    def config
+      yield configuration
+    end
+  end
+
+  ActiveSupport.run_load_hooks(:sweet_actions, self)
+end
+
+# overhead
+require 'sweet_actions/version'
+require 'sweet_actions/configuration'
+require 'sweet_actions/exceptions'
+
+# base classes
+require 'sweet_actions/action_factory'
+require 'sweet_actions/api_action'
+
+# concerns
+require 'sweet_actions/rest_serializer_concerns'
+require 'sweet_actions/rest_concerns'
+require 'sweet_actions/authorization_concerns'
+require 'sweet_actions/save_concerns'
+require 'sweet_actions/read_concerns'
+
+# actions
+require 'sweet_actions/collect_action'
+require 'sweet_actions/create_action'
+require 'sweet_actions/update_action'
+require 'sweet_actions/show_action'
+require 'sweet_actions/destroy_action'
+
+# helpers
+require 'sweet_actions/controller_concerns'
+require 'sweet_actions/routes_helpers'
+
+require 'sweet_actions/railtie' if defined?(::Rails)

data/lib/sweet_actions/action_factory.rb

@@ -0,0 +1,64 @@
+module SweetActions
+  class ActionFactory
+    attr_reader :controller, :resource_name, :action, :namespace
+
+    def initialize(controller, action_name)
+      @controller = controller
+      path_parameters = env['action_dispatch.request.path_parameters']
+      @resource_name = path_parameters[:resource_name]
+      @action = action_name
+      @namespace = path_parameters[:namespace]
+    end
+
+    def build_action
+      action_class.new(controller)
+    end
+
+    private
+
+    def env
+      controller.request.env
+    end
+
+    def action_class
+      klass_name = [namespace, resource_module, action_class_name].compact.join('::')
+      return klass_name.constantize if klass_defined?(klass_name)
+      default_action
+    end
+
+    def resource_module
+      return nil unless resource_name
+      resource_name.pluralize
+    end
+
+    def action_class_name
+      raise 'action is required to be passed into actionFactory' unless action.present?
+      action.to_s.classify
+    end
+
+    def default_action
+      modules = namespace.split('::')
+      class_found = false
+      klass_name = nil
+
+      until class_found || modules.count == 0
+        namespace_to_test = modules.join('::')
+        target = "#{namespace_to_test}::Defaults::#{action_class_name}"
+        if klass_defined?(target)
+          klass_name = target
+          class_found = true
+        end
+        modules.pop
+      end
+      return klass_name.constantize if klass_name.present?
+      "#{action_class_name}Action".constantize
+    end
+
+    def klass_defined?(klass_name)
+      klass_name.constantize
+      return true
+    rescue
+      return false
+    end
+  end
+end

data/lib/sweet_actions/api_action.rb

@@ -0,0 +1,63 @@
+module SweetActions
+  class ApiAction
+    attr_reader :controller, :response_data, :response_code
+
+    def initialize(controller, options = {})
+      @controller = controller
+      after_init(options)
+    end
+
+    def perform_action
+      run_action = Proc.new do
+        @response_data = action
+      end
+
+      debug_mode? ? run_action.call : fail_gracefully(run_action)
+    end
+
+    private
+
+    def after_init(options); end
+
+    def fail_gracefully(proc)
+      @response_code = '200'
+      begin
+        proc.call
+      rescue Exceptions::NotAuthorized => e
+        @response_code = '401'
+        @response_data = {
+          message: 'not authorized'
+        }
+      rescue StandardError => e
+        @response_code = '500'
+        @response_data = {
+          server_error: e.message
+        }
+      end
+    end
+
+    def debug_mode?
+      ENV['SWEET_ACTION_DEBUG_MODE'] == true
+    end
+
+    def action
+      raise "action method is required for #{self.class.name} because it inherits from ApiAction"
+    end
+
+    def path_parameters
+      @path_parameters ||= env['action_dispatch.request.path_parameters']
+    end
+
+    def request
+      @request ||= controller.request
+    end
+
+    def params
+      @params ||= controller.params
+    end
+
+    def env
+      request.env
+    end
+  end
+end

data/lib/sweet_actions/authorization_concerns.rb

@@ -0,0 +1,23 @@
+module SweetActions
+  module AuthorizationConcerns
+    private
+
+    def authorize?
+      SweetActions.configuration.authorize_rest_requests
+    end
+
+    def authorize
+      return unless authorize?
+      return true if authorized?
+      unauthorized
+    end
+
+    def authorized?
+      raise "authorized? method is required for the #{self.class.name} action"
+    end
+
+    def unauthorized
+      raise Exceptions::NotAuthorized
+    end
+  end
+end

data/lib/sweet_actions/collect_action.rb

@@ -0,0 +1,11 @@
+module SweetActions
+  class CollectAction < ApiAction
+    include ReadConcerns
+
+    private
+
+    def root_key
+      plural_key
+    end
+  end
+end