graphiti-rails 0.2.0

data/lib/graphiti/rails/context.rb

@@ -0,0 +1,33 @@
+module Graphiti
+  module Rails
+    # Wraps controller actions in a [Graphiti Context](https://www.graphiti.dev/guides/concepts/resources#context) which points to the
+    # controller instance by default.
+    module Context
+      def self.included(klass)
+        klass.class_eval do
+          include Graphiti::Context
+          around_action :wrap_graphiti_context
+        end
+      end
+
+      # Called by [`#around_action`](https://api.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-around_action)
+      # to wrap the current action in a Graphiti context defined by {#graphiti_context}.
+      def wrap_graphiti_context
+        Graphiti.with_context(graphiti_context, action_name.to_sym) do
+          yield
+        end
+      end
+
+      # The context to use for Graphiti Resources. Defaults to the controller instance.
+      # Can be redefined for different behavior.
+      def graphiti_context
+        if respond_to?(:jsonapi_context)
+          DEPRECATOR.deprecation_warning("Overriding jsonapi_context", "Override #graphiti_context instead")
+          jsonapi_context
+        else
+          self
+        end
+      end
+    end
+  end
+end

data/lib/graphiti/rails/debugging.rb

@@ -0,0 +1,18 @@
+module Graphiti
+  module Rails
+    # Wraps controller actions in a [Graphiti Debugger](https://www.graphiti.dev/guides/concepts/debugging#debugger).
+    module Debugging
+      def self.included(klass)
+        klass.around_action :debug_graphiti
+      end
+
+      # Called by [`#around_action`](https://api.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-around_action)
+      # to wrap the current action in a Graphiti Debugger.
+      def debug_graphiti
+        Debugger.debug do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/graphiti/rails/exception_handlers.rb

@@ -0,0 +1,83 @@
+module Graphiti
+  module Rails
+    class ExceptionHandler < RescueRegistry::ExceptionHandler
+      # We've actually changed the signature here which is somewhat risky...
+      def build_payload(show_details: false, traces: nil, style: :rails)
+        case style
+        when :standard
+          super(show_details: show_details, traces: traces)
+        when :rails
+          # TODO: Find way to not duplicate RailsExceptionHandler
+          body = {
+            status: status_code,
+            error:  title
+          }
+
+          if show_details
+            body[:exception] = exception.inspect
+            if traces
+              body[:traces] = traces
+            end
+          end
+
+          body
+        else
+          raise ArgumentError, "unknown style #{style}"
+        end
+      end
+
+      def formatted_response(content_type, **options)
+        # We're relying on the fact that `formatted_response` passes through unknown options to `build_payload`
+        if Graphiti::Rails.handled_exception_formats.include?(content_type.to_sym)
+          options[:style] = :standard
+        end
+        super
+      end
+    end
+
+    class FallbackHandler < ExceptionHandler
+      def formatted_response(content_type, **options)
+        if Graphiti::Rails.handled_exception_formats.include?(content_type.to_sym)
+          super
+        else
+          # The nil response will cause the default Rails handler to be used
+          nil
+        end
+      end
+    end
+
+    class InvalidRequestHandler < ExceptionHandler
+      # Mostly copied from GraphitiErrors could use some cleanup
+      # NOTE: That `style` is ignored
+      def build_payload(show_details: false, traces: nil, style: nil)
+        errors = exception.errors
+
+        errors_payload = []
+        errors.details.each_pair do |attribute, att_errors|
+          att_errors.each_with_index do |error, idx|
+            code = error[:error]
+            message = errors.messages[attribute][idx]
+
+            errors_payload << {
+              code: "bad_request",
+              status: "400",
+              title: "Request Error",
+              detail: errors.full_message(attribute, message),
+              source: {
+                pointer: attribute.to_s.tr(".", "/").gsub(/\[(\d+)\]/, '/\1'),
+              },
+              meta: {
+                attribute: attribute,
+                message: message,
+                code: code,
+              },
+            }
+          end
+        end
+
+        { errors: errors_payload }
+      end
+    end
+  end
+end
+

data/lib/graphiti/rails/graphiti_errors_testing.rb

@@ -0,0 +1,20 @@
+module Graphiti
+  module Rails
+    module GraphitiErrorsTesting
+      include RescueRegistry::RailsTestHelpers
+
+      def enable!
+        DEPRECATOR.deprecation_warning("GraphitiError.enable! in tests", "This method may cause leaked behavior between tests! Wrap in Graphiti::Rails::TestHelpers#handle_request_exceptions instead.")
+        super
+        handle_request_exceptions(true)
+      end
+
+      def disable!
+        DEPRECATOR.deprecation_warning("GraphitiError.disable! in tests", "This method may cause leaked behavior between tests! Wrap in Graphiti::Rails::TestHelpers#handle_request_exceptions instead. Note that exceptions are no longer caught by default during testing.")
+        handle_request_exceptions(false)
+      ensure
+        super
+      end
+    end
+  end
+end

