graphql_connector 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce0306b4b797a61fd2e4e26036731e5b702c7a3b3772f68f90f8db2f124f1ef
-  data.tar.gz: c7afc2f11f5a6c91bc3f788b08fda857de8451cba6905f179691f002ce6ba643
+  metadata.gz: 3fe4b7086d0edec851e2a6b7f12708e805e6d5eac0454d5eef4aa5cb3267ef4f
+  data.tar.gz: e2261580d8b3b238a7f9c9e1bdc6227290dc42efd51931d15a1a54d54e06afc9
 SHA512:
-  metadata.gz: 82de4e8e154f407995fb1fbe865ee59610d9b283f876e54af68bce38d20a2bc80fe00a08b2b104a6c532c551b6e242fb3b4792efdc5f27122fc4ad597b9edf76
-  data.tar.gz: da700041749e3f7d1ab40f13258c073556d6fc7f316224f3aa3c91368dce06895d9a3b9b4ac6098c896268b147a1cc370d19fe8072683b6255f028ca1c4a6aa2
+  metadata.gz: 8b45378200a895f3f163e52e99dce0547fa024316cceb5e3e0fa3a1b67859abc230435096667bdf1cb997a67b5b3d00c6e5fccf5d5ea59a1fac7f042b91c5b08
+  data.tar.gz: 621b269795d71c4bdf8ce268cb93b6f5e084e7c434c6d17e01b1c18179e8f133f3cd7b44716669e7d829ebdcbb51f8530b087432669ebd98ebe0a6996a619e95

data/.rubocop_todo.yml

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

data/CHANGELOG.md

@@ -1,18 +1,23 @@
+## 1.0.0 (2020-1-26)
 
-### 0.2.0
+### Breaking
+* add multiple graphql server querying
+* `query` and `raw_query` nested under server namespace
 
-** Features
+
+## 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. 
+  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)
 
-### 0.1.0.beta1
-
-** BugFix
-use model instead of hardcoded product
+### BugFix
+* use model instead of hardcoded product
 
 
-### 0.1.0.beta
+## 0.1.0.beta (2019-10-03)
 
-easy graphql logic
+* easy graphql logic

data/Gemfile.lock

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

data/README.md

@@ -1,12 +1,14 @@
+
 # GraphqlConnector
 
 [![Gem
 Version](https://badge.fury.io/rb/graphql_connector.svg)](https://badge.fury.io/rb/graphql_connector)
 [![Build
 Status](https://travis-ci.org/Garllon/graphql_connector.svg?branch=master)](https://travis-ci.org/Garllon/graphql_connector)
+[![Maintainability](https://api.codeclimate.com/v1/badges/548db3cf0d078b379c84/maintainability)](https://codeclimate.com/github/Garllon/graphql_connector/maintainability)
 
 An easy connector to call your `graphql` server. Currently there is no schema
-check in the code, but i will add this.
+check in the code, but i will add it.
 
 ## Installation
 
@@ -29,23 +31,26 @@ 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`.
 ```
 
 ### raw_query
 
 Then you can call your graphql_endpoint:
 ```ruby
-GraphqlConnector.query(model, condition, selected_fields)
+GraphqlConnector::<name>.raw_query(query_string)
 ```
 
+Note that `<name>` has to be replaced by any of the ones added via `add_mapping`
+
 ### query
 
-Or your are using the more comfortable `query`:
+You can also use the more comfortable `query`:
 ```ruby
-GraphqlConnector.query(model, condition, selected_fields)
+GraphqlConnector::<name>.query(model, condition, selected_fields)
 ```
 
 | Variable        | DataType                | Example                                 |
@@ -57,7 +62,7 @@ GraphqlConnector.query(model, condition, selected_fields)
 > 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. 
+> hashes.
 
 #### selected_fields
 
@@ -87,7 +92,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 ## 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
 

data/graphql_connector.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Simple GraphQL client'
   spec.description   = 'Simple grahql client to query with your own raw string'\
-                       'or with the samll helper method query.'
+                       ' or with the small helper method query.'
   spec.homepage      = 'https://github.com/Garllon/graphql_connector/blob/master/README.md'
   spec.license       = 'MIT'
 

data/lib/graphql_connector.rb

@@ -3,6 +3,8 @@
 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/custom_attribute_error'
 require 'httparty'
 
@@ -25,23 +27,4 @@ module GraphqlConnector
   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,57 @@
+# 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)
+
+        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 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)
+            http_client.raw_query(query_string)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql_connector/configuration.rb

@@ -3,11 +3,21 @@
 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.send :remove_const, name
+      end
+      @base_server_types = {}
     end
   end
 end

data/lib/graphql_connector/http_client.rb

@@ -0,0 +1,39 @@
+# 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]
+      return OpenStruct.new(result) unless result.is_a? Array
+
+      result.map { |entry| OpenStruct.new(entry) }
+    end
+
+    def raw_query(query_string)
+      response = HTTParty.post(@uri,
+                               headers: @headers,
+                               body: { query: query_string })
+      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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_connector
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Garllon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
-description: Simple grahql client to query with your own raw stringor with the samll
+description: Simple grahql client to query with your own raw string or with the small
   helper method query.
 email:
 - palluthe.bennet@gmail.com
@@ -116,8 +116,10 @@ files:
 - bin/console
 - 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/version.rb
 homepage: https://github.com/Garllon/graphql_connector/blob/master/README.md