rails-rest-kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9791aca5b378e9e0306e7f746c34842852d50c7be0c471237e6898e14767b097
+  data.tar.gz: a37b7cd5667dff1eb33b1ba20d5a5f17ce017c1098f9df811fead1f6c9adb3f6
+SHA512:
+  metadata.gz: b1259eb65ad5841f432ab688bf18f6b7c884fd74b3590ae5ede627c94565fa50965d42c4317d38e14d48ca3f21c0352ef441df0ff0518ae02e11d0433048f257
+  data.tar.gz: f217291537dde6c234aa3fbf03549ef8774de0fd34f68ea53fd0aabfcc75d34541adc7825e0880a136aefe4e5781bac2660889b777993a8e8e3b284ac95c316c

data/lib/rails_rest_kit/engine.rb

@@ -0,0 +1,4 @@
+module RailsRestKit
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_rest_kit/helpers/permitter_helper.rb

@@ -0,0 +1,41 @@
+module RailsRestKit
+  module Helpers
+    module PermitterHelper
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :permitter, instance_writer: false
+        self.permitter = RailsRestKit::Permitter.new
+      end
+
+      class_methods do
+        def permit_resource(resource_name, &block)
+          permitter.configure(resource_name, &block)
+        end
+      end
+
+      private
+
+      def permit_params(resource_name)
+        self.class.permitter.permit(resource_name, params)
+      end
+    end
+  end
+end
+
+# permitter.configure :blog_post do
+#   require :blog_post
+#   attributes :title, :body
+#   nested :author do
+#     attributes :name, :email
+#     nested :profile do
+#       attributes :bio
+#     end
+#   end
+#   collection :comments do
+#     attributes :content
+#     nested :user do
+#       attributes :username
+#     end
+#   end
+# end

data/lib/rails_rest_kit/helpers/resource_helper.rb

@@ -0,0 +1,42 @@
+module RailsRestKit
+  module Helper
+    module ResourceHelper
+      extend ActiveSupport::Concern
+
+      included do
+        # Set show resource
+        define_method("set_#{model_slug}") do
+          instance_variable_set("@#{model_slug}", model_class.find(params[:id])) if !instance_variable_get("@#{model_slug}")
+          instance_variable_get("@#{model_slug}")
+        end
+        # Set new resource
+        define_method("set_new_#{model_slug}") do
+          instance_variable_set("@#{model_slug}", model_class.new) if !instance_variable_get("@#{model_slug}")
+          instance_variable_get("@#{model_slug}")
+        end
+        # Set index resources
+        define_method("set_#{model_slug.pluralize}") do
+          instance_variable_set("@#{model_slug.pluralize}", model_class.all) if !instance_variable_get("@#{model_slug.pluralize}")
+          instance_variable_get("@#{model_slug.pluralize}")
+        end
+      end
+
+      class_methods do
+        def model_name
+          @model_name ||= controller_name.classify
+        end
+        alias_method :resource_name, :model_name
+
+        def model_slug
+          @model_slug ||= controller_name.singularize
+        end
+        alias_method :resource_slug, :model_slug
+
+        def model_class
+          @model_class ||= model_name.constantize
+        end
+        alias_method :resource_class, :model_class
+      end
+    end
+  end
+end

data/lib/rails_rest_kit/permitter.rb

@@ -0,0 +1,93 @@
+module RailsRestKit
+  class Permitter
+    attr_reader :configurations
+
+    def initialize
+      @configurations = {}
+    end
+
+    # Configure permitted attributes for a resource
+    def configure(resource_name, &block)
+      configurations[resource_name.to_s] = Configuration.new(&block)
+    end
+
+    # Get configuration for a specific resource
+    def for(resource_name)
+      configurations[resource_name.to_s]
+    end
+
+    # Permit parameters for a specific resource
+    def permit(resource_name, params)
+      config = for(resource_name)
+      raise ArgumentError, "No configuration found for resource: #{resource_name}" unless config
+      
+      config.permit(params)
+    end
+
+    # Configuration class for each resource
+    class Configuration
+      attr_reader :attributes, :nested_attributes, :collections
+
+      def initialize(&block)
+        @attributes = []
+        @nested_attributes = {}
+        @collections = {}
+        instance_eval(&block) if block_given?
+      end
+
+      # Specify required top-level keys
+      def require(*keys)
+        @required_keys.concat(keys.map(&:to_s))
+      end
+
+      # Specify expected top-level keys
+      def expect(*keys)
+        @expected_keys.concat(keys.map(&:to_s))
+      end
+
+      # Define basic attributes
+      def attributes(*attrs)
+        @attributes.concat(attrs.map(&:to_s))
+      end
+
+      # Define nested attributes
+      def nested(name, &block)
+        @nested_attributes[name.to_s] = Configuration.new(&block)
+      end
+
+      # Define collection attributes
+      def collection(name, &block)
+        @collections[name.to_s] = Configuration.new(&block)
+      end
+
+      # Permit parameters based on configuration
+      def permit(params)
+        filtered = params
+
+        # Apply require and expect to params
+        @required_keys.each { |key| filtered = filtered.require(key) }
+        @expected_keys.each { |key| filtered = filtered.expect(key) }
+
+        permitted = filtered.permit(@attributes)
+
+        # Handle nested attributes
+        @nested_attributes.each do |nested_name, nested_config|
+          if filtered[nested_name].present?
+            permitted[nested_name] = nested_config.permit(filtered[nested_name])
+          end
+        end
+
+        # Handle collection attributes
+        @collections.each do |collection_name, collection_config|
+          if filtered[collection_name].present?
+            permitted[collection_name] = filtered[collection_name].map do |item|
+              collection_config.permit(item)
+            end
+          end
+        end
+
+        permitted
+      end
+    end
+  end
+end

