lhs 25.1.0 → 25.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92e9ccdfc62407ecb0d4ba6b6ce18b28628ecaad229586f589eb7167fe8ff0de
-  data.tar.gz: 26924759db03d133fbfc8dee9be190e8238fa0fc3036f7b79b13636e881f785e
+  metadata.gz: 22ba3545c4f37d2becb37fbe7efb328a942af240d6a4d03e64fea4890e766969
+  data.tar.gz: 9cd64f9e1222e7f0f4cb041bdf967c257a2f0fd3ef1564618a65650e23a07ec1
 SHA512:
-  metadata.gz: 4186ce186f51e95872532c943c93a402b1d23160d35b123f2fa4c01a1e589ffc863b5f6345c8071c606545539e91e789d75bed7efefcef0546677fe852a56d3d
-  data.tar.gz: b31b7ab8443d71a735397127f389d8dda1f9add35fa318e92ba0172f65172d21928181120a56c953227d0051778646745c8c510c04967e17ba0c24ddd60723ea
+  metadata.gz: a9c87bfbc21370b89591c0b7a58bf30a24d8123ccbd41280f418afd69a5ebae47d05e0367fabdc7b7a0441a3cdf9729da8fee97b1c2fd5c39fbc757a7c1a0e6e
+  data.tar.gz: 4ef0c1857ba4983df1c567ea3ffee56ef5348e195e000beed34b4d91d7d372effc9c7fcbeb0d59419aebad7477926ece0e8938b9dfab936827603a8488f051a8

data/.github/workflows/rubocop.yml

@@ -4,24 +4,13 @@ on: push
 
 jobs:
   rubocop:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/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
+          bundler-cache: true
       - name: Run Rubocop
         run: |
           bundle exec rubocop

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

@@ -4,24 +4,17 @@ on: push
 
 jobs:
   rspec:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/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
+          bundler-cache: true
+        env:
+          BUNDLE_GEMFILE: Gemfile.activesupport5
       - name: Run Tests
+        env:
+          BUNDLE_GEMFILE: Gemfile.activesupport5
         run: |
-          BUNDLE_GEMFILE=Gemfile.activesupport5 bundle exec rspec
+          bundle exec rspec

data/.github/workflows/test.yml

@@ -4,24 +4,13 @@ on: push
 
 jobs:
   rspec:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/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
+          bundler-cache: true
       - name: Run Tests
         run: |
           bundle exec rspec

data/README.md

@@ -80,7 +80,6 @@ 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)
@@ -1254,41 +1253,6 @@ 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,8 +58,6 @@ 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/item/save.rb

@@ -45,7 +45,7 @@ class LHS::Item < LHS::Proxy
         _data.merge_raw!(response_data.unwrap(:item_created_key))
         response_headers = response_data._request.response.headers
       end
-      if response_headers && response_headers['Location']
+      if options.fetch(:followlocation, true) && response_headers && response_headers['Location']
         location_data = record.request(options.merge(url: response_headers['Location'], method: :get, body: nil))
         _data.merge_raw!(location_data.unwrap(:item_created_key))
       end

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

@@ -22,8 +22,6 @@ 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/version.rb

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

data/spec/dummy/app/controllers/request_cycle_cache_controller.rb

@@ -3,7 +3,7 @@
 class RequestCycleCacheController < ApplicationController
   def simple
     User.find(1) # first request
-    user = User.find(1) # second request that should be serverd from request cycle cache
+    user = User.find(1) # second request that should be served from request cycle cache
     render json: user.to_json
   end
 
@@ -15,13 +15,13 @@ class RequestCycleCacheController < ApplicationController
 
   def parallel
     User.find(1, 2) # first request
-    users = User.find(1, 2) # second request that should be serverd from request cycle cache
+    users = User.find(1, 2) # second request that should be served from request cycle cache
     render json: users.to_json
   end
 
-  def headers
+  def different_headers
     User.find(1) # first request
-    user = User.options(headers: { 'Authentication' => 'Bearer 123' }).find(1) # second request that should NOT be serverd from request cycle cache as the headers are different
+    user = User.options(headers: { 'Authentication' => 'Bearer 123' }).find(1) # second request that should NOT be served from request cycle cache as the headers are different
     render json: user.to_json
   end
 end

data/spec/dummy/config/initializers/lhs.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+LHS.configure do |config|
+  config.auto_oauth = -> { access_token }
+end

data/spec/dummy/config/routes.rb

