lhs 2.2.2 → 3.0.0

data/spec/proxy/load_spec.rb

@@ -3,7 +3,7 @@ require 'rails_helper'
 describe LHS::Proxy do
 
   before(:each) do
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/v2/feedbacks'
     end
   end
@@ -13,7 +13,7 @@ describe LHS::Proxy do
   end
 
   let(:data) do
-    LHS::Data.new(json, nil, SomeService)
+    LHS::Data.new(json, nil, Record)
   end
 
   let(:item) do

data/spec/{service → record}/all_spec.rb

@@ -6,7 +6,7 @@ describe LHS::Collection do
 
   before(:each) do
     LHC.config.placeholder('datastore', datastore)
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/:campaign_id/feedbacks'
       endpoint ':datastore/feedbacks'
     end
@@ -21,8 +21,8 @@ describe LHS::Collection do
       .to_return(status: 200, body: {items: (101..200).to_a, total: 300, limit: 100, offset: 101}.to_json)
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201")
       .to_return(status: 200, body: {items: (201..300).to_a, total: 300, limit: 100, offset: 201}.to_json)
-      all = SomeService.all
-      expect(all).to be_kind_of LHS::Data
+      all = Record.all
+      expect(all).to be_kind_of Record
       expect(all._proxy).to be_kind_of LHS::Collection
       expect(all.count).to eq 300
       expect(all.last).to eq 300
@@ -35,8 +35,8 @@ describe LHS::Collection do
       .to_return(status: 200, body: {items: (101..200).to_a, total: 300, offset: 101}.to_json)
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201")
       .to_return(status: 200, body: {items: (201..300).to_a, total: 300, offset: 201}.to_json)
-      all = SomeService.all
-      expect(all).to be_kind_of LHS::Data
+      all = Record.all
+      expect(all).to be_kind_of Record
       expect(all._proxy).to be_kind_of LHS::Collection
       expect(all.count).to eq 300
       expect(all.last).to eq 300
@@ -45,8 +45,8 @@ describe LHS::Collection do
     it 'also works when there is no item in the first response' do
       stub_request(:get, "#{datastore}/feedbacks?limit=100")
         .to_return(status: 200, body: {items: [], total: 300, offset: 0}.to_json)
-      all = SomeService.all
-      expect(all).to be_kind_of LHS::Data
+      all = Record.all
+      expect(all).to be_kind_of Record
       expect(all._proxy).to be_kind_of LHS::Collection
       expect(all.count).to eq 0
     end

data/spec/{service → record}/build_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'build' do
 
@@ -8,7 +8,7 @@ describe LHS::Service do
 
     before(:each) do
       LHC.config.placeholder('datastore', datastore)
-      class Feedback < LHS::Service
+      class Feedback < LHS::Record
         endpoint ':datastore/content-ads/:campaign_id/feedbacks'
         endpoint ':datastore/feedbacks'
       end
@@ -16,9 +16,10 @@ describe LHS::Service do
 
     it 'builds a new item from scratch' do
       feedback = Feedback.build recommended: true
+      expect(feedback).to be_kind_of Feedback
       expect(feedback.recommended).to eq true
-      stub_request(:post, "http://local.ch/v2/feedbacks")
-      .with(body: "{\"recommended\":true}")
+      stub_request(:post, 'http://local.ch/v2/feedbacks')
+        .with(body: "{\"recommended\":true}")
       feedback.save
     end
   end

data/spec/{service → record}/create_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'create' do
 
@@ -8,7 +8,7 @@ describe LHS::Service do
 
     before(:each) do
       LHC.config.placeholder('datastore', datastore)
-      class Feedback < LHS::Service
+      class Feedback < LHS::Record
         endpoint ':datastore/content-ads/:campaign_id/feedbacks'
         endpoint ':datastore/feedbacks'
       end
