lhs 25.0.4 → 25.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbf1bd4d4d3bec5d8264176e1b7806a4b04f56bceabd6b72f51efb50a0a49b46
-  data.tar.gz: f60fffae1148244ddb5d52c379668dbac292a3868baa1862f52362ecb7537ea5
+  metadata.gz: 92e9ccdfc62407ecb0d4ba6b6ce18b28628ecaad229586f589eb7167fe8ff0de
+  data.tar.gz: 26924759db03d133fbfc8dee9be190e8238fa0fc3036f7b79b13636e881f785e
 SHA512:
-  metadata.gz: 22e0045d22ae49e4537329ffb53d1db8ef070da54822ffda08315e85ed7fe6c6e66656e65f61d7d06a4aa2010f34a8a52d6f614c1da8ad13e88628538ebc0b4f
-  data.tar.gz: e297eabef047eed5cc42b102d13b6043c678ea7f2fc8c620d04a4b8b794ee0028459e65d80a3361cc7ea43ad2e17aa966323859b735a632847e77e376266fb9c
+  metadata.gz: 4186ce186f51e95872532c943c93a402b1d23160d35b123f2fa4c01a1e589ffc863b5f6345c8071c606545539e91e789d75bed7efefcef0546677fe852a56d3d
+  data.tar.gz: b31b7ab8443d71a735397127f389d8dda1f9add35fa318e92ba0172f65172d21928181120a56c953227d0051778646745c8c510c04967e17ba0c24ddd60723ea

data/.github/workflows/rubocop.yml

@@ -0,0 +1,27 @@
+name: Rubocop
+
+on: push
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - name: Cache Ruby Gems
+        uses: actions/cache@v2
+        with:
+          path: /.tmp/vendor/bundle
+          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-latest-
+      - name: Bundle Install
+        run: |
+          bundle config path /.tmp/vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run Rubocop
+        run: |
+          bundle exec rubocop

data/.github/workflows/test-active-support-5.yml

@@ -0,0 +1,27 @@
+name: Test ActiveSupport v5
+
+on: push
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - name: Cache Ruby Gems
+        uses: actions/cache@v2
+        with:
+          path: /.tmp/vendor/bundle
+          key: ${{ runner.os }}-gems-v5-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-v5-
+      - name: Bundle Install ActiveSupport v5
+        run: |
+          bundle config path /.tmp/vendor/bundle
+          BUNDLE_GEMFILE=Gemfile.activesupport5 bundle install --jobs 4 --retry 3
+      - name: Run Tests
+        run: |
+          BUNDLE_GEMFILE=Gemfile.activesupport5 bundle exec rspec

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on: push
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - name: Cache Ruby Gems
+        uses: actions/cache@v2
+        with:
+          path: /.tmp/vendor/bundle
+          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-latest-
+      - name: Bundle Install
+        run: |
+          bundle config path /.tmp/vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run Tests
+        run: |
+          bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.5
+ruby-2.7.2

data/README.md

