gearhead 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2840550719a44e41f271d9dd420ac4c848f5a914214e1125ccae0db63f0e460
-  data.tar.gz: 4efb4442da94ebdd53b4d55d865866cdf516315906ed7df74c090f46b8071db0
+  metadata.gz: 8da15acd51e6492411698015103ce3dc8f35e47f9c209b65624aa5d74d876141
+  data.tar.gz: 1f13b739558ced09c7b145c0e00a40557a07437b1e058ccc76074889cb242d2c
 SHA512:
-  metadata.gz: 5c0c1f1fa96578021c7e52653f689442a35f840f5e883f69ac0fc0f1a07fcb8fdc7efbd9b9857a30ea457c59860cb38806678678d67c088a7b2d3c5dcac00e37
-  data.tar.gz: bdc1d6d0d3b5b93f8fbf7c727a80141720036960d3d162475e04b3ebbbdd29e79e5b0a2f74fe05550f06608fe0c797fc0744465e1a81ddcc4243a93c494c65f6
+  metadata.gz: b4257c5b8dbf26a9c5b306f07ba1ca20f37fa3c6bc56ff75424067a67aaa98a1473ee6f37c28bb5908d8c73849cbe6d988d6bc82da9d3a0cd60a75001f869899
+  data.tar.gz: 15167236c5ecb3bf004650d12ace55a98548f678471cfd371688377357cdd72c656d431b37c6cde9221031e167133125e92226190aef4b52eb9e964f31ab2aa5

data/README.md

@@ -1,6 +1,11 @@
-# Gearhead test application
+# Gearhead
 
-Gearhead turns your database into a RESTful API. It's like if ActiveAdmin and Grape had a baby.
+Gearhead turns your database into a RESTful API. It's like if ActiveAdmin, InheritedResources, and Grape had a baby.
+
+## Purpose
+
+For internal projects I was always standing up API endpoints that were separate from my regular controllers. The boilerplate 
+got old real fast. This eliminates boilerplate and leaves enough configuration for you to make it your own.
 
 ## Installation
 
@@ -28,7 +33,7 @@ app/gears/.keep
 and modifies your routes:
 
 ```ruby
-Gearbox.routes(self)
+Gearhead.routes(self)
 ```
 
 ## Configuration
@@ -177,10 +182,22 @@ Just define what attributes you want exposed:
 
 ```ruby 
 Gearhead.register Post do 
-  attributes :id, :name
+  attributes :id, :title
 end
 ```
 
+And customize one-off attributes:
+
+```ruby 
+Gearhead.register Post do 
+  attributes :id, :title
+
+  attribute :excerpt do |resource|
+    resource.content.first(100)
+  end
+end 
+```
+
 ### Finding resources
 
 Change your finder:
