graphql_connector 0.2.0 → 1.2.1

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

@@ -0,0 +1,21 @@
+# 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
+
+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,24 @@
+# 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',
+                    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 samll 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'
 
@@ -30,11 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '~> 0.17'
+  spec.add_dependency 'httparty', '~> 0.16'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.75'
 end

data/lib/graphql_connector.rb

@@ -1,8 +1,16 @@
 # 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'
+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'
 
@@ -19,29 +27,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
-    parsed_body = raw_query(query_string)
-    OpenStruct.new(parsed_body['data'][model])
-  end
-
-  def self.raw_query(query_string)
-    response = HTTParty.post(GraphqlConnector.configuration.host,
-                             headers: GraphqlConnector.configuration.headers,
-                             body: { query: query_string })
-    parsed_body = JSON.parse(response.body)
-
-    if parsed_body.key? 'errors'
-      raise CustomAttributeError, parsed_body['errors']
-    end
-
-    parsed_body
-  end
 end

data/lib/graphql_connector/base_server_type.rb

@@ -0,0 +1,62 @@
+# 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_delegations(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_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
+    end
+  end
+end

data/lib/graphql_connector/configuration.rb

@@ -3,11 +3,22 @@
 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/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

@@ -0,0 +1,49 @@
+# 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 =
+        Formatters::QueryFormat.new(model, conditions, selected_fields).create
+      parsed_body = raw_query(query_string)
+      format_body(parsed_body['data'][model.to_s])
+    end
+
+    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: {})
+      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 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'
+
+      raise CustomAttributeError, parsed_body['errors']
+    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 method '#{class_method_name}: ... ' is "\
+                      'already implemented within the context of '\
+                      "#{invoked_class} and therefore cannot be used again!"
+          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