graphql_connector 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe4b7086d0edec851e2a6b7f12708e805e6d5eac0454d5eef4aa5cb3267ef4f
-  data.tar.gz: e2261580d8b3b238a7f9c9e1bdc6227290dc42efd51931d15a1a54d54e06afc9
+  metadata.gz: bf451963eb895b192df3959d06d56ea22588c2a38c284743f8289ecbebdc4e7e
+  data.tar.gz: 73b57eb9b9569feb90497f96eb286192cd96d08370a181f92ab15a8855b56294
 SHA512:
-  metadata.gz: 8b45378200a895f3f163e52e99dce0547fa024316cceb5e3e0fa3a1b67859abc230435096667bdf1cb997a67b5b3d00c6e5fccf5d5ea59a1fac7f042b91c5b08
-  data.tar.gz: 621b269795d71c4bdf8ce268cb93b6f5e084e7c434c6d17e01b1c18179e8f133f3cd7b44716669e7d829ebdcbb51f8530b087432669ebd98ebe0a6996a619e95
+  metadata.gz: e41d9ba90e6c33af01647e08243600e19d8c0d412c7701f3d8e0d4c4d0cecd3e3b5b7312c881b8db3782ab28c911b2e5d7541f8bf655fef21e6b980923a65c55
+  data.tar.gz: 9f496a3930e93affe9401a2e7ea0217471d2438619126ba243854202696fba634ed5b592b2a6a87c78daeb592bc4e1a509d9948a7c6012e72b9105a1265c5d3b

data/.rspec

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

data/.travis.yml

@@ -3,7 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.4
-before_install: gem install bundler -v 2.0.2
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 script:
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_connector (1.0.0)
+    graphql_connector (1.1.0)
       httparty (~> 0.17)
 
 GEM
@@ -10,12 +10,12 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    httparty (0.17.1)
+    httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     jaro_winkler (1.5.3)
     method_source (0.9.2)
-    mime-types (3.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.1009)
     multi_xml (0.6.0)
@@ -62,4 +62,4 @@ DEPENDENCIES
   rubocop (~> 0.75)
 
 BUNDLED WITH
-   2.0.2
+   2.1.2

data/README.md

@@ -33,19 +33,31 @@ You need to configure the `graphql_connector` first:
 GraphqlConnector.configure do |config|
   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
 
-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 +76,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 +90,104 @@ Example:
 ['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'>>
+```
+
+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'>>
+```
+
+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
 
 After checking out the repo, run
@@ -100,4 +212,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,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'
 

data/lib/graphql_connector.rb

@@ -5,6 +5,10 @@ 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'
 
@@ -21,7 +25,7 @@ module GraphqlConnector
   end
 
   def self.reset
-    @configuration = Configuration.new
+    @configuration.reset!
   end
 
   def self.configure

data/lib/graphql_connector/base_server_type.rb

@@ -11,6 +11,7 @@ module GraphqlConnector
         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
@@ -25,6 +26,20 @@ module GraphqlConnector
               '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
@@ -47,8 +62,8 @@ module GraphqlConnector
             http_client.query(model, conditions, selected_fields)
           end
 
-          def raw_query(query_string)
-            http_client.raw_query(query_string)
+          def raw_query(query_string, variables: {})
+            http_client.raw_query(query_string, variables: variables)
           end
         end
       end

data/lib/graphql_connector/configuration.rb

@@ -15,6 +15,7 @@ module GraphqlConnector
 
     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/http_client.rb

@@ -13,16 +13,17 @@ module GraphqlConnector
                                                         conditions,
                                                         selected_fields).create
       parsed_body = raw_query(query_string)
-      result = parsed_body['data'][model]
+      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)
+    def raw_query(query_string, variables: {})
       response = HTTParty.post(@uri,
                                headers: @headers,
-                               body: { query: query_string })
+                               body: { query: query_string,
+                                       variables: variables })
       parsed_body = JSON.parse(response.body)
       verify_response!(parsed_body)
       parsed_body

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 = '1.0.0'
+  VERSION = '1.1.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.1.0
 platform: ruby
 authors:
 - Garllon
+- sushie1984
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,10 +95,11 @@ 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: []
@@ -114,6 +116,9 @@ 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
@@ -121,6 +126,10 @@ files:
 - 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:
@@ -147,5 +156,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Simple GraphQL client
+summary: GraphQL client
 test_files: []