@@ -80,6 +80,7 @@ record.review # "Lunch was great
         * [Pagination strategy](#pagination-strategy)
            * [Pagination strategy: offset (default)](#pagination-strategy-offset-default)
            * [Pagination strategy: page](#pagination-strategy-page)
+           * [Pagination strategy: total_pages](#pagination-strategy-total-pages)
            * [Pagination strategy: start](#pagination-strategy-start)
            * [Pagination strategy: link](#pagination-strategy-link)
         * [Pagination keys](#pagination-keys)
@@ -1253,6 +1254,41 @@ In parallel:
   GET https://service.example.com/records?limit=100&page=3
 ```
 
+##### Pagination strategy: total_pages
+
+The `total_pages` strategy is based on the `page` strategy with the only difference
+that the responding api provides `total_pages` over `total_items`.
+
+```ruby
+# app/models/transaction.rb
+
+class Transaction < LHS::Record
+  configuration pagination_strategy: 'total_pages', pagination_key: 'page', total_key: 'total_pages'
+
+  endpoint '{+service}/transactions'
+end
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+Record.all
+
+```
+```
+GET https://service.example.com/transactions?limit=100
+{
+  items: [{...}, ...],
+  total_pages: 3,
+  limit: 100,
+  page: 1
+}
+In parallel:
+  GET https://service.example.com/records?limit=100&page=2
+  GET https://service.example.com/records?limit=100&page=3
+```
+
+
 ##### Pagination strategy: start
 
 In comparison to the `offset` strategy, the `start` strategy indicates with which item the current page starts. 

data/lib/lhs.rb

@@ -58,6 +58,8 @@ module LHS
       'lhs/pagination/offset'
     autoload :Page,
       'lhs/pagination/page'
+    autoload :TotalPages,
+      'lhs/pagination/total_pages'
     autoload :Start,
       'lhs/pagination/start'
     autoload :Link,

data/lib/lhs/concerns/record/pagination.rb

@@ -22,6 +22,8 @@ class LHS::Record
         case pagination_strategy.to_sym
         when :page
           LHS::Pagination::Page
+        when :total_pages
+          LHS::Pagination::TotalPages
         when :start
           LHS::Pagination::Start
         when :link

data/lib/lhs/pagination/total_pages.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class LHS::Pagination::TotalPages < LHS::Pagination::Page
+
+  def total
+    (data._raw.dig(*_record.total_key) || 0) * limit
+  end
+  alias count total
+end

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '25.0.4'
+  VERSION = '25.1.0'
 end

data/spec/pagination/total_pages_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'pagination' do
+
+    let(:page_1_json) do
+      {
+        items: [1, 2],
+        total_pages: 3,
+        page: 1,
+        limit: 2
+      }.to_json
+    end
+
+    let(:page_2_json) do
+      {
+        items: [3, 4],
+        total_pages: 3,
+        page: 2,
+        limit: 2
+      }.to_json
+    end
+
+    let(:page_3_json) do
+      {
+        items: [5, 6],
+        total_pages: 3,
+        page: 3,
+        limit: 2
+      }.to_json
+    end
+
+    before do
+      class Feedback < LHS::Record
+        configuration pagination_strategy: :total_pages, total_key: :total_pages, pagination_key: :page
+        endpoint 'http://local.ch/v2/feedbacks'
+      end
+      stub_request(:get, 'http://local.ch/v2/feedbacks?limit=100').to_return(body: page_1_json)
+      stub_request(:get, 'http://local.ch/v2/feedbacks?limit=2&page=2').to_return(body: page_2_json)
+      stub_request(:get, 'http://local.ch/v2/feedbacks?limit=2&page=3').to_return(body: page_3_json)
+    end
+
+    it 'responds to limit_value' do
+      feedbacks = Feedback.all.fetch
+      expect(feedbacks.length).to eq 6
+      expect(feedbacks.count).to eq 6
+      expect(feedbacks.items.as_json).to eq [1, 2, 3, 4, 5, 6]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 25.0.4
+  version: 25.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -241,28 +241,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".bundler-version"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test-active-support-5.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.localch.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
-- Gemfile.activesupport4
 - Gemfile.activesupport5
 - LICENSE
 - README.md
 - Rakefile
-- cider-ci.yml
-- cider-ci/bin/bundle
-- cider-ci/bin/ruby_install
-- cider-ci/bin/ruby_version
-- cider-ci/jobs/rspec-activesupport-4.yml
-- cider-ci/jobs/rspec-activesupport-5.yml
-- cider-ci/jobs/rspec-activesupport-latest.yml
-- cider-ci/jobs/rubocop.yml
-- cider-ci/task_components/bundle.yml
-- cider-ci/task_components/rspec.yml
-- cider-ci/task_components/rubocop.yml
-- cider-ci/task_components/ruby.yml
 - docs/accessing-data-in-lhs.png
 - friday.yml
 - lhs.gemspec
@@ -331,6 +321,7 @@ files:
 - lib/lhs/pagination/offset.rb
 - lib/lhs/pagination/page.rb
 - lib/lhs/pagination/start.rb
+- lib/lhs/pagination/total_pages.rb
 - lib/lhs/problems/base.rb
 - lib/lhs/problems/errors.rb
 - lib/lhs/problems/nested/base.rb
@@ -466,6 +457,7 @@ files:
 - spec/pagination/link/total_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
 - spec/pagination/parameters_spec.rb
+- spec/pagination/total_pages_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/proxy/record_identification_spec.rb
@@ -557,7 +549,7 @@ homepage: https://github.com/local-ch/lhs
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -573,8 +565,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.3.0
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
   interface for http (hypermedia) json services'
@@ -699,6 +691,7 @@ test_files:
 - spec/pagination/link/total_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
 - spec/pagination/parameters_spec.rb
+- spec/pagination/total_pages_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/proxy/record_identification_spec.rb

data/Gemfile.activesupport4

@@ -1,5 +0,0 @@
-source 'https://rubygems.org/'
-
-gemspec
-gem 'activesupport', '~> 4.2.11'
-gem 'bundler', '~> 1.17.3'

data/cider-ci.yml

@@ -1,6 +0,0 @@
-jobs:
-  include:
-    - cider-ci/jobs/rspec-activesupport-4.yml
-    - cider-ci/jobs/rspec-activesupport-5.yml
-    - cider-ci/jobs/rspec-activesupport-latest.yml
-    - cider-ci/jobs/rubocop.yml

data/cider-ci/bin/bundle

@@ -1,51 +0,0 @@
-#!/usr/bin/env bash
-set -eux
-
-export PATH=~/.rubies/$RUBY/bin:$PATH
-rm -f .bundle/config
-
-if [ ! -f ~/.rubies/$RUBY/bin/bundle ]; then
-  gem install bundler
-fi
-
-# install bundler v. 1.17.3 in order to be able to run the tests with
-# ACTIVESUPPORT=4 because rails (= 4.2.0) depends on bundler (< 2.0, >= 1.3.0)
-gem install bundler:1.17.3
-
-sed "s/^source 'https:\/\/rubygems\.intra\.local\.ch'*/source 'http\:\/\/52.29.7.59:9292'/g" Gemfile > Gemfile.tmp
-mv Gemfile.tmp Gemfile
-
-DIGEST=$(git ls-tree HEAD --\
-  cider-ci.yml cider-ci Gemfile.lock \
-  | openssl dgst -sha1 | cut -d ' ' -f 2)
-
-if [ ! -z ${ACTIVESUPPORT:-} ]; then
-  DIGEST=$(echo "$DIGEST $ACTIVESUPPORT")
-fi
-
-DIGEST=$(echo "$DIGEST $PATH" \
- | openssl dgst -sha1 | cut -d ' ' -f 2)
-
-echo "DIGEST"
-echo "${DIGEST}"
-
-CACHE_SIGNATURE_FILE="/tmp/bundle_cache_signature_${DIGEST}"
-
-if [ ! -f  $CACHE_SIGNATURE_FILE ] ; then
-  if [ ! -z ${ACTIVESUPPORT:-} ]; then
-    if [ ! -z ${BUNDLER:-} ]; then
-      echo "BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle $BUNDLER install"
-      BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle $BUNDLER install
-    else
-      echo "BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle install"
-      BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle install
-    fi
-  else
-    echo "bundle install"
-    bundle $BUNDLER install
-  fi
-  touch $CACHE_SIGNATURE_FILE
-fi
-
-echo "bundle install"
-bundle $BUNDLER install

data/cider-ci/bin/ruby_install

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -eux
-
-export PATH=~/.rubies/$RUBY/bin:$PATH
-
-if [ ! -d ~/.rubies/$RUBY ]; then
-  ruby-install --no-install-deps $RUBY
-fi

data/cider-ci/bin/ruby_version

@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-set -eux
-
-if [ -f ./.ruby-version ]; then
- echo ".ruby-version file found"
-fi
-
-if [ ! -f ./.ruby-version ]; then
-  echo ".ruby-version file not found" 
-  exit 1
-fi 
-
-IFS='-' read -ra EXPLODED_RUBY <<< "$RUBY"
-
-if [ "${#EXPLODED_RUBY[@]}" == "1" ]; then
-  echo 'No engine/version separator "-" found in .ruby-version file.'
-  exit 1
-fi
-
-if [ "${#EXPLODED_RUBY[@]}" != "1" ] && [ "${#EXPLODED_RUBY[@]}" != "2" ]; then
-  echo "Unknown format of .ruby-version file"
-  exit 1
-fi
-
-echo $RUBY

data/cider-ci/jobs/rspec-activesupport-4.yml

@@ -1,27 +0,0 @@
-rspec-active-support-v4:
-  name: 'rspec with ActiveSupport v4'
-
-  run_when:
-    'some HEAD has been updated':
-      type: branch
-      include_match: ^.*$
-
-  context:
-
-    script_defaults:
-      template_environment_variables: true
-
-    task_defaults:
-      environment_variables:
-        ACTIVESUPPORT: '4'
-        BUNDLER: '_1.17.3_'
-      max_trials: 2
-      dispatch_storm_delay_duration: 1 Seconds
-      include:
-        - cider-ci/task_components/ruby.yml
-        - cider-ci/task_components/bundle.yml
-        - cider-ci/task_components/rspec.yml
-
-    tasks:
-      all-rspec:
-        name: All rspec tests, using ActiveSupport v4

data/cider-ci/jobs/rspec-activesupport-5.yml

@@ -1,26 +0,0 @@
-rspec-active-support-v5:
-  name: 'rspec with ActiveSupport v5'
-
-  run_when:
-    'some HEAD has been updated':
-      type: branch
-      include_match: ^.*$
-
-  context:
-
-    script_defaults:
-      template_environment_variables: true
-
-    task_defaults:
-      environment_variables:
-        ACTIVESUPPORT: '5'
-      max_trials: 2
-      dispatch_storm_delay_duration: 1 Seconds
-      include:
-        - cider-ci/task_components/ruby.yml
-        - cider-ci/task_components/bundle.yml
-        - cider-ci/task_components/rspec.yml
-
-    tasks:
-      all-rspec:
-        name: All rspec tests, using ActiveSupport v5

data/cider-ci/jobs/rspec-activesupport-latest.yml

@@ -1,24 +0,0 @@
-rspec-active-support-latest:
-  name: 'rspec with ActiveSupport latest'
-
-  run_when:
-    'some HEAD has been updated':
-      type: branch
-      include_match: ^.*$
-
-  context:
-
-    script_defaults:
-      template_environment_variables: true
-
-    task_defaults:
-      max_trials: 2
-      dispatch_storm_delay_duration: 1 Seconds
-      include:
-        - cider-ci/task_components/ruby.yml
-        - cider-ci/task_components/bundle.yml
-        - cider-ci/task_components/rspec.yml
-
-    tasks:
-      all-rspec:
-        name: All rspec tests, using ActiveSupport latest

data/cider-ci/jobs/rubocop.yml

@@ -1,18 +0,0 @@
-rubocop:
-  name: 'Rubocop'
-
-  run_when:
-    'some HEAD has been updated':
-      type: branch
-      include_match: ^.*$
-
-  context:
-
-    tasks:
-
-      rubocop:
-        
-        include:        
-          - cider-ci/task_components/ruby.yml
-          - cider-ci/task_components/bundle.yml
-          - cider-ci/task_components/rubocop.yml

data/cider-ci/task_components/bundle.yml

@@ -1,22 +0,0 @@
-traits:
-  ruby-install: true
-  Bash: true
-
-trial_attachments:
-  gemfile:
-    include_match: Gemfile
-    content_type: text/plain
-
-environment_variables:
-  BUNDLER:
-    read_and_replace_with: .bundler-version
-
-scripts:
-
-  bundle:
-    exclusive_executor_resource: ruby-install_{{$RUBY}}
-    timeout: 20 Minutes
-    body: cider-ci/bin/bundle
-    start_when:
-      'ruby installed':
-        script_key: ruby-install

data/cider-ci/task_components/rspec.yml

@@ -1,37 +0,0 @@
-ports:
-  CAPYBARA_PORT:
-    min: 8000
-    max: 8999
-  PHANTOMJS_PORT:
-    min: 44600
-    max: 44999
-
-environment_variables:
-  RUBY:
-    read_and_replace_with: .ruby-version
-  BUNDLER:
-    read_and_replace_with: .bundler-version
-
-scripts:
-  rspec:
-    body: |
-      #!/usr/bin/env bash
-      set -eux
-      mkdir -p tmp/cache
-      export PATH=~/.rubies/$RUBY/bin:$PATH
-      if [ ! -z ${ACTIVESUPPORT:-} ]; then BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle $BUNDLER exec rspec; else bundle exec rspec; fi
-    
-    start_when:
-      'bundled':
-        script_key: bundle
-
-trial_attachments:
-  logs:
-    include_match: log\/.*\.log$
-    content_type: text/plain
-  image-screenshots:
-    include_match: tmp\/capybara\/.*\.png$
-    content_type: image/png
-  html-screenshots:
-    include_match: tmp\/capybara\/.*\.html$
-    content_type: text/html

data/cider-ci/task_components/rubocop.yml

@@ -1,29 +0,0 @@
-trial_attachments:
-  logs:
-    include_match: tmp\/checkstyle.json$
-    content_type: application/json
-
-tree_attachments:
-  logs:
-    include_match: tmp\/checkstyle.json$
-    content_type: application/json
-
-environment_variables:
-  RUBY:
-    read_and_replace_with: .ruby-version
-  RESULT_PATH: 'tmp/checkstyle.json'
-
-max_trials: 1
-
-scripts:
-  rubocop:
-    start_when:
-      'bundled':
-        script_key: bundle
-    body: |
-      #!/usr/bin/env bash
-      set -eux
-      mkdir -p tmp/cache
-      export PATH=~/.rubies/$RUBY/bin:$PATH
-      bundle exec rubocop --config .rubocop.yml \
-        --format json --out $RESULT_PATH --format progress

data/cider-ci/task_components/ruby.yml

@@ -1,15 +0,0 @@
-environment_variables:
-  RUBY:
-    read_and_replace_with: .ruby-version
-
-scripts:
-  ruby-version:
-    body: cider-ci/bin/ruby_version
-  ruby-install:
-    exclusive_executor_resource: ruby-install_{{$RUBY}}
-    timeout: 20 Minutes
-    body: cider-ci/bin/ruby_install
-    start_when:
-      'ruby version checked':
-        script_key: ruby-version
-