data/lib/graphiti/rails/railtie.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Graphiti
+  module Rails
+    # This Railtie exposes some configuration options:
+    # * `config.graphiti.handled_exception_formats`, defaulting to `[:jsonapi]`.
+    #   Formats in this list will always have their exceptions handled by Graphiti.
+    # * `config.graphiti.respond_to_formats`, defaulting to `[:json, :jsonapi, :xml]`.
+    #   When {Graphiti::Rails::Responders} is included in a controller it will respond
+    #   to these mime types by default.
+    class Railtie < ::Rails::Railtie
+      config.graphiti = ActiveSupport::OrderedOptions.new
+
+      config.graphiti.handled_exception_formats = [:jsonapi]
+
+      old_respond_to_formats = Graphiti::DEPRECATOR.silence { Graphiti.config.try(:respond_to) }
+      config.graphiti.respond_to_formats = old_respond_to_formats || [:json, :jsonapi, :xml]
+
+      rake_tasks do
+        load File.expand_path("../../tasks/graphiti.rake", __dir__)
+      end
+
+      initializer "graphiti-rails.config" do |app|
+        Graphiti::Rails.handled_exception_formats = app.config.graphiti.handled_exception_formats
+        Graphiti::Rails.respond_to_formats = app.config.graphiti.respond_to_formats
+
+        root = ::Rails.root
+
+        config_file = root.join(".graphiticfg.yml")
+        if config_file.exist?
+          cfg = YAML.load_file(config_file)
+          Graphiti.config.schema_path = root.join("public#{cfg["namespace"]}/schema.json")
+        else
+          Graphiti.config.schema_path = root.join("public/schema.json")
+        end
+      end
+
+      initializer "graphti-rails.logger" do
+        config.after_initialize do
+          Graphiti.config.debug = ::Rails.logger.level.zero?
+          Graphiti.logger = ::Rails.logger
+        end
+      end
+
+      initializer "graphiti-rails.init" do
+        if ::Rails.application.config.eager_load
+          config.after_initialize do |app|
+            ::Rails.application.reload_routes!
+            Graphiti.setup!
+          end
+        end
+
+        register_mime_type
+        register_parameter_parser
+        register_renderers
+        establish_concurrency
+        configure_endpoint_lookup
+      end
+
+      # from jsonapi-rails
+      MEDIA_TYPE = 'application/vnd.api+json'.freeze
+
+      PARSER = lambda do |body|
+        data = JSON.parse(body)
+        data[:format] = :jsonapi
+        data.with_indifferent_access
+      end
+
+      def register_mime_type
+        Mime::Type.register(MEDIA_TYPE, :jsonapi)
+      end
+
+      def register_parameter_parser
+        if ::Rails::VERSION::MAJOR >= 5
+          ActionDispatch::Request.parameter_parsers[:jsonapi] = PARSER
+        else
+          ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
+        end
+      end
+
+      def register_renderers
+        ActiveSupport.on_load(:action_controller) do
+          ::ActionController::Renderers.add(:jsonapi) do |proxy, options|
+            self.content_type ||= Mime[:jsonapi]
+
+            # opts = {}
+            # if respond_to?(:default_jsonapi_render_options)
+            #   opts = default_jsonapi_render_options
+            # end
+
+            if proxy.is_a?(Hash) # for destroy
+              render(options.merge(json: proxy))
+            else
+              proxy.to_jsonapi(options)
+            end
+          end
+        end
+
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Renderers.add(:jsonapi_errors) do |proxy, options|
+            self.content_type ||= Mime[:jsonapi]
+
+            validation = GraphitiErrors::Validation::Serializer.new \
+              proxy.data, proxy.payload.relationships
+
+            render \
+              json: {errors: validation.errors},
+              status: :unprocessable_entity
+          end
+        end
+      end
+
+      # Only run concurrently if our environment supports it
+      def establish_concurrency
+        Graphiti.config.concurrency = !::Rails.env.test? &&
+          ::Rails.application.config.cache_classes
+      end
+
+      def configure_endpoint_lookup
+        Graphiti.config.context_for_endpoint = ->(path, action) {
+          method = :GET
+          case action
+            when :show then path = "#{path}/1"
+            when :create then method = :POST
+            when :update
+              path = "#{path}/1"
+              method = :PUT
+            when :destroy
+              path = "#{path}/1"
+              method = :DELETE
+          end
+
+          route = begin
+                    ::Rails.application.routes.recognize_path(path, method: method)
+                  rescue
+                    nil
+                  end
+          "#{route[:controller]}_controller".classify.safe_constantize if route
+        }
+      end
+    end
+  end
+end

