stardust_rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bbe149e010f7ea906ef2931a7b4d54ce6b2617a98148e86a1bc2a448f21d296
+  data.tar.gz: 119e01c47e8cee378d93ba7d93b2dea97680aa643506d74ff658230f3b3ef2af
+SHA512:
+  metadata.gz: bb299aa1d30927a1364ef8b233f88ccd96141885375430b6ee9e9a415f25404434e09a17bd59805fb1fe0890ba7c869901f6dc9de101a0a5ebf3674b55d6ffb5
+  data.tar.gz: 6337f5244a51e946793b89b02920ab617ccfe7fe5e7b54167702f74c6d3d67a035246d81ce34994dacb9b89ca550089918f0181ad58e9bce2faf792e9b2576c5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Bradley Wittenbrook
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Stardust
+GraphQL APIs in Rails made easy
+
+Building on top of the fantastic [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) gem, Stardust allows you to focus on business logic
+
+```
+- app
+  - graph
+    - mutations
+    - queries
+    - types
+```
+
+## Usage
+
+Stardust uses `define_` hooks to automatically build out the graph by crawling through the `graph` directory inside your application.
+
+Mutations and Queries are called through the `resolve` method. Any arguments are passed in as **named** arguments to the function.
+
+### Mutation
+
+Mutations are used to define
+
+```ruby
+Stardust::GraphQL.define_mutation :add_item do
+
+ description "Add a new item"
+ null false
+
+ argument :name, :string, required: true
+
+ field :item, :item, null: true
+ field :success, :boolean, null: false
+
+ def resolve(name:)
+   {
+     success: true,
+     item: {
+       id: 4,
+       name: name
+     }
+   }
+ end
+
+end
+```
+
+### Query
+
+```ruby
+Stardust::GraphQL.define_query :items do
+
+  def items
+    [
+      {
+        id: 1,
+        name: "foo"
+      },
+      {
+        id: 2,
+        name: "bar"
+      },
+      {
+        id: 3,
+        name: "baz"
+      }
+    ].freeze
+  end
+
+  description "Get a list of items"
+  type [:item]
+  null false
+
+  def resolve
+    items
+  end
+
+end
+```
+
+### Type
+
+```ruby
+Stardust::GraphQL.define_types do
+
+  object :item do
+    description "An example item"
+    field :id, :id, null: false
+    field :name, :string, null: false
+  end
+
+end
+```
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stardust_rails', require: 'stardust'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install stardust_rails
+```
+
+Mount the engine:
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  ...
+  mount Stardust::Engine, at: "/"
+  ...
+end
+```
+
+Generate your first type, query or mutation:
+```bash
+$ rails g stardust:example
+$ rails g stardust:type foo
+$ rails g stardust:query foos
+$ rails g stardust:mutation bar
+```
+
+View GraphiQL here:
+[http://localhost:3000/graphiql](http://localhost:3000/graphiql)
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Stardust'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/stardust/graphql_controller.rb

@@ -0,0 +1,79 @@
+module Stardust
+  class GraphQLController < ActionController::API
+
+    def execute
+      result = nil
+      
+      around_execute do
+        result = GraphQL::Schema.execute(
+          query,
+          variables: variables,
+          context: context,
+          operation_name: operation_name
+        )
+      end
+      render json: result
+
+    rescue StandardError => e
+      raise e unless Rails.env.development?
+      handle_error_in_development e
+    end
+
+
+    private
+
+    def operation_name
+      params[:operationName]
+    end
+
+    def query
+      params[:query]
+    end
+
+    def variables
+      ensure_hash(params[:variables])
+    end
+
+    def context
+      setup_context = Stardust.configuration.graphql.setup_context
+      setup_context ? setup_context.(request) : {}
+    end
+
+    def around_execute
+      around_execute = Stardust.configuration.graphql.around_execute
+      yield around_execute
+    end
+
+    # Handle form data, JSON body, or a blank value
+    def ensure_hash(ambiguous_param)
+      case ambiguous_param
+      when String
+        if ambiguous_param.present?
+          ensure_hash(JSON.parse(ambiguous_param))
+        else
+          {}
+        end
+      when Hash, ActionController::Parameters
+        ambiguous_param
+      when nil
+        {}
+      else
+        raise ArgumentError, "Unexpected parameter: #{ambiguous_param}"
+      end
+    end
+
+    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,7 @@
+Rails.application.routes.draw do
+
+  post "/graphql", to: "stardust/graphql#execute"
+  if Stardust.instance == :development
+    mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
+  end
+end

data/lib/generators/example/mutations/update_item.rb

@@ -0,0 +1,22 @@
+Stardust::GraphQL.define_mutation :add_item do
+
+ description "Add a new item"
+ null false
+
+ argument :name, :string, required: true
+
+ field :item, :item, null: true
+ field :success, :boolean, null: false
+
+ def resolve(name:)
+   {
+     success: true,
+     item: {
+       id: 4,
+       name: name
+     }
+   }
+ end
+
+
+end

data/lib/generators/example/queries/foo.rb

@@ -0,0 +1,31 @@
+Stardust::GraphQL.define_query :item do
+
+  def items
+    [
+      {
+        id: 1,
+        name: "foo"
+      },
+      {
+        id: 2,
+        name: "bar"
+      },
+      {
+        id: 3,
+        name: "baz"
+      }
+    ].freeze
+  end
+
+  description "Get a specific item"
+  type :item
+  null true
+
+  argument :id, :integer, required: true
+
+  def resolve(id:)
+    items.select{|i| i[:id] == id}.first
+  end
+
+
+end

data/lib/generators/example/queries/foos.rb

@@ -0,0 +1,29 @@
+Stardust::GraphQL.define_query :items do
+
+  def items
+    [
+      {
+        id: 1,
+        name: "foo"
+      },
+      {
+        id: 2,
+        name: "bar"
+      },
+      {
+        id: 3,
+        name: "baz"
+      }
+    ].freeze
+  end
+
+  description "Get a list of items"
+  type [:item]
+  null false
+
+  def resolve
+    items
+  end
+
+
+end

data/lib/generators/example/types/item.rb

@@ -0,0 +1,9 @@
+Stardust::GraphQL.define_types do
+
+  object :item do
+    description "An example item"
+    field :id, :id, null: false
+    field :name, :string, null: false
+  end
+
+end

data/lib/generators/mutation.template

@@ -0,0 +1,30 @@
+Stardust::GraphQL.define_mutation :<%= type_name %> do
+
+  description "TODO: Write a detailed description"
+
+  ## Optional
+  ##
+  # argument :id, :integer, required: true,
+  #               loads: ::MyModel, as: :model
+
+  ## Required
+  ## What fields does this mutation return
+  ##
+  # field :item, :item, null: true
+  # field :error, :error, null: true
+
+  ## Can this query return nil
+  # null true
+
+
+  def resolve
+    ## TODO: add your logic here
+    ## if has_error
+    ##   {item: some_item}
+    ## else
+    ##   { error: { message: "Some error" } }
+    ## end
+  end
+
+
+end

data/lib/generators/query.template

@@ -0,0 +1,26 @@
+Stardust::GraphQL.define_query :<%= type_name %> do
+
+  description "TODO: Write a detailed description"
+
+  ## Required
+  ## What is the return type of this query
+  ## type :my_type
+
+  ## Can this query return nil
+  null true
+
+  ## Optional
+  ##
+  ## argument :id, :integer, required: true,
+  ##               loads: ::MyModel, as: :model
+  ##
+  ## Use named params to have access to any arguments
+  ## def resolve(model:)
+
+
+  ## This is the entrypoint for the query
+  def resolve
+    ## TODO: return something
+  end
+
+end

data/lib/generators/type.template

@@ -0,0 +1,8 @@
+Stardust::GraphQL.define_types do
+
+  object :<%= type_name %> do
+    description "TODO: Write a detailed description"
+    field :id, :id, null: false
+  end
+
+end

data/lib/stardust/configuration.rb

@@ -0,0 +1,13 @@
+module Stardust
+  class Configuration
+
+    def graphql
+      @graphql ||= GraphQL::Configuration.new
+    end
+
+    def configure_graphql
+      yield graphql
+    end
+
+  end
+end

data/lib/stardust/engine.rb

@@ -0,0 +1,51 @@
+require "graphql/rails_logger"
+require 'apollo_upload_server/middleware'
+
+module Stardust
+  class Engine < ::Rails::Engine
+
+    config.autoload_paths += Dir[
+      "#{config.root}/app/**/",
+      "#{config.root}/lib/**/"
+    ]
+
+    DIRS = [
+      "app/graph/types",
+      "app/graph/queries",
+      "app/graph/mutations",
+    ].freeze
+
+    initializer "stardust.graph.draw" do |app|
+
+      # !!IMPORTANT without this here the logger gets fired before the upload middlware
+      app.middleware.use ApolloUploadServer::Middleware
+
+      # Load graph definitions
+      DIRS.each do |dir|
+        Dir[Rails.root.join(dir).join("**/*.rb")].each do |file|
+          require file
+        end
+      end
+      Stardust::GraphQL::Collector.replace_types!
+
+      ActiveSupport::Reloader.after_class_unload do
+        Stardust::GraphQL::Collector.clear_definitions!
+        DIRS.each do |dir|
+          Dir[Rails.root.join(dir).join("**/*.rb")].each do |file|
+            load file
+          end
+        end
+        Stardust::GraphQL::Collector.replace_types!
+      end
+    end
+
+    config.to_prepare do
+      # Setup logger
+      ::GraphQL::RailsLogger.configure do |config|
+        config.white_list = {
+          'Stardust::GraphQLController' => %w(execute)
+        }
+      end
+    end
+  end
+end

data/lib/stardust/generators/example.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Stardust
+  module Generators
+    class Example < Rails::Generators::Base
+
+      source_root File.expand_path('../../generators/example', __dir__)
+
+      def copy_initializer_file
+        copy_file 'mutations/update_item.rb', 'app/graph/mutations/update_item.rb'
+        copy_file 'queries/foo.rb', 'app/graph/queries/foo.rb'
+        copy_file 'queries/foos.rb', 'app/graph/queries/foos.rb'
+        copy_file 'types/item.rb', 'app/graph/types/item.rb'
+      end
+    end
+  end
+end

data/lib/stardust/generators/mutation.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+module Stardust
+  module Generators
+    class Mutation < Rails::Generators::Base
+
+      argument :path, type: :string
+
+      source_root File.expand_path('../../generators', __dir__)
+
+      def generate_type
+        template "mutation.template", "app/graph/mutations/#{path.underscore}.rb"
+      end
+
+      private
+
+      def type_name
+        path.underscore.gsub("/", "_")
+      end
+    end
+  end
+end

data/lib/stardust/generators/query.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+module Stardust
+  module Generators
+    class Query < Rails::Generators::Base
+
+      argument :path, type: :string
+
+      source_root File.expand_path('../../generators', __dir__)
+
+      def generate_type
+        template "query.template", "app/graph/queries/#{path.underscore}.rb"
+      end
+
+      private
+
+      def type_name
+        path.underscore.gsub("/", "_")
+      end
+    end
+  end
+end

data/lib/stardust/generators/type.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+module Stardust
+  module Generators
+    class Type < Rails::Generators::Base
+
+      argument :path, type: :string
+
+      source_root File.expand_path('../../generators', __dir__)
+
+      def generate_type
+        template "type.template", "app/graph/types/#{path.underscore}.rb"
+      end
+
+      private
+
+      def type_name
+        path.underscore.split("/").last
+      end
+    end
+  end
+end

data/lib/stardust/generators.rb

@@ -0,0 +1,9 @@
+module Stardust
+  module Generators
+  end
+end
+
+require 'stardust/generators/example'
+require 'stardust/generators/type'
+require 'stardust/generators/query'
+require 'stardust/generators/mutation'