graphql_connector 0.1.0.beta1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc6fbc6e76e115e9f9b9cbc0a17c5e09d6404f0f3f688e69095fa80ef308c59a
-  data.tar.gz: 2159568d552c24a25a37d8233e06e125eedc3a4598a76f4a201818b105c6e787
+  metadata.gz: 8ce0306b4b797a61fd2e4e26036731e5b702c7a3b3772f68f90f8db2f124f1ef
+  data.tar.gz: c7afc2f11f5a6c91bc3f788b08fda857de8451cba6905f179691f002ce6ba643
 SHA512:
-  metadata.gz: 42ee8bbcdde2f68eea168e251259892aa06b617f5fd67735a7833af78c3d2c1341bb26befd10078df1e63b288ab23cb5f3d94df8754d96836801e09a2ed42895
-  data.tar.gz: 973006929bc4e2fde380dc6d7b7228f01a506ef2b34ee610c73515643ee6b74052dbad134ce9b33ad2e0bac95c04f9fd54d71132eb48b717f08990136e7ddd49
+  metadata.gz: 82de4e8e154f407995fb1fbe865ee59610d9b283f876e54af68bce38d20a2bc80fe00a08b2b104a6c532c551b6e242fb3b4792efdc5f27122fc4ad597b9edf76
+  data.tar.gz: da700041749e3f7d1ab40f13258c073556d6fc7f316224f3aa3c91368dce06895d9a3b9b4ac6098c896268b147a1cc370d19fe8072683b6255f028ca1c4a6aa2

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,3 @@
+Lint/DuplicateMethods:
+  Exclude:
+    - lib/graphql_connector.rb

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 
-### 0.1.0 Init
+### 0.2.0
+
+** 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. 
+* query supports associations for the selected_fields attribute
 
-TBA
 
 ### 0.1.0.beta1
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_connector (0.1.0.beta1)
+    graphql_connector (0.2.0)
       httparty (~> 0.17)
 
 GEM
@@ -17,7 +17,7 @@ GEM
     method_source (0.9.2)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
+    mime-types-data (3.2019.1009)
     multi_xml (0.6.0)
     parallel (1.17.0)
     parser (2.6.5.0)

data/README.md

@@ -5,8 +5,8 @@ Version](https://badge.fury.io/rb/graphql_connector.svg)](https://badge.fury.io/
 [![Build
 Status](https://travis-ci.org/Garllon/graphql_connector.svg?branch=master)](https://travis-ci.org/Garllon/graphql_connector)
 
-An easy connector to call your `graphql` server. 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphql_connector`. To experiment with that code, run `bin/console` for an interactive prompt.
+An easy connector to call your `graphql` server. Currently there is no schema
+check in the code, but i will add this.
 
 ## Installation
 
@@ -34,16 +34,42 @@ GraphqlConnector.configure do |config|
 end
 ```
 
+### raw_query
+
 Then you can call your graphql_endpoint:
 ```ruby
 GraphqlConnector.query(model, condition, selected_fields)
 ```
 
-| Variable        | DataType         | Example        |
-| ----------------|------------------| ---------------|
-| model           | String           | 'product'      |
-| condition       | Hash(key, value) | { id: 1 }      |
-| selected_fields | Array of Strings | ['id', 'name'] |
+### query
+
+Or your are using the more comfortable `query`:
+```ruby
+GraphqlConnector.query(model, condition, selected_fields)
+```
+
+| Variable        | DataType                | Example                                 |
+|----------------|-------------------------|------------------------------------------|
+| model           | String                  | 'product'                               |
+| condition       | Hash(key, value)        | { id: 1 }                               |
+| selected_fields | Array of Strings/Hashes | ['id', 'name', productCategory: ['id']] |
+
+> 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. 
+
+#### selected_fields
+
+The synatx for the associations looks like the following:
+```
+['<attribute_name>', <association_name>: ['<attribute_name_of_the_association>']]
+```
+
+Example:
+```ruby
+['id', 'name', productCategory: ['id', 'name']]
+```
 
 ## Development
 
@@ -53,7 +79,10 @@ bundle install
 ```
 
 Then, run
-```bundle exec rspec spec` to run the tests.
+```shell
+bundle exec rspec spec
+```
+to run the tests.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing

data/graphql_connector.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Garllon']
   spec.email         = ['palluthe.bennet@gmail.com']
 
-  spec.summary       = 'Hallo'
-  spec.description   = 'Hallo'
+  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.homepage      = 'https://github.com/Garllon/graphql_connector/blob/master/README.md'
   spec.license       = 'MIT'
 
@@ -20,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.metadata['changelog_uri'] = 'https://github.com/Garllon/graphql_connector/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
   end

data/lib/graphql_connector.rb

@@ -3,8 +3,12 @@
 require 'graphql_connector/version'
 require 'graphql_connector/query_builder'
 require 'graphql_connector/configuration'
+require 'graphql_connector/custom_attribute_error'
 require 'httparty'
 
+# Main file of the GraphQLConnector
+#   the main methods to configure the gem
+#   and to run a raw_query or a normal query.
 module GraphqlConnector
   class << self
     attr_accessor :configuration
@@ -24,10 +28,20 @@ module GraphqlConnector
 
   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)
-    OpenStruct.new(parsed_body['data'][model])
+
+    if parsed_body.key? 'errors'
+      raise CustomAttributeError, parsed_body['errors']
+    end
+
+    parsed_body
   end
 end

data/lib/graphql_connector/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module GraphqlConnector
+  # The configuration template file for the gem.
   class Configuration
     attr_accessor :host, :headers
 

data/lib/graphql_connector/custom_attribute_error.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class CustomAttributeError < StandardError; end

data/lib/graphql_connector/query_builder.rb

@@ -1,6 +1,7 @@
 # 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
@@ -9,7 +10,7 @@ module GraphqlConnector
     end
 
     def create
-      "query { #{@model}(#{main_filter}) { #{@selected_fields.join(' ')} } }"
+      "query { #{main_filter} { #{parse_fields(@selected_fields)} } }"
     end
 
     private
@@ -21,7 +22,7 @@ module GraphqlConnector
         array << "#{key}: #{value_as_parameter(value)}"
       end
 
-      conditions.join(', ')
+      "#{@model}(#{conditions.join(', ')})"
     end
 
     def value_as_parameter(value)
@@ -35,5 +36,24 @@ module GraphqlConnector
         '"' + 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

data/lib/graphql_connector/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.2.0
 platform: ruby
 authors:
 - Garllon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-06 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
-description: Hallo
+description: Simple grahql client to query with your own raw stringor with the samll
+  helper method query.
 email:
 - palluthe.bennet@gmail.com
 executables: []
@@ -103,6 +104,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -114,6 +117,7 @@ files:
 - graphql_connector.gemspec
 - lib/graphql_connector.rb
 - lib/graphql_connector/configuration.rb
+- lib/graphql_connector/custom_attribute_error.rb
 - lib/graphql_connector/query_builder.rb
 - lib/graphql_connector/version.rb
 homepage: https://github.com/Garllon/graphql_connector/blob/master/README.md
@@ -134,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Hallo
+summary: Simple GraphQL client
 test_files: []