gearhead 0.1.0

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

@@ -0,0 +1,7 @@
+module Gearhead
+  module Serializers
+    module FastJsonapi
+      class InvalidRequestSerializer < ::Gearhead::Serializers::InvalidRequestSerializer; end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Gearhead
+  module Serializers
+    module FastJsonapi
+      class InvalidResourceSerializer < ::Gearhead::Serializers::InvalidResourceSerializer; end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Gearhead
+  module Serializers
+    module FastJsonapi
+      class ResourceSerializer
+        def self.for(page)
+          klass = Class.new
+          klass.include JSONAPI::Serializer
+          klass.set_type page.resource.model_name.singular_route_key.to_param
+          klass.attributes *(page._gear_attributes.presence || page.default_attributes)
+
+          klass
+        end
+      end
+    end
+  end
+end

data/lib/gearhead/serializers/invalid_request_serializer.rb

@@ -0,0 +1,24 @@
+module Gearhead
+  module Serializers
+    class InvalidRequestSerializer
+
+      def initialize(request, message, status)
+        @request = request
+        @message = message
+        @status = status
+      end
+
+      def as_json(options = nil)
+        {}.tap do |hash|
+          hash[:status] = @status
+          hash[:url] = @request.url
+          hash[:message] = @message
+        end
+      end
+
+      def to_json(options = nil)
+        as_json.to_json(options)
+      end
+    end
+  end
+end

data/lib/gearhead/serializers/invalid_resource_serializer.rb

@@ -0,0 +1,59 @@
+module Gearhead
+  module Serializers
+    class InvalidResourceSerializer
+      attr_reader :resource, :errors
+      alias_method :serializable_hash, :as_json
+      alias_method :serialized_json, :to_json
+
+      def initialize(resource, options = {})
+        @resource = resource
+        @errors = errors_for(resource).flatten
+      end
+
+      def id
+        resource.id.to_s
+      end
+
+      def type
+        resource.class.name.downcase
+      end
+
+      def serializable_hash(options = nil)
+        {}.tap do |hash|
+          hash[:id] = id if has_id?
+          hash[:type] = type if has_id?
+          hash[:errors] = errors
+        end
+      end
+
+      def serialized_json(options = nil)
+        serializable_hash.to_json(options)
+      end
+
+      private
+
+      def has_id?
+        @resource.respond_to?(:id)
+      end
+
+      def errors_for(resource)
+        resource.errors.messages.map do |field, errors|
+          build_hashes_for(field, errors)
+        end
+      end
+
+      def build_hashes_for(field, errors)
+        errors.map do |error_message|
+          build_hash_for(field, error_message)
+        end
+      end
+
+      def build_hash_for(field, error_message)
+        {}.tap do |hash|
+          hash[:source] = {pointer: "/data/attributes/#{field}"}
+          hash[:detail] = error_message
+        end
+      end
+    end
+  end
+end

data/lib/gearhead/serializers/lookup.rb

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

data/lib/gearhead/version.rb

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

data/lib/generators/gearhead/gear/gear_generator.rb

@@ -0,0 +1,14 @@
+module Gearhead
+  module Generators
+    class GearGenerator < Rails::Generators::NamedBase
+      desc "Registers resources with Gearhead"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def generate_config_file
+        template "gear.rb.erb", "app/gears/#{file_path.tr('/', '_').pluralize}_gear.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/gearhead/gear/templates/gear.rb.erb

@@ -0,0 +1,3 @@
+Gearhead.register <%= class_name %> do
+
+end

data/lib/generators/gearhead/install/install_generator.rb

@@ -0,0 +1,17 @@
+module Gearhead
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Installs Gearhead"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def generate_config_file
+        template "gearhead.rb.erb", "config/initializers/gearhead.rb"
+      end
+
+      def install_routes
+        inject_into_file "config/routes.rb", "\n  Gearbox.routes(self)", after: /Rails.application.routes.draw do/
+      end
+    end
+  end
+end

data/lib/generators/gearhead/install/templates/gearhead.rb.erb

