dhs 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca31fdaf95b8fbff1a8de50591e9861554d00fed99645e79f01cd2363de9e8b7
-  data.tar.gz: 06d8d350c5da6878fd6c54a76826bb56c4fb506f6bc8c9be732743014b875f50
+  metadata.gz: 1ed15754a20492dd70e8d58fba832f6db2c747d4f13d04ad23457ab72fd81eda
+  data.tar.gz: 2626f410568a801f540f592e32c8f2f6ca5f9c21fa9e1a74229d9f0866139f21
 SHA512:
-  metadata.gz: 00035a95ea3b634fc97f6af5c7592b32e09a7135a371d29e234c54ee240da99b1b71ce8305b6342aa61b7fb9103c26576a6e729cfead930d7754745d106b5bda
-  data.tar.gz: 8f844da13a8f5d011b6179310b5ac1629853f3be24496eeba52b425412a5d7159fd2cb89744953afa2a0d615ef696c04993e3b3f921891bac060bd8d1702d63d
+  metadata.gz: 86b1ecd19fe674a0464ad2032337bd5801c9a4a6ef5209515e11b4f38b16d14a896f1b577e0cd37d2399159a7bb7c7a1cb2b0c2cd0d4dac1925616940d22bcb1
+  data.tar.gz: a663b02f76a6571a9f50ee00af2268be77c16d8c7606d01391e2d36c20d5e81fd0ba66b38f71226c9f643a403d8bd84b5162fa581447c68713c2a1748be6b324

data/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)
-

data/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'

data/lib/dhs/concerns/record/request.rb

@@ -469,6 +469,7 @@ class DHS::Record
         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?
@@ -476,6 +477,19 @@ class DHS::Record
         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!(

data/lib/dhs/concerns/record/update.rb

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

data/lib/dhs/version.rb

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

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: local_uri
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -136,6 +139,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rollbar
   requirement: !ruby/object:Gem::Requirement
@@ -429,6 +435,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/endpoint/for_url_spec.rb
 - spec/extended_rollbar_spec.rb
+- spec/graphql/main_spec.rb
 - spec/item/access_errors_spec.rb
 - spec/item/accessors_spec.rb
 - spec/item/add_error_spec.rb
@@ -571,7 +578,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.7.2
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
@@ -665,6 +672,7 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/endpoint/for_url_spec.rb
 - spec/extended_rollbar_spec.rb
+- spec/graphql/main_spec.rb
 - spec/item/access_errors_spec.rb
 - spec/item/accessors_spec.rb
 - spec/item/add_error_spec.rb