nulogy_graphql_api 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0610f7398cf9e5bdd286b954237677cffc7252a55eea6b6ab39d074c5f8419eb
+  data.tar.gz: d0eefb1f32964b05d61c53fc7d0195d33d33d34deb2bcb5a0e98d5ab0e040c14
+SHA512:
+  metadata.gz: 35934eb8f98a759437d27e81bc09b8cd2660e25f5bf4f97efb670e77af5deaba874ef248d3b197480d94ed1a9f07dd5ef5d465da67348fca1526f882859194e3
+  data.tar.gz: 07cde3c7bb90ed41455e215e6e05d648605d4eb978a4b12a7310cad65116a535f5f82b98d1eee67b969591537bad477f2c315abc77421e69cb0f0c4ad4156017

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock
+/spec/dummy/log/test.log
+
+# Appraisals
+*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require integration_spec_helper

data/.rubocop

@@ -0,0 +1 @@
+--display-cop-names

data/.rubocop.directories.yml

@@ -0,0 +1,11 @@
+#
+# The Rubocop directory and file configuration for Packmanager.
+#
+
+AllCops:
+  Include:
+    - '**/*.rb'
+    - 'Gemfile'
+
+  Exclude:
+    - '**/spec/dummy/**/*'

data/.rubocop.yml

