graphql_connector 0.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce0306b4b797a61fd2e4e26036731e5b702c7a3b3772f68f90f8db2f124f1ef
-  data.tar.gz: c7afc2f11f5a6c91bc3f788b08fda857de8451cba6905f179691f002ce6ba643
+  metadata.gz: b5e948edafea5975fe63377a5da8f4ca6d01d9876393a811da385b3d3f07fa88
+  data.tar.gz: 8aa20c39ae60c975e8e17fb1b54e8715a39d2be4f536d1e6df053a93208096b3
 SHA512:
-  metadata.gz: 82de4e8e154f407995fb1fbe865ee59610d9b283f876e54af68bce38d20a2bc80fe00a08b2b104a6c532c551b6e242fb3b4792efdc5f27122fc4ad597b9edf76
-  data.tar.gz: da700041749e3f7d1ab40f13258c073556d6fc7f316224f3aa3c91368dce06895d9a3b9b4ac6098c896268b147a1cc370d19fe8072683b6255f028ca1c4a6aa2
+  metadata.gz: a3a49cf0f8be6bbb061d29e34a5224c76f287c84a9fc2a9af51ba3c4475a043cb0321870ecd59ee027be111335a961b9ec55f609a5721429cabfb5897af5d4ed
+  data.tar.gz: f051786162a0f05136acc59d1682012c54c1d2d306f3e9284a8136b70be80410b101731c2c608d71d1f600101df0f0427917c0777c9ae725c1ebb8e1bee4bf80

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/.rubocop_todo.yml

@@ -1,3 +1,6 @@
 Lint/DuplicateMethods:
   Exclude:
     - lib/graphql_connector.rb
+Metrics/BlockLength:
+  Exclude:
+    - spec/graphql_connector/**/*.rb

data/CHANGELOG.md

@@ -1,18 +1,47 @@
+## 1.2.1 (2021-05-25)
 
-### 0.2.0
+* relax httparty dependency(`~> 0.17` => `~> 0.16`)
 
-** Features
+## 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
+* add multiple graphql server querying
+* `query` and `raw_query` nested under server namespace
+
+
+## 0.2.0 (2019-11-19)
+
+### Features
 * new `raw_query` method. you have to write the graphql query
-  string by your self and also you get only the parsed json back. 
+  string by your self and also you get only the parsed json back.
 * query supports associations for the selected_fields attribute
 
+## 0.1.0.beta1 (2019-10-06)
 
-### 0.1.0.beta1
-
-** BugFix
-use model instead of hardcoded product
+### BugFix
+* use model instead of hardcoded product
 
 
-### 0.1.0.beta
+## 0.1.0.beta (2019-10-03)
 
-easy graphql logic
+* easy graphql logic

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    graphql_connector (0.2.0)
-      httparty (~> 0.17)
+    graphql_connector (1.2.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

@@ -1,12 +1,13 @@
+
 # GraphqlConnector
 
 [![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
-check in the code, but i will add this.
+check in the code, but i will add it.
 
 ## Installation
 
@@ -29,23 +30,39 @@ Or install it yourself as:
 You need to configure the `graphql_connector` first:
 ``` ruby
 GraphqlConnector.configure do |config|
-  config.host = ''
-  config.headers = {}
+  config.add_server(name: 'Foo', uri: 'http://foo.com/api/graphql', headers: {})
 end
 ```
 
+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.query(model, condition, selected_fields)
+GraphqlConnector::<name>.raw_query(query_string)
 ```
 
+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
 
-Or your are using the more comfortable `query`:
+You can also use the more comfortable `query`:
 ```ruby
-GraphqlConnector.query(model, condition, selected_fields)
+GraphqlConnector::<name>.query(model, condition, selected_fields)
 ```
 
 | Variable        | DataType                | Example                                 |
@@ -57,11 +74,13 @@ GraphqlConnector.query(model, condition, selected_fields)
 > Caution:
 > You get an OpenStruct back. Currently only the first level attributes are
 > supported with OpenStruct, associated objects are still a normal array of
-> hashes. 
+> 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>']]
 ```
@@ -71,6 +90,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
@@ -87,7 +229,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/garllon/graphql_connector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/garllon/graphql_connector](https://github.com/garllon/graphql_connector). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -95,4 +237,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' } })