alchemy-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ce948ae7006c2d16bd83a5ff1e3994cabc55ef13e172022417f81b2f54eaf36
+  data.tar.gz: e136bac74fd3617b2d474257cb8331d69a1e496ebb735402199ec8a4943ff8ff
+SHA512:
+  metadata.gz: 812891c3d04023fbb842235c373ee45f4cec1e58b0a4369a5fd6f29f1afd00065a5d8c924ac07ba0217bcdfd4fa9422c55d3f901bdf12550928adf625a805840
+  data.tar.gz: f9827148143c719971ec244d1082f1a6b705dbbe02dd35daa3693018a8321c7f57e9a0d14032057a38313f14abb91119fb8a0569dead1dc59bfe367487b13e3b

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2019 Thomas von Deyen
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+  Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,338 @@
+[![CircleCI](https://circleci.com/gh/AlchemyCMS/alchemy-graphql/tree/master.svg?style=svg)](https://circleci.com/gh/AlchemyCMS/alchemy-graphql/tree/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d5ccbf59314f813ce195/maintainability)](https://codeclimate.com/github/AlchemyCMS/alchemy-graphql/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d5ccbf59314f813ce195/test_coverage)](https://codeclimate.com/github/AlchemyCMS/alchemy-graphql/test_coverage)
+
+# AlchemyCMS GraphQL API
+Add a GraphQL API to your AlchemyCMS powered site.
+
+**WARNING: This is in an early state and changes to the API may be applied without any further announcement!**
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-graphql', github: 'AlchemyCMS/alchemy-graphql'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Setup
+
+There are two ways of setting up the GraphQL API for AlchemyCMS.
+
+### Use the provided GraphQL endpoint
+
+This is the easiest way of setting up the AlchemyCMS GraphQL API. Recommended for apps not having a GraphQL API or stand alone Alchemy installations.
+
+```rb
+# config/routes
+Rails.application.routes.draw do
+  mount Alchemy::GraphQL::Engine => '/'
+  mount Alchemy::Engine => '/'
+  ...
+end
+```
+
+_NOTE:_ It is necessary to mount the `Alchemy::GraphQL::Engine` before mounting the `Alchemy::Engine` otherwise Alchemys catch all route will make your GraphQL endpoint unreachable.
+
+Your GraphQL endpoint will be available at `/graphql`.
+
+_TIP:_ Mounting the engine at a different path (ie `/cms`) will prefix the GraphQL endpoint with that path (ie. `/cms/graphql`)
+
+### Build your own GraphQL endpoint
+
+This is the more advanced way of setting up the AlchemyCMS GraphQL API.
+It is recommended for apps already having a GraphQL API or people who want to build their own schema.
+
+Include one or all of the [provided fields](https://github.com/AlchemyCMS/alchemy-graphql/tree/master/lib/alchemy/graphql/fields/) in your `GraphQL::Schema::Object` class.
+
+```rb
+# app/graphql/query.rb
+class GraphQL::Query < ::GraphQL::Schema::Object
+  field :my_field, String, null: true
+  include Alchemy::GraphQL::PageFields
+end
+```
+
+## Usage
+
+We recommend using [GraphiQL](https://github.com/rmosolgo/graphiql-rails) in your app to have an interactive API explorer in your browser.
+
+### Online demo
+
+We also provide an online demo for you to play with:
+
+https://demo.alchemy-cms.com/graphiql
+
+### Example queries
+
+#### Find an Alchemy page by its name
+
+```graphql
+query {
+  page: alchemyPage(name: "A page") {
+    name
+    elements(only: "article") {
+      contents(only: "headline") {
+        ingredient
+      }
+    }
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "page": {
+      "name": "A page",
+      "elements": [
+        {
+          "contents": [
+            {
+              "ingredient": "My headline"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}
+```
+
+It is also possible to find pages by a name match instead of an exact name.
+
+```graphql
+query {
+  page: alchemyPage(name: "Contact", exactMatch: false) {
+    name
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "page": {
+      "name": "Contact us"
+    }
+  }
+}
+```
+
+#### Find an Alchemy page by its urlname
+
+```graphql
+query {
+  page: alchemyPage(urlname: "a-page") {
+    elements {
+      contents {
+        ingredient
+      }
+    }
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "page": {
+      "elements": [
+        {
+          "contents": [
+            {
+              "ingredient": "My headline"
+            },
+            {
+              "ingredient": "<p>My paragraph.</p>"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}
+```
+
+It is also possible to find pages by an urlname match instead of an exact urlname.
+
+```graphql
+query {
+  page: alchemyPage(urlname: "contact", exactMatch: false) {
+    urlname
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "page": {
+      "urlname": "contact-us"
+    }
+  }
+}
+```
+
+#### Find an Alchemy page by several attributes
+
+You can even combine attributes to narrow down the result.
+
+```graphql
+query {
+  page: alchemyPage(
+    name: "Foot",
+    pageLayout: "footer",
+    exactMatch: false
+  ) {
+    name
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "page": {
+      "name": "Footer"
+    }
+  }
+}
+```
+
+#### Find an Alchemy element by its name
+
+```graphql
+query {
+  element: alchemyElement(name: "article") {
+    name
+    contents(only: "headline") {
+      ingredient
+    }
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "element": {
+      "name": "article",
+      "contents": [
+        {
+          "ingredient": "My headline"
+        }
+      ]
+    }
+  }
+}
+```
+
+It is also possible to find elements by a name match instead of an exact name.
+
+```graphql
+query {
+  element: alchemyElement(name: "head", exactMatch: false) {
+    name
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "element": {
+      "name": "header"
+    }
+  }
+}
+```
+
+#### Find Alchemy elements by name
+
+```graphql
+query {
+  elements: alchemyElements(only: "article") {
+    name
+    contents(only: "headline") {
+      ingredient
+    }
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "elements": [
+      {
+        "name": "article",
+        "contents": [
+          {
+            "ingredient": "My first headline"
+          }
+        ]
+      },
+      {
+        "name": "article",
+        "contents": [
+          {
+            "ingredient": "My second headline"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+It is also possible to exclude elements by name.
+
+```graphql
+query {
+  elements: alchemyElements(except: "article") {
+    name
+  }
+}
+```
+
+will return
+
+```json
+{
+  "data": {
+    "elements": [
+      {
+        "name": "header"
+      },
+      {
+        "name": "footer"
+      }
+    ]
+  }
+}
+```
+
+## License
+
+The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alchemy::GraphQL'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'

data/app/controllers/alchemy/graphql_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class GraphqlController < ApplicationController
+    include Alchemy::ControllerActions
+    include Alchemy::AbilityHelper
+
+    def execute
+      render json: Alchemy::GraphQL::Schema.execute(
+        params[:query],
+        context: {
+          current_user: current_alchemy_user,
+          current_ability: current_ability
+        },
+        operation_name: params[:operationName]
+      )
+    rescue StandardError => e
+      raise e unless Rails.env.development?
+
+      handle_error_in_development(e)
+    end
+
+    private
+
+    def handle_error_in_development(e)
+      logger.error e.message
+      logger.error e.backtrace.join("\n")
+
+      render json: { error: { message: e.message, backtrace: e.backtrace }, data: {} }, status: 500
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Alchemy::GraphQL::Engine.routes.draw do
+  post "/graphql", to: 'graphql#execute'
+end

data/lib/alchemy-graphql.rb

@@ -0,0 +1 @@
+require 'alchemy/graphql'

data/lib/alchemy/graphql.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require 'alchemy_cms'
+
+module Alchemy
+  module GraphQL
+    autoload :Schema,        'alchemy/graphql/schema'
+    autoload :Query,         'alchemy/graphql/query'
+    autoload :PageFields,    'alchemy/graphql/fields/page_fields'
+    autoload :ElementFields, 'alchemy/graphql/fields/element_fields'
+    autoload :PageType,      'alchemy/graphql/types/page_type'
+    autoload :ElementType,   'alchemy/graphql/types/element_type'
+    autoload :ContentType,   'alchemy/graphql/types/content_type'
+  end
+end
+
+require_relative 'graphql/engine'

data/lib/alchemy/graphql/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class Engine < ::Rails::Engine
+      isolate_namespace Alchemy
+      engine_name 'alchemy_graphql'
+    end
+  end
+end

data/lib/alchemy/graphql/fields/element_fields.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    module ElementFields
+      def self.included(query)
+        query.field :alchemy_elements, [ElementType], null: true do
+          description "Find Alchemy Elements."
+          argument :only, ::GraphQL::Types::String, required: false
+          argument :except, ::GraphQL::Types::String, required: false
+        end
+
+        query.field :alchemy_element, ElementType, null: true do
+          description "Find Alchemy Element by any of its attributes (id, name)."
+          argument :id, ::GraphQL::Types::ID, required: false
+          argument :name, ::GraphQL::Types::String, required: false
+          argument :exact_match, ::GraphQL::Types::Boolean, required: false, default_value: true
+        end
+      end
+
+      def alchemy_elements(only: nil, except: nil)
+        elements = Alchemy::Element.available
+        if only
+          elements.where(name: only)
+        elsif except
+          elements.where.not(name: except)
+        else
+          elements
+        end
+      end
+
+      def alchemy_element(attributes = {})
+        exact_match = attributes.delete(:exact_match)
+        if exact_match
+          Alchemy::Element.find_by(attributes)
+        else
+          conditions = attributes.flat_map do |attribute, value|
+            ["#{attribute} LIKE ?", "%#{sanitize_sql_like(value)}%"]
+          end
+          Alchemy::Element.where(conditions).first
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/graphql/fields/page_fields.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    module PageFields
+      def self.included(query)
+        query.field :alchemy_page, Alchemy::GraphQL::PageType, null: true do
+          description "Find Alchemy Page by any of its attributes (id, name, urlname, page_layout)."
+          argument :id, ::GraphQL::Types::ID, required: false
+          argument :name, ::GraphQL::Types::String, required: false
+          argument :urlname, ::GraphQL::Types::String, required: false
+          argument :page_layout, ::GraphQL::Types::String, required: false
+          argument :exact_match, ::GraphQL::Types::Boolean, required: false, default_value: true
+        end
+      end
+
+      include ActiveRecord::Sanitization::ClassMethods
+
+      def alchemy_page(attributes = {})
+        exact_match = attributes.delete(:exact_match)
+        if exact_match
+          Alchemy::Page.find_by(attributes)
+        else
+          conditions = attributes.flat_map do |attribute, value|
+            ["#{attribute} LIKE ?", "%#{sanitize_sql_like(value)}%"]
+          end
+          Alchemy::Page.where(conditions).first
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/graphql/query.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class Query < ::GraphQL::Schema::Object
+      description "Query Alchemy Pages by id, name or url."
+
+      include PageFields
+      include ElementFields
+    end
+  end
+end

data/lib/alchemy/graphql/schema.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class Schema < ::GraphQL::Schema
+      query(Alchemy::GraphQL::Query)
+    end
+  end
+end

data/lib/alchemy/graphql/types/content_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class ContentType < ::GraphQL::Schema::Object
+      description "A Alchemy Content"
+
+      field :id, ID, null: false
+      field :element, Alchemy::GraphQL::ElementType, null: false
+      field :name, String, null: false
+      field :ingredient, String, null: true
+
+      def ingredient
+        object.serialized_ingredient
+      end
+    end
+  end
+end

data/lib/alchemy/graphql/types/element_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class ElementType < ::GraphQL::Schema::Object
+      description "A Alchemy Element"
+
+      field :id, ID, null: false
+      field :page, Alchemy::GraphQL::PageType, null: false
+      field :parent_element, self, null: true
+      field :name, String, null: false
+
+      field :contents, [Alchemy::GraphQL::ContentType], null: false do
+        description "Filter elements contents by their name. " \
+          "Either pass `only` to exclusively load Contents with this name or `except` to exclude these contents."
+        argument :only, String, required: false
+        argument :except, String, required: false
+      end
+
+      def contents(only: nil, except: nil)
+        contents = object.contents
+        if only
+          contents.where(name: only)
+        elsif except
+          contents.where.not(name: except)
+        else
+          contents
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/graphql/types/page_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    class PageType < ::GraphQL::Schema::Object
+      description "A Alchemy Page"
+
+      field :id, ID, null: false
+      field :name, String, null: false
+      field :title, String, null: false
+      field :urlname, String, null: false
+
+      field :elements, [Alchemy::GraphQL::ElementType], null: false do
+        description "Filter pages elements by their name. " \
+          "Either pass `only` to exclusively load Elements with this name or `except` to exclude these elements."
+        argument :only, String, required: false
+        argument :except, String, required: false
+      end
+
+      def elements(only: nil, except: nil)
+        elements = object.elements.available
+        if only
+          elements.where(name: only)
+        elsif except
+          elements.where.not(name: except)
+        else
+          elements
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/graphql/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module GraphQL
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-graphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Description of Alchemy::GraphQL
+email:
+- thomas@vondeyen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/alchemy/graphql_controller.rb
+- config/routes.rb
+- lib/alchemy-graphql.rb
+- lib/alchemy/graphql.rb
+- lib/alchemy/graphql/engine.rb
+- lib/alchemy/graphql/fields/element_fields.rb
+- lib/alchemy/graphql/fields/page_fields.rb
+- lib/alchemy/graphql/query.rb
+- lib/alchemy/graphql/schema.rb
+- lib/alchemy/graphql/types/content_type.rb
+- lib/alchemy/graphql/types/element_type.rb
+- lib/alchemy/graphql/types/page_type.rb
+- lib/alchemy/graphql/version.rb
+homepage: https://alchemy-cms.com
+licenses:
+- BSD-3-Clause
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Alchemy::GraphQL
+test_files: []