lhs 15.5.1 → 15.6.0

data/lhs.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.name        = "lhs"
   s.version     = LHS::VERSION
   s.authors     = ['https://github.com/local-ch/lhs/graphs/contributors']
-  s.email       = ['ws-operations@local.ch']
+  s.email       = ['web@localsearch.ch']
   s.homepage    = 'https://github.com/local-ch/lhs'
-  s.summary     = 'Rails gem providing an easy, active-record-like interface for http json services'
+  s.summary     = 'REST services accelerator: Rails gem providing an easy, active-record-like interface for http (hypermedia) json services'
   s.description = s.summary
 
   s.files        = `git ls-files`.split("\n")

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

@@ -16,6 +16,10 @@ class LHS::Record
         Chain.new(self, Parameter.new(hash))
       end
 
+      def fetch
+        Chain.new(self, nil).fetch
+      end
+
       def all(hash = nil)
         chain = Chain.new(self, Parameter.new(hash))
         chain._links.push(Option.new(all: true))

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

@@ -60,6 +60,13 @@ class LHS::Record
         )
       end
 
+      # Allows record to be configured as not paginated,
+      # as by default it's considered paginated
+      def paginated
+        return true if @configuration.blank?
+        @configuration.fetch(:paginated, true)
+      end
+
       private
 
       def symbolize_unless_complex(value)

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

@@ -22,7 +22,7 @@ class LHS::Record
       private
 
       def single_request_load_and_merge_remaining_objects!(data, options, endpoint)
