ibrain-core 0.1.9 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 197d83360e5b4281c1580976c1e5fc56617cfbc62cb19771935c4e1d11eded46
-  data.tar.gz: 824c0ca8095c991c4ce31dac6e6fbad27ac48f8ab6855bb4165de78bf9cb7b29
+  metadata.gz: 9c01fb318f3aa91812d1bfa1e71f956260a51929f05bfe5a6ae642149f8219ba
+  data.tar.gz: d15d09f9e9b6761d2ab5424a04b1c12185898493034683a5394a482041e59f73
 SHA512:
-  metadata.gz: f17faebbf900b04bbd9deb8ac26ba3a92efe935294a97bdf045f39fbd168d5a5db00638d24b01663124dc710329454453c37631d7983a86b629f48b105daf475
-  data.tar.gz: d91616aa9dc3eba73f3a9a21dba11a5eea20cfec45abc17e0e47e0254678ecf1b7ab5df53e109b49e1502a57eaf889f32a88e4136e2582e997d14b08506d988d
+  metadata.gz: 4fd557d32f5ccdedcf916bccc2b3fd9d9af87a344276b9142946b9008b5b9681343801e80579a3564055b78c784cadf864a02faf014f1adddb423ad8d0c9b4da
+  data.tar.gz: b2c18c0af1ab23dab608e93e8a6634d23a5c90d21eb734320aabf9a6b3e4f99afc01557b5c7633b5cf10eecb1ec0a827e133bdd65e3124544bd6cd83566ae5a7

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/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

@@ -5,7 +5,6 @@ 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

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) { raise IbrainErrors::UnknownError.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/roles.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Extentions
+    class Roles < GraphQL::Schema::FieldExtension
+      def after_resolve(object:, arguments:, **rest)
+        raise IbrainErrors::PermissionError.new("You not have permission to access #{field&.name}") if is_invalid_role(object)
+
+        # yield the current time as `memo`
+        yield(object, arguments, rest)
+      end
+
+      private
+
+      def is_invalid_role(object)
+        roles = options.try(:fetch, :roles, [])
+        current_user = object.try(:context).try(:fetch, :current_user, nil)
+        role = current_user.try(:role) || current_user.try(:graphql_role)
+
+        return if roles.blank?
+        return true if current_user.blank?
+        return false if roles.include?(role)
+      end
+    end
+  end
+end

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(:context).try(:fetch, :current_user, nil).blank? && options.try(:fetch, :session_required, false)
+      end
+    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,16 @@
+# frozen_string_literal: true
+
+module Ibrain
+  module Types
+    class BaseApiField < GraphQL::Schema::Field
+      argument_class ::Ibrain::Types::BaseArgument
+
+      def initialize(*args, session_required: true, roles: nil, **kwargs, &block)
+        super(*args, camelize: false, **kwargs, &block)
+
+        extension(Ibrain::Extentions::SessionRequired, session_required: session_required) if session_required
+        extension(Ibrain::Extentions::Roles, roles: roles) if roles
+      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/graphql/ibrain/types/base_field.rb

@@ -5,10 +5,11 @@ module Ibrain
     class BaseField < GraphQL::Schema::Field
       argument_class ::Ibrain::Types::BaseArgument
 
-      def initialize(*args, default_value: nil, **kwargs, &block)
+      def initialize(*args, default_value: nil, roles: nil, **kwargs, &block)
         super(*args, camelize: false, **kwargs, &block)
 
         extension(::Ibrain::Extentions::DefaultValue, default_value: default_value) unless default_value.nil?
+        extension(Ibrain::Extentions::Roles, roles: roles) if roles
       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,5 +1,5 @@
 # frozen_string_literal: true
 
 Ibrain::Core::Engine.routes.draw do
-  post "/", controller: 'graphql', action: 'execute'
+  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/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Ibrain
-  VERSION = "0.1.9"
+  VERSION = "0.2.3"
 
   def self.ibrain_version
     VERSION
   end
 
   def self.previous_ibrain_minor_version
-    '0.1.8'
+    '0.2.2'
   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.9
+  version: 0.2.3
 platform: ruby
 authors:
 - Tai Nguyen Van
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-session_store
@@ -186,6 +186,8 @@ files:
 - app/controllers/ibrain/core/graphql_controller.rb
 - app/graphql/ibrain/base_schema.rb
 - app/graphql/ibrain/extentions/default_value.rb
+- app/graphql/ibrain/extentions/roles.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 +200,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 +213,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/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