@@ -12,7 +12,7 @@ Rails.application.routes.draw do
   get 'request_cycle_cache/simple' => 'request_cycle_cache#simple'
   get 'request_cycle_cache/no_caching_interceptor' => 'request_cycle_cache#no_caching_interceptor'
   get 'request_cycle_cache/parallel' => 'request_cycle_cache#parallel'
-  get 'request_cycle_cache/headers' => 'request_cycle_cache#headers'
+  get 'request_cycle_cache/different_headers' => 'request_cycle_cache#different_headers'
 
   # Error handling with chains
   get 'error_handling_with_chains/fetch_in_controller' => 'error_handling_with_chains#fetch_in_controller'

data/spec/record/create_spec.rb

@@ -135,25 +135,65 @@ describe LHS::Record do
     end
 
     context 'location header' do
-      before do
-        class ContactPerson < LHS::Record
-          endpoint 'http://datastore/contact_persons'
-        end
-      end
-
-      let(:location)   { 'http://datastore/contact_persons/1' }
       let(:created_at) { '2017-12-21' }
+      let(:location)   { 'http://datastore/contact_persons/1' }
       let(:name)       { 'Sebastian' }
-
-      it 'Loads the data from the "Location" header after creation' do
+      let!(:create_contact_person_request) do
         stub_request(:post, "http://datastore/contact_persons")
           .to_return(status: 204, headers: { Location: location })
+      end
+      let!(:fetch_contact_person_request) do
         stub_request(:get, "http://datastore/contact_persons/1")
           .to_return(body: { href: location, name: name, created_at: created_at }.to_json)
-        contact_person = ContactPerson.create!(name: name)
-        expect(contact_person.href).to eq location
-        expect(contact_person.created_at).to eq Date.parse(created_at)
-        expect(contact_person.name).to eq name
+      end
+
+      context 'without `followlocation` option' do
+        before do
+          class ContactPerson < LHS::Record
+            endpoint 'http://datastore/contact_persons'
+          end
+        end
+
+        it 'loads the data from the "Location" header after creation' do
+          contact_person = ContactPerson.create!(name: name)
+          expect(create_contact_person_request).to have_been_made.once
+          expect(fetch_contact_person_request).to have_been_made.once
+          expect(contact_person.href).to eq location
+          expect(contact_person.created_at).to eq Date.parse(created_at)
+          expect(contact_person.name).to eq name
+        end
+      end
+
+      context 'when `followlocation` is set to `true`' do
+        before do
+          class ContactPerson < LHS::Record
+            endpoint 'http://datastore/contact_persons', followlocation: true
+          end
+        end
+
+        it 'loads the data from the "Location" header after creation' do
+          contact_person = ContactPerson.create!(name: name)
+          expect(create_contact_person_request).to have_been_made.once
+          expect(fetch_contact_person_request).to have_been_made.once
+          expect(contact_person.href).to eq location
+          expect(contact_person.created_at).to eq Date.parse(created_at)
+          expect(contact_person.name).to eq name
+        end
+      end
+
+      context 'when `followlocation` is set to `false`' do
+        before do
+          class ContactPerson < LHS::Record
+            endpoint 'http://datastore/contact_persons', followlocation: false
+          end
+        end
+
+        it 'does not load the data from the "Location" header after creation' do
+          contact_person = ContactPerson.create!(name: name)
+          expect(create_contact_person_request).to have_been_made.once
+          expect(fetch_contact_person_request).not_to have_been_made
+          expect(contact_person.name).to eq name
+        end
       end
     end
   end

data/spec/request_cycle_cache_spec.rb

@@ -85,7 +85,7 @@ describe 'Request Cycle Cache', type: :request do
   context 'headers' do
     it 'considers the request headers when setting the cache key',
     dummy_models: true, request_cycle_cache: true do
-      get '/request_cycle_cache/headers'
+      get '/request_cycle_cache/different_headers'
       expect(request).to have_been_made.times(2)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 25.1.0
+  version: 25.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -321,7 +321,6 @@ 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
@@ -410,6 +409,7 @@ files:
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/lhs.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/rollbar.rb
 - spec/dummy/config/initializers/session_store.rb
@@ -457,7 +457,6 @@ 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
@@ -644,6 +643,7 @@ test_files:
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/lhs.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/rollbar.rb
 - spec/dummy/config/initializers/session_store.rb
@@ -691,7 +691,6 @@ 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/lib/lhs/pagination/total_pages.rb

@@ -1,9 +0,0 @@
-# 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/spec/pagination/total_pages_spec.rb

@@ -1,52 +0,0 @@
-# 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