@@ -23,9 +23,10 @@ describe LHS::Service do
 
     it 'creates new record on the backend' do
       stub_request(:post, "#{datastore}/feedbacks")
-      .with(body: object.to_json)
-      .to_return(status: 200, body: object.to_json)
+        .with(body: object.to_json)
+        .to_return(status: 200, body: object.to_json)
       record = Feedback.create(object)
+      expect(record).to be_kind_of Feedback
       expect(record.recommended).to eq true
       expect(record.errors).to eq nil
     end
@@ -64,7 +65,7 @@ describe LHS::Service do
 
       it 'provides errors accessor on the record when creation failed using create' do
         stub_request(:post, "#{datastore}/content-ads/12345/feedbacks")
-        .to_return(status: 400, body: creation_error.to_json)
+          .to_return(status: 400, body: creation_error.to_json)
         feedback = Feedback.create(object.merge(campaign_id: '12345'))
         expect(feedback.errors).to be_kind_of LHS::Errors
       end

data/spec/{service → record}/creation_failed_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'creation failed' do
 
@@ -8,7 +8,7 @@ describe LHS::Service do
 
     before(:each) do
       LHC.config.placeholder(:datastore, datastore)
-      class SomeService < LHS::Service
+      class Record < LHS::Record
         endpoint ':datastore/:campaign_id/feedbacks'
         endpoint ':datastore/feedbacks'
       end
@@ -34,8 +34,9 @@ describe LHS::Service do
 
     it 'provides errors when creation failed' do
       stub_request(:post, "#{datastore}/feedbacks")
-      .to_return(status: 400, body: creation_error.to_json)
-      record = SomeService.create(name: 'Steve')
+        .to_return(status: 400, body: creation_error.to_json)
+      record = Record.create(name: 'Steve')
+      expect(record).to be_kind_of Record
       expect(record.errors).to be
       expect(record.name).to eq 'Steve'
       expect(record.errors.include?(:ratings)).to eq true
@@ -48,7 +49,7 @@ describe LHS::Service do
     it 'doesnt fail when no fields are provided by the backend' do
       stub_request(:post, "#{datastore}/feedbacks")
       .to_return(status: 400, body: {}.to_json)
-      SomeService.create(name: 'Steve')
+      Record.create(name: 'Steve')
     end
   end
 end

data/spec/record/definitions_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+
+describe LHS::Record do
+
+  context 'definitions' do
+
+    let(:datastore) { 'http://local.ch/v2' }
+
+    before(:each) do
+      LHC.config.placeholder('datastore', datastore)
+      class LocalEntry < LHS::Record
+        endpoint ':datastore/local-entries'
+        endpoint ':datastore/local-entries/:id'
+      end
+    end
+
+    it 'allows mappings in all functions/defitions' do
+      class LocalEntry < LHS::Record
+        def name
+          addresses.first.business.identities.first.name
+        end
+      end
+      stub_request(:get, "#{datastore}/local-entries/1")
+        .to_return(status: 200, body: {addresses: [{business: {identities: [{name: 'Löwenzorn'}]}}]}.to_json)
+      entry = LocalEntry.find(1)
+      expect(entry.name).to eq 'Löwenzorn'
+    end
+  end
+end

data/spec/{service → record}/endpoint_misconfiguration_spec.rb

