graphql_connector 0.1.0.beta → 1.1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9f9c92e28fb86eff5e5fce2e6f7ed2302517c43bb0697247aaf729c0d23ba5
-  data.tar.gz: 8ae4ab7860cef16ecf330314d5fc1739851eb198945e248e4327ce5bcc39785e
+  metadata.gz: 8dbc699b8eeae3209dd9c8b4ddd01bcd0e544a56ac099465dc1508b1cb5d89fc
+  data.tar.gz: b7136a702f6c91413eb232cc3c10516c4404462a5ebe97a74bb573df6ce70f79
 SHA512:
-  metadata.gz: 4fcfa21b2178e1408b115bb4741217449bebad3c50fef8a2c260aaddb6d54a8b5207e502be349c55cfc1521b3a5484f7e2d59a67c5c3f4e766f64ae74ef254b0
-  data.tar.gz: 5d96018a7e2f5ab81fa0e35bec3b0e2d840d799be6551ac9aee4c63366bd7d7a77fd210ebbc9b85a34303145cb3687719aa6cb1dbda13a55413d080fb309ce26
+  metadata.gz: 28c64334cab94490d9f0cb4cd3aa210a5f4c647282b72ebb5bd9d7ed45ab29afd4e1dda57b483ab341835da4b52770a84e493f6a4e0e2cbc9a8d111a08832ccc
+  data.tar.gz: 9f4d50ce4a1cc525834c51f1f1a454ae00e269c74c6eb19369f398b6acce766c1f5d24c5ecf81698ca3f1d49df09686ca741d3454c467e50285f11cd58cbdbb9

data/.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [push]
+
+jobs: 
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.4.x', '2.5.x', '2.6.x', '2.7.x']
+    name: "ruby ${{ matrix.ruby }}"
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/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: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    - 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.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

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

data/CHANGELOG.md

@@ -1,3 +1,37 @@
-### 0.1.0 Init
+## 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.
+* query supports associations for the selected_fields attribute
+
+## 0.1.0.beta1 (2019-10-06)
+
+### BugFix
+* use model instead of hardcoded product
+
+
+## 0.1.0.beta (2019-10-03)
+
+* easy graphql logic

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_connector (0.1.0)
+    graphql_connector (1.1.1)
       httparty (~> 0.17)
 
 GEM
@@ -10,45 +10,46 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    httparty (0.17.1)
+    httparty (0.18.0)
       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.0904)
+    mime-types-data (3.2019.1009)
     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.4)
+    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
@@ -56,10 +57,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   graphql_connector!
-  pry
-  rake (~> 10.0)
+  pry (~> 0.10)
   rspec (~> 3.8)
   rubocop (~> 0.75)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,12 +1,13 @@
-# GraphqlConnector
 
