lhs 24.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (306) hide show
  1. checksums.yaml +7 -0
  2. data/.bundler-version +1 -0
  3. data/.gitignore +39 -0
  4. data/.rubocop.localch.yml +325 -0
  5. data/.rubocop.yml +52 -0
  6. data/.ruby-version +1 -0
  7. data/Gemfile +4 -0
  8. data/Gemfile.activesupport4 +5 -0
  9. data/Gemfile.activesupport5 +4 -0
  10. data/LICENSE +674 -0
  11. data/README.md +2836 -0
  12. data/Rakefile +25 -0
  13. data/cider-ci.yml +6 -0
  14. data/cider-ci/bin/bundle +51 -0
  15. data/cider-ci/bin/ruby_install +8 -0
  16. data/cider-ci/bin/ruby_version +25 -0
  17. data/cider-ci/jobs/rspec-activesupport-4.yml +27 -0
  18. data/cider-ci/jobs/rspec-activesupport-5.yml +26 -0
  19. data/cider-ci/jobs/rspec-activesupport-latest.yml +24 -0
  20. data/cider-ci/jobs/rubocop.yml +18 -0
  21. data/cider-ci/task_components/bundle.yml +22 -0
  22. data/cider-ci/task_components/rspec.yml +37 -0
  23. data/cider-ci/task_components/rubocop.yml +29 -0
  24. data/cider-ci/task_components/ruby.yml +15 -0
  25. data/friday.yml +2 -0
  26. data/lhs.gemspec +43 -0
  27. data/lib/lhs.rb +100 -0
  28. data/lib/lhs/collection.rb +84 -0
  29. data/lib/lhs/complex.rb +158 -0
  30. data/lib/lhs/concerns/autoload_records.rb +55 -0
  31. data/lib/lhs/concerns/collection/handle_nested.rb +43 -0
  32. data/lib/lhs/concerns/collection/internal_collection.rb +49 -0
  33. data/lib/lhs/concerns/configuration.rb +20 -0
  34. data/lib/lhs/concerns/data/becomes.rb +18 -0
  35. data/lib/lhs/concerns/data/equality.rb +14 -0
  36. data/lib/lhs/concerns/data/json.rb +14 -0
  37. data/lib/lhs/concerns/data/to_hash.rb +14 -0
  38. data/lib/lhs/concerns/inspect.rb +70 -0
  39. data/lib/lhs/concerns/is_href.rb +15 -0
  40. data/lib/lhs/concerns/item/destroy.rb +38 -0
  41. data/lib/lhs/concerns/item/endpoint_lookup.rb +27 -0
  42. data/lib/lhs/concerns/item/save.rb +55 -0
  43. data/lib/lhs/concerns/item/update.rb +50 -0
  44. data/lib/lhs/concerns/item/validation.rb +61 -0
  45. data/lib/lhs/concerns/o_auth.rb +25 -0
  46. data/lib/lhs/concerns/option_blocks.rb +26 -0
  47. data/lib/lhs/concerns/proxy/accessors.rb +132 -0
  48. data/lib/lhs/concerns/proxy/create.rb +45 -0
  49. data/lib/lhs/concerns/proxy/link.rb +25 -0
  50. data/lib/lhs/concerns/proxy/problems.rb +27 -0
  51. data/lib/lhs/concerns/record/attribute_assignment.rb +25 -0
  52. data/lib/lhs/concerns/record/batch.rb +40 -0
  53. data/lib/lhs/concerns/record/chainable.rb +465 -0
  54. data/lib/lhs/concerns/record/configuration.rb +103 -0
  55. data/lib/lhs/concerns/record/create.rb +24 -0
  56. data/lib/lhs/concerns/record/custom_setters.rb +22 -0
  57. data/lib/lhs/concerns/record/destroy.rb +18 -0
  58. data/lib/lhs/concerns/record/endpoints.rb +108 -0
  59. data/lib/lhs/concerns/record/equality.rb +14 -0
  60. data/lib/lhs/concerns/record/find.rb +86 -0
  61. data/lib/lhs/concerns/record/find_by.rb +38 -0
  62. data/lib/lhs/concerns/record/first.rb +20 -0
  63. data/lib/lhs/concerns/record/href_for.rb +19 -0
  64. data/lib/lhs/concerns/record/last.rb +27 -0
  65. data/lib/lhs/concerns/record/mapping.rb +25 -0
  66. data/lib/lhs/concerns/record/merge.rb +26 -0
  67. data/lib/lhs/concerns/record/model.rb +23 -0
  68. data/lib/lhs/concerns/record/pagination.rb +47 -0
  69. data/lib/lhs/concerns/record/provider.rb +23 -0
  70. data/lib/lhs/concerns/record/relations.rb +26 -0
  71. data/lib/lhs/concerns/record/request.rb +620 -0
  72. data/lib/lhs/concerns/record/scope.rb +25 -0
  73. data/lib/lhs/concerns/record/tracing.rb +24 -0
  74. data/lib/lhs/concerns/record/update.rb +17 -0
  75. data/lib/lhs/config.rb +24 -0
  76. data/lib/lhs/data.rb +165 -0
  77. data/lib/lhs/endpoint.rb +12 -0
  78. data/lib/lhs/interceptors/auto_oauth/interceptor.rb +33 -0
  79. data/lib/lhs/interceptors/auto_oauth/thread_registry.rb +18 -0
  80. data/lib/lhs/interceptors/extended_rollbar/handler.rb +40 -0
  81. data/lib/lhs/interceptors/extended_rollbar/interceptor.rb +20 -0
  82. data/lib/lhs/interceptors/extended_rollbar/thread_registry.rb +19 -0
  83. data/lib/lhs/interceptors/request_cycle_cache/interceptor.rb +41 -0
  84. data/lib/lhs/interceptors/request_cycle_cache/thread_registry.rb +18 -0
  85. data/lib/lhs/item.rb +59 -0
  86. data/lib/lhs/pagination/base.rb +90 -0
  87. data/lib/lhs/pagination/link.rb +21 -0
  88. data/lib/lhs/pagination/offset.rb +22 -0
  89. data/lib/lhs/pagination/page.rb +18 -0
  90. data/lib/lhs/pagination/start.rb +22 -0
  91. data/lib/lhs/problems/base.rb +113 -0
  92. data/lib/lhs/problems/errors.rb +69 -0
  93. data/lib/lhs/problems/nested/base.rb +54 -0
  94. data/lib/lhs/problems/nested/errors.rb +16 -0
  95. data/lib/lhs/problems/nested/warnings.rb +15 -0
  96. data/lib/lhs/problems/warnings.rb +24 -0
  97. data/lib/lhs/proxy.rb +68 -0
  98. data/lib/lhs/railtie.rb +34 -0
  99. data/lib/lhs/record.rb +112 -0
  100. data/lib/lhs/rspec.rb +10 -0
  101. data/lib/lhs/test/stubbable_records.rb +34 -0
  102. data/lib/lhs/unprocessable.rb +6 -0
  103. data/lib/lhs/version.rb +5 -0
  104. data/script/ci/build.sh +18 -0
  105. data/spec/auto_oauth_spec.rb +169 -0
  106. data/spec/autoloading_spec.rb +48 -0
  107. data/spec/collection/accessors_spec.rb +31 -0
  108. data/spec/collection/collection_items_spec.rb +44 -0
  109. data/spec/collection/configurable_spec.rb +43 -0
  110. data/spec/collection/delegate_spec.rb +21 -0
  111. data/spec/collection/enumerable_spec.rb +27 -0
  112. data/spec/collection/href_spec.rb +17 -0
  113. data/spec/collection/meta_data_spec.rb +57 -0
  114. data/spec/collection/respond_to_spec.rb +20 -0
  115. data/spec/collection/to_a_spec.rb +34 -0
  116. data/spec/collection/to_ary_spec.rb +40 -0
  117. data/spec/collection/without_object_items_spec.rb +27 -0
  118. data/spec/complex/reduce_spec.rb +202 -0
  119. data/spec/concerns/record/request_spec.rb +78 -0
  120. data/spec/data/collection_spec.rb +56 -0
  121. data/spec/data/equality_spec.rb +23 -0
  122. data/spec/data/inspect_spec.rb +88 -0
  123. data/spec/data/is_item_or_collection_spec.rb +40 -0
  124. data/spec/data/item_spec.rb +106 -0
  125. data/spec/data/merge_spec.rb +27 -0
  126. data/spec/data/parent_spec.rb +39 -0
  127. data/spec/data/raw_spec.rb +48 -0
  128. data/spec/data/respond_to_spec.rb +26 -0
  129. data/spec/data/root_spec.rb +25 -0
  130. data/spec/data/select_spec.rb +27 -0
  131. data/spec/data/to_ary_spec.rb +28 -0
  132. data/spec/data/to_json_spec.rb +68 -0
  133. data/spec/dummy/Rakefile +8 -0
  134. data/spec/dummy/app/assets/images/.keep +0 -0
  135. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  136. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  137. data/spec/dummy/app/controllers/application_controller.rb +26 -0
  138. data/spec/dummy/app/controllers/automatic_authentication_controller.rb +29 -0
  139. data/spec/dummy/app/controllers/concerns/.keep +0 -0
  140. data/spec/dummy/app/controllers/error_handling_with_chains_controller.rb +36 -0
  141. data/spec/dummy/app/controllers/extended_rollbar_controller.rb +10 -0
  142. data/spec/dummy/app/controllers/option_blocks_controller.rb +15 -0
  143. data/spec/dummy/app/controllers/request_cycle_cache_controller.rb +27 -0
  144. data/spec/dummy/app/helpers/application_helper.rb +4 -0
  145. data/spec/dummy/app/mailers/.keep +0 -0
  146. data/spec/dummy/app/models/.keep +0 -0
  147. data/spec/dummy/app/models/concerns/.keep +0 -0
  148. data/spec/dummy/app/models/dummy_customer.rb +6 -0
  149. data/spec/dummy/app/models/dummy_record.rb +6 -0
  150. data/spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb +6 -0
  151. data/spec/dummy/app/models/dummy_record_with_multiple_oauth_providers1.rb +7 -0
  152. data/spec/dummy/app/models/dummy_record_with_multiple_oauth_providers2.rb +7 -0
  153. data/spec/dummy/app/models/dummy_record_with_multiple_providers_per_endpoint.rb +6 -0
  154. data/spec/dummy/app/models/dummy_record_with_oauth.rb +7 -0
  155. data/spec/dummy/app/models/dummy_user.rb +6 -0
  156. data/spec/dummy/app/models/providers/customer_system.rb +7 -0
  157. data/spec/dummy/app/models/providers/internal_services.rb +7 -0
  158. data/spec/dummy/app/views/error_handling_with_chains/error.html.erb +1 -0
  159. data/spec/dummy/app/views/error_handling_with_chains/show.html.erb +3 -0
  160. data/spec/dummy/app/views/form_for.html.erb +5 -0
  161. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  162. data/spec/dummy/bin/bundle +5 -0
  163. data/spec/dummy/bin/rails +6 -0
  164. data/spec/dummy/bin/rake +6 -0
  165. data/spec/dummy/config.ru +6 -0
  166. data/spec/dummy/config/application.rb +16 -0
  167. data/spec/dummy/config/boot.rb +7 -0
  168. data/spec/dummy/config/environment.rb +7 -0
  169. data/spec/dummy/config/environments/development.rb +36 -0
  170. data/spec/dummy/config/environments/production.rb +77 -0
  171. data/spec/dummy/config/environments/test.rb +40 -0
  172. data/spec/dummy/config/initializers/assets.rb +10 -0
  173. data/spec/dummy/config/initializers/backtrace_silencers.rb +9 -0
  174. data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
  175. data/spec/dummy/config/initializers/filter_parameter_logging.rb +6 -0
  176. data/spec/dummy/config/initializers/inflections.rb +18 -0
  177. data/spec/dummy/config/initializers/mime_types.rb +6 -0
  178. data/spec/dummy/config/initializers/rollbar.rb +9 -0
  179. data/spec/dummy/config/initializers/session_store.rb +5 -0
  180. data/spec/dummy/config/initializers/wrap_parameters.rb +11 -0
  181. data/spec/dummy/config/locales/en.yml +23 -0
  182. data/spec/dummy/config/routes.rb +27 -0
  183. data/spec/dummy/config/secrets.yml +22 -0
  184. data/spec/dummy/lib/assets/.keep +0 -0
  185. data/spec/dummy/public/404.html +67 -0
  186. data/spec/dummy/public/422.html +67 -0
  187. data/spec/dummy/public/500.html +66 -0
  188. data/spec/dummy/public/favicon.ico +0 -0
  189. data/spec/endpoint/for_url_spec.rb +27 -0
  190. data/spec/extended_rollbar_spec.rb +67 -0
  191. data/spec/item/access_errors_spec.rb +33 -0
  192. data/spec/item/accessors_spec.rb +21 -0
  193. data/spec/item/add_error_spec.rb +21 -0
  194. data/spec/item/becomes_spec.rb +38 -0
  195. data/spec/item/blacklisted_keywords_spec.rb +30 -0
  196. data/spec/item/delegate_spec.rb +32 -0
  197. data/spec/item/destroy_spec.rb +113 -0
  198. data/spec/item/dig_spec.rb +29 -0
  199. data/spec/item/error_codes_spec.rb +55 -0
  200. data/spec/item/errors_spec.rb +324 -0
  201. data/spec/item/fetch_spec.rb +39 -0
  202. data/spec/item/getter_spec.rb +24 -0
  203. data/spec/item/internal_data_structure_spec.rb +37 -0
  204. data/spec/item/map_spec.rb +46 -0
  205. data/spec/item/nested_errors_spec.rb +28 -0
  206. data/spec/item/partial_update_spec.rb +170 -0
  207. data/spec/item/respond_to_spec.rb +31 -0
  208. data/spec/item/save_spec.rb +115 -0
  209. data/spec/item/setter_spec.rb +44 -0
  210. data/spec/item/translate_errors_spec.rb +257 -0
  211. data/spec/item/update_spec.rb +161 -0
  212. data/spec/item/validation_spec.rb +131 -0
  213. data/spec/item/warning_codes_spec.rb +55 -0
  214. data/spec/item/warnings_spec.rb +52 -0
  215. data/spec/option_blocks/ensure_reset_between_requests_spec.rb +23 -0
  216. data/spec/option_blocks/main_spec.rb +55 -0
  217. data/spec/pagination/link/current_page_spec.rb +19 -0
  218. data/spec/pagination/link/pages_left_spec.rb +36 -0
  219. data/spec/pagination/link/parallel_spec.rb +19 -0
  220. data/spec/pagination/link/total_spec.rb +46 -0
  221. data/spec/pagination/offset/pages_left_spec.rb +26 -0
  222. data/spec/pagination/parameters_spec.rb +61 -0
  223. data/spec/proxy/create_sub_resource_spec.rb +182 -0
  224. data/spec/proxy/load_spec.rb +75 -0
  225. data/spec/proxy/record_identification_spec.rb +35 -0
  226. data/spec/rails_helper.rb +13 -0
  227. data/spec/record/all_spec.rb +133 -0
  228. data/spec/record/attribute_assignment_spec.rb +28 -0
  229. data/spec/record/build_spec.rb +26 -0
  230. data/spec/record/cast_nested_data_spec.rb +78 -0
  231. data/spec/record/create_spec.rb +160 -0
  232. data/spec/record/creation_failed_spec.rb +55 -0
  233. data/spec/record/custom_setters_spec.rb +45 -0
  234. data/spec/record/definitions_spec.rb +29 -0
  235. data/spec/record/destroy_spec.rb +38 -0
  236. data/spec/record/dig_configuration_spec.rb +75 -0
  237. data/spec/record/dup_spec.rb +20 -0
  238. data/spec/record/endpoint_inheritance_spec.rb +65 -0
  239. data/spec/record/endpoint_options_spec.rb +52 -0
  240. data/spec/record/endpoint_priorities_spec.rb +26 -0
  241. data/spec/record/endpoints_spec.rb +96 -0
  242. data/spec/record/equality_spec.rb +27 -0
  243. data/spec/record/error_handling_integration_spec.rb +25 -0
  244. data/spec/record/error_handling_spec.rb +40 -0
  245. data/spec/record/expanded_spec.rb +69 -0
  246. data/spec/record/fetch_spec.rb +41 -0
  247. data/spec/record/find_by_chains_spec.rb +21 -0
  248. data/spec/record/find_by_spec.rb +76 -0
  249. data/spec/record/find_each_spec.rb +57 -0
  250. data/spec/record/find_in_batches_spec.rb +122 -0
  251. data/spec/record/find_in_parallel_spec.rb +67 -0
  252. data/spec/record/find_spec.rb +104 -0
  253. data/spec/record/first_spec.rb +39 -0
  254. data/spec/record/force_merge_spec.rb +56 -0
  255. data/spec/record/handle_includes_errors_spec.rb +32 -0
  256. data/spec/record/has_many_spec.rb +120 -0
  257. data/spec/record/has_one_spec.rb +116 -0
  258. data/spec/record/href_for_spec.rb +25 -0
  259. data/spec/record/ignore_errors_spec.rb +139 -0
  260. data/spec/record/immutable_chains_spec.rb +22 -0
  261. data/spec/record/includes_first_page_spec.rb +737 -0
  262. data/spec/record/includes_spec.rb +693 -0
  263. data/spec/record/includes_warning_spec.rb +46 -0
  264. data/spec/record/item_key_spec.rb +81 -0
  265. data/spec/record/items_created_key_configuration_spec.rb +37 -0
  266. data/spec/record/last_spec.rb +68 -0
  267. data/spec/record/loading_twice_spec.rb +19 -0
  268. data/spec/record/mapping_spec.rb +102 -0
  269. data/spec/record/model_name_spec.rb +17 -0
  270. data/spec/record/new_spec.rb +106 -0
  271. data/spec/record/options_getter_spec.rb +26 -0
  272. data/spec/record/options_spec.rb +164 -0
  273. data/spec/record/paginatable_collection_spec.rb +360 -0
  274. data/spec/record/pagination_chain_spec.rb +101 -0
  275. data/spec/record/pagination_links_spec.rb +72 -0
  276. data/spec/record/pagination_spec.rb +71 -0
  277. data/spec/record/persisted_spec.rb +52 -0
  278. data/spec/record/provider_spec.rb +41 -0
  279. data/spec/record/references_spec.rb +53 -0
  280. data/spec/record/relation_caching_spec.rb +121 -0
  281. data/spec/record/reload_by_id_spec.rb +43 -0
  282. data/spec/record/reload_spec.rb +65 -0
  283. data/spec/record/request_spec.rb +90 -0
  284. data/spec/record/save_spec.rb +40 -0
  285. data/spec/record/scope_chains_spec.rb +39 -0
  286. data/spec/record/select_spec.rb +17 -0
  287. data/spec/record/to_ary_spec.rb +65 -0
  288. data/spec/record/to_hash_spec.rb +22 -0
  289. data/spec/record/to_json_spec.rb +22 -0
  290. data/spec/record/tracing_spec.rb +154 -0
  291. data/spec/record/update_spec.rb +62 -0
  292. data/spec/record/where_chains_spec.rb +57 -0
  293. data/spec/record/where_spec.rb +62 -0
  294. data/spec/record/where_values_hash_spec.rb +32 -0
  295. data/spec/request_cycle_cache_spec.rb +106 -0
  296. data/spec/require_lhs_spec.rb +9 -0
  297. data/spec/spec_helper.rb +6 -0
  298. data/spec/stubs/all_spec.rb +72 -0
  299. data/spec/support/fixtures/json/feedback.json +11 -0
  300. data/spec/support/fixtures/json/feedbacks.json +174 -0
  301. data/spec/support/fixtures/json/localina_content_ad.json +23 -0
  302. data/spec/support/load_json.rb +5 -0
  303. data/spec/support/request_cycle_cache.rb +10 -0
  304. data/spec/support/reset.rb +67 -0
  305. data/spec/views/form_for_spec.rb +20 -0
  306. metadata +776 -0
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rails_helper'
4
+
5
+ describe LHS::Record do
6
+ before do
7
+ class Record < LHS::Record
8
+ endpoint 'http://local.ch/v2/records'
9
+ end
10
+ end
11
+
12
+ it 'always returns a new chain and does not mutate the original' do
13
+ blue_request = stub_request(:get, "http://local.ch/v2/records?color=blue").to_return(body: [].to_json)
14
+ blue_records = Record.where(color: 'blue')
15
+ blue_active_request = stub_request(:get, "http://local.ch/v2/records?color=blue&active=true").to_return(body: [].to_json)
16
+ active_blue_records = blue_records.where(active: true)
17
+ blue_records.first
18
+ active_blue_records.first
19
+ assert_requested(blue_request)
20
+ assert_requested(blue_active_request)
21
+ end
22
+ end
@@ -0,0 +1,737 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rails_helper'
4
+
5
+ describe LHS::Record do
6
+ let(:datastore) { 'http://local.ch/v2' }
7
+ before { LHC.config.placeholder('datastore', datastore) }
8
+
9
+ let(:stub_campaign_request) do
10
+ stub_request(:get, "#{datastore}/content-ads/51dfc5690cf271c375c5a12d")
11
+ .to_return(body: {
12
+ 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d",
13
+ 'entry' => { 'href' => "#{datastore}/local-entries/lakj35asdflkj1203va" },
14
+ 'user' => { 'href' => "#{datastore}/users/lakj35asdflkj1203va" }
15
+ }.to_json)
16
+ end
17
+
18
+ let(:stub_entry_request) do
19
+ stub_request(:get, "#{datastore}/local-entries/lakj35asdflkj1203va")
20
+ .to_return(body: { 'name' => 'Casa Ferlin' }.to_json)
21
+ end
22
+
23
+ let(:stub_user_request) do
24
+ stub_request(:get, "#{datastore}/users/lakj35asdflkj1203va")
25
+ .to_return(body: { 'name' => 'Mario' }.to_json)
26
+ end
27
+
28
+ context 'singlelevel includes' do
29
+ before do
30
+ class LocalEntry < LHS::Record
31
+ endpoint '{+datastore}/local-entries'
32
+ endpoint '{+datastore}/local-entries/{id}'
33
+ end
34
+ class User < LHS::Record
35
+ endpoint '{+datastore}/users'
36
+ endpoint '{+datastore}/users/{id}'
37
+ end
38
+ class Favorite < LHS::Record
39
+ endpoint '{+datastore}/favorites'
40
+ endpoint '{+datastore}/favorites/{id}'
41
+ end
42
+ stub_request(:get, "#{datastore}/local-entries/1")
43
+ .to_return(body: { company_name: 'local.ch' }.to_json)
44
+ stub_request(:get, "#{datastore}/users/1")
45
+ .to_return(body: { name: 'Mario' }.to_json)
46
+ stub_request(:get, "#{datastore}/favorites/1")
47
+ .to_return(body: {
48
+ local_entry: { href: "#{datastore}/local-entries/1" },
49
+ user: { href: "#{datastore}/users/1" }
50
+ }.to_json)
51
+ end
52
+
53
+ it 'includes a resource' do
54
+ favorite = Favorite.includes_first_page(:local_entry).find(1)
55
+ expect(favorite.local_entry.company_name).to eq 'local.ch'
56
+ end
57
+
58
+ it 'duplicates a class' do
59
+ expect(Favorite.object_id).not_to eq(Favorite.includes_first_page(:local_entry).object_id)
60
+ end
61
+
62
+ it 'includes a list of resources' do
63
+ favorite = Favorite.includes_first_page(:local_entry, :user).find(1)
64
+ expect(favorite.local_entry).to be_kind_of LocalEntry
65
+ expect(favorite.local_entry.company_name).to eq 'local.ch'
66
+ expect(favorite.user.name).to eq 'Mario'
67
+ end
68
+
69
+ it 'includes an array of resources' do
70
+ favorite = Favorite.includes_first_page([:local_entry, :user]).find(1)
71
+ expect(favorite.local_entry.company_name).to eq 'local.ch'
72
+ expect(favorite.user.name).to eq 'Mario'
73
+ end
74
+ end
75
+
76
+ context 'multilevel includes' do
77
+ before do
78
+ class Feedback < LHS::Record
79
+ endpoint '{+datastore}/feedbacks'
80
+ endpoint '{+datastore}/feedbacks/{id}'
81
+ end
82
+ stub_campaign_request
83
+ stub_entry_request
84
+ stub_user_request
85
+ end
86
+
87
+ it 'includes linked resources while fetching multiple resources from one service' do
88
+ stub_request(:get, "#{datastore}/feedbacks?has_reviews=true")
89
+ .to_return(status: 200, body: {
90
+ items: [
91
+ {
92
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
93
+ 'campaign' => { 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d" }
94
+ }
95
+ ]
96
+ }.to_json)
97
+
98
+ feedbacks = Feedback.includes_first_page(campaign: :entry).where(has_reviews: true)
99
+ expect(feedbacks.first.campaign.entry.name).to eq 'Casa Ferlin'
100
+ end
101
+
102
+ it 'includes linked resources while fetching a single resource from one service' do
103
+ stub_request(:get, "#{datastore}/feedbacks/123")
104
+ .to_return(status: 200, body: {
105
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
106
+ 'campaign' => { 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d" }
107
+ }.to_json)
108
+
109
+ feedbacks = Feedback.includes_first_page(campaign: :entry).find(123)
110
+ expect(feedbacks.campaign.entry.name).to eq 'Casa Ferlin'
111
+ end
112
+
113
+ it 'includes linked resources with array while fetching a single resource from one service' do
114
+ stub_request(:get, "#{datastore}/feedbacks/123")
115
+ .to_return(status: 200, body: {
116
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
117
+ 'campaign' => { 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d" }
118
+ }.to_json)
119
+
120
+ feedbacks = Feedback.includes_first_page(campaign: [:entry, :user]).find(123)
121
+ expect(feedbacks.campaign.entry.name).to eq 'Casa Ferlin'
122
+ expect(feedbacks.campaign.user.name).to eq 'Mario'
123
+ end
124
+
125
+ it 'includes list of linked resources while fetching a single resource from one service' do
126
+ stub_request(:get, "#{datastore}/feedbacks/123")
127
+ .to_return(status: 200, body: {
128
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
129
+ 'campaign' => { 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d" },
130
+ 'user' => { 'href' => "#{datastore}/users/lakj35asdflkj1203va" }
131
+ }.to_json)
132
+
133
+ feedbacks = Feedback.includes_first_page(:user, campaign: [:entry, :user]).find(123)
134
+ expect(feedbacks.campaign.entry.name).to eq 'Casa Ferlin'
135
+ expect(feedbacks.campaign.user.name).to eq 'Mario'
136
+ expect(feedbacks.user.name).to eq 'Mario'
137
+ end
138
+
139
+ context 'include objects from known services' do
140
+ let(:stub_feedback_request) do
141
+ stub_request(:get, "#{datastore}/feedbacks")
142
+ .to_return(status: 200, body: {
143
+ items: [
144
+ {
145
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
146
+ 'entry' => {
147
+ 'href' => "#{datastore}/local-entries/lakj35asdflkj1203va"
148
+ }
149
+ }
150
+ ]
151
+ }.to_json)
152
+ end
153
+
154
+ let(:interceptor) { spy('interceptor') }
155
+
156
+ before do
157
+ class Entry < LHS::Record
158
+ endpoint '{+datastore}/local-entries/{id}'
159
+ end
160
+ LHC.config.interceptors = [interceptor]
161
+ end
162
+
163
+ it 'uses interceptors for included links from known services' do
164
+ stub_feedback_request
165
+ stub_entry_request
166
+ expect(Feedback.includes_first_page(:entry).where.first.entry.name).to eq 'Casa Ferlin'
167
+ expect(interceptor).to have_received(:before_request).twice
168
+ end
169
+ end
170
+
171
+ context 'includes not present in response' do
172
+ before do
173
+ class Parent < LHS::Record
174
+ endpoint '{+datastore}/local-parents'
175
+ endpoint '{+datastore}/local-parents/{id}'
176
+ end
177
+
178
+ class OptionalChild < LHS::Record
179
+ endpoint '{+datastore}/local-children/{id}'
180
+ end
181
+ end
182
+
183
+ it 'handles missing but included fields in single object response' do
184
+ stub_request(:get, "#{datastore}/local-parents/1")
185
+ .to_return(status: 200, body: {
186
+ 'href' => "#{datastore}/local-parents/1",
187
+ 'name' => 'RspecName'
188
+ }.to_json)
189
+
190
+ parent = Parent.includes_first_page(:optional_children).find(1)
191
+ expect(parent).not_to be nil
192
+ expect(parent.name).to eq 'RspecName'
193
+ expect(parent.optional_children).to be nil
194
+ end
195
+
196
+ it 'handles missing but included fields in collection response' do
197
+ stub_request(:get, "#{datastore}/local-parents")
198
+ .to_return(status: 200, body: {
199
+ items: [
200
+ {
201
+ 'href' => "#{datastore}/local-parents/1",
202
+ 'name' => 'RspecParent'
203
+ }, {
204
+ 'href' => "#{datastore}/local-parents/2",
205
+ 'name' => 'RspecParent2',
206
+ 'optional_child' => {
207
+ 'href' => "#{datastore}/local-children/1"
208
+ }
209
+ }
210
+ ]
211
+ }.to_json)
212
+
213
+ stub_request(:get, "#{datastore}/local-children/1")
214
+ .to_return(status: 200, body: {
215
+ href: "#{datastore}/local_children/1",
216
+ name: 'RspecOptionalChild1'
217
+ }.to_json)
218
+
219
+ child = Parent.includes_first_page(:optional_child).where[1].optional_child
220
+ expect(child).not_to be nil
221
+ expect(child.name).to eq 'RspecOptionalChild1'
222
+ end
223
+ end
224
+ end
225
+
226
+ context 'links pointing to nowhere' do
227
+ before do
228
+ class Feedback < LHS::Record
229
+ endpoint '{+datastore}/feedbacks'
230
+ endpoint '{+datastore}/feedbacks/{id}'
231
+ end
232
+
233
+ stub_request(:get, "#{datastore}/feedbacks/123")
234
+ .to_return(status: 200, body: {
235
+ 'href' => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
236
+ 'campaign' => { 'href' => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d" }
237
+ }.to_json)
238
+
239
+ stub_request(:get, "#{datastore}/content-ads/51dfc5690cf271c375c5a12d")
240
+ .to_return(status: 404)
241
+ end
242
+
243
+ it 'raises LHC::NotFound for links that cannot be included' do
244
+ expect(-> {
245
+ Feedback.includes_first_page(campaign: :entry).find(123)
246
+ }).to raise_error LHC::NotFound
247
+ end
248
+
249
+ it 'ignores LHC::NotFound for links that cannot be included if configured so with reference options' do
250
+ feedback = Feedback
251
+ .includes_first_page(campaign: :entry)
252
+ .references(campaign: { ignore: [LHC::NotFound] })
253
+ .find(123)
254
+ expect(feedback.campaign._raw.keys.length).to eq 1
255
+ end
256
+ end
257
+
258
+ context 'modules' do
259
+ before do
260
+ module Services
261
+ class LocalEntry < LHS::Record
262
+ endpoint '{+datastore}/local-entries'
263
+ end
264
+
265
+ class Feedback < LHS::Record
266
+ endpoint '{+datastore}/feedbacks'
267
+ end
268
+ end
269
+ stub_request(:get, "http://local.ch/v2/feedbacks?id=123")
270
+ .to_return(body: [].to_json)
271
+ end
272
+
273
+ it 'works with modules' do
274
+ Services::Feedback.includes_first_page(campaign: :entry).find(123)
275
+ end
276
+ end
277
+
278
+ context 'arrays' do
279
+ before do
280
+ class Place < LHS::Record
281
+ endpoint '{+datastore}/place'
282
+ endpoint '{+datastore}/place/{id}'
283
+ end
284
+ end
285
+
286
+ let!(:place_request) do
287
+ stub_request(:get, "#{datastore}/place/1")
288
+ .to_return(body: {
289
+ 'relations' => [
290
+ { 'href' => "#{datastore}/place/relations/2" },
291
+ { 'href' => "#{datastore}/place/relations/3" }
292
+ ]
293
+ }.to_json)
294
+ end
295
+
296
+ let!(:relation_request_1) do
297
+ stub_request(:get, "#{datastore}/place/relations/2")
298
+ .to_return(body: { name: 'Category' }.to_json)
299
+ end
300
+
301
+ let!(:relation_request_2) do
302
+ stub_request(:get, "#{datastore}/place/relations/3")
303
+ .to_return(body: { name: 'ZeFrank' }.to_json)
304
+ end
305
+
306
+ it 'includes items of arrays' do
307
+ place = Place.includes_first_page(:relations).find(1)
308
+ expect(place.relations.first.name).to eq 'Category'
309
+ expect(place.relations[1].name).to eq 'ZeFrank'
310
+ end
311
+
312
+ context 'parallel with empty links' do
313
+ let!(:place_request_2) do
314
+ stub_request(:get, "#{datastore}/place/2")
315
+ .to_return(body: {
316
+ 'relations' => []
317
+ }.to_json)
318
+ end
319
+
320
+ it 'loads places in parallel and merges included data properly' do
321
+ place = Place.includes_first_page(:relations).find(2, 1)
322
+ expect(place[0].relations.empty?).to be true
323
+ expect(place[1].relations[0].name).to eq 'Category'
324
+ expect(place[1].relations[1].name).to eq 'ZeFrank'
325
+ end
326
+ end
327
+ end
328
+
329
+ context 'empty collections' do
330
+ it 'skips including empty collections' do
331
+ class Place < LHS::Record
332
+ endpoint '{+datastore}/place'
333
+ endpoint '{+datastore}/place/{id}'
334
+ end
335
+
336
+ stub_request(:get, "#{datastore}/place/1")
337
+ .to_return(body: {
338
+ 'available_products' => {
339
+ "url" => "#{datastore}/place/1/products",
340
+ "items" => []
341
+ }
342
+ }.to_json)
343
+
344
+ place = Place.includes_first_page(:available_products).find(1)
345
+ expect(place.available_products.empty?).to eq true
346
+ end
347
+ end
348
+
349
+ context 'extend items with arrays' do
350
+ it 'extends base items with arrays' do
351
+ class Place < LHS::Record
352
+ endpoint '{+datastore}/place'
353
+ endpoint '{+datastore}/place/{id}'
354
+ end
355
+
356
+ stub_request(:get, "#{datastore}/place/1")
357
+ .to_return(body: {
358
+ 'contracts' => {
359
+ 'items' => [{ 'href' => "#{datastore}/place/1/contacts/1" }]
360
+ }
361
+ }.to_json)
362
+
363
+ stub_request(:get, "#{datastore}/place/1/contacts/1")
364
+ .to_return(body: {
365
+ 'products' => { 'href' => "#{datastore}/place/1/contacts/1/products" }
366
+ }.to_json)
367
+
368
+ place = Place.includes_first_page(:contracts).find(1)
369
+ expect(place.contracts.first.products.href).to eq "#{datastore}/place/1/contacts/1/products"
370
+ end
371
+ end
372
+
373
+ context 'unexpanded response when requesting the included collection' do
374
+ before do
375
+ class Customer < LHS::Record
376
+ endpoint '{+datastore}/customer/{id}'
377
+ end
378
+ end
379
+
380
+ let!(:customer_request) do
381
+ stub_request(:get, "#{datastore}/customer/1")
382
+ .to_return(body: {
383
+ places: {
384
+ href: "#{datastore}/places"
385
+ }
386
+ }.to_json)
387
+ end
388
+
389
+ let!(:places_request) do
390
+ stub_request(:get, "#{datastore}/places")
391
+ .to_return(body: {
392
+ items: [{ href: "#{datastore}/places/1" }]
393
+ }.to_json)
394
+ end
395
+
396
+ let!(:place_request) do
397
+ stub_request(:get, "#{datastore}/places/1")
398
+ .to_return(body: {
399
+ name: 'Casa Ferlin'
400
+ }.to_json)
401
+ end
402
+
403
+ it 'loads the collection and the single items, if not already expanded' do
404
+ place = Customer.includes_first_page(:places).find(1).places.first
405
+ assert_requested(place_request)
406
+ expect(place.name).to eq 'Casa Ferlin'
407
+ end
408
+
409
+ context 'forwarding options' do
410
+ let!(:places_request) do
411
+ stub_request(:get, "#{datastore}/places")
412
+ .with(headers: { 'Authorization' => 'Bearer 123' })
413
+ .to_return(
414
+ body: {
415
+ items: [{ href: "#{datastore}/places/1" }]
416
+ }.to_json
417
+ )
418
+ end
419
+
420
+ let!(:place_request) do
421
+ stub_request(:get, "#{datastore}/places/1")
422
+ .with(headers: { 'Authorization' => 'Bearer 123' })
423
+ .to_return(
424
+ body: {
425
+ name: 'Casa Ferlin'
426
+ }.to_json
427
+ )
428
+ end
429
+
430
+ it 'forwards options used to expand those unexpanded items' do
431
+ place = Customer
432
+ .includes_first_page(:places)
433
+ .references(places: { headers: { 'Authorization' => 'Bearer 123' } })
434
+ .find(1)
435
+ .places.first
436
+ assert_requested(place_request)
437
+ expect(place.name).to eq 'Casa Ferlin'
438
+ end
439
+ end
440
+ end
441
+
442
+ context 'includes with options' do
443
+ before do
444
+ class Customer < LHS::Record
445
+ endpoint '{+datastore}/customers/{id}'
446
+ endpoint '{+datastore}/customers'
447
+ end
448
+
449
+ class Place < LHS::Record
450
+ endpoint '{+datastore}/places'
451
+ end
452
+
453
+ stub_request(:get, "#{datastore}/places?forwarded_params=123")
454
+ .to_return(body: {
455
+ 'items' => [{ id: 1 }]
456
+ }.to_json)
457
+ end
458
+
459
+ it 'forwards includes options to requests made for those includes' do
460
+ stub_request(:get, "#{datastore}/customers/1")
461
+ .to_return(body: {
462
+ 'places' => {
463
+ 'href' => "#{datastore}/places"
464
+ }
465
+ }.to_json)
466
+ customer = Customer
467
+ .includes_first_page(:places)
468
+ .references(places: { params: { forwarded_params: 123 } })
469
+ .find(1)
470
+ expect(customer.places.first.id).to eq 1
471
+ end
472
+
473
+ it 'is chain-able' do
474
+ stub_request(:get, "#{datastore}/customers?name=Steve")
475
+ .to_return(body: [
476
+ 'places' => {
477
+ 'href' => "#{datastore}/places"
478
+ }
479
+ ].to_json)
480
+ customers = Customer
481
+ .where(name: 'Steve')
482
+ .references(places: { params: { forwarded_params: 123 } })
483
+ .includes_first_page(:places)
484
+ expect(customers.first.places.first.id).to eq 1
485
+ end
486
+ end
487
+
488
+ context 'more complex examples' do
489
+ before do
490
+ class Place < LHS::Record
491
+ endpoint 'http://datastore/places/{id}'
492
+ end
493
+ end
494
+
495
+ it 'forwards complex references' do
496
+ stub_request(:get, "http://datastore/places/123?limit=1&forwarded_params=for_place")
497
+ .to_return(body: {
498
+ 'contracts' => {
499
+ 'href' => "http://datastore/places/123/contracts"
500
+ }
501
+ }.to_json)
502
+ stub_request(:get, "http://datastore/places/123/contracts?forwarded_params=for_contracts")
503
+ .to_return(body: {
504
+ href: "http://datastore/places/123/contracts?forwarded_params=for_contracts",
505
+ items: [
506
+ { product: { 'href' => "http://datastore/products/llo" } }
507
+ ]
508
+ }.to_json)
509
+ stub_request(:get, "http://datastore/products/llo?forwarded_params=for_product")
510
+ .to_return(body: {
511
+ 'href' => "http://datastore/products/llo",
512
+ 'name' => 'Local Logo'
513
+ }.to_json)
514
+ place = Place
515
+ .options(params: { forwarded_params: 'for_place' })
516
+ .includes_first_page(contracts: :product)
517
+ .references(
518
+ contracts: {
519
+ params: { forwarded_params: 'for_contracts' },
520
+ product: { params: { forwarded_params: 'for_product' } }
521
+ }
522
+ )
523
+ .find_by(id: '123')
524
+ expect(
525
+ place.contracts.first.product.name
526
+ ).to eq 'Local Logo'
527
+ end
528
+
529
+ it 'expands empty arrays' do
530
+ stub_request(:get, "http://datastore/places/123")
531
+ .to_return(body: {
532
+ 'contracts' => {
533
+ 'href' => "http://datastore/places/123/contracts"
534
+ }
535
+ }.to_json)
536
+ stub_request(:get, "http://datastore/places/123/contracts")
537
+ .to_return(body: {
538
+ href: "http://datastore/places/123/contracts",
539
+ items: []
540
+ }.to_json)
541
+ place = Place.includes_first_page(:contracts).find('123')
542
+ expect(place.contracts.collection?).to eq true
543
+ expect(
544
+ place.contracts.as_json
545
+ ).to eq('href' => 'http://datastore/places/123/contracts', 'items' => [])
546
+ expect(place.contracts.to_a).to eq([])
547
+ end
548
+ end
549
+
550
+ context 'include and merge arrays when calling find in parallel' do
551
+ before do
552
+ class Place < LHS::Record
553
+ endpoint 'http://datastore/places/{id}'
554
+ end
555
+ stub_request(:get, 'http://datastore/places/1')
556
+ .to_return(body: {
557
+ category_relations: [{ href: 'http://datastore/category/1' }, { href: 'http://datastore/category/2' }]
558
+ }.to_json)
559
+ stub_request(:get, 'http://datastore/places/2')
560
+ .to_return(body: {
561
+ category_relations: [{ href: 'http://datastore/category/2' }, { href: 'http://datastore/category/1' }]
562
+ }.to_json)
563
+ stub_request(:get, "http://datastore/category/1").to_return(body: { name: 'Food' }.to_json)
564
+ stub_request(:get, "http://datastore/category/2").to_return(body: { name: 'Drinks' }.to_json)
565
+ end
566
+
567
+ it 'includes and merges linked resources in case of an array of links' do
568
+ places = Place
569
+ .includes_first_page(:category_relations)
570
+ .find(1, 2)
571
+ expect(places[0].category_relations[0].name).to eq 'Food'
572
+ expect(places[1].category_relations[0].name).to eq 'Drinks'
573
+ end
574
+ end
575
+
576
+ context 'single href with array response' do
577
+ it 'extends base items with arrays' do
578
+ class Sector < LHS::Record
579
+ endpoint '{+datastore}/sectors'
580
+ endpoint '{+datastore}/sectors/{id}'
581
+ end
582
+
583
+ stub_request(:get, "#{datastore}/sectors")
584
+ .with(query: hash_including(key: 'my_service'))
585
+ .to_return(body: [
586
+ {
587
+ href: "#{datastore}/sectors/1",
588
+ services: {
589
+ href: "#{datastore}/sectors/1/services"
590
+ },
591
+ keys: [
592
+ {
593
+ key: 'my_service',
594
+ language: 'de'
595
+ }
596
+ ]
597
+ }
598
+ ].to_json)
599
+
600
+ stub_request(:get, "#{datastore}/sectors/1/services")
601
+ .to_return(body: [
602
+ {
603
+ href: "#{datastore}/services/s1",
604
+ price_in_cents: 9900,
605
+ key: 'my_service_service_1'
606
+ },
607
+ {
608
+ href: "#{datastore}/services/s2",
609
+ price_in_cents: 19900,
610
+ key: 'my_service_service_2'
611
+ }
612
+ ].to_json)
613
+
614
+ sector = Sector.includes_first_page(:services).find_by(key: 'my_service')
615
+ expect(sector.services.length).to eq 2
616
+ expect(sector.services.first.key).to eq 'my_service_service_1'
617
+ end
618
+ end
619
+
620
+ context 'include for POST/create' do
621
+
622
+ before do
623
+ class Record < LHS::Record
624
+ endpoint 'https://records'
625
+ end
626
+ stub_request(:post, 'https://records/')
627
+ .with(body: { color: 'blue' }.to_json)
628
+ .to_return(
629
+ body: {
630
+ color: 'blue',
631
+ alternative_categories: [
632
+ { href: 'https://categories/blue' }
633
+ ]
634
+ }.to_json
635
+ )
636
+ stub_request(:get, 'https://categories/blue')
637
+ .to_return(
638
+ body: {
639
+ name: 'blue'
640
+ }.to_json
641
+ )
642
+ end
643
+
644
+ it 'includes the resources from the post response' do
645
+ records = Record.includes_first_page(:alternative_categories).create(color: 'blue')
646
+ expect(records.alternative_categories.first.name).to eq 'blue'
647
+ end
648
+ end
649
+
650
+ context 'nested within another structure' do
651
+ before do
652
+ class Place < LHS::Record
653
+ endpoint 'https://places/{id}'
654
+ end
655
+ stub_request(:get, "https://places/1")
656
+ .to_return(body: {
657
+ customer: {
658
+ salesforce: {
659
+ href: 'https://salesforce/customers/1'
660
+ }
661
+ }
662
+ }.to_json)
663
+ end
664
+
665
+ let!(:nested_request) do
666
+ stub_request(:get, "https://salesforce/customers/1")
667
+ .to_return(body: {
668
+ name: 'Steve'
669
+ }.to_json)
670
+ end
671
+
672
+ it 'includes data that has been nested in an additional structure' do
673
+ place = Place.includes_first_page(customer: :salesforce).find(1)
674
+ expect(nested_request).to have_been_requested
675
+ expect(place.customer.salesforce.name).to eq 'Steve'
676
+ end
677
+
678
+ context 'included data has a configured record endpoint option' do
679
+ before do
680
+ class SalesforceCustomer < LHS::Record
681
+ endpoint 'https://salesforce/customers/{id}', headers: { 'Authorization': 'Bearer 123' }
682
+ end
683
+ end
684
+
685
+ let!(:nested_request) do
686
+ stub_request(:get, "https://salesforce/customers/1")
687
+ .with(headers: { 'Authorization' => 'Bearer 123' })
688
+ .to_return(body: {
689
+ name: 'Steve'
690
+ }.to_json)
691
+ end
692
+
693
+ it 'includes data that has been nested in an additional structure' do
694
+ place = Place.includes_first_page(customer: :salesforce).find(1)
695
+ expect(nested_request).to have_been_requested
696
+ expect(place.customer.salesforce.name).to eq 'Steve'
697
+ end
698
+ end
699
+ end
700
+
701
+ context 'include empty structures' do
702
+ before do
703
+ class Place < LHS::Record
704
+ endpoint 'https://places/{id}'
705
+ end
706
+ stub_request(:get, "https://places/1")
707
+ .to_return(body: {
708
+ id: '123'
709
+ }.to_json)
710
+ end
711
+
712
+ it 'skips includes when there is nothing and also does not raise an exception' do
713
+ expect(-> {
714
+ Place.includes_first_page(contracts: :product).find(1)
715
+ }).not_to raise_exception
716
+ end
717
+ end
718
+
719
+ context 'include partially empty structures' do
720
+ before do
721
+ class Place < LHS::Record
722
+ endpoint 'https://places/{id}'
723
+ end
724
+ stub_request(:get, "https://places/1")
725
+ .to_return(body: {
726
+ id: '123',
727
+ customer: {}
728
+ }.to_json)
729
+ end
730
+
731
+ it 'skips includes when there is nothing and also does not raise an exception' do
732
+ expect(-> {
733
+ Place.includes_first_page(customer: :salesforce).find(1)
734
+ }).not_to raise_exception
735
+ end
736
+ end
737
+ end