dhs 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca31fdaf95b8fbff1a8de50591e9861554d00fed99645e79f01cd2363de9e8b7
-  data.tar.gz: 06d8d350c5da6878fd6c54a76826bb56c4fb506f6bc8c9be732743014b875f50
+  metadata.gz: c31dbca2778853f9bafb3a74e2c7ef830d3897c0caa78b66e5bb58203fc8bb11
+  data.tar.gz: 8e5968134c395c0b4e6196506ef5502f5941f68754423bc885bc536a44c2ba33
 SHA512:
-  metadata.gz: 00035a95ea3b634fc97f6af5c7592b32e09a7135a371d29e234c54ee240da99b1b71ce8305b6342aa61b7fb9103c26576a6e729cfead930d7754745d106b5bda
-  data.tar.gz: 8f844da13a8f5d011b6179310b5ac1629853f3be24496eeba52b425412a5d7159fd2cb89744953afa2a0d615ef696c04993e3b3f921891bac060bd8d1702d63d
+  metadata.gz: 54e1c9ec3c0b71566a8b6831690250d0eecc00f00155617dc39873c20d49a26ef57051ae04d7d3a1bbb3733f75fc3ccc0024b96c3b4bd086dafe48a1634cb8cf
+  data.tar.gz: 1bea7f70ccd0cba8dc488604d5f4a668d1bc602a2cb30d19058b195a17b2d9f1aaa5d72e21286e910570a89be0e78c25adac4bb45186a6f3f11ffcc81128b39c

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_key: [: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.
@@ -1285,6 +1386,51 @@ Sequentially:
   GET https://service.example.com/records?from_record_id=xcaoXBmuMyFFEcFDSgNgDQ&limit=100
 ```
 
+##### Pagination strategy: next_offset
+
+The `next_offset` strategy continuously follows in-response offset information to following pages until the last page is reached (indicated by next offset being either empty or 0).
+
+*WARNING*
+
+Loading all pages from a resource paginated with next_offset only can result in very poor performance, as pages can only be loaded sequentially!
+
+```ruby
+# app/models/record.rb
+
+class Search < DHS::Record
+  configuration pagination_strategy: 'next_offset'
+
+  endpoint '{+service}/assets'
+end
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+Record.all
+
+```
+```
+GET https://service.example.com/assets?limit=100
+{
+  items: [{...}, ...],
+  limit: 10,
+  next_offset: 29
+}
+GET https://service.example.com/assets?offset=29
+{
+  items: [{...}, ...],
+  limit: 10,
+  next_offset: 39
+}
+GET https://service.example.com/assets?offset=39
+{
+  items: [{...}, ...],
+  limit: 10,
+  next_offset: 0
+}
+```
+
 #### Pagination keys
 
 ##### limit_key
@@ -2851,4 +2997,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/pagination.rb

@@ -30,6 +30,8 @@ class DHS::Record
           DHS::Pagination::Start
         when :link
           DHS::Pagination::Link
+        when :next_offset
+          DHS::Pagination::NextOffset
         else
           DHS::Pagination::Offset
         end
@@ -43,7 +45,8 @@ class DHS::Record
       def paginated?(raw)
         raw.is_a?(Hash) && (
           raw.dig(*total_key).present? ||
-          raw.dig(*limit_key(:body)).present?
+          raw.dig(*limit_key(:body)).present? ||
+          raw.dig(*pagination_key(:body)).present?
         )
       end
     end

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

@@ -237,7 +237,7 @@ class DHS::Record
         if pagination.parallel?
           load_and_merge_parallel_requests!(record, data, pagination, options)
         else
-          load_and_merge_sequential_requests!(record, data, options, data._raw.dig(:next, :href), pagination)
+          load_and_merge_sequential_requests!(record, data, options, pagination)
         end
       end
 
@@ -249,13 +249,16 @@ class DHS::Record
         end
       end
 
-      def load_and_merge_sequential_requests!(record, data, options, next_link, pagination)
-        warn '[WARNING] You are loading all pages from a resource paginated with links only. As this is performed sequentially, it can result in very poor performance! (https://github.com/DePayFi/dhs#pagination-strategy-link).'
-        while next_link.present?
-          page_data = record.request(
-            options.except(:all).merge(url: next_link)
-          )
-          next_link = page_data._raw.dig(:next, :href)
+      def load_and_merge_sequential_requests!(record, data, options, pagination)
+        warn '[WARNING] You are loading all pages from a resource paginated with sequential pagination.'
+        next_value = pagination.next(data._raw)
+        while next_value.present?
+          page_data = if next_value.is_a?(String) && next_value.match(/^http/)
+             record.request(options.except(:all).merge(url: next_value))
+          else
+            record.request(options.except(:all).merge(params: (options.dig(:params) || {}).merge(next_value) ))
+          end
+          next_value = pagination.next(page_data._raw)
           merge_batch_data_with_parent!(page_data, data, pagination)
         end
       end
@@ -469,6 +472,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 +480,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/pagination/link.rb

@@ -7,6 +7,10 @@ class DHS::Pagination::Link < DHS::Pagination::Base
 
   alias count total
 
+  def next(current)
+    current.dig(:next, :href)
+  end
+
   def pages_left
     pages_left? ? 1 : 0
   end

data/lib/dhs/pagination/next_offset.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DHS::Pagination::NextOffset < DHS::Pagination::Base
+
+  DEFAULT_OFFSET = 0
+  
+  def total
+    data._raw.dig(*_record.items_key).count || 0
+  end
+  alias count total
+
+  def parallel?
+    false
+  end
+
+  def pages_left?
+    next_offset = data._raw.dig(*_record.pagination_key(:body))
+    next_offset.present? && !next_offset.zero?
+  end
+
+  def next(current)
+    next_value = current.dig(*_record.pagination_key(:body))
+    return if next_value.blank? || next_value.zero?
+    {
+      _record.pagination_key(:parameter) => current.dig(*_record.pagination_key(:body))
+    }
+  end
+end

data/lib/dhs/version.rb

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

data/lib/dhs.rb

@@ -39,6 +39,7 @@ module DHS
     autoload :Page, 'dhs/pagination/page'
     autoload :TotalPages, 'dhs/pagination/total_pages'
     autoload :OffsetPage, 'dhs/pagination/offset_page'
+    autoload :NextOffset, 'dhs/pagination/next_offset'
     autoload :Start, 'dhs/pagination/start'
     autoload :Link, 'dhs/pagination/link'
   end

data/spec/graphql/main_spec.rb

@@ -0,0 +1,126 @@
+# 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
+    DHC.config.placeholder('bitquery', 'https://graphql.bitquery.io/')
+
+    class Record < DHS::Record
+
+      configuration items_key: [:data, :ethereum, :address, 0, :balances]
+
+      endpoint '{+bitquery}',
+        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

data/spec/pagination/next_offset_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+
+  context 'pagination' do
+
+    def stub_api_request(items: [], offset: nil, next_offset:)
+      stub_request(:get, ["http://depay.fi/v2/transactions?limit=100", offset ? "offset=#{offset}" : nil].compact.join('&'))
+        .to_return(body: { items: items, next_offset: next_offset }.to_json)
+    end
+
+    let!(:requests) do
+      stub_api_request(items: (0...100).to_a, next_offset: 99)
+      stub_api_request(items: (100...200).to_a, offset: 99, next_offset: 199)
+      stub_api_request(items: (200...300).to_a, offset: 199, next_offset: 0)
+    end
+
+    before do
+      class Transaction < DHS::Record
+        configuration pagination_strategy: :next_offset, pagination_key: { body: :next_offset, parameter: :offset }
+
+        endpoint 'http://depay.fi/v2/transactions'
+      end
+    end
+
+    it 'fetches all the pages' do
+      transactions = Transaction.all.fetch
+      expect(transactions.to_a).to eq (0...300).to_a
+    end
+  end
+end

data/spec/record/includes_spec.rb

@@ -167,7 +167,7 @@ describe DHS::Record do
           .includes(:users, contracts: :products)
           .find(1)
       end).to output(
-        %r{\[WARNING\] You are loading all pages from a resource paginated with links only. As this is performed sequentially, it can result in very poor performance! \(https://github.com/DePayFi/dhs#pagination-strategy-link\).}
+        %r{\[WARNING\] You are loading all pages from a resource paginated with sequential pagination.}
       ).to_stderr
 
       expect(customer.users.length).to eq amount_of_users

data/spec/record/paginatable_collection_spec.rb

@@ -348,7 +348,7 @@ describe DHS::Record do
       expect(lambda do
         all = Record.all.fetch
       end).to output(
-        %r{\[WARNING\] You are loading all pages from a resource paginated with links only. As this is performed sequentially, it can result in very poor performance! \(https://github.com/DePayFi/dhs#pagination-strategy-link\).}
+        %r{\[WARNING\] You are loading all pages from a resource paginated with sequential pagination.}
       ).to_stderr
 
       expect(all).to be_kind_of Record

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.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: 2023-04-25 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
@@ -321,6 +327,7 @@ files:
 - lib/dhs/item.rb
 - lib/dhs/pagination/base.rb
 - lib/dhs/pagination/link.rb
+- lib/dhs/pagination/next_offset.rb
 - lib/dhs/pagination/offset.rb
 - lib/dhs/pagination/offset_page.rb
 - lib/dhs/pagination/page.rb
@@ -429,6 +436,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
@@ -459,6 +467,7 @@ files:
 - spec/pagination/link/pages_left_spec.rb
 - spec/pagination/link/parallel_spec.rb
 - spec/pagination/link/total_spec.rb
+- spec/pagination/next_offset_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
 - spec/pagination/offset_page_spec.rb
 - spec/pagination/parameters_spec.rb
@@ -571,7 +580,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.7.2
-rubygems_version: 3.2.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
@@ -665,6 +674,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
@@ -695,6 +705,7 @@ test_files:
 - spec/pagination/link/pages_left_spec.rb
 - spec/pagination/link/parallel_spec.rb
 - spec/pagination/link/total_spec.rb
+- spec/pagination/next_offset_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
 - spec/pagination/offset_page_spec.rb
 - spec/pagination/parameters_spec.rb