rails-rest-kit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9791aca5b378e9e0306e7f746c34842852d50c7be0c471237e6898e14767b097
-  data.tar.gz: a37b7cd5667dff1eb33b1ba20d5a5f17ce017c1098f9df811fead1f6c9adb3f6
+  metadata.gz: bdce6fff4de34b5f24f476fc966128a63391f33182434e97523c64dba8a147b6
+  data.tar.gz: ed150eeb5e7d9de29569cf15dc9e9d25b5d30dd1905e53714f61a3e38ad2b8b5
 SHA512:
-  metadata.gz: b1259eb65ad5841f432ab688bf18f6b7c884fd74b3590ae5ede627c94565fa50965d42c4317d38e14d48ca3f21c0352ef441df0ff0518ae02e11d0433048f257
-  data.tar.gz: f217291537dde6c234aa3fbf03549ef8774de0fd34f68ea53fd0aabfcc75d34541adc7825e0880a136aefe4e5781bac2660889b777993a8e8e3b284ac95c316c
+  metadata.gz: fefb836097ddc75a27cff0a7cc4d0d803ca3b85264c5d1ba50b28c0aac07c5c9884f7650d23c6436f7bb4ae1604c939d276aaa6520703e50048ae95740e71352
+  data.tar.gz: 3903916b339d925e8169cf0cc08dd74acd34eb1bff0e16ca2d2f25c7d780c014959ab7cc2190c215753c88c81a9ac37501ad0338baa0d665f63dd1fdd6b90f5d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Brandon Woodruff
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,219 @@
+# Rails Rest Kit
+Rails Rest Kit is a comprehensive Rails gem that automates RESTful controller actions with built-in lifecycle callbacks and intelligent parameter permitting. It eliminates boilerplate code while providing a flexible, convention-over-configuration approach to building REST APIs.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails-rest-kit"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails-rest-kit
+```
+
+## Usage
+Include the `RailsRestKit::RestfulControllerActions` module in your controller. This will automatically provide callback hooks for your default REST actions (`index, show, new, create, edit, update, destroy`):
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::RestfulControllerActions
+end
+```
+
+You can hook into a specific callback by defining callback blocks for each hook:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::RestfulControllerActions
+
+  before_index do 
+    Rails.logger.info("Before index")
+  end
+
+  around_show do
+    Rails.logger.info("Around show")
+  end
+
+  after_create_valid do 
+    Rails.logger.info("Succesfully created resource")
+  end
+end
+```
+You can reference all callback hooks here.
+
+### Permitters
+
+You can use `RailsRestKit::Permitter` in your controller by including the `RailsRestKit::Helpers::PermitterHelper` or `RailsRestKit::RestfulControllerActions` in your controller:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::PermitterHelper
+end
+```
+
+You can define permitted params for a controller using the `RailsRestKit::Permitter` DSL:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::PermitterHelper
+
+  permit_resource :user do
+    attributes :name, :email
+    nested :address do
+      attributes :street, :city, :state
+    end
+    collection :posts do
+      attributes :content
+    end
+  end
+end
+```
+
+Then you can access permissions with the `permit_params` method:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::PermitterHelper
+
+  permit_resource :user do
+    attributes :name, :email
+    nested :address do
+      attributes :street, :city, :state
+    end
+    collection :posts do
+      attributes :content
+    end
+  end
+
+  # Incoming params:
+  # user: {
+  #   name: "John Doe",
+  #   email: "john@example.com",
+  #   age: 27
+  #   address: { street: "123 Main St", city: "Anytown", zip: 12345 },
+  #   posts: [{ title: "First Post", content: "Hello" }]
+  # }
+  def test_action
+    permitted_user_params = permit_params(:user)
+    # Permitted params:
+    # {
+    #   name: "John Doe",
+    #   email: "john@example.com"
+    #   address: { street: "123 Main St", city: "Anytown" },
+    #   posts: [{ content: "Hello" }]
+    # }
+  end
+end
+```
+
+You can use the `required: true` flag to require resource params:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::PermitterHelper
+
+  permit_resource :user, required: true do
+    attributes :name, :email
+    nested :address do
+      attributes :street, :city, :state
+    end
+    collection :posts do
+      attributes :content
+    end
+  end
+
+  # Incoming params:
+  # user: {}
+  def test_action
+    permitted_user_params = permit_params(:user) # Raises a ActionController::ParameterMissing error
+  end
+end
+```
+
+### Helpers
+
+Rails Rest Kit provides a number of controller helper methods to use by including the `RailsRestKit::Helpers::ResourceHelper` or `RailsRestKit::RestfulControllerActions` in your controller:
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::ResourceHelper
+end
+```
+
+Then you can call the setter helper methods to set resource instance variables:
+
+```js
+// Users table
+[
+  {
+    id: 1,
+    name: "John Doe",
+    email: "john@example.com",
+  },
+  {
+    id: 2,
+    name: "Jane Doe",
+    email: "jane@example.com",
+  }
+]
+```
+
+```ruby
+class UsersController < ApplicationController
+  include RailsRestKit::Helpers::ResourceHelper
+
+  def test_index_action
+    set_users
+    Rails.logger.info(@users)
+    # [
+    #   {
+    #     id: 1,
+    #     name: "John Doe",
+    #     email: "john@example.com",
+    #   },
+    #   {
+    #     id: 2,
+    #     name: "Jane Doe",
+    #     email: "jane@example.com",
+    #   }
+    # ]
+  end
+
+  # Incoming params:
+  # { id: 1 }
+  def test_show_action
+    set_user
+    Rails.logger.info(@user)
+    # {
+    #   id: 1,
+    #   name: "John Doe",
+    #   email: "john@example.com",
+    # }
+  end
+
+  def test_new_action
+    set_new_user
+    Rails.logger.info(@user)
+    # {
+    #   id: nil,
+    #   name: nil,
+    #   email: nil,
+    # }
+  end
+end
+```
+
+You can see a detailed list of all helper methods here.
+
+## Contributing
+We welcome contributions to Rails Rest Kit!
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails_rest_kit/engine.rb

