lhs 0.3.0

data/spec/service/endpoint_misconfiguration_spec.rb

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

data/spec/service/endpoint_options_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+describe LHS::Service do
+
+  context 'set options for an endpoint' do
+
+    before(:each) do
+      class SomeService < LHS::Service
+        endpoint 'backend/v2/feedbacks', cache_expires_in: 1.day, retry: 2, cache: true
+      end
+    end
+
+    it 'stores endpoints with options' do
+      expect(SomeService.instance.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)
+    end
+  end
+end

data/spec/service/endpoints_spec.rb

@@ -0,0 +1,57 @@
+require 'rails_helper'
+
+describe LHS::Service do
+
+  context 'endpoints' do
+
+    let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+    before(:each) do
+      LHC.config.placeholder(:datastore, datastore)
+      class SomeService < LHS::Service
+        endpoint ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
+        endpoint ':datastore/:campaign_id/feedbacks'
+        endpoint ':datastore/feedbacks'
+      end
+    end
+
+    it 'stores the endpoints of the service' do
+      expect(SomeService.instance.endpoints.count).to eq 3
+      expect(SomeService.instance.endpoints[0].url).to eq ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
+      expect(SomeService.instance.endpoints[1].url).to eq ':datastore/:campaign_id/feedbacks'
+      expect(SomeService.instance.endpoints[2].url).to eq ':datastore/feedbacks'
+    end
+
+    it 'finds the endpoint by the one with the most route param hits' do
+      expect(
+        SomeService.instance.find_endpoint(campaign_id: '12345').url
+      ).to eq ':datastore/:campaign_id/feedbacks'
+      expect(
+        SomeService.instance.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.instance.find_endpoint.url
+      ).to eq ':datastore/feedbacks'
+    end
+
+    context 'unsorted endpoints' do
+
+      before(:each) do
+        class AnotherService < LHS::Service
+          endpoint ':datastore/feedbacks'
+          endpoint ':datastore/:campaign_id/feedbacks'
+          endpoint ':datastore/entries/:entry_id/content-ads/:campaign_id/feedbacks'
+        end
+      end
+
+      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)
+      end
+
+    end
+  end
+end

data/spec/service/find_by_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+
+describe LHS::Service do
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+  before(:each) do
+    LHC.config.placeholder(:datastore, datastore)
+    class SomeService < LHS::Service
+      endpoint ':datastore/content-ads/:campaign_id/feedbacks'
+      endpoint ':datastore/feedbacks'
+    end
+  end
+
+  context 'find_by' 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
+    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')
+      ).to eq nil
+    end
+
+    it 'return first item by parameters' do
+      json = load_json(:feedbacks)
+      stub_request(:get, "#{datastore}/feedbacks?has_reviews=true&limit=1")
+        .to_return(status: 200, body: json)
+      expect(
+        SomeService.find_by(has_reviews: true).id
+      ).to eq json['items'].first['id']
+    end
+  end
+
+  context 'find_by!' 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) }
+        .to raise_error LHC::NotFound
+    end
+  end
+end

data/spec/service/find_each_spec.rb

@@ -0,0 +1,47 @@
+require 'rails_helper'
+
+describe LHS::Collection do
+
+  let(:total) { 443 }
+
+  let(:limit) { 100 }
+
+  def api_response(ids, offset)
+    records = ids.map{|i| {id: i}}
+    {
+      items: records,
+      total: total,
+      limit: limit,
+      offset: offset
+    }.to_json
+  end
+
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+  before(:each) do
+    LHC.config.placeholder('datastore', datastore)
+    class SomeService < LHS::Service
+      endpoint ':datastore/:campaign_id/feedbacks'
+      endpoint ':datastore/feedbacks'
+    end
+  end
+
+  context 'find_each' do
+
+    it 'processes each record by fetching records in batches' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
+      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|
+        count += 1
+        expect(record.id).to eq(count)
+        expect(record).to be_kind_of LHS::Data
+        expect(record._proxy).to be_kind_of LHS::Item
+      end
+      expect(count).to eq total
+    end    
+  end
+end

data/spec/service/find_in_batches_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+describe LHS::Collection do
+
+  let(:total) { 443 }
+
+  let(:limit) { 100 }
+
+  def api_response(ids, offset)
+    records = ids.map{|i| {id: i}}
+    {
+      items: records,
+      total: total,
+      limit: limit,
+      offset: offset
+    }.to_json
+  end
+
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+  before(:each) do
+    LHC.config.placeholder('datastore', datastore)
+    class SomeService < LHS::Service
+      endpoint ':datastore/:campaign_id/feedbacks'
+      endpoint ':datastore/feedbacks'
+    end
+  end
+
+  context 'find_batches' do
+
+    it 'processes records in batches' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
+      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|
+        count += records.count
+        expect(records).to be_kind_of LHS::Data
+        expect(records._proxy).to be_kind_of LHS::Collection
+      end
+      expect(count).to eq total
+    end
+
+    it 'adapts to backend max limit' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=230&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
+      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|
+        count += records.count
+        expect(records).to be_kind_of LHS::Data
+        expect(records._proxy).to be_kind_of LHS::Collection
+      end
+      expect(count).to eq total
+    end
+
+    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|
+        expect(records.count).to eq(total-400)
+      end
+    end
+  end
+end