@@ -0,0 +1,61 @@
+Gearhead.configure do |config|
+  # == Routing
+  #
+  # The endpoint in which to mount gearhead on.
+  # Default is "/gearhead" — must start with a slash, and have no trailing slash
+  # config.endpoint = "/api/v314"
+  #
+  # The default actions a Gear can respond to
+  # Default is [:index, :create, :show, :update, :destroy]
+  # config.actions = [:index, :show]
+  #
+
+  # == Querying
+  #
+  # The default scope of a Gear will be the default scope of the resource.
+  # Default is nil
+  # config.scope = :visible
+  #
+
+  # == Params
+  #
+  # Ignored params for creating/updating records
+  # Default is [:id, :created_at, :updated_at]
+  # config.ignored_params = [:id, :created_at, :updated_at]
+  #
+
+  # == Automount
+  #
+  # Change this to true if you want to automatically mount all your resources.
+  # config.automount.enabled = false
+  #
+  # Automatically mount most of your resources
+  # config.automount.resources = ['User', 'Post', 'Comment']
+  #
+  # Don't automatically mount these resources
+  # config.automount.excluded = ['User', 'Post']
+  #
+
+  # == Serialization
+  #
+  # Change the default serializer
+  # Currently supports FastJSONAPI (:fast_jsonapi) and ActiveModelSerializers (:active_model_serializers)
+  # Default is :fast_jsonapi
+  # config.serialization.adapter = :fast_jsonapi
+  #
+
+  # == Pagination
+  #
+  # Change the default paginator
+  # Currently supports :pagy and :will_paginate
+  # Default is :pagy
+  # config.pagination.adapter = :pagy
+  #
+
+  # == Controller
+  #
+  # Base class for the Gearhead controller
+  # Default is 'ApplicationController'
+  # config.base_controller = 'ApplicationController'
+  #
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: gearhead
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: better_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Description of Gearhead.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+- lib/gearhead/actions/show.rb
+- lib/gearhead/actions/update.rb
+- lib/gearhead/configuration.rb
+- lib/gearhead/engine.rb
+- lib/gearhead/extensions/actions.rb
+- lib/gearhead/extensions/associations.rb
+- lib/gearhead/extensions/attributes.rb
+- lib/gearhead/extensions/custom_actions.rb
+- lib/gearhead/extensions/enabled_actions.rb
+- lib/gearhead/extensions/finder.rb
+- lib/gearhead/extensions/pagination.rb
+- lib/gearhead/extensions/permitted_params.rb
+- lib/gearhead/extensions/querying.rb
+- lib/gearhead/extensions/scoping.rb
+- lib/gearhead/extensions/serialization.rb
+- lib/gearhead/gear.rb
+- lib/gearhead/gear_lookup.rb
+- lib/gearhead/gearbox.rb
+- lib/gearhead/paginators/lookup.rb
+- lib/gearhead/paginators/paginator.rb
+- lib/gearhead/paginators/pagy_paginator.rb
+- lib/gearhead/paginators/will_paginate_paginator.rb
+- lib/gearhead/params_builder.rb
+- lib/gearhead/registry.rb
+- lib/gearhead/resource_finder.rb
+- lib/gearhead/router.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/invalid_request_serializer.rb
+- lib/gearhead/serializers/fast_jsonapi/invalid_resource_serializer.rb
+- lib/gearhead/serializers/fast_jsonapi/resource_serializer.rb
+- lib/gearhead/serializers/invalid_request_serializer.rb
+- lib/gearhead/serializers/invalid_resource_serializer.rb
+- lib/gearhead/serializers/lookup.rb
+- lib/gearhead/version.rb
+- lib/generators/gearhead/gear/gear_generator.rb
+- lib/generators/gearhead/gear/templates/gear.rb.erb
+- lib/generators/gearhead/install/install_generator.rb
+- lib/generators/gearhead/install/templates/gearhead.rb.erb
+homepage: https://github.com/joshmn/gearhead
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Summary of Gearhead.
+test_files: []