@@ -193,6 +210,12 @@ Gearhead.register Post do
 end
 ```
 
+### Querying 
+
+Uses Ransack under the hood. Just send the normal `q` in the query, like:
+
+`GET /gearhead/posts?q[user_id]=1`
+
 ### Permitting params
 
 Works just like the params you're used to:

data/lib/gearhead/actions/index.rb

@@ -21,7 +21,7 @@ module Gearhead
         @collection = apply_query
         @collection = apply_pagination
         @collection = apply_serializer
-        @collection
+        @collection.to_json
       end
 
       private
@@ -70,7 +70,7 @@ module Gearhead
       end
 
       def apply_serializer
-        @gear.serializer_class.new(@collection, serialization_options)
+        @gear.collection_serializer.for(@collection, @gear.serializer_class, serialization_options)
       end
 
       def serialization_options

data/lib/gearhead/engine.rb

@@ -6,5 +6,7 @@ module Gearhead
       end
       Rails.autoloaders.main.ignore(Rails.root.join('app/gears'))
     end
+
+    paths["app/controllers"] = "lib"
   end
 end

data/lib/gearhead/extensions/attributes.rb

@@ -2,6 +2,7 @@ module Gearhead
   module Extensions
     module Attributes
       def self.included(klass)
+        klass.define_gear_setting :custom_attributes, []
       end
 
       def _gear_attributes
@@ -15,6 +16,10 @@ module Gearhead
       def default_attributes
         @resource.columns_hash.keys.map(&:to_sym)
       end
+
+      def attribute(name, &block)
+        @_gear_custom_attributes << [name, block]
+      end
     end
   end
 end

data/lib/gearhead/extensions/serialization.rb

@@ -2,6 +2,11 @@ module Gearhead
   module Extensions
     module Serialization
       def self.included(klass)
+        klass.define_gear_setting :serializer_adapter, Gearhead.config.serialization.adapter
+      end
+
+      def serializer_adapter(adapter)
+        @_gear_serializer_adapter = adapter
       end
 
       def serializer(klass)
@@ -9,13 +14,17 @@ module Gearhead
       end
 
       def serializer_class
-        real_serializer = Serializers::Lookup.for(:resource)
+        real_serializer = Serializers::Lookup.for(:resource, @_gear_serializer_adapter)
         if real_serializer.respond_to?(:for)
           real_serializer.for(self)
         else
           real_serializer
         end
       end
+
+      def collection_serializer
+        Serializers::Lookup.for(:collection, @_gear_serializer_adapter)
+      end
     end
   end
 end

data/lib/gearhead/gearbox.rb

@@ -1,11 +1,8 @@
 module Gearhead
   class Gearbox
-    def initialize
-    end
+    def initialize; end
 
-    def setup!
-      # nothing
-    end
+    def setup!; end
 
     def prepare!
       ActiveSupport::Dependencies.autoload_paths -= load_paths
@@ -54,7 +51,7 @@ module Gearhead
         unload_gearhead = -> { Gearhead.gearbox.unload! }
 
         if app.config.reload_classes_only_on_change
-           ActiveSupport::Reloader.to_prepare(prepend: true, &unload_gearhead)
+          ActiveSupport::Reloader.to_prepare(prepend: true, &unload_gearhead)
         else
           ActiveSupport::Reloader.to_complete(&unload_gearhead)
         end
@@ -72,9 +69,9 @@ module Gearhead
         app.reloaders << routes_reloader
 
         ActiveSupport::Reloader.to_prepare do
-           unless Gearhead.gearbox.loaded?
+          unless Gearhead.gearbox.loaded?
             routes_reloader.execute_if_updated
-            Gearhead.application.load!
+            Gearhead.gearbox.load!
           end
         end
       end

data/{app/controllers → lib}/gearhead/gears_controller.rb

@@ -1,16 +1,14 @@
-# todo:
-if defined?(ActiveModelSerializers)
-  ActiveModelSerializers.config.serializer_lookup_enabled = false
-end
+# frozen_string_literal: true
 
+ActiveModelSerializers.config.serializer_lookup_enabled = false
 module Gearhead
   class GearsController < ::Gearhead.config.base_controller.constantize
     before_action :find_gear!
-    before_action :ensure_action_enabled!, only: [:index, :create, :show, :update, :destroy]
-    before_action :find_resource!, except: [:index, :create, :collection_action]
+    before_action :ensure_action_enabled!, only: %i[index create show update destroy]
+    before_action :find_resource!, except: %i[index create collection_action]
 
     def index
-      render json: Gearhead::Actions::Index.build(@gear, request), adapter: false
+      render json: Gearhead::Actions::Index.build(@gear, request)
     end
 
     def create
@@ -18,7 +16,7 @@ module Gearhead
       if @resource.save
         render json: @gear.serializer_class.new(@resource)
       else
-        render json: { errors: @resource.errors }
+        render json: { errors: @resource.errors }, status: :unprocessable_entity
       end
     end
 
@@ -32,7 +30,7 @@ module Gearhead
       if @resource.save
         render json: @gear.serializer_class.new(@resource)
       else
-        render json: { errors: @resource.errors }
+        render json: { errors: @resource.errors }, status: :unprocessable_entity
       end
     end
 
@@ -40,21 +38,21 @@ module Gearhead
       if @resource.destroy
         render json: @gear.serializer_class.new(resource)
       else
-        render json: { errors: resource.errors }
+        render json: { errors: @resource.errors }, status: :unprocessable_entity
       end
     end
 
     def member_action
       action = @gear._gear_member_actions[params[:member_action].to_sym]
-      if action && action.verbs.include?(request.request_method.to_sym.downcase)
-        return render json: instance_exec(&action.block)
+      if action&.verbs&.include?(request.request_method.to_sym.downcase)
+        render json: instance_exec(&action.block)
       end
     end
 
     def collection_action
       action = @gear._gear_collection_actions[params[:collection_action]]
-      if action && action.verbs.include?(request.request_method.to_sym.downcase)
-        return render json: instance_exec(&action.block)
+      if action&.verbs&.include?(request.request_method.to_sym.downcase)
+        render json: instance_exec(&action.block)
       end
     end
 
@@ -64,35 +62,31 @@ module Gearhead
       @gear = Gearhead.gear_for(request)
       return @gear if @gear
 
-      if @gear.nil?
-        error!("Can't find or infer gear.", 404)
-      end
-      if @gear == false
-        error!("Gear already mounted somewhere else.", 500)
-      end
+      error!("Can't find or infer gear.", 404) if @gear.nil?
+      error!('Gear already mounted somewhere else.', 500) if @gear == false
     end
 
     # remember that request method is from rack so GET/POST/etc.
     def check_collection_actions!
       action = @gear._gear_collection_actions[request.request_method][params[:resource_id].to_sym]
-      if action
-        return render json: instance_exec(&action)
-      end
+      return render json: instance_exec(&action) if action
     end
 
     def find_resource!
       @resource = ::Gearhead::ResourceFinder.for(@gear, params)
-      error!("#{@gear.resource.name} not found for #{@gear._gear_param_key} #{params[:resource_id]}") if @resource.nil?
+      if @resource.nil?
+        error!("#{@gear.resource.name} not found for #{@gear._gear_param_key} #{params[:resource_id]}")
+      end
     end
 
     def ensure_action_enabled!
       unless @gear.action_enabled?(action_name.to_sym)
-        error!("Action not allowed for #{@gear.resource.name}##{action_name}", 405)
+        error!("Action not allowed for #{@gear.resource.name}##{action_name}", :method_not_allowed)
       end
     end
 
     def error!(msg, code = 400)
-      render json: Serializers::Lookup.for(:invalid_request).new(request, msg, code), serializer: nil
+      render json: Serializers::Lookup.for(:invalid_request).new(request, msg, code)
     end
   end
 end

data/lib/gearhead/serializers/active_model_serializers/collection_serializer.rb

@@ -0,0 +1,12 @@
+module Gearhead
+  module Serializers
+    module ActiveModelSerializers
+      class CollectionSerializer
+        def self.for(records, serializer, options = {})
+          options[:each_serializer] = serializer
+          ::ActiveModelSerializers::SerializableResource.new(records, options)
+        end
+      end
+    end
+  end
+end

data/lib/gearhead/serializers/active_model_serializers/resource_serializer.rb

@@ -3,10 +3,16 @@ module Gearhead
     module ActiveModelSerializers
       class ResourceSerializer
         def self.for(page)
-          if defined?(ActiveModelSerializers::Serializer)
-            klass = Class.new(ActiveModelSerializers::Serializer)
+          if defined?(ActiveModel::Serializer)
+            klass = Class.new(ActiveModel::Serializer)
             klass.attributes *(page._gear_attributes.presence || page.default_attributes)
 
+            page._gear_custom_attributes.each do |attr, block|
+              klass.attribute attr do |klass|
+                block.call(klass.object)
+              end
+            end
+
             klass
           end
         end

data/lib/gearhead/serializers/fast_jsonapi/collection_serializer.rb

@@ -0,0 +1,11 @@
+module Gearhead
+  module Serializers
+    module ActiveModelSerializers
+      class CollectionSerializer
+        def self.for(records, serializer, options = {})
+          serializer.new(records, options)
+        end
+      end
+    end
+  end
+end

data/lib/gearhead/serializers/fast_jsonapi/resource_serializer.rb

@@ -8,6 +8,12 @@ module Gearhead
           klass.set_type page.resource.model_name.singular_route_key.to_param
           klass.attributes *(page._gear_attributes.presence || page.default_attributes)
 
+          page._gear_custom_attributes.each do |attr, block|
+            klass.attribute attr do |object|
+              block.call(object)
+            end
+          end
+
           klass
         end
       end

data/lib/gearhead/serializers/lookup.rb

@@ -1,26 +1,24 @@
 module Gearhead
   module Serializers
     class Lookup
-      def self.for(action)
-        new(action).serializer
+      def self.for(type, adapter_name = ::Gearhead.config.serialization.adapter)
+        new(type, adapter_name).serializer
       end
 
-      def initialize(action)
-        @action = action.to_s
+      attr_reader :adapter_name
+      def initialize(type, adapter_name)
+        @type = type.to_s
+        @adapter_name = adapter_name
       end
 
       def serializer
-        "::Gearhead::Serializers::#{adapter}::#{@action.classify}Serializer".constantize
+        "::Gearhead::Serializers::#{adapter}::#{@type.classify}Serializer".constantize
       end
 
       private
 
-      def adapter_name
-        ::Gearhead.config.serialization.adapter
-      end
-
       def adapter
-        adapter_name.to_s.classify
+        adapter_name.to_s.camelcase
       end
     end
   end

data/lib/gearhead/version.rb

@@ -1,3 +1,3 @@
 module Gearhead
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gearhead
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,28 +148,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -194,9 +194,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/controllers/gearhead/application_controller.rb
-- app/controllers/gearhead/gears_controller.rb
-- config/routes.rb
 - lib/gearhead.rb
 - lib/gearhead/actions/create.rb
 - lib/gearhead/actions/index.rb
@@ -218,6 +215,7 @@ files:
 - lib/gearhead/gear.rb
 - lib/gearhead/gear_lookup.rb
 - lib/gearhead/gearbox.rb
+- lib/gearhead/gears_controller.rb
 - lib/gearhead/paginators/lookup.rb
 - lib/gearhead/paginators/paginator.rb
 - lib/gearhead/paginators/pagy_paginator.rb
@@ -226,9 +224,11 @@ files:
 - lib/gearhead/registry.rb
 - lib/gearhead/resource_finder.rb
 - lib/gearhead/router.rb
+- lib/gearhead/serializers/active_model_serializers/collection_serializer.rb
 - lib/gearhead/serializers/active_model_serializers/invalid_request_serializer.rb
 - lib/gearhead/serializers/active_model_serializers/invalid_resource_serializer.rb
 - lib/gearhead/serializers/active_model_serializers/resource_serializer.rb
+- lib/gearhead/serializers/fast_jsonapi/collection_serializer.rb
 - lib/gearhead/serializers/fast_jsonapi/invalid_request_serializer.rb
 - lib/gearhead/serializers/fast_jsonapi/invalid_resource_serializer.rb
 - lib/gearhead/serializers/fast_jsonapi/resource_serializer.rb

data/app/controllers/gearhead/application_controller.rb

@@ -1,5 +0,0 @@
-module Gearhead
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
-  end
-end

data/config/routes.rb

@@ -1,9 +0,0 @@
-Gearhead::Engine.routes.draw do
-  scope module: :gearhead do
-    # resources :gears, path: ':resource_class', param: :resource_id do
-    #  member do
-    #    match ':member_action' => 'gears#member_action', via: :all
-    #  end
-    # end
-  end
-end