card-mod-graphql 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6671fb819df81906a42cfa6b31f917702c45f2d9c21a8db1856f7038c4789a04
+  data.tar.gz: af0734bd58e72ab4d48e70384ec75ed8f6a01746f91ee3e436f5dcb4d513ef9b
+SHA512:
+  metadata.gz: 12425293668d7cb00b2fec6678ea333d8062d111d4894b3fdde37076b41dd696bcf2a9809af996f76551d438041ac1aa1ad5ede3013eb3302829e5450f856e20
+  data.tar.gz: 863b3a60b13f477ee78635e7c83f97919dbb70d8f4ec61d27a3f4926976e2ad0fc0dc409ed7fd1931ed6595fefa2773ae134dacfce1325317f2e2ab4a38abf0c

data/README.md

@@ -0,0 +1,20 @@
+<!--
+# @title README - mod: graphql
+-->
+
+# GraphQL mod (alpha)
+
+This experimental mod supports simple GraphQL queries of decko sites.
+
+## Setup
+
+Once this mod is installed, you will need to add the following to 
+`config/routes.rb`:
+
+```
+  post "api/graphql", to: "graphql#execute"
+  mount GraphiQL::Rails::Engine, at: "api/graphiql", graphql_path: "graphql"
+```
+
+Having done so, you can point your browser to `YOUR_DECK_ROOT/api/graphiql` to
+get a GraphiQL client with which you can make GraphiQL requests.

data/lib/card/mod/graphql.rb

@@ -0,0 +1,2 @@
+require "graphql"
+require "graphiql/rails"

data/lib/graph_q_l/card_schema.rb

@@ -0,0 +1,36 @@
+module GraphQL
+  class CardSchema < GraphQL::Schema
+    GraphQL::Loader.load_mod_queries
+    mutation Types::MutationType
+    query Types::Query
+
+    class << self
+      # Union and Interface Resolution
+      def 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 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 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
+    end
+  end
+end

data/lib/graph_q_l/loader.rb

@@ -0,0 +1,7 @@
+module GraphQL
+  module Loader
+    def self.load_mod_queries
+      Cardio.config.paths["lib/graph_q_l/types/query.rb"].existent.each { |q| load q }
+    end
+  end
+end

data/lib/graph_q_l/mutations/base_mutation.rb

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

data/lib/graph_q_l/types/base_argument.rb

@@ -0,0 +1,6 @@
+module GraphQL
+  module Types
+    class BaseArgument < Schema::Argument
+    end
+  end
+end

data/lib/graph_q_l/types/base_connection.rb

@@ -0,0 +1,9 @@
+module GraphQL
+  module Types
+    class BaseConnection < Types::BaseObject
+      # add `nodes` and `pageInfo` fields,
+      # as well as `edge_type(...)` and `node_nullable(...)` overrides
+      include Types::Relay::ConnectionBehaviors
+    end
+  end
+end

data/lib/graph_q_l/types/base_edge.rb

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

data/lib/graph_q_l/types/base_enum.rb

@@ -0,0 +1,6 @@
+module GraphQL
+  module Types
+    class BaseEnum < Schema::Enum
+    end
+  end
+end

data/lib/graph_q_l/types/base_field.rb

@@ -0,0 +1,7 @@
+module GraphQL
+  module Types
+    class BaseField < Schema::Field
+      argument_class Types::BaseArgument
+    end
+  end
+end

data/lib/graph_q_l/types/base_input_object.rb

@@ -0,0 +1,7 @@
+module GraphQL
+  module Types
+    class BaseInputObject < Schema::InputObject
+      argument_class Types::BaseArgument
+    end
+  end
+end

data/lib/graph_q_l/types/base_interface.rb

@@ -0,0 +1,12 @@
+module GraphQL
+  module Types
+    module BaseInterface
+      include Schema::Interface
+      edge_type_class Types::BaseEdge
+      connection_type_class Types::BaseConnection
+
+      field_class Types::BaseField
+    end
+  end
+end
+

data/lib/graph_q_l/types/base_object.rb

@@ -0,0 +1,9 @@
+module GraphQL
+  module Types
+    class BaseObject < Schema::Object
+      edge_type_class Types::BaseEdge
+      connection_type_class Types::BaseConnection
+      field_class Types::BaseField
+    end
+  end
+end

data/lib/graph_q_l/types/base_scalar.rb

@@ -0,0 +1,6 @@
+module GraphQL
+  module Types
+    class BaseScalar < Schema::Scalar
+    end
+  end
+end

data/lib/graph_q_l/types/base_union.rb

@@ -0,0 +1,8 @@
+module GraphQL
+  module Types
+    class BaseUnion < Schema::Union
+      edge_type_class Types::BaseEdge
+      connection_type_class Types::BaseConnection
+    end
+  end
+end

data/lib/graph_q_l/types/card.rb

@@ -0,0 +1,50 @@
+module GraphQL
+  module Types
+    class Card < BaseObject
+      field :id, Integer, "unique numerical identifier", null: true
+      field :type, Card, "card type", null: false
+      field :name, String, "name that is unique across all cards", null: false
+      field :linkname, String,"url-friendly name variant", null: false
+      field :created_at, Types::ISO8601DateTime, "when created", null: true
+      field :updated_at, Types::ISO8601DateTime, "when last updated", null: true
+      field :creator, Card, "User who created", null: true
+      field :updater, Card, "User who last updated", null: true
+      field :left, Card, "left name", null: true
+      field :right, Card, "right name", null: true
+      field :content, String, "core view of card rendered in text format", null: true
+
+      def type
+        object.type_id.card
+      end
+
+      def linkname
+        object.name.url_key
+      end
+
+      def left
+        object.left_id.card
+      end
+
+      def right
+        object.right_id.card
+      end
+
+      def content
+        object.format(:text).render_core
+      end
+
+      def creator
+        object.creator_id.card
+      end
+
+      def updater
+        object.updater_id.card
+      end
+
+      # support methods (move to module?)
+      def referers type, field
+        ::Card.search type: type, limit: 10, right_plus: [field, refer_to: object.card_id]
+      end
+    end
+  end
+end