-[![Build
-Status](https://travis-ci.org/Garllon/graphql_connector.svg?branch=master)](https://travis-ci.org/Garllon/graphql_connector)
+# GraphqlConnector
 
-An easy connector to call your `graphql` server. 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphql_connector`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem
+Version](https://badge.fury.io/rb/graphql_connector.svg)](https://badge.fury.io/rb/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)
 
-TODO: Delete this and the text above, and describe your gem
+An easy connector to call your `graphql` server. Currently there is no schema
+check in the code, but i will add it.
 
 ## Installation
 
@@ -29,21 +30,162 @@ 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)
+* `service class inclusion` --> [Examples](examples/departments_service_class_examples.rb)
+
+See the following sub sections for details
+
+### raw_query
+
+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_server`
+
+See also [here](examples/raw_query_examples.rb) for example usage
+
+---
+### query
+
+You can also use the more comfortable `query`:
+```ruby
+GraphqlConnector::<name>.query(model, condition, selected_fields)
+```
+
+| Variable        | DataType                | Example                                 |
+|----------------|-------------------------|------------------------------------------|
+| model           | String                  | 'product'                               |
+| condition       | Hash(key, value)        | { id: 1 }                               |
+| selected_fields | Array of Strings/Hashes | ['id', 'name', productCategory: ['id']] |
+
+> 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.
+
+See also [here](examples/query_examples.rb) for example usage
+
+#### selected_fields
+
+The syntax for the associations looks like the following:
+```
+['<attribute_name>', <association_name>: ['<attribute_name_of_the_association>']]
+```
+
+Example:
+```ruby
+['id', 'name', productCategory: ['id', 'name']]
+```
+
+---
+
+### Service class inclusion
+
+This approach can be used to `graphqlize` **any** kind of ruby (service) class
+so that it has re-usable graphql query methods.
+
+* First add `extend GraphqlConnector::<server>::Query` in the the class(es) that should be `graphqlized`
+* Next for each mapping add a `add_query` or `add_raw_query` aliasing the graphql server type supports as follows:
+  * `add_query <alias>: <query type in graphql server>, params: [<any kind of query type params>], returns: [<selected_fields>]`
+  * `add_raw_query <alias>: <query string>, params: [<any kind of query type params>]`
+  * If <query type>/<query string> does not need them, omit `params`
+
+See also [here](examples/departments_service_class_examples.rb) for example usage as also in the following:
+
+```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]]
 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'>>
 ```
 
-Then you can call your graphql_endpoint:
+Also custom **class methods** can used to call any kind of `query` and do further selection instead:
+
 ```ruby
-GraphqlConnector.query(model, condition, selected_fields)
+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'>>
 ```
 
-| Variable        | DataType         | Example        |
-| ----------------|------------------| ---------------|
-| model           | String           | 'product'      |
-| condition       | Hash(key, value) | { id: 1 }      |
-| selected_fields | Array of Strings | ['id', 'name'] |
+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' }
+
+```
 
 ## Development
 
@@ -53,12 +195,15 @@ bundle install
 ```
 
 Then, run
-```bundle exec rspec spec` to run the tests.
+```shell
+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/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
 
@@ -66,4 +211,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,38 @@
+# frozen_string_literal: true
+
+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]
+end
+
+Department.all
+
+Department.by_id(id: %w[1 2])
+
+Department.all_raw
+
+Department.by_id_raw(id: %w[1 2])

data/examples/query_examples.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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,19 @@
+# frozen_string_literal: true
+
+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,11 +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       = 'Hallo'
-  spec.description   = 'Hallo'
+  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'
 
@@ -20,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.metadata['changelog_uri'] = 'https://github.com/Garllon/graphql_connector/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
   end
@@ -31,8 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'httparty', '~> 0.17'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop', '~> 0.75'
 end

data/lib/graphql_connector.rb

@@ -3,8 +3,18 @@
 require 'graphql_connector/version'
 require 'graphql_connector/query_builder'
 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'
 
+# Main file of the GraphQLConnector
+#   the main methods to configure the gem
+#   and to run a raw_query or a normal query.
 module GraphqlConnector
   class << self
     attr_accessor :configuration
@@ -15,19 +25,10 @@ module GraphqlConnector
   end
 
   def self.reset
-    @configuration = Configuration.new
+    @configuration.reset!
   end
 
   def self.configure
     yield(configuration)
   end
-
-  def self.query(model, conditions, selected_fields)
-    query_string = QueryBuilder.new(model, conditions, selected_fields).create
-    response = HTTParty.post(GraphqlConnector.configuration.host,
-                             headers: GraphqlConnector.configuration.headers,
-                             body: { query: query_string })
-    parsed_body = JSON.parse(response.body)
-    OpenStruct.new(parsed_body['data']['product'])
-  end
 end

data/lib/graphql_connector/base_server_type.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  class BaseServerTypeAlreadyExistsError < StandardError; end
+  # Class to wrap http_client calls under a specific namespaced class
+  class BaseServerType
+    class << self
+      def build(name, uri, headers)
+        verify_new_client_type_for!(name)
+        base_class = class_with(uri, headers)
+        base_object = GraphqlConnector.const_set(name, base_class)
+        inject_http_client(base_object)
+        inject_query_methods(base_object)
+        create_service_class_module(base_object)
+
+        base_object
+      end
+
+      private
+
+      def verify_new_client_type_for!(name)
+        return unless GraphqlConnector.const_defined?(name)
+
+        raise BaseServerTypeAlreadyExistsError,
+              "The name: #{name} is already in use. Check your "\
+              'configuration!'
+      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 http_client
+              #{base_object}.http_client
+            end
+          end
+        METHOD
+      end
+
+      def class_with(uri, headers)
+        Class.new do
+          attr_accessor :uri, :headers
+          @uri = uri
+          @headers = headers
+        end
+      end
+
+      def inject_http_client(base_object)
+        base_object.instance_eval do
+          def http_client
+            @http_client ||= GraphqlConnector::HttpClient.new(@uri, @headers)
+          end
+        end
+      end
+
+      def inject_query_methods(base_object)
+        base_object.instance_eval do
+          def query(model, conditions, selected_fields)
+            http_client.query(model, conditions, selected_fields)
+          end
+
+          def raw_query(query_string, variables: {})
+            http_client.raw_query(query_string, variables: variables)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql_connector/configuration.rb

@@ -1,10 +1,24 @@
+# frozen_string_literal: true
+
 module GraphqlConnector
+  # The configuration template file for the gem.
   class Configuration
-    attr_accessor :host, :headers
+    attr_reader :base_server_types
 
     def initialize
-      @host = nil
-      @headers = nil
+      @base_server_types = {}
+    end
+
+    def add_server(name:, uri:, headers:)
+      @base_server_types[name] = BaseServerType.build(name, uri, headers)
+    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 = {}
     end
   end
 end

data/lib/graphql_connector/custom_attribute_error.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class CustomAttributeError < StandardError; end

data/lib/graphql_connector/http_client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GraphqlConnector
+  # Wrapper class for HTTParty post query
+  class HttpClient
+    def initialize(uri, headers)
+      @uri = uri
+      @headers = headers
+    end
+
+    def query(model, conditions, selected_fields)
+      query_string = GraphqlConnector::QueryBuilder.new(model,
+                                                        conditions,
+                                                        selected_fields).create
+      parsed_body = raw_query(query_string)
+      result = parsed_body['data'][model.to_s]
+      return OpenStruct.new(result) unless result.is_a? Array
+
+      result.map { |entry| OpenStruct.new(entry) }
+    end
+
+    def raw_query(query_string, variables: {})
+      response = HTTParty.post(@uri,
+                               headers: @headers,
+                               body: { query: query_string,
+                                       variables: variables })
+      parsed_body = JSON.parse(response.body)
+      verify_response!(parsed_body)
+      parsed_body
+    end
+
+    private
+
+    def verify_response!(parsed_body)
+      return unless parsed_body.key? 'errors'
+
+      raise CustomAttributeError, parsed_body['errors']
+    end
+  end
+end

data/lib/graphql_connector/query_builder.rb

@@ -1,4 +1,7 @@
+# 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
@@ -7,31 +10,52 @@ module GraphqlConnector
     end
 
     def create
-      "query { #{@model}(#{main_filter}) { #{@selected_fields.join(' ')} } }"
+      "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
+
+      return @model if conditions.empty?
+
+      "#{@model}(#{conditions.join(', ')})"
     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
-
-	  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 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

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 (raw_)add_query '#{class_method_name}: ... ' is "\
+                      'already implemented within the context of '\
+                      "#{invoked_class} and therefore cannot be used!"
+          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,76 @@
+# 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
+
+      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
+    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 = '0.1.0.beta'
+  VERSION = '1.1.1.1'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 1.1.1.1
 platform: ruby
 authors:
 - Garllon
+- sushie1984
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,47 +40,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -94,16 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
-description: Hallo
+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"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -111,10 +102,20 @@ files:
 - LICENSE.txt
 - README.md
 - bin/console
+- examples/departments_service_class_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/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:
@@ -134,12 +135,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Hallo
+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