Graphql (#6)

* adds graphql support

* version

* bundle

* fix rubocop

Author: spape

README.md

@@ -155,6 +155,107 @@ GET https://service.example.com/records
 
 **Be aware that, if you configure ambigious endpoints accross multiple classes, the order of things is not deteministic. Ambigious endpoints accross multiple classes need to be avoided.**
 
+#### GraphQL Endpoints
+
+You can use DHS also to fetch records from GraphQL Endpoints:
+
+```ruby
+# app/models/record.rb
+
+class Record < DHS::Record
+
+  configuration items_keys: [:data, :ethereum, :address, 0, :balances]
+
+  endpoint 'https://graphql.bitquery.io/',
+    graphql: {
+      query: %Q{
+        query ($network: EthereumNetwork!, $address: String!) {
+          ethereum(network: $network) {
+            address(address: {is: $address}) {
+              balances {
+                currency {
+                  address
+                  name
+                  symbol
+                  decimals
+                  tokenType
+                }
+                value
+              }
+            }
+          }
+        }
+      },
+      variables: [:network, :address]
+    }
+
+end
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+records = Record.where(network: 'ethereum', address: '0x317D875cA3B9f8d14f960486C0d1D1913be74e90')
+```
+
+```
+POST https://graphql.bitquery.io/
+
+BODY
+{
+  "query": "
+    query ($network: EthereumNetwork!, $address: String!) {
+      ethereum(network: $network) {
+        address(address: {is: $address}) {
+          balances {
+            currency {
+              address
+              name
+              symbol
+              decimals
+              tokenType
+            }
+            value
+          }
+        }
+      }
+    }
+  ",
+  "variables": {
+    "network": "ethereum",
+    "address": "0x317D875cA3B9f8d14f960486C0d1D1913be74e90"
+  }
+}
+
+RESPONSE
+"data": {
+  "ethereum": {
+    "address": [
+      {
+        balances: [
+          {
+            "currency": {
+              "address": "-",
+              "name": "Ether",
+              "decimals": 18,
+              "symbol": "ETH",
+              "tokenType": ""
+            },
+            "value": 0.11741978
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+records.first.currency.name # Ethereum
+```
+
 ### Provider
 
 Providers in DHS allow you to group shared endpoint options under a common provider.
@@ -2851,4 +2952,3 @@ expect(
 ## License
 
 [GNU General Public License Version 3.](https://www.gnu.org/licenses/gpl-3.0.en.html)
-

dhs.gemspec

@@ -24,14 +24,14 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport', '>= 6'
-  s.add_dependency 'dhc'
+  s.add_dependency 'dhc', '>= 2'
   s.add_dependency 'local_uri'
 
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'json', '>=  1.8.2'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-byebug'
-  s.add_development_dependency 'rails', '>= 6'
+  s.add_development_dependency 'rails', '>= 6', '< 7'
   s.add_development_dependency 'rollbar', '<= 2.24.0'
   s.add_development_dependency 'rspec-rails', '>= 3.7.0'
   s.add_development_dependency 'rubocop'

lib/dhs/concerns/record/request.rb

@@ -469,13 +469,27 @@ def process_options(options, endpoint)
         options = (provider_options || {})
           .deep_merge(endpoint.options || {})
           .deep_merge(options)
+        set_graphql_options!(options) if options.dig(:graphql).present?
         options[:url] = compute_url!(options[:params]) unless options.key?(:url)
         merge_explicit_params!(options[:params])
         options.delete(:params) if options[:params]&.empty?
         inject_interceptors!(options)
         options
       end
 
+      def set_graphql_options!(options)
+        options[:method] = :post
+        variables = {}
+        options.dig(:graphql, :variables).each do |key|
+          variables[key] = options[:params][key]
+          options[:params].delete(key)
+        end
+        options[:body] = {
+          query: options.dig(:graphql, :query).squish,
+          variables: variables.to_json
+        }
+      end
+
       def inject_interceptors!(options)
         if DHS.config.request_cycle_cache_enabled
           inject_interceptor!(

lib/dhs/concerns/record/update.rb

@@ -8,7 +8,7 @@ module Update
     extend ActiveSupport::Concern
 
     included do
-      class <<self
+      class << self
         alias_method :update, :create
         alias_method :update!, :create!
       end

lib/dhs/version.rb

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

spec/graphql/main_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe 'main graphql support' do
+  let(:network) { 'ethereum' }
+  let(:address) { '0x317D875cA3B9f8d14f960486C0d1D1913be74e90' }
+
+  let!(:stubbed_request) do
+    stub_request(:post, 'https://graphql.bitquery.io/')
+    .with(
+      body: {
+        query: %{
+          query ($network: EthereumNetwork!, $address: String!) {
+            ethereum(network: $network) {
+              address(address: {is: $address}) {
+                balances {
+                  currency {
+                    address
+                    name
+                    symbol
+                    decimals
+                    tokenType
+                  }
+                  value
+                }
+              }
+            }
+          }
+        }.squish,
+        variables: {
+          "network": network,
+          "address": address
+        }.to_json
+      }.to_json
+    ).to_return(body: {
+      "data": {
+        "ethereum": {
+          "address": [
+            {
+              balances: [
+                {
+                  "currency": {
+                    "address": '-',
+                    "name": 'Ether',
+                    "decimals": 18,
+                    "symbol": 'ETH',
+                    "tokenType": ''
+                  },
+                  "value": 0.11741978
+                },
+                {
+                  "currency": {
+                    "address": '0xb63b606ac810a52cca15e44bb630fd42d8d1d83d',
+                    "name": 'Monaco',
+                    "decimals": 8,
+                    "symbol": 'MCO',
+                    "tokenType": 'ERC20'
+                  },
+                  "value": 0
+                },
+                {
+                  "currency": {
+                    "address": '0x06012c8cf97bead5deae237070f9587f8e7a266d',
+                    "name": 'CryptoKitties',
+                    "decimals": 0,
+                    "symbol": 'CK',
+                    "tokenType": 'ERC721'
+                  },
+                  "value": 90
+                },
+                {
+                  "currency": {
+                    "address": '0xdac17f958d2ee523a2206206994597c13d831ec7',
+                    "name": 'Tether USD',
+                    "decimals": 6,
+                    "symbol": 'USDT',
+                    "tokenType": 'ERC20'
+                  },
+                  "value": 10
+                }
+              ]
+            }
+          ]
+        }
+      }
+    }.to_json)
+  end
+
+  before do
+    class Record < DHS::Record
+
+      configuration items_key: [:data, :ethereum, :address, 0, :balances]
+
+      endpoint 'https://graphql.bitquery.io/',
+        graphql: {
+          query: %{
+            query ($network: EthereumNetwork!, $address: String!) {
+              ethereum(network: $network) {
+                address(address: {is: $address}) {
+                  balances {
+                    currency {
+                      address
+                      name
+                      symbol
+                      decimals
+                      tokenType
+                    }
+                    value
+                  }
+                }
+              }
+            }
+          },
+          variables: %i[network address]
+        }
+    end
+  end
+
+  it 'fetches data from graphql and converts it into DHS Record structure' do
+    records = Record.where(network: 'ethereum', address: '0x317D875cA3B9f8d14f960486C0d1D1913be74e90').fetch
+    expect(records.first.currency.name).to eq 'Ether'
+  end
+end