@@ -1,3 +1,5 @@
+require "rails_rest_kit"
+
 module RailsRestKit
   class Engine < ::Rails::Engine
   end

data/lib/rails_rest_kit/helpers/permitter_helper.rb

@@ -9,8 +9,8 @@ module RailsRestKit
       end
 
       class_methods do
-        def permit_resource(resource_name, &block)
-          permitter.configure(resource_name, &block)
+        def permit_resource(resource_name, required: false, &block)
+          permitter.configure(resource_name, required: required, &block)
         end
       end
 
@@ -21,21 +21,4 @@ module RailsRestKit
       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
+end

data/lib/rails_rest_kit/helpers/resource_helper.rb

@@ -1,5 +1,5 @@
 module RailsRestKit
-  module Helper
+  module Helpers
     module ResourceHelper
       extend ActiveSupport::Concern
 
@@ -19,6 +19,9 @@ module RailsRestKit
           instance_variable_set("@#{model_slug.pluralize}", model_class.all) if !instance_variable_get("@#{model_slug.pluralize}")
           instance_variable_get("@#{model_slug.pluralize}")
         end
+
+        # Instance method aliases for class methods
+        delegate :model_name, :resource_name, :model_slug, :resource_slug, :model_class, :resource_class, to: :class
       end
 
       class_methods do

data/lib/rails_rest_kit/permitter.rb

@@ -7,8 +7,8 @@ module RailsRestKit
     end
 
     # Configure permitted attributes for a resource
-    def configure(resource_name, &block)
-      configurations[resource_name.to_s] = Configuration.new(&block)
+    def configure(resource_name, required: false, &block)
+      configurations[resource_name.to_s] = Configuration.new(required: required, &block)
     end
 
     # Get configuration for a specific resource
@@ -18,33 +18,28 @@ module RailsRestKit
 
     # Permit parameters for a specific resource
     def permit(resource_name, params)
-      config = for(resource_name)
+      config = self.for(resource_name)
       raise ArgumentError, "No configuration found for resource: #{resource_name}" unless config
-      
-      config.permit(params)
+      if config.required
+        resource_params = params.require(resource_name)
+      else
+        resource_params = params[resource_name] || params
+      end
+      config.permit(resource_params)
     end
 
     # Configuration class for each resource
     class Configuration
-      attr_reader :attributes, :nested_attributes, :collections
+      attr_reader :attributes, :nested_attributes, :collections, :required
 
-      def initialize(&block)
+      def initialize(required: false, &block)
         @attributes = []
         @nested_attributes = {}
         @collections = {}
+        @required = required
         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))
@@ -62,25 +57,19 @@ module RailsRestKit
 
       # 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)
+        permitted = params.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])
+          if params[nested_name].present?
+            permitted[nested_name] = nested_config.permit(params[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|
+          if params[collection_name].present?
+            permitted[collection_name] = params[collection_name].map do |item|
               collection_config.permit(item)
             end
           end

data/lib/rails_rest_kit/restful_controller_actions.rb

@@ -14,7 +14,7 @@ module RailsRestKit
 
     included do
       include RailsRestKit::Helpers::PermitterHelper
-      include RailsRestKit::Helper::ResourceHelper
+      include RailsRestKit::Helpers::ResourceHelper
 
       define_restful_actions_and_callbacks
     end
@@ -74,34 +74,32 @@ module RailsRestKit
     end
 
     def default_destroy
+      resource = send("set_#{model_slug}")
+      run_callbacks(:destroy) do
+        resource.destroy
+      end
     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)
+    class_methods do
+      def define_restful_actions_and_callbacks
+        RESTFUL_ACTIONS.each do |action, hooks|
+          define_callbacks(action)
+          hooks.each do |hook|
+            define_callbacks("#{action}_#{hook}")
           end
-          lifecycle_hooks.each do |hook|
-            define_singleton_method("#{callback}_#{action}_#{hook}") do |*args, &block|
+          %i[ before after around ].each do |callback|
+            define_singleton_method("#{callback}_#{action}") do |*args, &block|
               set_callback(action, callback, &block)
             end
+            hooks.each do |hook|
+              define_singleton_method("#{callback}_#{action}_#{hook}") do |*args, &block|
+                set_callback("#{action}_#{hook}", callback, &block)
+              end
+            end
+          end
+          define_method(action) do
+            send("default_#{action}")
           end
-        end
-        # Define the action method
-        define_method(action) do
-          send("default_#{action}")
         end
       end
     end

data/lib/rails_rest_kit/version.rb

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

data/lib/rails_rest_kit.rb

@@ -1,9 +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)
+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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-rest-kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brandon Woodruff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-26 00:00:00.000000000 Z
+date: 2025-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,16 +62,44 @@ dependencies:
   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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.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
@@ -84,6 +112,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
 - lib/rails_rest_kit.rb
 - lib/rails_rest_kit/engine.rb
 - lib/rails_rest_kit/helpers/permitter_helper.rb