ibrain-core 0.1.8 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48487077f193996a5756c2c1e000b4ff5df6bd8e8364b557edcdfc0958a625aa
-  data.tar.gz: ab5e00f8d7c86202c0b13b53d808b26bb9cc60bbd7480e1ee0c012a3e4795df5
+  metadata.gz: 0accd0585dbb8b751342cfbeae014e22ef41b75b56bb3aba37f2071813307344
+  data.tar.gz: b5e922dea8ec2515d5ee390271d04e9ba879d88d0b629f54868420d46771386e
 SHA512:
-  metadata.gz: 869c5f04e5b7dd23aa84c4159909c63c9913e10dc4c3a1c2832d2a566fd8a2f5dfe52f1a10628695f64b6fdbe8a1d7fec955c38511868c592e6b48c99bb3b682
-  data.tar.gz: ccb1c397c1493b1d788af86f3dca9a368150165825e8ed82af04b06b481a96ed66e376ce3c3f53a6ce2a183f2bf80af83446a7b719d7a66b4e5d0a151251a2d5
+  metadata.gz: be6f2b3e72bdba22100743dfa74b99b001ab17f5c4ebf3cc4218ab776667fc3761ad7db01326de8ed4c0d9cf5362f35cf66bbde2260fc943e72327e81a8557b0
+  data.tar.gz: 47dd41b984584ca4e3bc820e9a07b18eafcbcd8312f5ccad9c03c322ca49ff56cc2bf43ac1d1360db61f87dca904cfb61edac157b6527ae94ce746e1224a2abf

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
@@ -13,14 +13,6 @@ module Ibrain
 
     protected
 
-    def operation_name
-      params[:operationName]
-    end
-
-    def skip_operations
-      %w[sign_in].include?(operation_name)
-    end
-
     def cryptor
       Ibrain::Encryptor.new
     end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Core
+    class GraphqlController < ::Ibrain::BaseController
+      include Devise::Controllers::ScopedViews
+
+      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::PermissionError.new("You not have permission to access #{type}.#{field}") }
     )
 
     # Union and Interface Resolution

data/app/graphql/ibrain/extentions/session_required.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Extentions
+    class SessionRequired < GraphQL::Schema::FieldExtension
+      def resolve(object:, arguments:, **rest)
+        raise ActionController::InvalidAuthenticityToken, I18n.t('ibrain.errors.session.invalid_session') if is_invalid_session(object)
+
+        # yield the current time as `memo`
+        yield(object, arguments, rest)
+      end
+
+      private
+
+      def is_invalid_session(object)
+        object.try(:contect).try(:fetch, :current_user, nil).blank? && options.try(:fetch, :session_required, false)
+      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/types/base_api_connection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Types
+    class BaseApiConnection < Types::BaseObject
+      # add `nodes` and `pageInfo` fields, as well as `edge_type(...)` and `node_nullable(...)` overrides
+      include GraphQL::Types::Relay::ConnectionBehaviors
+
+      field :total_count, Integer, null: false, camelize: false
+
+      def total_count
+        object.items.size
+      end
+    end
+  end
+end

data/app/graphql/ibrain/types/base_api_edge.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Types
+    class BaseApiEdge < Types::BaseObject
+      # add `node` and `cursor` fields, as well as `node_type(...)` override
+      include GraphQL::Types::Relay::EdgeBehaviors
+    end
+  end
+end

data/app/graphql/ibrain/types/base_api_field.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Types
+    class BaseApiField < GraphQL::Schema::Field
+      argument_class ::Ibrain::Types::BaseArgument
+
+      def initialize(*args, session_required: true, **kwargs, &block)
+        super(*args, camelize: false, **kwargs, &block)
+
+        extension(Ibrain::Extentions::SessionRequired, session_required: session_required) if session_required
+      end
+    end
+  end
+end

