ibrain-core 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57017a63ef4f94fba49be6f78fa18d5754bd81109f144995c44d8ff38a7c8bc0
-  data.tar.gz: 7204281494ec365f7528714301bf1fd7b2b40eff3f9e29e874207f8592c8fe33
+  metadata.gz: 5c262993dec17ae9595461851704d63d2db7c281c131e54694f804d935a2554e
+  data.tar.gz: 8a1500b6a3dc0e6ab6411335f85c7f5e197fb4f4166e87bf301c3c50a48611d8
 SHA512:
-  metadata.gz: 948449257443e847916a2281a7acd9c346579a800d98af65e2bad7e32cf3812b8b69ff768dc760b0d4fcf098c1eba412e674ec5b34b87fa6e3a75415d69df1c7
-  data.tar.gz: 33f5104110a2912405452c65829076ffb92b217835c2a1e9d0b4f7991c3577d35a739342a8e4e99215115f4af0dfcae73b6b3b32c491706432a00a68eee8a207
+  metadata.gz: e26db7af8481c6910d5a77a65c0c199da2464302ce412cbf13d682c25cfeac8d9fe15e27eb11def778b4ead1cd40cdb2060d76a9967f9a21f39c44711ce5acb4
+  data.tar.gz: 7b7681cc908112ae19e63e3abbec85824f86331ea91f966953b744f15564cac62f087a31b234dd4b4888cd62a2b5b8300b93546cf7d9ad9dae2ca75b55475ae6

data/README.md

@@ -54,20 +54,34 @@ bundle exec rails generate ibrain:graphql:resolvers users --model=User
 For pagination please using aggregate body query, something like
 ```
 query users($offset: Int, $limit: Int, $filter: Filter) {
-    users(offset: $offset, limit: $limit, filter: $filter) {
-        id
-        first_name
-    }
+	users(offset: $offset, limit: $limit, filter: $filter) {
+		id
+		first_name
+	}
 
-    users_aggregate(filter: $filter) {
-        total_count
-    }
+	users_aggregate(filter: $filter) {
+		total_count
+	}
 }
 ```
 To generate graphql mutation to insert, update, delete user
 ```bash
 bundle exec rails generate ibrain:graphql:mutation insert_user --model=User
 ```