@@ -1,13 +1,13 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'misconfiguration of endpoints' do
 
     it 'fails trying to add clashing endpoints' do
       expect(
         ->{
-          class SomeService < LHS::Service
+          class Record < LHS::Record
             endpoint ':datastore/v2/feedbacks'
             endpoint ':datastore/v2/reviews'
           end
@@ -15,7 +15,7 @@ describe LHS::Service do
       ).to raise_error('Clashing endpoints.')
       expect(
         ->{
-          class SomeService < LHS::Service
+          class Record < LHS::Record
             endpoint ':datastore/v2/:campaign_id/feedbacks'
             endpoint ':datastore/v2/:campaign_id/reviews'
           end

data/spec/{service → record}/endpoint_options_spec.rb

@@ -1,23 +1,23 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'set options for an endpoint' do
 
     before(:each) do
-      class SomeService < LHS::Service
+      class Record < LHS::Record
         endpoint 'backend/v2/feedbacks/:id', cache_expires_in: 1.day, retry: 2, cache: true
       end
     end
 
     it 'stores endpoints with options' do
-      expect(SomeService.endpoints[0].options).to eq(cache_expires_in: 86400, retry: 2, cache: true)
+      expect(Record.endpoints[0].options).to eq(cache_expires_in: 86400, retry: 2, cache: true)
     end
 
     it 'uses the options that are configured for an endpoint' do
       expect(LHC).to receive(:request).with(cache_expires_in: 1.day, retry: 2, cache: true, url: 'backend/v2/feedbacks/1').and_call_original
       stub_request(:get, "http://backend/v2/feedbacks/1").to_return(status: 200)
-      SomeService.find(1)
+      Record.find(1)
     end
   end
 end

data/spec/{service → record}/endpoints_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   context 'endpoints' do
 
@@ -8,7 +8,7 @@ describe LHS::Service do
 
     before(:each) do
       LHC.config.placeholder(:datastore, datastore)
-      class SomeService < LHS::Service
+      class Record < LHS::Record
         endpoint ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
         endpoint ':datastore/:campaign_id/feedbacks'
         endpoint ':datastore/feedbacks'
@@ -16,37 +16,37 @@ describe LHS::Service do
     end
 
     it 'stores all the endpoints by url' do
-      expect(LHS::Service::Endpoints.all[':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks']).to be 
-      expect(LHS::Service::Endpoints.all[':datastore/:campaign_id/feedbacks']).to be
-      expect(LHS::Service::Endpoints.all[':datastore/feedbacks']).to be
+      expect(LHS::Record::Endpoints.all[':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks']).to be 
+      expect(LHS::Record::Endpoints.all[':datastore/:campaign_id/feedbacks']).to be
+      expect(LHS::Record::Endpoints.all[':datastore/feedbacks']).to be
     end
 
     it 'stores the endpoints of the service' do
-      expect(SomeService.endpoints.count).to eq 3
-      expect(SomeService.endpoints[0].url).to eq ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
-      expect(SomeService.endpoints[1].url).to eq ':datastore/:campaign_id/feedbacks'
-      expect(SomeService.endpoints[2].url).to eq ':datastore/feedbacks'
+      expect(Record.endpoints.count).to eq 3
+      expect(Record.endpoints[0].url).to eq ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
+      expect(Record.endpoints[1].url).to eq ':datastore/:campaign_id/feedbacks'
+      expect(Record.endpoints[2].url).to eq ':datastore/feedbacks'
     end
 
     it 'finds the endpoint by the one with the most route param hits' do
       expect(
-        SomeService.find_endpoint(campaign_id: '12345').url
+        Record.find_endpoint(campaign_id: '12345').url
       ).to eq ':datastore/:campaign_id/feedbacks'
       expect(
-        SomeService.find_endpoint(campaign_id: '12345', entry_id: '123').url
+        Record.find_endpoint(campaign_id: '12345', entry_id: '123').url
       ).to eq ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
     end
 
     it 'finds the base endpoint (endpoint with least amount of route params)' do
       expect(
-        SomeService.find_endpoint.url
+        Record.find_endpoint.url
       ).to eq ':datastore/feedbacks'
     end
 
     context 'compute url from endpoint' do
 
       before(:each) do
-        class Feedback < LHS::Service
+        class Feedback < LHS::Record
           endpoint ':datastore/feedbacks'
           endpoint ':datastore/feedbacks/:id'
         end
@@ -61,7 +61,7 @@ describe LHS::Service do
     context 'unsorted endpoints' do
 
       before(:each) do
-        class AnotherService < LHS::Service
+        class AnotherRecord < LHS::Record
           endpoint ':datastore/feedbacks'
           endpoint ':datastore/:campaign_id/feedbacks'
           endpoint ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
@@ -70,7 +70,7 @@ describe LHS::Service do
 
       it 'sorts endpoints before trying to find the best endpoint' do
         stub_request(:get, "#{datastore}/entries/123/content-ads/123/feedbacks").to_return(status: 200)
-        AnotherService.where(campaign_id: 123, entry_id: 123)
+        AnotherRecord.where(campaign_id: 123, entry_id: 123)
       end
 
     end

data/spec/{service → record}/find_by_spec.rb

@@ -1,11 +1,11 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
   let(:datastore) { 'http://local.ch/v2' }
 
   before(:each) do
     LHC.config.placeholder(:datastore, datastore)
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/content-ads/:campaign_id/feedbacks'
       endpoint ':datastore/content-ads/:campaign_id/feedbacks/:id'
       endpoint ':datastore/feedbacks'
@@ -17,16 +17,16 @@ describe LHS::Service do
     it 'finds a single record' do
       stub_request(:get, "#{datastore}/feedbacks/z12f-3asm3ngals?limit=1")
         .to_return(status: 200, body: load_json(:feedback))
-      expect(
-        SomeService.find_by(id: 'z12f-3asm3ngals').source_id
-      ).to be_kind_of String
+      record = Record.find_by(id: 'z12f-3asm3ngals')
+      expect(record.source_id).to be_kind_of String
+      expect(record).to be_kind_of Record
     end
 
     it 'returns nil if no record was found' do
       stub_request(:get, "#{datastore}/feedbacks/something-inexistent?limit=1")
         .to_return(status: 404)
       expect(
-        SomeService.find_by(id: 'something-inexistent')
+        Record.find_by(id: 'something-inexistent')
       ).to eq nil
     end
 
@@ -35,7 +35,7 @@ describe LHS::Service do
       stub_request(:get, "#{datastore}/feedbacks?has_reviews=true&limit=1")
         .to_return(status: 200, body: json)
       expect(
-        SomeService.find_by(has_reviews: true).id
+        Record.find_by(has_reviews: true).id
       ).to eq json['items'].first['id']
     end
   end
@@ -44,7 +44,7 @@ describe LHS::Service do
     it 'raises if nothing was found with parameters' do
       stub_request(:get, "#{datastore}/feedbacks?has_reviews=true&limit=1")
         .to_return(status: 200, body: { items: [] }.to_json)
-      expect { SomeService.find_by!(has_reviews: true) }
+      expect { Record.find_by!(has_reviews: true) }
         .to raise_error LHC::NotFound
     end
   end

data/spec/{service → record}/find_each_spec.rb

@@ -20,7 +20,7 @@ describe LHS::Collection do
 
   before(:each) do
     LHC.config.placeholder('datastore', datastore)
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/:campaign_id/feedbacks'
       endpoint ':datastore/feedbacks'
     end
@@ -35,10 +35,10 @@ describe LHS::Collection do
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
       count = 0
-      SomeService.find_each do |record|
+      Record.find_each do |record|
         count += 1
         expect(record.id).to eq(count)
-        expect(record).to be_kind_of LHS::Data
+        expect(record).to be_kind_of Record
         expect(record._proxy).to be_kind_of LHS::Item
       end
       expect(count).to eq total

data/spec/{service → record}/find_in_batches_spec.rb

@@ -20,7 +20,7 @@ describe LHS::Collection do
 
   before(:each) do
     LHC.config.placeholder('datastore', datastore)
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/:campaign_id/feedbacks'
       endpoint ':datastore/feedbacks'
     end
@@ -35,9 +35,9 @@ describe LHS::Collection do
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
       count = 0
-      SomeService.find_in_batches do |records|
+      Record.find_in_batches do |records|
         count += records.count
-        expect(records).to be_kind_of LHS::Data
+        expect(records).to be_kind_of Record
         expect(records._proxy).to be_kind_of LHS::Collection
       end
       expect(count).to eq total
@@ -50,9 +50,9 @@ describe LHS::Collection do
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
       count = 0
-      SomeService.find_in_batches(batch_size: 230) do |records|
+      Record.find_in_batches(batch_size: 230) do |records|
         count += records.count
-        expect(records).to be_kind_of LHS::Data
+        expect(records).to be_kind_of Record
         expect(records._proxy).to be_kind_of LHS::Collection
       end
       expect(count).to eq total
@@ -60,7 +60,7 @@ describe LHS::Collection do
 
     it 'forwards offset' do
       stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
-      SomeService.find_in_batches(start: 401) do |records|
+      Record.find_in_batches(start: 401) do |records|
         expect(records.count).to eq(total-400)
       end
     end

data/spec/{service → record}/find_spec.rb

@@ -1,12 +1,12 @@
 require 'rails_helper'
 
-describe LHS::Service do
+describe LHS::Record do
 
   let(:datastore) { 'http://local.ch/v2' }
 
   before(:each) do
     LHC.config.placeholder(:datastore, datastore)
-    class SomeService < LHS::Service
+    class Record < LHS::Record
       endpoint ':datastore/content-ads/:campaign_id/feedbacks'
       endpoint ':datastore/content-ads/:campaign_id/feedbacks/:id'
       endpoint ':datastore/feedbacks'
@@ -19,20 +19,21 @@ describe LHS::Service do
     it 'finds a single unique record' do
       stub_request(:get, "#{datastore}/feedbacks/z12f-3asm3ngals").
       to_return(status: 200, body: load_json(:feedback))
-      record = SomeService.find('z12f-3asm3ngals')
+      record = Record.find('z12f-3asm3ngals')
+      expect(record).to be_kind_of Record
       expect(record.source_id).to be_kind_of String
     end
 
     it 'raises if nothing was found' do
       stub_request(:get, "#{datastore}/feedbacks/not-existing").
       to_return(status: 404)
-      expect { SomeService.find('not-existing') }.to raise_error LHC::NotFound
+      expect { Record.find('not-existing') }.to raise_error LHC::NotFound
     end
 
     it 'finds unique item by providing parameters' do
       stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
       .to_return(body: "{}")
-      data = SomeService.find(campaign_id: '123', id: '123')
+      data = Record.find(campaign_id: '123', id: '123')
       expect(data._proxy).to be_kind_of LHS::Item
     end
 
@@ -41,7 +42,7 @@ describe LHS::Service do
       data['items'] = [data['items'].first]
       stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
       .to_return(body: data.to_json)
-      data = SomeService.find(campaign_id: '123', id: '123')
+      data = Record.find(campaign_id: '123', id: '123')
       expect(data._proxy).to be_kind_of LHS::Item
     end
 
@@ -49,7 +50,7 @@ describe LHS::Service do
       stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
       .to_return(body: load_json(:feedbacks))
       expect(->{
-        SomeService.find(campaign_id: '123', id: '123')
+        Record.find(campaign_id: '123', id: '123')
       }).to raise_error LHC::NotFound
     end
 
@@ -59,14 +60,14 @@ describe LHS::Service do
       stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
       .to_return(body: data.to_json)
       expect(->{
-        SomeService.find(campaign_id: '123', id: '123')
+        Record.find(campaign_id: '123', id: '123')
       }).to raise_error LHC::NotFound
     end
 
     it 'raises if nothing was found with parameters' do
       stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
         .to_return(status: 404)
-      expect { SomeService.find(campaign_id: '123', id: '123') }.to raise_error LHC::NotFound
+      expect { Record.find(campaign_id: '123', id: '123') }.to raise_error LHC::NotFound
     end
 
   end