graphql_connector 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe4b7086d0edec851e2a6b7f12708e805e6d5eac0454d5eef4aa5cb3267ef4f
-  data.tar.gz: e2261580d8b3b238a7f9c9e1bdc6227290dc42efd51931d15a1a54d54e06afc9
+  metadata.gz: dec05781e16009638ffb57356c4b648730b6d04eb60129211cc1f462c6b1db77
+  data.tar.gz: fde0b8313c159ae15b43b3aa050c53c710902854080459e41d7da28595226c8d
 SHA512:
-  metadata.gz: 8b45378200a895f3f163e52e99dce0547fa024316cceb5e3e0fa3a1b67859abc230435096667bdf1cb997a67b5b3d00c6e5fccf5d5ea59a1fac7f042b91c5b08
-  data.tar.gz: 621b269795d71c4bdf8ce268cb93b6f5e084e7c434c6d17e01b1c18179e8f133f3cd7b44716669e7d829ebdcbb51f8530b087432669ebd98ebe0a6996a619e95
+  metadata.gz: 4a30c45c22bc87d78bc34377c1bca7e40c78d72c96a8d1e840ee89aec119cacfc01b1a517c86c5ca2867573a160742382bd3bf9ce02f256e8e8f42313b36aa5b
+  data.tar.gz: 218116c1728b4da4583e709435df2f2e1ba3477edcae34ec0958f398e42ccad3fdee8b80d3de1cc3312c4d7cae9a97add6384273d2cc162a4a86031dd4c5f149

data/.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [push]
+
+jobs: 
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.4.10', '2.5.9', '2.6.7', '2.7.3', '3.0.1']
+    name: "ruby ${{ matrix.ruby }}"
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run Test with rspec
+        run: bundle exec rspec spec
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.3
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle install
+    - name: Build and test
+      run: |
+        bundle exec rubocop

data/.rspec

@@ -1 +1,2 @@
 --require spec_helper
+--order rand

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 1.3.0 (2021-06-02)
+
+* add the option to use a connector instead of init header for authorization
+  part of headers 
+
+## 1.2.1 (2021-05-25)
+
+* relax httparty dependency(`~> 0.17` => `~> 0.16`)
+
+## 1.2.0 (2020-12-22)
+
+### Features
+* Add `mutation` under server namespace and service class inclusion
+* See `README` for details
+
+## 1.1.1 (2020-5-04)
+
+### BugFix
+* Omit invalid `()` for empty conditions in `query` method
+
+## 1.1.0 (2020-4-19)
+
+### Features
+* Allow building graphql querying in custom classes via `service class inclusion`
+* See `README` for details about `service class inclusion`
+
+### BugFix
+* Forward `variables` when performing a `raw_query`
+
 ## 1.0.0 (2020-1-26)
 
 ### Breaking

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    graphql_connector (1.0.0)
-      httparty (~> 0.17)
+    graphql_connector (1.3.0)
+      httparty (~> 0.16)
 
 GEM
   remote: https://rubygems.org/
@@ -10,45 +10,46 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    httparty (0.17.1)
+    httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    jaro_winkler (1.5.3)
-    method_source (0.9.2)
-    mime-types (3.3)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2021.0225)
     multi_xml (0.6.0)
-    parallel (1.17.0)
-    parser (2.6.5.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
       ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.5)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.3)