data/lib/rails_rest_kit/restful_controller_actions.rb

@@ -0,0 +1,109 @@
+module RailsRestKit
+  module RestfulControllerActions
+    extend ActiveSupport::Concern
+
+    RESTFUL_ACTIONS = {
+      index: %i[],
+      show: %i[],
+      new: %i[],
+      create: %i[ valid invalid ],
+      edit: %i[],
+      update: %i[ valid invalid ],
+      destroy: %i[]
+    }
+
+    included do
+      include RailsRestKit::Helpers::PermitterHelper
+      include RailsRestKit::Helper::ResourceHelper
+
+      define_restful_actions_and_callbacks
+    end
+
+    private
+
+    def default_index
+      run_callbacks(:index) do
+        send("set_#{model_slug.pluralize}")
+      end
+    end
+
+    def default_show
+      run_callbacks(:show) do
+        send("set_#{model_slug}")
+      end
+    end
+
+    def default_new
+      run_callbacks(:new) do
+        send("set_new_#{model_slug}")
+      end
+    end
+
+    def default_create
+      resource = send("set_new_#{model_slug}")
+      resource.assign_attributes(permit_params(model_slug))
+      run_callbacks(:create) do
+        if resource.save
+          run_callbacks(:create_valid) do
+          end
+        else
+          run_callbacks(:create_invalid) do
+          end
+        end
+      end
+    end
+
+    def default_edit
+      run_callbacks(:edit) do
+        send("set_#{model_slug}")
+      end
+    end
+
+    def default_update
+      resource = send("set_#{model_slug}")
+      resource.assign_attributes(permit_params(model_slug))
+      run_callbacks(:update) do
+        if resource.save
+          run_callbacks(:update_valid) do
+          end
+        else
+          run_callbacks(:update_invalid) do
+          end
+        end
+      end
+    end
+
+    def default_destroy
+    end
+
+    def self.define_restful_actions_and_callbacks
+      # Get RESTful routes for this controller
+      controller_routes = Rails.application.routes.routes.select do |route|
+        route.defaults[:controller] == controller_name && route.defaults[:action].in?(RESTFUL_ACTIONS.keys)
+      end
+      controller_routes.each do |route|
+        action = route.defaults[:action]
+        lifecycle_hooks = RESTFUL_ACTIONS[action]
+        # Define callbacks for the action
+        define_callbacks(action)
+        lifecycle_hooks.each do |hook|
+          define_callbacks("#{action}_#{hook}")
+        end
+        %w[ before after around ].each do |callback|
+          define_singleton_method("#{callback}_#{action}") do |*args, &block|
+            set_callback(action, callback, &block)
+          end
+          lifecycle_hooks.each do |hook|
+            define_singleton_method("#{callback}_#{action}_#{hook}") do |*args, &block|
+              set_callback(action, callback, &block)
+            end
+          end
+        end
+        # Define the action method
+        define_method(action) do
+          send("default_#{action}")
+        end
+      end
+    end
+  end
+end

data/lib/rails_rest_kit/version.rb

@@ -0,0 +1,3 @@
+module RailsRestKit
+  VERSION = "0.1.0"
+end

data/lib/rails_rest_kit.rb

@@ -0,0 +1,9 @@
+require "rails-rest_kit/version"
+require "rails-rest_kit/helpers/resource_helper"
+require "rails-rest_kit/helpers/permitter_helper"
+require "rails-rest_kit/restful_controller_actions"
+require "rails-rest_kit/permitter"
+require "rails-rest_kit/engine" if defined?(Rails)
+
+module RailsRestKit
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rails-rest-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Woodruff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RailsRestKit provides a comprehensive solution for building RESTful Rails
+  controllers with minimal boilerplate. It automatically generates standard CRUD actions
+  (index, show, new, create, edit, update, destroy) with built-in lifecycle callbacks
+  and validation states (valid/invalid). The gem includes intelligent resource helpers
+  that automatically infer model relationships from controller names, and a flexible
+  parameter permitting system that supports nested attributes and collections. Perfect
+  for rapidly building consistent REST APIs with proper separation of concerns.
+email: brandonwoodruff92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_rest_kit.rb
+- lib/rails_rest_kit/engine.rb
+- lib/rails_rest_kit/helpers/permitter_helper.rb
+- lib/rails_rest_kit/helpers/resource_helper.rb
+- lib/rails_rest_kit/permitter.rb
+- lib/rails_rest_kit/restful_controller_actions.rb
+- lib/rails_rest_kit/version.rb
+homepage: https://github.com/brandonwoodruff92/rails-rest-kit
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Automated RESTful controller actions with lifecycle callbacks and parameter
+  permitting
+test_files: []