data/lib/graph_q_l/types/mutation_type.rb

@@ -0,0 +1,12 @@
+module GraphQL
+  module Types
+    class MutationType < Types::BaseObject
+      # TODO: remove me
+      field :test_field, String, null: false,
+        description: "An example field added by the generator"
+      def test_field
+        "Hello World"
+      end
+    end
+  end
+end

data/lib/graph_q_l/types/node_type.rb

@@ -0,0 +1,9 @@
+module GraphQL
+  module Types
+    module NodeType
+      include Types::BaseInterface
+      # Add the `id` field
+      include Types::Relay::NodeBehaviors
+    end
+  end
+end

data/lib/graph_q_l/types/query.rb

@@ -0,0 +1,49 @@
+module GraphQL
+  module Types
+    class Query < BaseObject
+      # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
+      # include Types::Relay::HasNodeField
+      # include Types::Relay::HasNodesField
+
+      # Add root-level fields here.
+      # They will be entry points for queries on your schema.
+
+      field :card, Card, null: true do
+        argument :name, String, required: false
+        argument :id, Integer, required: false
+      end
+
+      field :cards, [Card], null: false do
+        argument :name, String, required: false
+        argument :type, String, required: false
+      end
+
+      def card **mark
+        ok_card nil, **mark
+      end
+
+      def cards name: nil, type: nil, limit: 10, offset: 0
+        card_search name, type, limit, offset
+      end
+
+      private
+
+      def ok_card_of_type type_code, **mark
+        card = ok_card(**mark)
+        card if card.type_code == type_code
+      end
+
+      def ok_card type_code, name: nil, id: nil
+        card = ::Card.fetch name || id
+        card if card&.ok?(:read) && (!type_code || card.type_code == type_code)
+      end
+
+      def card_search name, type, limit, offset
+        cql = { limit: limit, offset: offset }
+        cql[:type] = type if type
+        cql[:name] = [:match, name] if name
+        ::Card.search cql
+      end
+    end
+  end
+end

data/lib/graph_q_l.rb

@@ -0,0 +1 @@
+require "card/mod/graphql"

data/lib/graphql_controller.rb

@@ -0,0 +1,58 @@
+# bypasses card controller, executes graphql queries
+class GraphqlController < ActionController::Base
+  # If accessing from outside this domain, nullify the session
+  # This allows for outside API access while preventing CSRF attacks,
+  # but you'll have to authenticate your user separately
+  # protect_from_forgery with: :null_session
+
+  def execute
+    variables = prepare_variables params[:variables]
+    query = params[:query]
+    operation_name = params[:operationName]
+    context = {
+      # Query context goes here, for example:
+      # current_user: current_user,
+    }
+    result = GraphQL::CardSchema.execute query,
+                                         variables: variables,
+                                         context: context,
+                                         operation_name: operation_name
+    render json: result
+  rescue StandardError => e
+    raise e unless Rails.env.development?
+    handle_error_in_development e
+  end
+
+  private
+
+  # Handle variables in form data, JSON body, or a blank value
+  def prepare_variables variables_param
+    case variables_param
+    when String
+      prepare_string_variable variables_param
+    when Hash
+      variables_param
+    when ActionController::Parameters
+      variables_param.to_unsafe_hash
+      # GraphQL-Ruby will validate name and type of incoming variables.
+    when nil
+      {}
+    else
+      raise ArgumentError, "Unexpected parameter: #{variables_param}"
+    end
+  end
+
+  def prepare_string_variable string
+    return {} unless string.present?
+
+    JSON.parse(string) || {}
+  end
+
+  def handle_error_in_development e
+    logger.error e.message
+    logger.error e.backtrace.join("\n")
+
+    render json: { errors: [{ message: e.message, backtrace: e.backtrace }],
+                   data: {} }, status: 500
+  end
+end

data/lib/tasks/graphql.rake

@@ -0,0 +1,3 @@
+require "graphql/rake_task"
+
+GraphQL::RakeTask.new schema_name: "GraphQL::CardSchema"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-graphql
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: graphiql-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/card/mod/graphql.rb
+- lib/graph_q_l.rb
+- lib/graph_q_l/card_schema.rb
+- lib/graph_q_l/loader.rb
+- lib/graph_q_l/mutations/base_mutation.rb
+- lib/graph_q_l/types/base_argument.rb
+- lib/graph_q_l/types/base_connection.rb
+- lib/graph_q_l/types/base_edge.rb
+- lib/graph_q_l/types/base_enum.rb
+- lib/graph_q_l/types/base_field.rb
+- lib/graph_q_l/types/base_input_object.rb
+- lib/graph_q_l/types/base_interface.rb
+- lib/graph_q_l/types/base_object.rb
+- lib/graph_q_l/types/base_scalar.rb
+- lib/graph_q_l/types/base_union.rb
+- lib/graph_q_l/types/card.rb
+- lib/graph_q_l/types/mutation_type.rb
+- lib/graph_q_l/types/node_type.rb
+- lib/graph_q_l/types/query.rb
+- lib/graphql_controller.rb
+- lib/tasks/graphql.rake
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: graphql
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: GraphQL for decko cards
+test_files: []