@@ -0,0 +1,138 @@
+require: rubocop-rspec
+
+inherit_from:
+  - .rubocop.directories.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Layout/LineLength:
+  Max: 140
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-5" do
+  gem "rails", "5.2.4"
+end
+
+appraise "rails-6" do
+  gem "rails", "6.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Change log
+
+## master (unreleased)
+
+## 0.4.0 (2020-07-06)
+
+**Breaking Changes**
+
+* Remove the GraphqlApiController
+* Add the ErrorHandling controller concern
+
+## 0.3.1 (2020-07-03)
+
+* Support Rails 6
+
+## 0.3.0 (2020-06-25)
+
+**Breaking Changes**
+
+* Remove spec helpers related to subscriptions
+
+## 0.2.0 (2020-06-24)
+
+**Breaking Changes**
+
+* Rename `GraphqlExecutor.call` to `execute`
+* Change `schema` parameter on `execute_graphql` test helper to positional
+
+## 0.1.1 (2020-06-24)
+
+**New Features**
+
+* RSpec custom matchers
+* RSpec helpers
+
+## 0.1.0 (2020-06-05)
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danielsi@nulogy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nulogy_graphql_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.9"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Silva
+
+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,242 @@
+# NulogyGraphqlApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "nulogy_graphql_api", "0.4.0", git: "https://github.com/nulogy/nulogy_graphql_api.git"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nulogy_graphql_api
+
+## Usage
+
+#### Developing
+
+- [Receiving Requests](#receiving-requests)
+- [Error Handling](#error-handling)
+- [Types](#types)
+  - [UserErrorType](#usererrortype)
+  - [UUID](#uuid)
+- [Rake task](#rake-task)
+
+#### Testing
+
+- [RSpec helpers](#rspec-helpers)
+  - [Test helpers](#test-helpers)
+  - [Custom matchers](#custom-matchers)
+
+
+#### Receiving Requests
+
+Given that you have already defined your GraphQL `Schema` you can receive requests by defining a controller action and execute the params by calling the `NulogyGraphqlApi::GraphqlExecutor`. 
+
+ - Remember to configure your routes to include the controller action. 
+ - We called the action `execute` in the example below, but you can call it whatever makes more sense for your app.
+
+```ruby
+module MyApp
+  class GraphqlApiController < ApplicationController
+    include NulogyGraphqlApi::ErrorHandling
+
+    def execute
+      NulogyGraphqlApi::GraphqlExecutor.execute(
+        params, 
+        context, 
+        Schema, 
+        NulogyGraphqlApi::TransactionService.new
+      )
+    end
+  end
+end
+```
+
+#### Error Handling
+
+The `NulogyGraphqlApi::ErrorHandling` concern rescues from any unhandled `StandardError`. If you need to log errors before the response is sent to the client you can override the `render_error` method.
+
+```ruby
+module MyApp
+  class GraphqlApiController < ApplicationController
+    include NulogyGraphqlApi::ErrorHandling
+
+    def render_error(exception)
+      MyApp::ExceptionNotifier.notify(exception)
+        
+      super
+    end
+  end
+end
+```
+
+### Types
+
+#### UserErrorType
+
+This type provides a way of returning end-user errors. You can find more details about this error handling strategy in [this document](https://docs.google.com/document/d/19JBm3gKfn0poxo07fg9rSy5iJ2N9cf3NjuVp0xQnXPQ/edit?usp=sharing).
+
+```ruby
+module MyApp
+  class CreateEntity < GraphQL::Schema::Mutation
+    field :entity, MyApp::EntityType, null: false
+    field :errors, [NulogyGraphqlApi::Types::UserErrorType], null: false
+    
+    def resolve(args)
+      entity = create_entity(args)
+    
+      {
+        entity: entity,
+        errors: extract_errors(entity)
+      }
+    end
+
+    def extract_errors(entity)
+      entity.errors.map do |attribute, message| 
+        {
+          path: path_for(attribute),
+          message: entity.errors.full_message(attribute, message)
+        }
+      end
+    end
+  end
+end
+```
+
+#### UUID
+
+This type provides a way of returning UUID values.
+
+```ruby
+module MyApp
+  class EntityType < GraphQL::Schema::Object
+    field :id, NulogyGraphqlApi::Types::UUID, null: false
+  end
+end
+```
+
+### Rake task
+
+There is a Rake task to generate the `schema.graphql` file. All you need to provide is the path to the old and the new schema files so that the task can detect breaking changes. If you don't have an old schema file because it's your first time generating it then the rake task will just create one for you.
+
+```ruby
+namespace :my_app_graphql_api do
+  desc "Generate the graphql schema of the api."
+
+  task :generate_schema => :environment do
+    old_schema_file_path = MyApp::Engine.root.join("schema.graphql")
+    new_schema_file_path = MyApp::Engine.root.join("app/graphql/my_app/schema.rb")
+
+    Rake::Task["nulogy_graphql_api:generate_schema"]
+      .invoke(old_schema_file_path, new_schema_file_path)
+  end
+end
+```
+
+### RSpec helpers
+
+Add this to your `spec_helpers.rb` file:
+
+```ruby
+require "nulogy_graphql_api/rspec"
+```
+
+Then you can include helpers and matchers as in:
+
+```ruby
+RSpec.configure do |config|
+  config.include NulogyGraphqlApi::GraphqlMatchers, graphql: true
+  config.include NulogyGraphqlApi::GraphqlHelpers, graphql: true
+end
+``` 
+
+#### Test helpers
+
+The `execute_graphql` helper execute GraphQL operations directly against the provided schema. This is how it can be used:
+
+```ruby
+RSpec.describe MyApp::Graphql::Query, :graphql do
+  let(:schema) { MyApp::Schema }
+
+  it "returns an entity" do
+    entity = create(:entity)
+
+    response = execute_graphql(<<~GRAPHQL, schema)
+      query {
+        entity(id: "#{entity.id}") {
+          id
+        }
+      }
+    GRAPHQL
+
+    expect(response).to have_graphql_data(
+      project: {
+        id: entity.id
+      }
+    )
+  end
+end
+```
+
+The `request_graphql` helper issues a POST request against the provided URL. This is how it can be used:
+
+```ruby
+RSpec.describe MyApp::Graphql::Query, :graphql, type: :request do
+  it "returns 401 Unauthorized given an unauthenticated request" do
+      gql_response = request_graphql(url, <<~GRAPHQL, headers: { "HTTP_AUTHORIZATION" => nil })
+        query {
+          entities {
+            id
+          }
+        }
+      GRAPHQL
+
+      expect(response.status).to eq(401)
+      expect(gql_response).to have_graphql_error("Unauthorized")
+    end
+end
+```
+
+#### Custom matchers
+
+These are the custom matchers available:
+
+`have_graphql_data` for checking the response `data`
+
+```ruby
+expect(response).to have_graphql_data(
+  project: {
+    id: entity.id
+  }
+)
+```
+
+`have_graphql_error` for checking the response `errors`
+
+```ruby
+expect(response).to have_graphql_error("Error message")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run rubocop and tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nulogy/nulogy_graphql_api/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nulogy/nulogy_graphql_api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NulogyGraphqlApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nulogy/nulogy_graphql_api/blob/master/CODE_OF_CONDUCT.md).