graphql_connector 1.1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dbc699b8eeae3209dd9c8b4ddd01bcd0e544a56ac099465dc1508b1cb5d89fc
-  data.tar.gz: b7136a702f6c91413eb232cc3c10516c4404462a5ebe97a74bb573df6ce70f79
+  metadata.gz: 76343e24e10c4dd1cf216693639ca283fa96c6562e10432b7815f57effd07171
+  data.tar.gz: 83f6e99ac9d87619e2464d7436493ccc0eaa79b2a27cf9d60103e806fe2d09aa
 SHA512:
-  metadata.gz: 28c64334cab94490d9f0cb4cd3aa210a5f4c647282b72ebb5bd9d7ed45ab29afd4e1dda57b483ab341835da4b52770a84e493f6a4e0e2cbc9a8d111a08832ccc
-  data.tar.gz: 9f4d50ce4a1cc525834c51f1f1a454ae00e269c74c6eb19369f398b6acce766c1f5d24c5ecf81698ca3f1d49df09686ca741d3454c467e50285f11cd58cbdbb9
+  metadata.gz: 725ae753055da95a57738ce5581e9e877bbd54c0511eab2726e2b415701e9be8ca1dd3e5db201af8cbdadc0e70e855ee90f7c7bc58a9e95591fbe19a6eb4c58f
+  data.tar.gz: 3f4b4ecfe3ea1a75010c94e9d8dab85b192ef254a84f913f635584d814689d6fabca96d416c74ed75acfb1acb12a02397d0353b10effe6ad8d8d7b0fa75c6564

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_connector (1.1.1)
+    graphql_connector (1.2.0)
       httparty (~> 0.17)
 
 GEM

data/README.md

@@ -41,6 +41,7 @@ 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
@@ -91,18 +92,31 @@ Example:
 
 ---
 
+### 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 methods.
+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`
-* 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:
+* 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|
@@ -131,6 +145,10 @@ class Product
   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
@@ -147,6 +165,9 @@ Product.by(id: 1, 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:
@@ -166,6 +187,9 @@ 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
@@ -187,6 +211,8 @@ Product.by(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

data/examples/departments_service_class_examples.rb

@@ -1,5 +1,10 @@
 # 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: {})
@@ -27,6 +32,12 @@ class Department
                               }
                             }',
                 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
@@ -36,3 +47,5 @@ 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

@@ -1,5 +1,10 @@
 # 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: {})

data/examples/raw_query_examples.rb

@@ -1,5 +1,10 @@
 # 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',

data/lib/graphql_connector.rb

@@ -1,7 +1,9 @@
 # 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'

data/lib/graphql_connector/base_server_type.rb

@@ -9,8 +9,7 @@ module GraphqlConnector
         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)
+        inject_http_client_delegations(base_object)
         create_service_class_module(base_object)
 
         base_object
@@ -48,25 +47,16 @@ module GraphqlConnector
         end
       end
 
-      def inject_http_client(base_object)
+      def inject_http_client_delegations(base_object)
         base_object.instance_eval do
+          extend SingleForwardable
+          def_delegators :http_client, :query, :raw_query, :mutation
+
           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/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

@@ -9,14 +9,17 @@ module GraphqlConnector
     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.to_s]
-      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, variables: {})
@@ -31,6 +34,12 @@ module GraphqlConnector
 
     private
 
+    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

@@ -13,9 +13,9 @@ module GraphqlConnector
                                      .map(&:to_s)
                                      .include?(class_method_name.to_s)
 
-          error_msg = "The (raw_)add_query '#{class_method_name}: ... ' is "\
+          error_msg = "The method '#{class_method_name}: ... ' is "\
                       'already implemented within the context of '\
-                      "#{invoked_class} and therefore cannot be used!"
+                      "#{invoked_class} and therefore cannot be used again!"
           raise ClassMethodAlreadyImplementedError, error_msg
         end
 

data/lib/graphql_connector/service_classable/queryable.rb

@@ -38,6 +38,21 @@ module GraphqlConnector
         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)
@@ -71,6 +86,23 @@ module GraphqlConnector
           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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql_connector
 version: !ruby/object:Gem::Version
-  version: 1.1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Garllon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -103,6 +103,7 @@ files:
 - 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
@@ -110,8 +111,10 @@ files:
 - 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

data/lib/graphql_connector/query_builder.rb

@@ -1,61 +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
-
-      return @model if conditions.empty?
-
-      "#{@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