-        return unless options[:all]
+        return if options[:all].blank? || !paginated
         load_and_merge_remaining_objects!(
           data: data,
           options: process_options(options, endpoint),
@@ -40,6 +40,7 @@ class LHS::Record
       # Tries to apply an high value for limit and reacts on the limit
       # returned by the endpoint to make further requests
       def apply_limit!(options)
+        return if !paginated || options[:all].blank?
         options[:params] ||= {}
         options[:params] = options[:params].merge(limit_key(:parameter) => options[:params][limit_key(:parameter)] || LHS::Pagination::Base::DEFAULT_LIMIT)
       end
@@ -239,6 +240,7 @@ class LHS::Record
         elsif data.collection? && paginated?(data.first.try(:_raw))
           load_and_merge_set_of_paginated_collections!(data, options)
         elsif load_not_paginated_collection
+          warn('[Warning] "all" has been requested, but endpoint does not provide pagination meta data. If you just want to fetch the first response, use "where" or "fetch".')
           load_and_merge_not_paginated_collection!(data, options)
         end
       end
@@ -522,7 +524,7 @@ class LHS::Record
         including = options.delete(:including)
         referencing = options.delete(:referencing)
         endpoint = find_endpoint(options[:params], options.fetch(:url, nil))
-        apply_limit!(options) if options[:all]
+        apply_limit!(options)
         response = LHC.request(process_options(options, endpoint))
         return nil if !response.success? && response.error_ignored?
         data = LHS::Data.new(response.body, nil, self, response.request, endpoint)

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '15.5.1'
+  VERSION = '15.6.0'
 end

data/spec/autoloading_spec.rb

@@ -4,7 +4,7 @@ describe LHS, type: :request do
   context 'autoloading' do
     it "pre/re-loads all LHS classes initialy,|
         because it's necessary for endpoint-to-record-class-discovery",
-    cleanup_before: false do
+    reset_before: false do
       all_endpoints = LHS::Record::Endpoints.all
       expect(all_endpoints['http://datastore/v2/users']).to be_present
       expect(all_endpoints['http://datastore/v2/users/{id}']).to be_present

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

@@ -0,0 +1,34 @@
+class ErrorHandlingWithChainsController < ApplicationController
+
+  # Example where the query chain is resolved
+  # in the view (during render 'show')
+  def fetch_in_view
+    @records = Record
+      .handle(LHC::Error, ->(error) { handle_error(error) })
+      .where(color: 'blue')
+    render 'show'
+    render_error if @error
+  end
+
+  # Example where the query chain is resolved
+  # before the view is rendered
+  def fetch_in_controller
+    @records = Record
+      .handle(LHC::Error, ->(error) { handle_error(error) })
+      .where(color: 'blue').fetch
+    render 'show'
+    render_error if @error
+  end
+
+  private
+
+  def handle_error(error)
+    @error = error
+    nil
+  end
+
+  def render_error
+    self.response_body = nil
+    render 'error'
+  end
+end

data/spec/dummy/app/models/record.rb

@@ -0,0 +1,4 @@
+class Record < LHS::Record
+  endpoint 'http://datastore/v2/records'
+  endpoint 'http://datastore/v2/records/{id}'
+end

data/spec/dummy/app/views/error_handling_with_chains/error.html.erb

@@ -0,0 +1 @@
+Sorry there was an error.

data/spec/dummy/app/views/error_handling_with_chains/show.html.erb

@@ -0,0 +1,3 @@
+<% @records.each do |record| %>
+Name: <%= record.name %>
+<% end %>

data/spec/dummy/config/routes.rb

@@ -1,7 +1,13 @@
 Rails.application.routes.draw do
   root 'application#root'
+
+  # Request Cycle Cache
   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'
+
+  # Error handling with chains
+  get 'error_handling_with_chains/fetch_in_controller' => 'error_handling_with_chains#fetch_in_controller'
+  get 'error_handling_with_chains/fetch_in_view' => 'error_handling_with_chains#fetch_in_view'
 end

data/spec/pagination/parameters_spec.rb

@@ -16,9 +16,9 @@ describe LHS::Record do
     end
   end
 
-  context 'explicit pagination paramters for retreiving pages' do
+  context 'explicit pagination parameters for retrieving pages' do
 
-    it 'uses explicit parameters when retreiving pages' do
+    it 'uses explicit parameters when retrieving pages' do
       stub_request(:get, "http://uberall/locations?max=100")
         .to_return(body: {
           response: {

data/spec/record/all_spec.rb

@@ -101,5 +101,31 @@ describe LHS::Record do
       records = Category.all(language: 'en').fetch
       expect(records.length).to eq 300
     end
+
+    it 'outputs a warning, if all is requested, but endpoint does not implement pagination meta data' do
+      stub_batch('http://store/categories?language=en&max=100', 100)
+      stub_batch('http://store/categories?language=en&max=100&offset=100', 100)
+      stub_batch('http://store/categories?language=en&max=100&offset=200', 100)
+      stub_batch('http://store/categories?language=en&max=100&offset=300', 0)
+      expect(-> { Category.all(language: 'en').fetch }).to output(
+        %r{\[Warning\] "all" has been requested, but endpoint does not provide pagination meta data. If you just want to fetch the first response, use "where" or "fetch".}
+      ).to_stderr
+    end
+
+    context 'with record set to not paginated' do
+      before do
+        class Record < LHS::Record
+          configuration paginated: false
+          endpoint 'http://datastore/records'
+        end
+      end
+
+      it 'just fetches the first response' do
+        stub_request(:get, "http://datastore/records")
+          .to_return(body: [{ name: 'Steve' }].to_json)
+        records = Record.all
+        expect(records.first.name).to eq 'Steve'
+      end
+    end
   end
 end

data/spec/record/error_handling_integration_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+require 'lhc/test/cache_helper.rb'
+
+describe 'Error handling with chains', type: :request do
+  let!(:request) do
+    stub_request(:get, "http://datastore/v2/records?color=blue")
+      .to_return(status: 404)
+  end
+
+  it 'handles errors in rails controllers when query resolved in controller',
+  dummy_models: true do
+    get '/error_handling_with_chains/fetch_in_controller'
+    expect(request).to have_been_made.once
+    expect(response.body).to include('Sorry there was an error.')
+  end
+
+  it 'handles errors in rails controllers when query resolved in view',
+  dummy_models: true do
+    get '/error_handling_with_chains/fetch_in_view'
+    expect(request).to have_been_made.once
+    expect(response.body).to include('Sorry there was an error.')
+  end
+end

data/spec/record/fetch_spec.rb

@@ -8,17 +8,32 @@ describe LHS::Record do
   end
 
   context 'fetch' do
-    let!(:request_stub) do
-      stub_request(:get, "http://datastore/records/?available=true&color=blue&range=%3E26")
-        .to_return(body: [{
-          name: 'Steve'
-        }].to_json)
+
+    context 'to resolve the chain' do
+      let!(:request_stub) do
+        stub_request(:get, "http://datastore/records/?available=true&color=blue&range=%3E26")
+          .to_return(body: [{
+            name: 'Steve'
+          }].to_json)
+      end
+
+      it 'resolves chains' do
+        records = Record.where(color: 'blue').where(range: '>26', available: true).fetch
+        expect(request_stub).to have_been_requested
+        expect(records.first.name).to eq 'Steve'
+      end
     end
 
-    it 'resolves chains' do
-      records = Record.where(color: 'blue').where(range: '>26', available: true).fetch
-      expect(request_stub).to have_been_requested
-      expect(records.first.name).to eq 'Steve'
+    context 'to fetch the first response' do
+      let!(:request_stub) do
+        stub_request(:get, "http://datastore/records/")
+          .to_return(body: [{ name: 'Steve' }])
+      end
+
+      it 'does fetch the first response if requested directly on the record' do
+        records = Record.fetch
+        expect(records.first.name).to eq 'Steve'
+      end
     end
   end
 end

data/spec/{request_cycle_cache/main_spec.rb → request_cycle_cache_spec.rb}

@@ -21,7 +21,7 @@ describe 'Request Cycle Cache', type: :request do
   end
 
   it 'serves requests that are exactly the same during one request cycle from the cache',
-  cleanup_before: false, request_cycle_cache: true do
+  dummy_models: true, request_cycle_cache: true do
     get '/request_cycle_cache/simple'
     expect(request).to have_been_made.once
 
@@ -31,7 +31,7 @@ describe 'Request Cycle Cache', type: :request do
   end
 
   it 'does not serve from request cycle cache when cache interceptor is not hooked in, but logs a warning',
-  cleanup_before: false, request_cycle_cache: true do
+  dummy_models: true, request_cycle_cache: true do
     expect(lambda do
       get '/request_cycle_cache/no_caching_interceptor'
     end).to output(
@@ -41,14 +41,14 @@ describe 'Request Cycle Cache', type: :request do
   end
 
   it 'serves requests also from cache when LHS/LHC makes requests in parallel',
-  cleanup_before: false, request_cycle_cache: true do
+  dummy_models: true, request_cycle_cache: true do
     get '/request_cycle_cache/parallel'
     expect(request).to have_been_made.once
     expect(second_request).to have_been_made.once
   end
 
   it 'sets different uniq request ids as base for request cycle caching for different requests',
-  cleanup_before: false, request_cycle_cache: true do
+  dummy_models: true, request_cycle_cache: true do
     get '/request_cycle_cache/simple'
     first_request_id = LHS::Record::RequestCycleCache::RequestCycleThreadRegistry.request_id
     second_request_id = nil
@@ -64,7 +64,7 @@ describe 'Request Cycle Cache', type: :request do
 
   context 'disabled request cycle cache' do
     it 'does not serve from request cycle cache when cache interceptor is not hooked in, and does not warn if request cycle cache is explicitly disabled',
-    cleanup_before: false do
+    dummy_models: true do
       expect(lambda do
         get '/request_cycle_cache/no_caching_interceptor'
       end).not_to output(
@@ -74,7 +74,7 @@ describe 'Request Cycle Cache', type: :request do
     end
 
     it 'DOES NOT serve requests that are exactly the same during one request cycle from the cache, when request cycle cache is disabled',
-    cleanup_before: false do
+    dummy_models: true do
       get '/request_cycle_cache/simple'
       expect(request).to have_been_made.times(2)
     end
@@ -82,7 +82,7 @@ describe 'Request Cycle Cache', type: :request do
 
   context 'headers' do
     it 'considers the request headers when setting the cache key',
-    cleanup_before: false, request_cycle_cache: true do
+    dummy_models: true, request_cycle_cache: true do
       get '/request_cycle_cache/headers'
       expect(request).to have_been_made.times(2)
     end
@@ -95,7 +95,7 @@ describe 'Request Cycle Cache', type: :request do
     after { LHS.config.request_cycle_cache = old_cache }
 
     it 'uses the cache passed in',
-    cleanup_before: true, request_cycle_cache: true do
+    dummy_models: true, request_cycle_cache: true do
       expect(LHS.config.request_cycle_cache).to receive(:fetch).at_least(:once)
       expect(LHS.config.request_cycle_cache).to receive(:write).at_least(:once)
       get '/request_cycle_cache/simple'

data/spec/support/reset.rb

@@ -0,0 +1,43 @@
+require 'lhc'
+class LHC::Config
+
+  def _cleanup
+    @endpoints = {}
+    @placeholders = {}
+    @interceptors = nil
+  end
+end
+
+class LHS::Record
+
+  CHILDREN = []
+
+  def self.inherited(child)
+    CHILDREN.push(child)
+    super
+  end
+
+end
+
+def reset_lhc
+  LHC::Config.instance._cleanup
+end
+
+def reset_lhs
+  LHS::Record::Endpoints.all = {}
+  LHS::Record::CHILDREN.each do |child|
+    child.endpoints = [] if !child.name['LHS'] && defined?(child.endpoints)
+    child.configuration({}) if !child.name['LHS']
+  end
+end
+
+RSpec.configure do |config|
+  config.before do |spec|
+    reset_lhc unless spec.metadata.key?(:reset_before) && spec.metadata[:reset_before] == false
+    reset_lhs unless spec.metadata.key?(:reset_before) && spec.metadata[:reset_before] == false
+    next unless spec.metadata.key?(:dummy_models) && spec.metadata[:dummy_models] == true
+    Dir.glob(Rails.root.join('app', 'models', '**', '*.rb')).each do |file|
+      load file if File.read(file).match('LHS::Record')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 15.5.1
+  version: 15.6.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -178,10 +178,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails gem providing an easy, active-record-like interface for http json
-  services
+description: 'REST services accelerator: Rails gem providing an easy, active-record-like
+  interface for http (hypermedia) json services'
 email:
-- ws-operations@local.ch
+- web@localsearch.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -302,12 +302,16 @@ files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/controllers/error_handling_with_chains_controller.rb
 - spec/dummy/app/controllers/request_cycle_cache_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/record.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/views/error_handling_with_chains/error.html.erb
+- spec/dummy/app/views/error_handling_with_chains/show.html.erb
 - spec/dummy/app/views/form_for.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
@@ -371,7 +375,6 @@ files:
 - spec/record/all_spec.rb
 - spec/record/build_spec.rb
 - spec/record/cast_nested_data_spec.rb
-- spec/record/chain_error_handling_spec.rb
 - spec/record/create_spec.rb
 - spec/record/creation_failed_spec.rb
 - spec/record/definitions_spec.rb
@@ -382,6 +385,8 @@ files:
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
+- spec/record/error_handling_integration_spec.rb
+- spec/record/error_handling_spec.rb
 - spec/record/expanded_spec.rb
 - spec/record/fetch_spec.rb
 - spec/record/find_by_chains_spec.rb
@@ -426,15 +431,15 @@ files:
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb
-- spec/request_cycle_cache/main_spec.rb
+- spec/request_cycle_cache_spec.rb
 - spec/require_lhs_spec.rb
 - spec/spec_helper.rb
-- spec/support/cleanup.rb
 - spec/support/fixtures/json/feedback.json
 - spec/support/fixtures/json/feedbacks.json
 - spec/support/fixtures/json/localina_content_ad.json
 - spec/support/load_json.rb
 - spec/support/request_cycle_cache.rb
+- spec/support/reset.rb
 - spec/views/form_for_spec.rb
 homepage: https://github.com/local-ch/lhs
 licenses:
@@ -457,10 +462,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.3.0
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Rails gem providing an easy, active-record-like interface for http json services
+summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
+  interface for http (hypermedia) json services'
 test_files:
 - spec/autoloading_spec.rb
 - spec/collection/accessors_spec.rb
@@ -495,12 +501,16 @@ test_files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/controllers/error_handling_with_chains_controller.rb
 - spec/dummy/app/controllers/request_cycle_cache_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/record.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/views/error_handling_with_chains/error.html.erb
+- spec/dummy/app/views/error_handling_with_chains/show.html.erb
 - spec/dummy/app/views/form_for.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
@@ -564,7 +574,6 @@ test_files:
 - spec/record/all_spec.rb
 - spec/record/build_spec.rb
 - spec/record/cast_nested_data_spec.rb
-- spec/record/chain_error_handling_spec.rb
 - spec/record/create_spec.rb
 - spec/record/creation_failed_spec.rb
 - spec/record/definitions_spec.rb
@@ -575,6 +584,8 @@ test_files:
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
+- spec/record/error_handling_integration_spec.rb
+- spec/record/error_handling_spec.rb
 - spec/record/expanded_spec.rb
 - spec/record/fetch_spec.rb
 - spec/record/find_by_chains_spec.rb
@@ -619,13 +630,13 @@ test_files:
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb
-- spec/request_cycle_cache/main_spec.rb
+- spec/request_cycle_cache_spec.rb
 - spec/require_lhs_spec.rb
 - spec/spec_helper.rb
-- spec/support/cleanup.rb
 - spec/support/fixtures/json/feedback.json
 - spec/support/fixtures/json/feedbacks.json
 - spec/support/fixtures/json/localina_content_ad.json
 - spec/support/load_json.rb
 - spec/support/request_cycle_cache.rb
+- spec/support/reset.rb
 - spec/views/form_for_spec.rb