cm-graphql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88cbec80aeb7ce0649e72b28495436a8bfd2372d564f5b593056106fb10bca8c
+  data.tar.gz: 90e971f56d3b41f432418bfce7652ba76c7b99bf797ae1cfef2d3a4b0aa0e7cf
+SHA512:
+  metadata.gz: 237af1356eb71878cb5d0cbc21502a3ea95828286da8b8178aaf6be061ccd12e818d4b9545d3e5e92f8a0bc620bd2849afea13bd6f9da89919a5c37058508bad
+  data.tar.gz: 827e8261f871b22adc627375f39b06bedc8ff7e434330dbf9d8b1919179d26ad8f8c989f8d0106f82793af0595f40864c71393c086efc74d180f1340892e04f7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+source 'https://rails-assets.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    cm-graphql (0.0.1)
+      graphiql-rails (~> 1.8.0)
+      graphql (~> 1.13.1)
+      graphql-errors (~> 0.4.0)
+      graphql-rails_logger (~> 1.2.3)
+      kaminari (~> 1.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rails-assets.org/
+  specs:
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    erubi (1.11.0)
+    graphiql-rails (1.8.0)
+      railties
+      sprockets-rails
+    graphql (1.13.15)
+    graphql-errors (0.4.0)
+      graphql (>= 1.6.0, < 2)
+    graphql-rails_logger (1.2.3)
+      actionpack (> 5.0)
+      activesupport (> 5.0)
+      railties (> 5.0)
+      rouge (~> 3.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rouge (3.30.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  cm-graphql!
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -0,0 +1,53 @@
+# CmGraphql
+
+This should help you to install graphql and setup the basics on any new rails application.
+
+## Install
+
+Add the gem to the Gemfile
+
+```
+gem 'cm-admin', git: 'https://github.com/commutatus/template-paging-api.git', branch: 'main'
+```
+
+## Setup
+
+If this is the first time graphql is getting added to the project, run the following generator
+
+```
+rails g cm_graphql:add_graphql
+```
+
+This will run the graphql generator `graphql:install` and copy the graphql schema template.
+
+## Generator
+
+Another generator to help you get started with a basic list endpoint is 
+
+```
+rails g cm_graphql:list_api model_name
+rails g cm_graphql:list_api course
+```
+
+This will add the necessary files to the application.
+- course_list_type
+- course_type
+- course_query
+
+Mount the engine at 
+```
+mount CmGraphql::Engine => "/cm-graphql"
+```
+
+And you are done, you can test out the pagination.
+
+## Explaination on how this works.
+
+1. Kaminari Gem has `page` and `per` methods. These methods are used to set the page no and records per page of a model.
+2. The paging Input type in `app/graphql/types/inputs/base/paging.rb` exposes a interface to the frontend where the frontend can enter page no and records per page.
+3. The query uses a `list` method on the model. This method is inherited by the model from the paginator concern.
+4. We apply the kaminari method in the list method to apply pagination to the model.
+5. The paginator then calls the filtered_list model to arrange the model data and paging data in a representable way. This helps us make sure all the pagination follow the same pattern for data representation.
+6. The paging_type in `app/graphql/types/objects/base/paging_type.rb` is used to represent the paging data to the frontend.
+7. The pagination and model data is represented with object type in `app/graphql/types/objects/example_list_type.rb`.
+8. And we have successfully applied pagination to our graphql project.

data/app/graphql/mutations/base_mutation.rb

@@ -0,0 +1,8 @@
+module Mutations
+  class BaseMutation < GraphQL::Schema::RelayClassicMutation
+    argument_class Types::BaseArgument
+    field_class Types::BaseField
+    input_object_class Types::BaseInputObject
+    object_class Types::BaseObject
+  end
+end

data/app/graphql/queries/base_query.rb

@@ -0,0 +1,4 @@
+module Queries
+  class BaseQuery < GraphQL::Schema::Resolver
+  end
+end

data/app/graphql/types/enums/base/sort_column.rb

@@ -0,0 +1,7 @@
+module Types
+  class Enums::Base::SortColumn < Types::BaseEnum
+    description "Possible values for sort column"
+
+    value :created_at, "Sort by created_at"
+  end
+end

data/app/graphql/types/enums/base/sort_direction.rb

@@ -0,0 +1,8 @@
+module Types
+  class Enums::Base::SortDirection < Types::BaseEnum
+    description "Possible values for sort direction"
+
+    value :asc, "Sort by ascending"
+    value :desc, "Sort by descending"
+  end
+end

data/app/graphql/types/inputs/base/attachment.rb

@@ -0,0 +1,15 @@
+module Types
+  module Inputs
+    module Base
+      class Attachment < Types::BaseInputObject
+        graphql_name "AttachmentInput"
+
+        description "Attributes needed to attach a file"
+
+        argument :filename,   String, nil,  required: true
+        argument :content,    String, nil,  required: true
+      end
+    end
+  end
+end
+

data/app/graphql/types/inputs/base/filter.rb

@@ -0,0 +1,15 @@
+module Types
+  module Inputs
+    module Base
+      class Filter < Types::BaseInputObject
+        graphql_name "BaseFilterInput"
+
+        description "Attributes needed for filtering items"
+
+        argument :ids,          [Integer],  nil,  required: false
+        argument :q,            String,     nil,  required: false
+      end
+    end
+  end
+end
+

data/app/graphql/types/inputs/base/paging.rb

@@ -0,0 +1,14 @@
+module Types
+    module Inputs
+      module Base
+        class Paging < Types::BaseInputObject
+          graphql_name "PagingInput"
+  
+          description "Attributes needed for paginating list of items"
+  
+          argument :page_no,      Integer, nil,  required: true
+          argument :per_page,     Integer, nil,  required: false
+        end
+      end
+    end
+  end

data/app/graphql/types/inputs/base/sort.rb

@@ -0,0 +1,15 @@
+module Types
+  module Inputs
+    module Base
+      class Sort < Types::BaseInputObject
+        graphql_name "SortInput"
+
+        description "Attributes needed for sorting the list of items"
+
+        argument :column,         Types::Enums::Base::SortColumn, nil,  required: true
+        argument :direction,      Types::Enums::Base::SortDirection, nil,  required: true
+      end
+    end
+  end
+end
+

data/app/graphql/types/objects/base/attachment_type.rb

@@ -0,0 +1,31 @@
+module Types::Objects::Base
+  class AttachmentType < Types::BaseObject
+    field :id,          Int,      nil, null: false
+    field :filename,    String,   nil, null: false
+    field :url,         String,   nil, null: false
+
+    def id
+      if object.class.eql?(ActiveStorage::Variant)
+        object.blob.id
+      else
+        object.id
+      end
+    end
+
+    def filename
+      if object.class.eql?(ActiveStorage::Variant)
+        object.blob.filename.to_s + "-" + object.variation.transformations[:resize]
+      else
+        object.filename.to_s
+      end
+    end
+
+    def url
+      if object.class.eql?(ActiveStorage::Variant)
+        Rails.application.routes.url_helpers.rails_representation_url(object)
+      else
+        object.service_url
+      end
+    end
+  end
+end

data/app/graphql/types/objects/base/paging_type.rb

@@ -0,0 +1,8 @@
+module Types::Objects::Base
+    class PagingType < Types::BaseObject
+        graphql_name "PagingType"
+        field :current_page, Integer, null: true
+        field :total_count, Integer, null: true
+        field :total_pages, Integer, null: true
+    end
+end

data/app/models/concerns/paginator.rb

@@ -0,0 +1,11 @@
+module Paginator
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def list(per_page = DEFAULT_PER_PAGE, page = nil)
+        paginated_list = {}
+        per_page = DEFAULT_PER_PAGE if per_page == 0
+        paginated_list[:list] = self.page(page || 1).per(per_page)
+        FilteredList.new(paginated_list)
+      end
+    end
+end

data/app/models/filtered_list.rb

@@ -0,0 +1,21 @@
+class FilteredList
+    attr_reader :data, :facets, :paging
+  
+    def initialize(paginated_list)
+      self.data   = paginated_list[:list]
+      self.paging = paginated_list
+    end
+  
+    def data=(data)
+      @data = []
+      @data = data if data.present?
+    end
+  
+    def paging=(paginated_list)
+      @paging = {
+        total_count:  paginated_list[:list].total_count,
+        current_page: paginated_list[:list].current_page,
+        total_pages:  paginated_list[:list].total_pages
+      }
+    end
+end

data/cm-graphql.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'cm-graphql'
+  spec.version     = '0.0.1'
+  spec.date        = '2022-09-14'
+  spec.summary     = "A gem to setup grapqhl basics like pagination, file upload"
+  spec.description = "A gem to setup grapqhl basics like pagination, file upload"
+  spec.authors     = ["Anbazhagan Palani"]
+  spec.email       = 'anbu@commutatus.com'
+  spec.homepage    =
+    'https://github.com/commutatus/template-paging-api'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'graphql', '~> 1.13.1'
+  spec.add_runtime_dependency 'graphql-errors', '~> 0.4.0'
+  spec.add_runtime_dependency 'graphql-rails_logger', '~> 1.2.3'
+  spec.add_runtime_dependency 'graphiql-rails', '~> 1.8.0'
+  spec.add_runtime_dependency 'kaminari', '~> 1.2.2'
+end

data/config/initializers/active_record_extension.rb

@@ -0,0 +1,7 @@
+ActiveSupport.on_load(:active_record) do
+  module ActiveRecord
+    class Base
+      include Paginator
+    end
+  end
+end

data/config/initializers/constants.rb

@@ -0,0 +1,3 @@
+DEFAULT_PER_PAGE = 20
+DEFAULT_SORT_COLUMN = 'created_at'
+DEFAULT_SORT_DIRECTION = 'desc' 

data/lib/cm-graphql/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+module CmGraphql
+  class Engine < Rails::Engine
+    isolate_namespace CmGraphql
+  end
+end

data/lib/cm-graphql.rb

@@ -0,0 +1,5 @@
+require 'graphql'
+require 'kaminari'
+require 'cm-graphql/engine'
+module CmGraphql
+end

data/lib/generators/cm_graphql/add_graphql_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module CmGraphql
+  module Generators
+    class AddGraphqlGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_graphql
+        generate 'graphql:install'
+        template 'graphql_schema.rb', "app/graphql/#{Rails.application.class.module_parent_name.underscore}_schema.rb"
+      end
+    end
+  end
+end

data/lib/generators/cm_graphql/list_api_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module CmGraphql
+  module Generators
+    class ListApiGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_graphql
+        @model_name = args.first
+        template "list_type.rb", "app/graphql/types/objects/#{@model_name}_list_type.rb"
+        template "record_type.rb", "app/graphql/types/objects/#{@model_name}_type.rb"
+        template "query_type.rb", "app/graphql/queries/#{@model_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/cm_graphql/templates/graphql_schema.rb

@@ -0,0 +1,55 @@
+class <%= Rails.application.class.module_parent_name %>Schema < GraphQL::Schema
+  mutation(Types::MutationType)
+  query(Types::QueryType)
+
+  # Union and Interface Resolution
+  def self.resolve_type(abstract_type, obj, ctx)
+    # TODO: Implement this function
+    # to return the correct object type for `obj`
+    raise(GraphQL::RequiredImplementationMissingError)
+  end
+
+  # Relay-style Object Identification:
+
+  # Return a string UUID for `object`
+  def self.id_from_object(object, type_definition, query_ctx)
+    # Here's a simple implementation which:
+    # - joins the type name & object.id
+    # - encodes it with base64:
+    # GraphQL::Schema::UniqueWithinType.encode(type_definition.name, object.id)
+  end
+
+  # Given a string UUID, find the object
+  def self.object_from_id(id, query_ctx)
+    # For example, to decode the UUIDs generated above:
+    # type_name, item_id = GraphQL::Schema::UniqueWithinType.decode(id)
+    #
+    # Then, based on `type_name` and `id`
+    # find an object in your application
+    # ...
+  end
+
+  rescue_from ActiveRecord::RecordNotFound do |err, obj, args, ctx, field|
+    GraphQL::ExecutionError.new("#{field.type.unwrap.graphql_name} not found", extensions: {code: :unprocessable_entity, sub_code: :record_invalid, message: err.message})
+  end
+
+  rescue_from ActiveRecord::RecordInvalid do |err, obj, args, ctx, field|
+    GraphQL::ExecutionError.new(err.message, extensions: {code: :unprocessable_entity, sub_code: :record_invalid, message: err.message})
+  end
+
+  rescue_from BaseException do |err, obj, args, ctx, field|
+    GraphQL::ExecutionError.new(err.message, extensions: {code: err.code, sub_code: err.sub_code, message: err.message})
+  end
+
+  unless Rails.env.development?
+	  rescue_from StandardError do |err, obj, args, ctx, field|
+      rollbar_error = Rollbar.error(err)
+	    GraphQL::ExecutionError.new("Internal Server Error", extensions: {code: :internal_server_error, uuid: rollbar_error[:uuid]})
+	  end
+	end
+
+  def self.unauthorized_object(error)
+    raise Unauthorized, I18n.t("graphql.unauthorized", error_type: error.type.graphql_name)
+  end
+  
+end

data/lib/generators/cm_graphql/templates/list_type.rb

@@ -0,0 +1,8 @@
+module Types::Objects
+  class <%= @model_name.titleize %>ListType < Types::BaseObject
+    graphql_name "<%= @model_name.titleize %>ListType"
+
+    field :paging, Types::Objects::Base::PagingType, null: true
+    field :data, [Types::Objects::<%= @model_name.titleize %>Type], null: false
+  end
+end

data/lib/generators/cm_graphql/templates/query_type.rb

@@ -0,0 +1,16 @@
+module Queries
+  class <%= @model_name.titleize %> < Queries::BaseQuery
+    description "Fetch all or specific <%= @model_name.titleize %> detail"
+
+    type Types::Objects::<%= @model_name.titleize %>ListType, null: true
+
+    argument :paging, Types::Inputs::Base::Paging, required: false
+    argument :sort, Types::Inputs::Base::Sort, required: false
+
+    def resolve(paging: nil, filters: nil, sort: nil)
+      raise Unauthorized, I18n.t("graphql.unauthorized") if (filters && filters.my) && Current.user.nil?
+      ::<%= @model_name.titleize %>.all.list(paging&.per_page, paging&.page_no)
+    end
+
+  end
+end

data/lib/generators/cm_graphql/templates/record_type.rb

@@ -0,0 +1,8 @@
+module Types::Objects
+  class <%= @model_name.titleize %>Type < Types::BaseObject
+
+    graphql_name "<%= @model_name.titleize %>"
+
+    field :id,                  Integer, null: false
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: cm-graphql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anbazhagan Palani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+- !ruby/object:Gem::Dependency
+  name: graphql-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: graphql-rails_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: graphiql-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: A gem to setup grapqhl basics like pagination, file upload
+email: anbu@commutatus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- app/graphql/mutations/base_mutation.rb
+- app/graphql/queries/base_query.rb
+- app/graphql/types/enums/base/sort_column.rb
+- app/graphql/types/enums/base/sort_direction.rb
+- app/graphql/types/inputs/base/attachment.rb
+- app/graphql/types/inputs/base/filter.rb
+- app/graphql/types/inputs/base/paging.rb
+- app/graphql/types/inputs/base/sort.rb
+- app/graphql/types/objects/base/attachment_type.rb
+- app/graphql/types/objects/base/paging_type.rb
+- app/models/concerns/paginator.rb
+- app/models/filtered_list.rb
+- cm-graphql.gemspec
+- config/initializers/active_record_extension.rb
+- config/initializers/constants.rb
+- lib/cm-graphql.rb
+- lib/cm-graphql/engine.rb
+- lib/generators/cm_graphql/add_graphql_generator.rb
+- lib/generators/cm_graphql/list_api_generator.rb
+- lib/generators/cm_graphql/templates/graphql_schema.rb
+- lib/generators/cm_graphql/templates/list_type.rb
+- lib/generators/cm_graphql/templates/query_type.rb
+- lib/generators/cm_graphql/templates/record_type.rb
+homepage: https://github.com/commutatus/template-paging-api
+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.2.3
+signing_key:
+specification_version: 4
+summary: A gem to setup grapqhl basics like pagination, file upload
+test_files: []