+
+Default all operation will be rejected if you not have Authorization Token at request header, so to skip authenticate please change `parent_controller` at `ibrain.rb`
+```
+config.parent_controller = "<Your parent controller>"
+```
+then create method skip_operations at this parent_controller
+```
+class ApplicationController < BaseController::API
+	def skip_operations
+		%w[sign_in].include?(operation_name)
+	end
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/concerns/ibrain_handler.rb

@@ -12,6 +12,7 @@ module IbrainHandler
     rescue_from IbrainErrors::UnknownError, with: :bad_request_handler
     rescue_from ActionController::InvalidAuthenticityToken, with: :unauthorized_handler
     rescue_from ActiveSupport::MessageVerifier::InvalidSignature, with: :unauthorized_handler
+    rescue_from GraphQL::ExecutionError, with: :bad_request_handler
   end
 
   private

data/app/controllers/ibrain/base_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Ibrain
-  class BaseController < ActionController::API
+  class BaseController < Ibrain::Config.parent_controller.constantize
     include ActionController::Helpers
     include Ibrain::Core::ControllerHelpers::Response
     include Ibrain::Core::ControllerHelpers::StrongParameters
@@ -18,7 +18,7 @@ module Ibrain
     end
 
     def skip_operations
-      []
+      super || ['IntrospectionQuery'].include?(operation_name)
     end
 
     def cryptor

data/app/controllers/ibrain/core/graphql_controller.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Core
+    class GraphqlController < ::Ibrain::BaseController
+      include Devise::Controllers::ScopedViews
+
+      before_action :authenticate_user!, unless: :skip_operations
+      before_action :map_user_class_to_request
+
+      helpers = %w(resource scope_name resource_name signed_in_resource
+                   resource_class resource_params devise_mapping)
+      helper_method(*helpers)
+
+      def execute
+        query, variables, operation_name = normalize_entity
+
+        result = schema.execute(
+          query,
+          variables: variables,
+          context: {
+            session: session,
+            current_user: try_ibrain_current_user,
+            controller: self,
+            request: request
+          },
+          operation_name: operation_name
+        )
+
+        render_json_ok(result['data'], nil, result['errors'])
+      end
+
+      protected
+
+      def normalize_entity
+        query = params[:query]
+        operation_name = params[:operationName]
+        variables = prepare_variables(params[:variables])
+
+        [query, variables, operation_name]
+      end
+
+      # Handle variables in form data, JSON body, or a blank value
+      def prepare_variables(variables_param)
+        case variables_param
+        when String
+          if variables_param.present?
+            JSON.parse(variables_param) || {}
+          else
+            {}
+          end
+        when Hash
+          variables_param
+        when ActionController::Parameters
+          variables_param.to_unsafe_hash # GraphQLRuby will validate name and type of incoming variables.
+        when nil
+          {}
+        else
+          raise ArgumentError, "Unexpected parameter: #{variables_param}"
+        end
+      end
+
+      def schema
+        Ibrain::Config.graphql_schema.safe_constantize
+      end
+
+      def map_user_class_to_request
+        return if request.env['devise.mapping'].present?
+
+        request.env['devise.mapping'] = Ibrain.user_class
+      end
+    end
+  end
+end

data/app/graphql/ibrain/base_schema.rb

@@ -6,7 +6,7 @@ module Ibrain
 
     use GraphQL::Guard.new(
       policy_object: ::Ibrain::Config.graphql_policy.safe_constantize,
-      not_authorized: ->(type, field) { GraphQL::ExecutionError.new("Not authorized to access #{type}.#{field}") }
+      not_authorized: ->(type, field) { raise IbrainErrors::UnknownError.new("Not authorized to access #{type}.#{field}") }
     )
 
     # Union and Interface Resolution

data/app/graphql/ibrain/mutations/base_mutation.rb

@@ -30,6 +30,18 @@ module Ibrain
       def current_user
         context[:current_user]
       end
+
+      def controller
+        context[:controller]
+      end
+
+      def session
+        context[:session]
+      end
+
+      def request
+        context[:request]
+      end
     end
   end
 end

data/app/graphql/ibrain/policies/base_policy.rb

@@ -3,26 +3,32 @@
 module Ibrain
   module Policies
     class BasePolicy
-      IBRAIN_QUERY_RULES = {
-        '*': {
-          guard: ->(_obj, _args, _ctx) { true }
-        }
-      }
-
-      IBRAIN_MUTATION_RULES = {
-        '*': {
-          guard: ->(_obj, _args, ctx) { roles.include?(ctx[:current_user].try(:role)) }
-        }
-      }
-
-      RULES = {
-        'Query' => IBRAIN_QUERY_RULES,
-        'Mutation' => IBRAIN_MUTATION_RULES
-      }.freeze
-
       class << self
+        def query_rules
+          {
+            '*': {
+              guard: ->(_obj, _args, _ctx) { false }
+            }
+          }
+        end
+
+        def mutation_rules
+          {
+            '*': {
+              guard: ->(_obj, _args, _ctx) { false }
+            }
+          }
+        end
+
+        def rules
+          {
+            'Types::QueryType' => query_rules,
+            'Types::MutationType' => mutation_rules
+          }.freeze
+        end
+
         def roles
-          Ibrain::Config.ibrain_roles
+          Ibrain.user_class.roles.keys
         end
 
         def has_permission?(current_user, resource)
@@ -33,11 +39,11 @@ module Ibrain
         end
 
         def guard(type, field)
-          RULES.dig(type.name, field, :guard)
+          rules.dig(type.name, field, :guard)
         end
 
         def not_authorized_handler(type, field)
-          RULES.dig(type, field, :not_authorized) || RULES.dig(type, :*, :not_authorized)
+          rules.dig(type, field, :not_authorized) || rules.dig(type, :*, :not_authorized)
         end
       end
     end

data/app/graphql/ibrain/resolvers/base_resolver.rb

@@ -10,6 +10,10 @@ module Ibrain
       def current_user
         context.fetch(:current_user)
       end
+
+      def controller
+        context[:controller]
+      end
     end
   end
 end

data/app/models/ibrain/base.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-IGNORE_ATTRIBUTES = %w(id created_at updated_at)
-
 class Ibrain::Base < Ibrain::ApplicationRecord
   include ActionView::Helpers::DateHelper
 
+  IGNORE_ATTRIBUTES = %w(id created_at updated_at)
+
   self.abstract_class = true
 
   def string_id

data/config/routes.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
 Ibrain::Core::Engine.routes.draw do
-  if ::Ibrain::Config.api_version.blank?
-    post '/api/graphql', to: 'graphql#execute'
-  else
-    post "/api/#{::Ibrain::Config.api_version.downcase}/graphql", controller: 'graphql', action: 'execute'
-  end
+  match "/", controller: 'graphql', action: 'execute', via: [:options, :post]
 end

data/lib/generators/ibrain/graphql/templates/resolver.erb

@@ -7,7 +7,7 @@ module Resolvers
     # description
 
     # TODO: define return fields
-    type Types::Objects::<%= model_name.capitalize %>Type, null: false, description: 'Define data type will be response to client'
+    type Types::Objects::<%= model_name.capitalize %>Type, null: false
 
     argument :id, ID, required: false, description: 'TODO: describe about this argument'
 

data/lib/generators/ibrain/graphql/templates/resolvers.erb

@@ -7,7 +7,7 @@ module Resolvers
     # description
 
     # TODO: define return fields
-    type [Types::Objects::<%= model_name.capitalize %>Type], null: false, description: 'Define data type will be response to client'
+    type [Types::Objects::<%= model_name.capitalize %>Type], null: false
 
     # TODO: define resolve method
     def resolve(args)

data/lib/generators/ibrain/install/templates/config/initializers/ibrain.rb.tt

@@ -41,6 +41,9 @@ Ibrain.config do |config|
 
   # Graphql Encryptor key
   # config.ibrain_encryptor_key = Rails.application.secrets.secret_key_base.byteslice(0..31)
+
+  # Parent controller
+  # config.parent_controller = 'ActionController::API'
 end
 
 <% if defined?(Ibrain::Api::Engine) -%>

data/lib/ibrain/app_configuration.rb

@@ -48,6 +48,9 @@ module Ibrain
     # Graphql Encryptor key
     preference :ibrain_encryptor_key, :string, default: nil
 
+    # Parent controller
+    preference :parent_controller, :string, default: 'ActionController::API'
+
     def static_model_preferences
       @static_model_preferences ||= Ibrain::Preferences::StaticModelPreferences.new
     end

data/lib/ibrain/core/controller_helpers/response.rb

@@ -16,6 +16,7 @@ module Ibrain
         def render_json_error(error, status)
           e_message = error.try(:record).try(:errors).try(:full_messages).try(:first)
           e_message = error.try(:message) if e_message.blank?
+          e_message = error.try(:details) if e_message.blank?
 
           backtrace = error.try(:backtrace).try(:join, "\n")
 

data/lib/ibrain/core/engine.rb

@@ -5,7 +5,7 @@ require 'ibrain/config'
 module Ibrain
   module Core
     class Engine < ::Rails::Engine
-      isolate_namespace Ibrain
+      isolate_namespace Ibrain::Core
       config.generators.api_only = true
 
       initializer "ibrain.environment", before: :load_config_initializers do |app|

data/lib/ibrain/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Ibrain
-  VERSION = "0.1.7"
+  VERSION = "0.2.1"
 
   def self.ibrain_version
     VERSION
   end
 
   def self.previous_ibrain_minor_version
-    '0.1.6'
+    '0.2.0'
   end
 
   def self.ibrain_gem_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibrain-core
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Tai Nguyen Van
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-session_store
@@ -183,7 +183,7 @@ files:
 - app/controllers/concerns/ibrain_errors.rb
 - app/controllers/concerns/ibrain_handler.rb
 - app/controllers/ibrain/base_controller.rb
-- app/controllers/ibrain/graphql_controller.rb
+- app/controllers/ibrain/core/graphql_controller.rb
 - app/graphql/ibrain/base_schema.rb
 - app/graphql/ibrain/extentions/default_value.rb
 - app/graphql/ibrain/interfaces/base_interface.rb

data/app/controllers/ibrain/graphql_controller.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Ibrain
-  class GraphqlController < Ibrain::BaseController
-    def execute
-      query, variables, operation_name = normalize_entity
-
-      result = schema.execute(
-        query,
-        variables: variables,
-        context: {
-          session: session,
-          current_user: try_ibrain_current_user
-        },
-        operation_name: operation_name
-      )
-
-      render_json_ok(result['data'], nil, result['errors'])
-    end
-
-    protected
-
-    def normalize_entity
-      query = params[:query]
-      operation_name = params[:operationName]
-      variables = prepare_variables(params[:variables])
-
-      [query, variables, operation_name]
-    end
-
-    # Handle variables in form data, JSON body, or a blank value
-    def prepare_variables(variables_param)
-      case variables_param
-      when String
-        if variables_param.present?
-          JSON.parse(variables_param) || {}
-        else
-          {}
-        end
-      when Hash
-        variables_param
-      when ActionController::Parameters
-        variables_param.to_unsafe_hash # GraphQLRuby will validate name and type of incoming variables.
-      when nil
-        {}
-      else
-        raise ArgumentError, "Unexpected parameter: #{variables_param}"
-      end
-    end
-
-    def schema
-      Ibrain::Config.graphql_schema.safe_constantize
-    end
-  end
-end