-    rubocop (0.75.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -57,9 +58,8 @@ DEPENDENCIES
   bundler (~> 2.0)
   graphql_connector!
   pry (~> 0.10)
-  rake (~> 10.0)
   rspec (~> 3.8)
   rubocop (~> 0.75)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -3,8 +3,7 @@
 
 [![Gem
 Version](https://badge.fury.io/rb/graphql_connector.svg)](https://badge.fury.io/rb/graphql_connector)
-[![Build
-Status](https://travis-ci.org/Garllon/graphql_connector.svg?branch=master)](https://travis-ci.org/Garllon/graphql_connector)
+[![CI](https://github.com/Garllon/graphql_connector/workflows/CI/badge.svg)](https://github.com/Garllon/graphql_connector/actions?query=workflow%3ACI)
 [![Maintainability](https://api.codeclimate.com/v1/badges/548db3cf0d078b379c84/maintainability)](https://codeclimate.com/github/Garllon/graphql_connector/maintainability)
 
 An easy connector to call your `graphql` server. Currently there is no schema
@@ -31,21 +30,47 @@ Or install it yourself as:
 You need to configure the `graphql_connector` first:
 ``` ruby
 GraphqlConnector.configure do |config|
-  config.add_server(name: 'Foo', uri: 'http://foo.com/api/graphql', headers: {})
+  config.add_server(name: 'Foo', uri: 'http://foo.com/api/graphql', headers: {}, connector: {})
 end
+```
 
-For each graphql server you wish to query use `add_server`.
+The connector is expecting that it contains a `base` connector instance and a
+`method` parameter as string, where it gets the token. Currently like this:
+```ruby
+{ base: TokenAgent.new, method: 'get_authorization_header' }
 ```
 
+Your method should return a hash like this:
+```ruby
+{ 'Authorization' => 'Token HERE' }
+
+When you set a connector, it will override the setting in the headers for
+Authorization.
+
+For each graphql server you wish to query use `add_server`.
+
+Afterwards you will have the following options to fetch and/or mutate data with
+one or many graphql servers:
+
+* `raw_query` --> [Examples](examples/raw_query_examples.rb)
+* `query` --> [Examples](examples/query_examples.rb)
+* `mutation` --> [Examples](examples/mutation_examples.rb)
+* `service class inclusion` --> [Examples](examples/departments_service_class_examples.rb)
+
+See the following sub sections for details
+
 ### raw_query
 
-Then you can call your graphql_endpoint:
+You can call your graphql_endpoint via:
 ```ruby
 GraphqlConnector::<name>.raw_query(query_string)
 ```
 
-Note that `<name>` has to be replaced by any of the ones added via `add_mapping`
+Note that `<name>` has to be replaced by any of the ones added via `add_server`
 
+See also [here](examples/raw_query_examples.rb) for example usage
+
+---
 ### query
 
 You can also use the more comfortable `query`:
@@ -64,9 +89,11 @@ GraphqlConnector::<name>.query(model, condition, selected_fields)
 > supported with OpenStruct, associated objects are still a normal array of
 > hashes.
 
+See also [here](examples/query_examples.rb) for example usage
+
 #### selected_fields
 
-The synatx for the associations looks like the following:
+The syntax for the associations looks like the following:
 ```
 ['<attribute_name>', <association_name>: ['<attribute_name_of_the_association>']]
 ```
@@ -76,6 +103,129 @@ Example:
 ['id', 'name', productCategory: ['id', 'name']]
 ```
 
+---
+
+### mutation
+
+Works in the same way as [query](#query)
+
+See also [here](examples/mutation_examples.rb) for example usage
+
+### Service class inclusion
+
+This approach can be used to `graphqlize` **any** kind of ruby (service) class
+so that it has re-usable graphql `query` and `mutation` **class methods**.
+
+* First add `extend GraphqlConnector::<server>::Query` in the the class(es) that should be `graphqlized`
+
+* Then you can aliases as many graphql server types via `add_query` and/or `add_raw_query` and/or `add_mutation`:
+
+```ruby
+add_query <alias>: :<graphql_server_type>, params: [...], returns: [...]
+
+add_raw_query <alias>: 'query { ... }', params: [...]
+
+add_mutation <alias>: :<graphql_server_type>, params: [...], returns: [...]
+```
+* :grey_exclamation: If not needed omit `params`
+
+See also [here](examples/departments_service_class_examples.rb) and also here for complete example usage:
+
+```ruby
+GraphqlConnector.configure do |config|
+  config.add_server(name: 'Foo', uri: 'http://foo.com/api/graphql', headers: {})
+end
+
+# product.rb
+class Product
+  extend GraphqlConnector::Foo::Query
+
+  add_query all: :products,
+            returns: [:id, :name]
+
+  add_query by_id: :products,
+            params: :id,
+            returns: [:name, product_category: [:id, :name]]
+
+  add_query by_names: :products,
+            params: :names,
+            returns: [:id, :name, product_category: [:id, :name]]
+
+  add_query by: :products,
+            params: [:id, :name],
+            returns: [:name]
+
+  add_query by_category_id: :products,
+            params: :product_category,
+            returns: [product_category: [:id, :name]]
+
+  add_mutation create: :createProduct,
+               params: [:name, :catgetoryId],
+               returns: [:id, :name]
+end
+
+Product.all
+=> [OpenStruct<id=1, name='Demo Product', ...]
+
+Product.by_id(id: 1)
+=> [OpenStruct<name='Demo Product', product_category=<ProductCategory<id=10, name='Demo Category'>>]
+
+Product.by_names(names: ['Demo Product', 'Non Demo Product'])
+=> [OpenStruct<id=1, name='Demo Product', product_category=<ProductCategory<id=10, name='Demo Category'>>, Product<id=2, name='Demo Product' ...]
+
+Product.by(id: 1, name: 'Demo Product')
+=> OpenStruct<name='Demo Product'>
+
+Product.by_category_id(product_category: { id: 10})
+=> OpenStruct<product_category=<ProductCategory<id=10, name='Demo Category'>>
+
+Product.create(name: 'Another Product', catgetoryId: 10)
+=> OpenStruct<id=10, name='Another Product'>
+```
+
+Also custom **class methods** can used to call any kind of `query` and do further selection instead:
+
+```ruby
+class Product
+  extend GraphqlConnector::Foo::Query
+
+  add_query all: :products, returns: [:name]
+
+  def self.by_id(id:)
+    all.select { |products| products.id == id }.first
+  end
+end
+
+Product.by_id(id: 1)
+=> OpenStruct<id=1, name='Demo Product'>>
+```
+
+:warning: Ensure that your custom **class method** never has the **same name** as an `<alias>` of `add_query`, `add_raw_query` or `add_mutation`. Otherwise the associated grapqhl query will not be performed because of [Ruby Open Class principle](https://ruby-lang.co/ruby-open-class/)
+
+
+Example for `raw_query`:
+
+```ruby
+class Product
+  extend GraphqlConnector::Foo::Query
+
+  add_raw_query all: ' query { products { id name } } '
+  add_raw_query by: ' query products($id: !ID, $name: !String) '\
+                '{ products(id: $id, name: $name) { id name } }',
+                params: [:id, :name]
+
+end
+
+Product.all
+=> [ { id: '1', name: 'Demo Product' }, ...]
+
+Product.by(id: '1', name: 'Demo Product')
+=> { id: '1', name: 'Demo Product' }
+
+```
+
+:exclamation: There is no `add_raw_mutation` since `add_raw_query` does already cover such a case
+
 ## Development
 
 After checking out the repo, run
@@ -100,4 +250,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GraphqlConnector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/graphql_connector/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the GraphqlConnector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Garllon/graphql_connector/blob/master/CODE_OF_CONDUCT.md).

data/examples/departments_service_class_examples.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# ! The following examples are used together with
+# ! https://github.com/sushie1984/rails-graphql-server
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+uri = 'http://rails-graphql-server.herokuapp.com/api/graphql'
+GraphqlConnector.configure do |config|
+  config.add_server(name: 'RailsGraphqlServer', uri: uri, headers: {})
+end
+
+# Service class for fetching department data
+class Department
+  extend GraphqlConnector::RailsGraphqlServer::Query
+
+  add_query all: :departments, returns: [:id, :name, employees: [:yearlySalary]]
+
+  add_query by_id: :departments,
+            params: [:id],
+            returns: [:id, :name, employees: [:yearlySalary]]
+
+  add_raw_query all_raw: 'query {
+                            departments {
+                              id name employees { yearlySalary }
+                            }
+                          }'
+
+  add_raw_query by_id_raw: 'query departments($id: [ID!]) {
+                              departments(id: $id) {
+                                name employees { name }
+                              }
+                            }',
+                params: [:id]
+
+  # We use a nested 'input' as of convention for
+  # https://github.com/sushie1984/rails-graphql-server/blob/master/app/graphql/input_objects/department_attributes.rb
+  add_mutation create: :createDepartment,
+               params: :input,
+               returns: [department: %i[id name location]]
+end
+
+Department.all
+
+Department.by_id(id: %w[1 2])
+
+Department.all_raw
+
+Department.by_id_raw(id: %w[1 2])
+
+Department.create(input: { attributes: { name: 'One', location: 'Berlin' } })

data/examples/mutation_examples.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# ! The following examples are used together with
+# ! https://github.com/sushie1984/rails-graphql-server
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+uri = 'http://rails-graphql-server.herokuapp.com/api/graphql'
+GraphqlConnector.configure do |config|
+  config.add_server(name: 'RailsGraphqlServer', uri: uri, headers: {})
+end
+
+department_input = { attributes: { name: 'One', location: 'Berlin' } }
+return_fields = ['department': ['id', 'name', 'employees' => ['yearlySalary']]]
+GraphqlConnector::RailsGraphqlServer.mutation('createDepartment',
+                                              { input: department_input },
+                                              return_fields)

data/examples/query_examples.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# ! The following examples are used together with
+# ! https://github.com/sushie1984/rails-graphql-server
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+uri = 'http://rails-graphql-server.herokuapp.com/api/graphql'
+GraphqlConnector.configure do |config|
+  config.add_server(name: 'RailsGraphqlServer', uri: uri, headers: {})
+end
+
+GraphqlConnector::RailsGraphqlServer.query('departments',
+                                           {},
+                                           ['id', 'name',
+                                            'employees' => ['yearlySalary']])
+
+GraphqlConnector::RailsGraphqlServer.query('departments',
+                                           { id: %w[1 2] },
+                                           ['id', 'name',
+                                            'employees' => ['yearlySalary']])

data/examples/raw_query_examples.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# ! The following examples are used together with
+# ! https://github.com/sushie1984/rails-graphql-server
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+GraphqlConnector.configure do |config|
+  config.add_server(name: 'RailsGraphqlServer',
+                    uri: 'http://rails-graphql-server.herokuapp.com/api/graphql',
+                    headers: {})
+end
+
+GraphqlConnector::RailsGraphqlServer.raw_query(
+  'query { departments { id name employees { yearlySalary } } }'
+)
+
+GraphqlConnector::RailsGraphqlServer.raw_query(
+  'query departments($id: [ID!]) {
+    departments(id: $id) { name employees { name }
+    }
+  }',
+  variables: { id: %w[1 2] }
+)

data/graphql_connector.gemspec

@@ -7,12 +7,13 @@ require 'graphql_connector/version'
 Gem::Specification.new do |spec|
   spec.name          = 'graphql_connector'
   spec.version       = GraphqlConnector::VERSION
-  spec.authors       = ['Garllon']
-  spec.email         = ['palluthe.bennet@gmail.com']
+  spec.authors       = %w[Garllon sushie1984]
+  spec.email         = ['palluthe.bennet@gmail.com', 'sascha_burku@yahoo.de']
 
-  spec.summary       = 'Simple GraphQL client'
-  spec.description   = 'Simple grahql client to query with your own raw string'\
-                       ' or with the small helper method query.'
+  spec.summary       = 'GraphQL client'
+  spec.description   = 'Grahql client to query with your own raw string, '\
+                       'with the small helper method query or with service '\
+                       'class inclusion.'
   spec.homepage      = 'https://github.com/Garllon/graphql_connector/blob/master/README.md'
   spec.license       = 'MIT'
 
@@ -30,11 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '~> 0.17'
+  spec.add_dependency 'httparty', '~> 0.16'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.75'
 end

data/lib/graphql_connector.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
 require 'graphql_connector/version'
-require 'graphql_connector/query_builder'
+require 'graphql_connector/formatters/base_format'
+require 'graphql_connector/formatters/query_format'
+require 'graphql_connector/formatters/mutation_format'
 require 'graphql_connector/configuration'
 require 'graphql_connector/http_client'
 require 'graphql_connector/base_server_type'
+require 'graphql_connector/service_classable/class_method_validator'
+require 'graphql_connector/service_classable/params_validator'
+require 'graphql_connector/service_classable/return_fields_validator'
+require 'graphql_connector/service_classable/queryable'
 require 'graphql_connector/custom_attribute_error'
 require 'httparty'
 
@@ -21,7 +27,7 @@ module GraphqlConnector
   end
 
   def self.reset
-    @configuration = Configuration.new
+    @configuration.reset!
   end
 
   def self.configure

data/lib/graphql_connector/base_server_type.rb

@@ -5,12 +5,12 @@ module GraphqlConnector
   # Class to wrap http_client calls under a specific namespaced class
   class BaseServerType
     class << self
-      def build(name, uri, headers)
+      def build(name, uri, headers, connector = {})
         verify_new_client_type_for!(name)
-        base_class = class_with(uri, headers)
+        base_class = class_with(uri, headers, connector)
         base_object = GraphqlConnector.const_set(name, base_class)
-        inject_http_client(base_object)
-        inject_query_methods(base_object)
+        inject_http_client_delegations(base_object)
+        create_service_class_module(base_object)
 
         base_object
       end
@@ -25,30 +25,37 @@ module GraphqlConnector
               'configuration!'
       end
 
-      def class_with(uri, headers)
-        Class.new do
-          attr_accessor :uri, :headers
-          @uri = uri
-          @headers = headers
-        end
-      end
+      def create_service_class_module(base_object)
+        base_object.class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          module Query
+            def self.extended(base)
+              base.extend(GraphqlConnector::ServiceClassable::Queryable)
+            end
 
-      def inject_http_client(base_object)
-        base_object.instance_eval do
-          def http_client
-            @http_client ||= GraphqlConnector::HttpClient.new(@uri, @headers)
+            def http_client
+              #{base_object}.http_client
+            end
           end
+        METHOD
+      end
+
+      def class_with(uri, headers, connector = {})
+        Class.new do
+          attr_accessor :uri, :headers, :connector
+          @uri       = uri
+          @headers   = headers
+          @connector = connector
         end
       end
 
-      def inject_query_methods(base_object)
+      def inject_http_client_delegations(base_object)
         base_object.instance_eval do
-          def query(model, conditions, selected_fields)
-            http_client.query(model, conditions, selected_fields)
-          end
+          extend SingleForwardable
+          def_delegators :http_client, :query, :raw_query, :mutation
 
-          def raw_query(query_string)
-            http_client.raw_query(query_string)
+          def http_client
+            @http_client ||=
+              GraphqlConnector::HttpClient.new(@uri, @headers, @connector)
           end
         end
       end

data/lib/graphql_connector/configuration.rb

@@ -9,12 +9,14 @@ module GraphqlConnector
       @base_server_types = {}
     end
 
-    def add_server(name:, uri:, headers:)
-      @base_server_types[name] = BaseServerType.build(name, uri, headers)
+    def add_server(name:, uri:, headers:, connector: {})
+      @base_server_types[name] =
+        BaseServerType.build(name, uri, headers, connector)
     end
 
     def reset!
       @base_server_types.keys.each do |name|
+        GraphqlConnector.const_get(name).send :remove_const, 'Query'
         GraphqlConnector.send :remove_const, name
       end
       @base_server_types = {}

data/lib/graphql_connector/formatters/base_format.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module Formatters
+    # Class that returns in query or mutation string format
+    class BaseFormat
+      def initialize(model, conditions, selected_fields)
+        @model = model
+        @conditions = conditions
+        @selected_fields = selected_fields
+      end
+
+      def create
+        <<-STRING
+        #{query_type} {
+          #{@model}#{arguments} {
+            #{parse_fields(@selected_fields)}
+          }
+        }
+        STRING
+      end
+
+      private
+
+      def arguments
+        conditions = @conditions.each_with_object([]) do |(key, value), array|
+          array << "#{key}: #{value_as_parameter(value)}"
+        end
+
+        return '' if conditions.empty?
+
+        "(#{conditions.join(', ')})"
+      end
+
+      def value_as_parameter(value)
+        case value
+        when Array
+          casted_values = value.map { |v| value_as_parameter(v) }
+          "[#{casted_values.join(',')}]"
+        when Hash
+          casted_values = value.map { |k, v| "#{k}: #{value_as_parameter(v)}" }
+          "{#{casted_values.join(',')}}"
+        else
+          scalar_types(value)
+        end
+      end
+
+      def scalar_types(value)
+        case value
+        when TrueClass, FalseClass, Integer, Float
+          value
+        else # fallback to string
+          '"' + value.to_s + '"'
+        end
+      end
+
+      def parse_fields(selected_fields)
+        results = selected_fields.map do |field|
+          case field
+          when Hash
+            handle_association(field)
+          else
+            field
+          end
+        end
+
+        results.join(' ')
+      end
+
+      def handle_association(hash)
+        hash.map do |key, fields|
+          "#{key} { #{parse_fields(fields)} }"
+        end
+      end
+
+      def query_type
+        raise 'query_type undefined'
+      end
+    end
+  end
+end

data/lib/graphql_connector/formatters/mutation_format.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module Formatters
+    # Class that returns in mutation string format
+    class MutationFormat < BaseFormat
+      private
+
+      def query_type
+        'mutation'
+      end
+    end
+  end
+end

data/lib/graphql_connector/formatters/query_format.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module Formatters
+    # Class that returns in query string format
+    class QueryFormat < BaseFormat
+      private
+
+      def query_type
+        'query'
+      end
+    end
+  end
+end

data/lib/graphql_connector/http_client.rb

@@ -3,26 +3,31 @@
 module GraphqlConnector
   # Wrapper class for HTTParty post query
   class HttpClient
-    def initialize(uri, headers)
+    def initialize(uri, headers, connector = {})
       @uri = uri
       @headers = headers
+      @connector = connector
     end
 
     def query(model, conditions, selected_fields)
-      query_string = GraphqlConnector::QueryBuilder.new(model,
-                                                        conditions,
-                                                        selected_fields).create
+      query_string =
+        Formatters::QueryFormat.new(model, conditions, selected_fields).create
       parsed_body = raw_query(query_string)
-      result = parsed_body['data'][model]
-      return OpenStruct.new(result) unless result.is_a? Array
+      format_body(parsed_body['data'][model.to_s])
+    end
 
-      result.map { |entry| OpenStruct.new(entry) }
+    def mutation(model, inputs, selected_fields)
+      query_string =
+        Formatters::MutationFormat.new(model, inputs, selected_fields).create
+      parsed_body = raw_query(query_string)
+      format_body(parsed_body['data'][model.to_s])
     end
 
-    def raw_query(query_string)
+    def raw_query(query_string, variables: {})
       response = HTTParty.post(@uri,
-                               headers: @headers,
-                               body: { query: query_string })
+                               headers: handle_headers,
+                               body: { query: query_string,
+                                       variables: variables })
       parsed_body = JSON.parse(response.body)
       verify_response!(parsed_body)
       parsed_body
@@ -30,6 +35,19 @@ module GraphqlConnector
 
     private
 
+    def handle_headers
+      return @headers if @connector.empty?
+
+      @headers
+        .merge(@connector[:base].send(@connector[:method]))
+    end
+
+    def format_body(response_body)
+      return OpenStruct.new(response_body) unless response_body.is_a? Array
+
+      response_body.map { |entry| OpenStruct.new(entry) }
+    end
+
     def verify_response!(parsed_body)
       return unless parsed_body.key? 'errors'
 

data/lib/graphql_connector/service_classable/class_method_validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module ServiceClassable
+    class ClassMethodAlreadyImplementedError < StandardError; end
+    class InvalidClassTypeError < StandardError; end
+    # Checks whether a class method for a specific graphql query is in an
+    # expected format
+    class ClassMethodValidator
+      class << self
+        def validate_class_method(class_method_name, invoked_class)
+          return unless invoked_class.singleton_methods
+                                     .map(&:to_s)
+                                     .include?(class_method_name.to_s)
+
+          error_msg = "The method '#{class_method_name}: ... ' is "\
+                      'already implemented within the context of '\
+                      "#{invoked_class} and therefore cannot be used again!"
+          raise ClassMethodAlreadyImplementedError, error_msg
+        end
+
+        def validate_element_class_type(element, class_types)
+          return if element.class == class_types
+
+          raise InvalidClassTypeError, "Please ensure that #{element} is a"\
+                                       "#{class_types}!"
+        end
+      end
+    end
+  end
+end

data/lib/graphql_connector/service_classable/params_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module ServiceClassable
+    class InvalidParamsError < StandardError; end
+    # Checks whether params for a specifc graphql query are in an expected
+    # format
+    class ParamsValidator
+      class << self
+        def validate(query_params)
+          params = [query_params].flatten
+          return if params.empty? ||
+                    params.map(&:class).uniq == [Symbol] ||
+                    params.map(&:class).uniq == [String]
+
+          raise InvalidParamsError,
+                "Please ensure that #{query_params} are either "\
+                'Symbols/Strings as described in the README '\
+                '(e.g.: params: [:id, :name])'
+        end
+      end
+    end
+  end
+end

data/lib/graphql_connector/service_classable/queryable.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module ServiceClassable
+    # Module that allows to build query methods within the context of
+    # service class
+    module Queryable
+      CONDITIONS = 'binding.local_variables.map do |var|
+                      [var, binding.local_variable_get(var)]
+                    end.to_h'
+
+      def add_query(params: [], returns:, **method_to_query)
+        class_method_name = method_to_query.first[0]
+        query_type = method_to_query.first[1]
+        ReturnFieldsValidator.validate(returns)
+        ClassMethodValidator.validate_class_method(class_method_name, self)
+        ClassMethodValidator.validate_element_class_type(query_type, Symbol)
+
+        if params.empty?
+          return query_method(class_method_name, query_type, returns)
+        end
+
+        ParamsValidator.validate(params)
+        query_keyword_method(class_method_name, query_type, params, returns)
+      end
+
+      def add_raw_query(params: [], **method_to_raw_query)
+        class_method_name = method_to_raw_query.first[0]
+        query_string = method_to_raw_query.first[1]
+        ClassMethodValidator.validate_class_method(class_method_name, self)
+        ClassMethodValidator.validate_element_class_type(query_string, String)
+
+        if params.empty?
+          return raw_query_method(class_method_name, query_string)
+        end
+
+        ParamsValidator.validate(params)
+        raw_query_keyword_method(class_method_name, query_string, params)
+      end
+
+      def add_mutation(params: [], returns:, **method_to_query)
+        class_method_name = method_to_query.first[0]
+        query_type = method_to_query.first[1]
+        ReturnFieldsValidator.validate(returns)
+        ClassMethodValidator.validate_class_method(class_method_name, self)
+        ClassMethodValidator.validate_element_class_type(query_type, Symbol)
+
+        if params.empty?
+          return mutation_method(class_method_name, query_type, returns)
+        end
+
+        ParamsValidator.validate(params)
+        mutation_keyword_method(class_method_name, query_type, params, returns)
+      end
+
+      private
+
+      def query_method(class_method_name, query_type, return_fields)
+        define_singleton_method class_method_name do
+          http_client.query(query_type, {}, return_fields.to_a)
+        end
+      end
+
+      def raw_query_method(class_method_name, query_string)
+        define_singleton_method class_method_name do
+          http_client.raw_query(query_string)
+        end
+      end
+
+      def query_keyword_method(name, query_type, keywords, return_fields)
+        keywords = [keywords].flatten
+        instance_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}(#{keywords.map { |keyword| "#{keyword}:" }.join(', ')})
+            http_client.query("#{query_type}",
+                              #{CONDITIONS},
+                              #{return_fields.to_a})
+          end
+        METHOD
+      end
+
+      def raw_query_keyword_method(name, query_string, keywords)
+        keywords = [keywords].flatten
+        instance_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}(#{keywords.map { |keyword| "#{keyword}:" }.join(', ')})
+            http_client.raw_query("#{query_string}", variables: #{CONDITIONS})
+          end
+        METHOD
+      end
+
+      def mutation_method(class_method_name, query_type, return_fields)
+        define_singleton_method class_method_name do
+          http_client.mutation(query_type, {}, return_fields.to_a)
+        end
+      end
+
+      def mutation_keyword_method(name, query_type, keywords, return_fields)
+        keywords = [keywords].flatten
+        instance_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}(#{keywords.map { |keyword| "#{keyword}:" }.join(', ')})
+            http_client.mutation("#{query_type}",
+                                  #{CONDITIONS},
+                                  #{return_fields.to_a})
+          end
+        METHOD
+      end
+    end
+  end
+end

data/lib/graphql_connector/service_classable/return_fields_validator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  module ServiceClassable
+    class ReturnFieldsErrors < StandardError; end
+    # Valdations for return fields set within the context of a service class
+    class ReturnFieldsValidator
+      class << self
+        def validate(return_fields)
+          unless return_fields.is_a?(Array)
+            raise ReturnFieldsErrors, 'Please ensure that returns is followed '\
+                                      'by an array. E.g. returns: [:id]'
+          end
+
+          return_fields.each { |entry| recursive_validation(entry) }
+        end
+
+        private
+
+        def recursive_validation(entry)
+          case entry
+          when Hash
+            hash_validation(entry)
+          when Array
+            entry.each { |item| recursive_validation(item) }
+          else
+            return if [String, Symbol].member?(entry.class)
+
+            raise ReturnFieldsErrors, "The #{entry} is neither a String nor a"\
+                                      'Symbol!'
+          end
+        end
+
+        def hash_validation(hash)
+          hash.each do |key, value|
+            recursive_validation(key)
+            recursive_validation(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql_connector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlConnector
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql_connector
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Garllon
-autorequire: 
+- sushie1984
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,19 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
-description: Simple grahql client to query with your own raw string or with the small
-  helper method query.
+description: Grahql client to query with your own raw string, with the small helper
+  method query or with service class inclusion.
 email:
 - palluthe.bennet@gmail.com
+- sascha_burku@yahoo.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -114,13 +102,23 @@ files:
 - LICENSE.txt
 - README.md
 - bin/console
+- examples/departments_service_class_examples.rb
+- examples/mutation_examples.rb
+- examples/query_examples.rb
+- examples/raw_query_examples.rb
 - graphql_connector.gemspec
 - lib/graphql_connector.rb
 - lib/graphql_connector/base_server_type.rb
 - lib/graphql_connector/configuration.rb
 - lib/graphql_connector/custom_attribute_error.rb
+- lib/graphql_connector/formatters/base_format.rb
+- lib/graphql_connector/formatters/mutation_format.rb
+- lib/graphql_connector/formatters/query_format.rb
 - lib/graphql_connector/http_client.rb
-- lib/graphql_connector/query_builder.rb
+- lib/graphql_connector/service_classable/class_method_validator.rb
+- lib/graphql_connector/service_classable/params_validator.rb
+- lib/graphql_connector/service_classable/queryable.rb
+- lib/graphql_connector/service_classable/return_fields_validator.rb
 - lib/graphql_connector/version.rb
 homepage: https://github.com/Garllon/graphql_connector/blob/master/README.md
 licenses:
@@ -129,7 +127,7 @@ metadata:
   homepage_uri: https://github.com/Garllon/graphql_connector/blob/master/README.md
   source_code_uri: https://github.com/Garllon/graphql_connector
   changelog_uri: https://github.com/Garllon/graphql_connector/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Simple GraphQL client
+summary: GraphQL client
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.4
-before_install: gem install bundler -v 2.0.2
-script:
-  - bundle exec rspec spec

data/lib/graphql_connector/query_builder.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module GraphqlConnector
-  # create the graphql query_string out of the given attributes.
-  class QueryBuilder
-    def initialize(model, conditions, selected_fields)
-      @model            = model
-      @conditions       = conditions
-      @selected_fields  = selected_fields
-    end
-
-    def create
-      "query { #{main_filter} { #{parse_fields(@selected_fields)} } }"
-    end
-
-    private
-
-    def main_filter
-      conditions = @conditions.each_with_object([]) do |(key, value), array|
-        next if value.is_a? Hash # will be processed in #field_with_filter
-
-        array << "#{key}: #{value_as_parameter(value)}"
-      end
-
-      "#{@model}(#{conditions.join(', ')})"
-    end
-
-    def value_as_parameter(value)
-      case value
-      when TrueClass, FalseClass, Integer, Float
-        value
-      when Array
-        casted_values = value.map { |v| value_as_parameter(v) }
-        "[#{casted_values.join(',')}]"
-      else # fallback to string
-        '"' + value.to_s + '"'
-      end
-    end
-
-    def parse_fields(selected_fields)
-      results = selected_fields.map do |field|
-        case field
-        when Hash
-          handle_association(field)
-        else
-          field
-        end
-      end
-
-      results.join(' ')
-    end
-
-    def handle_association(hash)
-      hash.map do |key, fields|
-        "#{key} { #{parse_fields(fields)} }"
-      end
-    end
-  end
-end