graphql_connector 0.2.0 → 1.2.1

data/lib/graphql_connector/service_classable/queryable.rb

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

data/lib/graphql_connector/service_classable/return_fields_validator.rb

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

data/lib/graphql_connector/version.rb

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

metadata

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

data/.travis.yml

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

data/lib/graphql_connector/query_builder.rb

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