data/lib/graphiti/rails/responders.rb

@@ -0,0 +1,21 @@
+# For use with the `responders` gem responders gem to get respond_with
+module Graphiti
+  module Rails
+    module Responders
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+        respond_to(*Graphiti::Rails.respond_to_formats)
+      end
+
+      # Override to avoid location url generation (for now)
+      def respond_with(*args, &blk)
+        opts = args.extract_options!
+        opts[:location] = nil
+        args << opts
+        super(*args, &blk)
+      end
+    end
+  end
+end

data/lib/graphiti/rails/test_helpers.rb

@@ -0,0 +1,7 @@
+module Graphiti
+  module Rails
+    module TestHelpers
+      include RescueRegistry::RailsTestHelpers
+    end
+  end
+end

data/lib/graphiti/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Graphiti
+  module Rails
+    VERSION = '0.2.0'
+  end
+end

data/lib/tasks/graphiti.rake

@@ -0,0 +1,53 @@
+namespace :graphiti do
+  include RescueRegistry::RailsTestHelpers
+
+  def session
+    @session ||= ActionDispatch::Integration::Session.new(Rails.application)
+  end
+
+  def setup_rails!
+    Rails.application.eager_load!
+    Rails.application.config.cache_classes = true
+    Rails.application.config.action_controller.perform_caching = false
+  end
+
+  def make_request(path, debug = false)
+    if path.split("/").length == 2
+      path = "#{ApplicationResource.endpoint_namespace}#{path}"
+    end
+    path << if path.include?("?")
+      "&cache=bust"
+    else
+      "?cache=bust"
+    end
+    path = "#{path}&debug=true" if debug
+    handle_request_exceptions do
+      session.get(path.to_s)
+    end
+    JSON.parse(session.response.body)
+  end
+
+  desc "Execute request without web server."
+  task :request, [:path, :debug] => [:environment] do |_, args|
+    setup_rails!
+    Graphiti.logger = Graphiti.stdout_logger
+    Graphiti::Debugger.preserve = true
+    require "pp"
+    path, debug = args[:path], args[:debug]
+    puts "Graphiti Request: #{path}"
+    json = make_request(path, debug)
+    pp json
+    Graphiti::Debugger.flush if debug
+  end
+
+  desc "Execute benchmark without web server."
+  task :benchmark, [:path, :requests] => [:environment] do |_, args|
+    setup_rails!
+    took = Benchmark.ms {
+      args[:requests].to_i.times do
+        make_request(args[:path])
+      end
+    }
+    puts "Took: #{(took / args[:requests].to_f).round(2)}ms"
+  end
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: graphiti-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Peter Wagenet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphiti
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rescue_registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: graphiti_spec_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: factory_bot
+  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: responders
+  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: yard
+  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: kramdown-parser-gfm
+  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: rouge
+  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'
+description: 
+email:
+- peter.wagenet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/graphiti/api_test_generator.rb
+- lib/generators/graphiti/generator_mixin.rb
+- lib/generators/graphiti/install_generator.rb
+- lib/generators/graphiti/resource_generator.rb
+- lib/generators/graphiti/resource_test_generator.rb
+- lib/generators/graphiti/templates/application_resource.rb.erb
+- lib/generators/graphiti/templates/controller.rb.erb
+- lib/generators/graphiti/templates/create_request_spec.rb.erb
+- lib/generators/graphiti/templates/destroy_request_spec.rb.erb
+- lib/generators/graphiti/templates/index_request_spec.rb.erb
+- lib/generators/graphiti/templates/resource.rb.erb
+- lib/generators/graphiti/templates/resource_reads_spec.rb.erb
+- lib/generators/graphiti/templates/resource_writes_spec.rb.erb
+- lib/generators/graphiti/templates/show_request_spec.rb.erb
+- lib/generators/graphiti/templates/update_request_spec.rb.erb
+- lib/graphiti-rails.rb
+- lib/graphiti/rails.rb
+- lib/graphiti/rails/context.rb
+- lib/graphiti/rails/debugging.rb
+- lib/graphiti/rails/exception_handlers.rb
+- lib/graphiti/rails/graphiti_errors_testing.rb
+- lib/graphiti/rails/railtie.rb
+- lib/graphiti/rails/responders.rb
+- lib/graphiti/rails/test_helpers.rb
+- lib/graphiti/rails/version.rb
+- lib/tasks/graphiti.rake
+homepage: https://www.graphiti.dev
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/graphiti-api/graphiti-rails/issues
+  changelog_uri: https://github.com/graphiti-api/graphiti-rails/CHANGELOG.md
+  source_code_uri: https://github.com/graphiti-api/graphiti-rails
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Rails integration for Graphiti
+test_files: []