lhs 19.0.2 → 19.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b7b500cba025714dd25acd5768e165e52a9a3a5310c4aee5a76e649edbadf6
-  data.tar.gz: d6460304be65c24f414e71c8a58bcf127cc7a79ad6a6fb3854c50dc177c0f835
+  metadata.gz: fce80cb737ee0b8d0cedfb8d5ff785baf20e468fcb875dcaab3a241861df1253
+  data.tar.gz: 7bd2a65ea111864756de1b9d74063db7865026f47e702a6ba005fa8dead64c3e
 SHA512:
-  metadata.gz: f6777297192f3a1daefd322c76681a9402bef7893f67c9520e4db7b67357d67065a580f34069b85f13f971738c7a174e9be97f54641fe2254bdec07939f4dd60
-  data.tar.gz: 46d307a8ad2c62f749c30552c2785db48d44dcb87612150eb25b312129320561f782041fc9139ed9ecc4abcfc8336bf91693f207b958a8c76b386d1f3b371f3d
+  metadata.gz: 80bda8a5f669ea96f3a4922a0a0efb69f456b68431cf844fed26392fbc5b8eb0cbab68cc69972226558c05a138290dd226c6c606342685c56d0f1d417481dcb1
+  data.tar.gz: 66bded778c0ad0ad02e71f6a81daa06ed28c640ff94064496d1dea8129200473ce11e658b9c4bcbf462ec5ea2ec5e3d4c4d11e3228218115888b79c4e20b9d19

data/README.md

@@ -45,7 +45,7 @@ record.review # "Lunch was great
       * [Record](#record)
          * [Endpoints](#endpoints)
             * [Configure endpoint hosts](#configure-endpoint-hosts)
-            * [Ambiguous endpoints](#ambiguous-endpoints)
+            * [Endpoint priorities](#endpoint-priorities)
          * [Record inheritance](#record-inheritance)
          * [Find multiple records](#find-multiple-records)
             * [fetch](#fetch)
@@ -228,9 +228,11 @@ class Record < LHS::Record
 end
 ```
 
-#### Ambiguous endpoints
+#### Endpoint Priorities
 
-If you try to setup a Record with ambiguous endpoints, LHS will immediately raise an exception:
+LHS uses endpoint configurations to determine what endpoint to use when data is requested, in a similiar way, routes are identified in Rails to map requests to controllers.
+
+If they are ambiguous, LHS will always use the first one found:
 
 ```ruby
 # app/models/record.rb
@@ -241,9 +243,18 @@ class Record < LHS::Record
   endpoint '{+service}/bananas'
 
 end
+```
+
+```ruby
+# app/controllers/some_controller.rb
 
-# raises: Ambiguous endpoints
+Record.fetch
+```
 ```
+GET https://service.example.com/records
+```
+
+**Be aware that, if you configure ambigious endpoints accross multiple classes, the order of things is not deteministic. Ambigious endpoints accross multiple classes need to be avoided.**
 
 ### Record inheritance
 

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

@@ -25,7 +25,6 @@ class LHS::Record
         self.endpoints = endpoints.clone
         validates_deprecation_check!(options)
         endpoint = LHC::Endpoint.new(url, options)
-        sanity_check(endpoint)
         endpoints.push(endpoint)
         LHS::Record::Endpoints.all ||= {}
         LHS::Record::Endpoints.all[url] = self
@@ -50,16 +49,6 @@ class LHS::Record
         endpoint
       end
 
-      # Prevent ambiguous endpoints
-      def sanity_check(new_endpoint)
-        endpoints.each do |existing_endpoint|
-          invalid = existing_endpoint.placeholders.sort == new_endpoint.placeholders.sort &&
-            existing_endpoint.url != new_endpoint.url
-          next unless invalid
-          raise "Ambiguous endpoints! Cannot differentiate between #{existing_endpoint.url} and #{new_endpoint.url}"
-        end
-      end
-
       # Computes the url from params
       # by identifiying endpoint and compiles it if necessary.
       def compute_url!(params)
@@ -112,7 +101,6 @@ class LHS::Record
           endpoint.placeholders.length
         end
         bases = endpoints[endpoints.keys.min]
-        raise 'Multiple base endpoints found' if bases.count > 1
         bases.first
       end
     end

data/lib/lhs/version.rb

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

data/spec/record/endpoint_priorities_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+
+  context 'endpoint priorities' do
+
+    before do
+      class Record < LHS::Record
+        endpoint 'https://api/v2/feedbacks'
+        endpoint 'https://api/v2/reviews'
+        endpoint 'https://api/v2/streets/{id}'
+        endpoint 'https://api/v2/feedbacks/{id}'
+        endpoint 'https://api/v2/reviews/{id}'
+      end
+    end
+
+    it 'always takes the first endpoint found' do
+      stub_request(:get, "https://api/v2/feedbacks").to_return(status: 200)
+      Record.fetch
+      stub_request(:get, "https://api/v2/streets/1").to_return(status: 200)
+      Record.find(1)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.0.2
+  version: 19.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -391,8 +391,8 @@ files:
 - spec/record/dig_configuration_spec.rb
 - spec/record/dup_spec.rb
 - spec/record/endpoint_inheritance_spec.rb
-- spec/record/endpoint_misconfiguration_spec.rb
 - spec/record/endpoint_options_spec.rb
+- spec/record/endpoint_priorities_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
 - spec/record/error_handling_integration_spec.rb
@@ -472,7 +472,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.3.0
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
@@ -591,8 +592,8 @@ test_files:
 - spec/record/dig_configuration_spec.rb
 - spec/record/dup_spec.rb
 - spec/record/endpoint_inheritance_spec.rb
-- spec/record/endpoint_misconfiguration_spec.rb
 - spec/record/endpoint_options_spec.rb
+- spec/record/endpoint_priorities_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
 - spec/record/error_handling_integration_spec.rb

data/spec/record/endpoint_misconfiguration_spec.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-describe LHS::Record do
-  context 'misconfiguration of endpoints' do
-    it 'fails trying to add ambiguous endpoints' do
-      expect(
-        lambda {
-          class Record < LHS::Record
-            endpoint '{+datastore}/v2/feedbacks'
-            endpoint '{+datastore}/v2/reviews'
-          end
-        }
-      ).to raise_error(/Ambiguous endpoints/)
-
-      expect(
-        lambda {
-          class Record < LHS::Record
-            endpoint '{+datastore}/v2/{campaign_id}/feedbacks'
-            endpoint '{+datastore}/v2/{campaign_id}/reviews'
-          end
-        }
-      ).to raise_error(/Ambiguous endpoints/)
-    end
-  end
-end