data/spec/service/find_spec.rb

@@ -0,0 +1,71 @@
+require 'rails_helper'
+
+describe LHS::Service do
+
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+  before(:each) do
+    LHC.config.placeholder(:datastore, datastore)
+    class SomeService < LHS::Service
+      endpoint ':datastore/content-ads/:campaign_id/feedbacks'
+      endpoint ':datastore/feedbacks'
+    end
+  end
+
+  context 'find' 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')
+      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
+    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')
+      expect(data._proxy).to be_kind_of LHS::Item
+    end
+
+    it 'returns item in case of backend returning collection' do
+      data = JSON.parse(load_json(:feedbacks))
+      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')
+      expect(data._proxy).to be_kind_of LHS::Item
+    end
+
+    it 'fails when multiple items where found by parameters' do
+      stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
+      .to_return(body: load_json(:feedbacks))
+      expect(->{
+        SomeService.find(campaign_id: '123', id: '123')
+      }).to raise_error LHC::NotFound
+    end
+
+    it 'fails when no item as found by parameters' do
+      data = JSON.parse(load_json(:feedbacks))
+      data['items'] = []
+      stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
+      .to_return(body: data.to_json)
+      expect(->{
+        SomeService.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
+    end
+
+  end
+end

data/spec/service/first_spec.rb

@@ -0,0 +1,39 @@
+require 'rails_helper'
+
+describe LHS::Service do
+
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+
+  before(:each) do
+    LHC.config.placeholder(:datastore, datastore)
+    class SomeService < LHS::Service
+      endpoint ':datastore/content-ads/:campaign_id/feedbacks'
+      endpoint ':datastore/feedbacks'
+    end
+  end
+
+  context 'first' do
+
+    it 'finds a single record' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=1")
+        .to_return(status: 200, body: load_json(:feedback))
+
+      SomeService.first.source_id
+    end
+
+    it 'returns nil if no record was found' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=1")
+        .to_return(status: 404)
+      expect(SomeService.first).to be_nil
+    end
+  end
+
+  context 'first!' do
+
+    it 'raises if nothing was found with parameters' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=1")
+        .to_return(status: 404)
+      expect { SomeService.first! }.to raise_error LHC::NotFound
+    end
+  end
+end

data/spec/service/includes_spec.rb

@@ -0,0 +1,61 @@
+require 'rails_helper'
+
+describe LHS::Service do
+
+  let(:datastore) { 'http://datastore-stg.lb-service.sunrise.intra.local.ch/v2' }
+  before(:each) { LHC.config.placeholder('datastore', datastore) }
+
+  context 'includes' do
+
+    before(:each) do
+      class Feedback < LHS::Service
+        endpoint ':datastore/feedbacks'
+      end
+
+      stub_request(:get, "#{datastore}/content-ads/51dfc5690cf271c375c5a12d")
+      .to_return(status: 200, body: {
+         "href" => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d",
+         "entry" => {
+           "href" => "#{datastore}/local-entries/lakj35asdflkj1203va"
+         }
+      }.to_json)
+
+      stub_request(:get, "#{datastore}/local-entries/lakj35asdflkj1203va")
+      .to_return(status: 200, body: {
+         "name" => 'Casa Ferlin'
+      }.to_json)
+    end
+
+    it 'includes linked resources while fetching multiple resources from one service' do
+
+      stub_request(:get, "#{datastore}/feedbacks?has_reviews=true")
+      .to_return(status: 200, body: {
+          items:[
+            {
+              "href" => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
+              "campaign" => {
+                "href" => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d"
+              }
+            }
+          ]
+      }.to_json)
+
+      feedbacks = Feedback.includes(campaign: :entry).where(has_reviews: true)
+      expect(feedbacks.first.campaign.entry.name).to eq 'Casa Ferlin'
+    end
+
+    it 'includes linked resources while fetching a single resource from one service' do
+
+      stub_request(:get, "#{datastore}/feedbacks/123")
+      .to_return(status: 200, body: {
+        "href" => "#{datastore}/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
+        "campaign" => {
+          "href" => "#{datastore}/content-ads/51dfc5690cf271c375c5a12d"
+        }
+      }.to_json)
+
+      feedbacks = Feedback.includes(campaign: :entry).find(123)
+      expect(feedbacks.campaign.entry.name).to eq 'Casa Ferlin'
+    end
+  end
+end