graphql_util 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa249e09e5755630deaa4b7638f4bf5e03e144386fed0280bbb0638ab944c9da
+  data.tar.gz: b55751528e31214081eb07585d5ed205949376eedf2ed19fa04cb2a1d06d654e
+SHA512:
+  metadata.gz: 5ab65f496ca6b6502309508f7551956798a6a0e859b8627721eaf57c090460354da28b55445e791ba9ac02d26f8cd16d5af21c2453b68bec7a9bddba2a1ee83e
+  data.tar.gz: 10a82c850ac9af82ff90cc0d52656305fd3029f95b0df108c4a1f8e51413c7c99d929489427c644d08d881fdb815cc64e301142595d9ac38b4978f2779a6afdc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,181 @@
+# Allow longer lines and methods
+Layout/LineLength:
+  Max: 500
+
+Metrics/MethodLength:
+  Max: 600
+
+# Tests are declarative, no block length test
+Metrics/BlockLength:
+  IgnoredMethods: ["describe", "context", "namespace"]
+ 
+ 
+AllCops:
+  TargetRubyVersion: 2.5
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - "**/templates/**/*"
+    - "**/vendor/**/*"
+    - "**/vendor/**/.*"
+    - "**/node_modules/**/*"
+    - "actionpack/lib/action_dispatch/journey/parser.rb"
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Style/FrozenStringLiteralComment:
+#   Enabled: true
+#   EnforcedStyle: always
+#   Exclude:
+#     - "actionview/test/**/*.builder"
+#     - "actionview/test/**/*.ruby"
+#     - "actionpack/test/**/*.builder"
+#     - "actionpack/test/**/*.ruby"
+#     - "activestorage/db/migrate/**/*.rb"
+#     - "db/migrate/**/*.rb"
+#     - "db/*.rb"
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+# Supports --auto-correct
+Style/RedundantSelf:
+  Description: Don't use self where it's not needed.
+  StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#no-self-unless-required
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.1.2] - 2021-11-16
+
+### Fixed
+
+- Methods and Gem documentation
+- General optimization

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graphql_util.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    graphql_util (0.1.2)
+      graphql-client (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    graphql (1.13.2)
+    graphql-client (0.17.0)
+      activesupport (>= 3.0)
+      graphql (~> 1.10)
+    hashdiff (1.0.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  graphql_util!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Elisacci Lapo
+
+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,155 @@
+![logo](https://user-images.githubusercontent.com/50866745/138700181-01b54097-b19c-4655-b032-237c1a77a1fb.png)
+
+![](https://img.shields.io/badge/Ruby-CC342D?style=for-the-badge&logo=ruby&logoColor=white)
+# GraphQL Util
+
+The gem wraps the Ruby [graphql-client](https://github.com/github/graphql-client) gem, to dinamically define GraphQL Clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql_util'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install graphql_util
+
+## Usage
+
+Define a GraphQL client class, like so:
+
+```Ruby
+  class Client
+    GraphqlUtil.act_as_graphql_client(
+      self, # Required
+      endpoint: 'https://api.github.com/graphql', # Required
+      path: __dir__, # Required, (Recommended: __dir__)
+      headers: {} # Optional
+    )
+  end
+```
+
+The `act_as_graphql_client` method accepts the following parameters:
+
+1. `self`, which allows GraphqlUtil to inject the required code inside the class;
+2. `endpoint`, which has to be the URL of the GraphQL endpoint;
+3. `path`, which has to be the location where to store operations files and the Schema dump. (`__dir__` is the suggested one, but any valid path will do);
+4. `headers`, a Hash of headers to be attached to any performed HTTP request.
+
+### Schema
+
+The very first time the Client class loads, an Introspection Query will be performed agains the GraphQL endpoint to dump the relative Schema.
+You'll find your `schema.json` dump file under the above mentioned `path`.
+
+(Remember that the Graphql Schema may change over time, therefore whenever you need to update the dump, simply delete the file. The new version will get created later.)
+
+### Queries and Mutations
+
+The Graphql operations you want your client to perform must be defined inside `.graphql` files under any `dir` subdirectory.
+
+### Example and Best practise
+
+Let's take the Github Graphql API as an example.
+
+1. First we create a directory (a Ruby module) named `github` to contain all the necessary code.
+2. We then create a file called `client.rb` , just like this:
+
+```Ruby
+  module Github
+    class Client
+      GraphqlUtil.act_as_graphql_client(
+        self,
+        endpoint: 'https://api.github.com/graphql',
+        path: __dir__,
+        headers: { # You can place any HTTP Header here
+          'Authorization': GITHUB_TOKEN
+        }
+      )
+    end
+  end
+```
+
+3. Now we need to define our Queries / Mutations, to do so, place each operation definition under one (or many) subdirectory(ies), like this:
+
+`github/queries/user_info.graphql`
+```GraphQL
+  query userInfo($username: String!) {
+    user(login: $username) {
+      followers(first: 1) {
+        totalCount
+      }
+    }
+  }
+```
+
+or
+
+`github/mutations/add_comment.graphql`
+```GraphQL
+  mutation addComment($input: AddCommentInput!) {
+    clientMutaitonId
+  }
+```
+
+4. Now we have a file structure that looks like this:
+
+```Code
+  github
+  ├── queries
+  │   └── user_info.graphql
+  ├── mutations
+  │   └── add_comment.graphql
+  ├── client.rb
+  └── schema.json
+```
+
+5. Each defined operation generates a class method inside our client to perform the relative request. In our example `.user_info` & `.add_comment`.
+6. Each defined method will accept arguments to be passed as variables.
+
+```Ruby
+Github::Client.user_info(username: 'LapoElisacci')
+```
+
+or
+
+```Ruby
+Github::Client.add_comment(input: { body: 'This gem is awesome!', subjectId: '12345678' })
+```
+
+## Constraints
+
+The client Class as well as the sudirectories names are up to you, but only one level nesting is allowed.
+Something like `anywhere/anything/whatever/whatever.graphql` won't produce the relative method, but `anywhere/anything/whatever.graphql` will, as long as `anywhere/whatever.rb` is the class that "act_as_graphql_client".
+
+```Code
+  anywhere
+  ├── anything
+  │   ├── wont_work
+  │   │   └── wont_work.graphql
+  │   └── anything_that_works.graphql
+  ├── anything_2
+  │   └── anything_that_works_too.graphql
+  ├── whatever.rb
+  └── schema.json
+```
+
+You can find more details about the `graphql-client` [here](https://github.com/github/graphql-client).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LapoElisacci/graphql_util.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql_util"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/graphql_util/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'graphql/client'
+
+class GraphqlUtil::Client < GraphQL::Client
+  #
+  # Performs a GraphQL Query and handles the response
+  #
+  # @param [String] parsed_query GraphQL parsed query
+  # @param [Hash] variables GraphQL query params
+  #
+  # @return [GraphQL::Client::Response] Request Response
+  #
+  def query(parsed_query, variables: {})
+    super(parsed_query, variables: variables, context: {})
+  end
+end

data/lib/graphql_util/http.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'graphql/client/http'
+
+class GraphqlUtil::Http < GraphQL::Client::HTTP
+  attr_accessor :token
+  #
+  # Returns the GraphQL::Client::HTTP instance injecting the PulsarAuthUtil authentication Token
+  #
+  # @param [String] endpoint GraphQL API Endpoint
+  # @param [Hash] headers HTTP Request headers
+  #
+  def initialize(endpoint:, headers: {})
+    @headers = headers
+    super(endpoint) do
+      def headers(context)
+        @headers
+      end
+    end
+  end
+end

data/lib/graphql_util/schema.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'graphql/client'
+
+class GraphqlUtil::Schema
+  #
+  # Initialize the GraphqlUtil::Schema to generate or retrieve the GraphQL Schema dump
+  #
+  # @param [GraphqlUtil::Http] http HTTP Client instance
+  # @param [String] path Path to the client Class
+  #
+  def initialize(http, path:)
+    @http = http
+    @path = path
+  end
+
+  #
+  # Loads the GraphQL Endpoint Introspection Schema from a dumped file if present, or dumps itself if needed
+  #
+  # @return [Class] GraphQL Schema
+  #
+  def load_schema
+    if !File.exist?(@path)
+      schema_dir = File.dirname(@path)
+      FileUtils.mkdir_p(schema_dir) unless File.directory?(schema_dir)
+      GraphQL::Client.dump_schema(@http, @path)
+    end
+
+    GraphQL::Client.load_schema(@path)
+  end
+end

data/lib/graphql_util/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GraphqlUtil
+  VERSION = '0.1.0'
+end

data/lib/graphql_util.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'graphql_util/version'
+require 'graphql_util/client'
+require 'graphql_util/http'
+require 'graphql_util/schema'
+
+module GraphqlUtil
+  #
+  # Allows a Ruby class to behave like a GraphQL Client by extending it with the required methods and constants to perform GraphQL Queries / Mutations.
+  #
+  # * Extends the class with the required methods and constants to perform GraphQL Queries / Mutations
+  # * Dumps the GraphQL Schema into the passed folder
+  # * Dynamically defines constants and methods to perform the queries defined as .graphql files under under the passed path subdirectories
+  #
+  # @param [Class] base Class
+  # @param [String] endpoint GraphQL API Endpoint
+  # @param [String] path GraphQL Schema / Queries definitions path
+  # @param [Hash] headers HTTP Request Headers
+  #
+  # @return [Boolean] true
+  #
+  def self.act_as_graphql_client(base, endpoint:, path:, headers: {})
+    raise 'GraphqlUtil - Constant GRAPHQL_UTIL_HTTP is already defined' if defined?(base::GRAPHQL_UTIL_HTTP)
+    raise 'GraphqlUtil - Constant GRAPHQL_UTIL_SCHEMA is already defined' if defined?(base::GRAPHQL_UTIL_SCHEMA)
+    raise 'GraphqlUtil - Constant GRAPHQL_UTIL_CLIENT is already defined' if defined?(base::GRAPHQL_UTIL_CLIENT)
+    raise 'GraphqlUtil - Constant GRAPHQL_UTIL_SCHEMA_DUMP is already defined' if defined?(base::GRAPHQL_UTIL_SCHEMA_DUMP)
+
+    base.const_set('GRAPHQL_UTIL_SCHEMA_DUMP', "#{path}/schema.json")
+    base.const_set('GRAPHQL_UTIL_HTTP', GraphqlUtil::Http.new(endpoint: endpoint, headers: headers))
+    base.const_set('GRAPHQL_UTIL_SCHEMA', GraphqlUtil::Schema.new(base::GRAPHQL_UTIL_HTTP, path: base::GRAPHQL_UTIL_SCHEMA_DUMP))
+    base.const_set('GRAPHQL_UTIL_CLIENT', GraphqlUtil::Client.new(schema: base::GRAPHQL_UTIL_SCHEMA.load_schema, execute: base::GRAPHQL_UTIL_HTTP))
+    base.extend GraphqlUtilMethods
+
+    Dir["#{path}/**/*.graphql"].each do |filename|
+      const_name = filename.split('/').last.gsub('.graphql', '')
+      raise "GraphqlUtil - #{const_name} is already defined, please use a different filename." if (base.const_get(const_name.upcase.to_sym).present? rescue false)
+
+      base.const_set(const_name.upcase, base::GRAPHQL_UTIL_CLIENT.parse(File.open(filename).read))
+      base.define_singleton_method(const_name.downcase.to_sym) do |variables = {}|
+        base.query(base.const_get(const_name.upcase.to_sym), variables: variables)
+      end
+    end
+
+    true
+  end
+
+  module GraphqlUtilMethods
+    #
+    # Calls the Client query method to perform the passed GraphQL Query / Mutation request with variables
+    #
+    # @param [GraphQL::Client::OperationDefinition] query GraphQL Operation
+    # @param [Hash] variables Variables to be passed to the GraphQL Query / Mutation
+    #
+    # @return [GraphQL::Client::Response] Request Response
+    #
+    def query(query, variables: {})
+      self::GRAPHQL_UTIL_CLIENT.query(query, variables: variables)
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: graphql_util
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elisacci Lapo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GraphqlUtil allows you to dynamically define GraphQL Client
+email:
+- lapoelisacci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/graphql_util.rb
+- lib/graphql_util/client.rb
+- lib/graphql_util/http.rb
+- lib/graphql_util/schema.rb
+- lib/graphql_util/version.rb
+homepage: https://github.com/LapoElisacci/graphql_util
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LapoElisacci/graphql_util
+  source_code_uri: https://github.com/LapoElisacci/graphql_util
+  changelog_uri: https://github.com/LapoElisacci/graphql_util/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby GraphQL Client utility
+test_files: []