data/app/graphql/ibrain/types/base_api_object.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Types
+    class BaseApiObject < GraphQL::Schema::Object
+      include GraphQL::Relay::Node
+
+      edge_type_class(Ibrain::Types::BaseApiEdge)
+      connection_type_class(Ibrain::Types::BaseApiConnection)
+
+      field_class Ibrain::Types::BaseApiField
+    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/generators/ibrain/install/templates/graphql/types/mutation_type.rb.tt

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
 module Types
-  class MutationType < Ibrain::Types::BaseObject
+  class MutationType < Ibrain::Types::BaseApiObject
     description 'Define all mutation for client'
 
     # TODO: remove me
-    field :test_field, String, null: false,
+    # Default session_required is true, set false if yout want to skip authenticated
+    field :test_authenticated_field, , String, null: false,
                                description: 'An example field added by the generator'
+
+    field :test_field, String, null: false,
+                               description: 'An example field added by the generator', session_required: false
     def test_field
       'Hello World'
     end
+
+    def test_authenticated_field
+      'Im logged in!'
+    end
   end
 end

data/lib/generators/ibrain/install/templates/graphql/types/query_type.rb.tt

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Types
-  class QueryType < Ibrain::Types::BaseObject
+  class QueryType < Ibrain::Types::BaseApiObject
     description 'Define all resolver for client'
 
     # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
@@ -9,9 +9,11 @@ module Types
     include GraphQL::Types::Relay::HasNodesField
 
     # Add root-level fields here.
+    # Default session_required is true, set false if yout want to skip authenticated
     # They will be entry points for queries on your schema.
 
     # Example with user resolvers
-    # field :users, resolver: Resolvers::UsersResolver
+    # field :authenticated_users, resolver: Resolvers::UsersResolver
+    # field :users, resolver: Resolvers::UsersResolver, session_required: false
   end
 end

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.8"
+  VERSION = "0.2.2"
 
   def self.ibrain_version
     VERSION
   end
 
   def self.previous_ibrain_minor_version
-    '0.1.7'
+    '0.2.1'
   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.8
+  version: 0.2.2
 platform: ruby
 authors:
 - Tai Nguyen Van
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-session_store
@@ -183,9 +183,10 @@ 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/extentions/session_required.rb
 - app/graphql/ibrain/interfaces/base_interface.rb
 - app/graphql/ibrain/interfaces/person_interface.rb
 - app/graphql/ibrain/interfaces/record_interface.rb
@@ -198,6 +199,10 @@ files:
 - app/graphql/ibrain/resolvers/base_resolver.rb
 - app/graphql/ibrain/types/aggregate_type.rb
 - app/graphql/ibrain/types/attribute_type.rb
+- app/graphql/ibrain/types/base_api_connection.rb
+- app/graphql/ibrain/types/base_api_edge.rb
+- app/graphql/ibrain/types/base_api_field.rb
+- app/graphql/ibrain/types/base_api_object.rb
 - app/graphql/ibrain/types/base_argument.rb
 - app/graphql/ibrain/types/base_connection.rb
 - app/graphql/ibrain/types/base_edge.rb
@@ -207,7 +212,6 @@ files:
 - app/graphql/ibrain/types/base_interface.rb
 - app/graphql/ibrain/types/base_node.rb
 - app/graphql/ibrain/types/base_object.rb
-- app/graphql/ibrain/types/base_query_type.rb
 - app/graphql/ibrain/types/base_scalar.rb
 - app/graphql/ibrain/types/base_union.rb
 - app/graphql/ibrain/types/filter_type.rb

data/app/controllers/ibrain/graphql_controller.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Ibrain
-  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

data/app/graphql/ibrain/types/base_query_type.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Ibrain
-  module Types
-    class BaseQueryType < Types::BaseObject
-      # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
-      include GraphQL::Types::Relay::HasNodeField
-      include GraphQL::Types::Relay::HasNodesField
-
-      # Add root-level fields here.
-      # They will be entry points for queries on your schema.
-    end
-  end
-end