dhs 1.0.0

data/spec/record/equality_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'equality' do
+    before do
+      class Record < DHS::Record
+        endpoint 'http://depay.fi/records'
+      end
+    end
+
+    let(:raw) do
+      { name: 'Steve' }
+    end
+
+    def record
+      DHS::Record.new DHS::Data.new(raw, nil, Record)
+    end
+
+    it 'is equal when two data objects share the same raw data' do
+      expect(
+        record
+      ).to eq record
+    end
+  end
+end

data/spec/record/error_handling_integration_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'dhc/rspec'
+
+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/error_handling_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:handler) { spy('handler') }
+
+  before do
+    class Record < DHS::Record
+      endpoint 'http://depay.fi/v2/records'
+    end
+    stub_request(:get, 'http://depay.fi/v2/records?color=blue')
+      .to_return(status: 400)
+  end
+
+  it 'allows to chain error handling' do
+    expect {
+      Record.where(color: 'blue').rescue(DHC::Error, ->(_error) { handler.handle }).first
+    }.not_to raise_error
+    expect(handler).to have_received(:handle)
+  end
+
+  it 'reraises in case chained error is not matched' do
+    expect {
+      Record.where(color: 'blue').rescue(DHC::Conflict, ->(_error) { handler.handle }).first
+    }.to raise_error(DHC::Error)
+    expect(handler).not_to have_received(:handle)
+  end
+
+  it 'calls all the handlers' do
+    expect {
+      Record.where(color: 'blue')
+        .rescue(DHC::Error, ->(_error) { handler.handle_1 })
+        .rescue(DHC::Error, ->(_error) { handler.handle_2 })
+        .first
+    }.not_to raise_error
+    expect(handler).to have_received(:handle_1)
+    expect(handler).to have_received(:handle_2)
+  end
+end

data/spec/record/expanded_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  before do
+    class Record < DHS::Record
+      endpoint 'http://depay.fi/v2/records'
+    end
+  end
+
+  let!(:request_collection) do
+    stub_request(:get, 'http://depay.fi/v2/records?color=blue')
+      .to_return(body: {
+        items: [
+          { href: 'http://depay.fi/v2/records/1' },
+          { href: 'http://depay.fi/v2/records/2' }
+        ]
+      }.to_json)
+  end
+
+  let!(:request_item_1) do
+    stub_request(:get, 'http://depay.fi/v2/records/1?via=collection')
+      .to_return(body: {
+        name: 'Steve'
+      }.to_json)
+  end
+
+  let!(:request_item_2) do
+    stub_request(:get, 'http://depay.fi/v2/records/2?via=collection')
+      .to_return(body: {
+        name: 'John'
+      }.to_json)
+  end
+
+  it 'expands collections that just contains links' do
+    records = Record.where(color: 'blue').expanded(params: { via: 'collection' })
+    expect(records[0].name).to eq 'Steve'
+    expect(records[1].name).to eq 'John'
+    assert_requested request_collection
+    assert_requested request_item_1
+    assert_requested request_item_2
+  end
+
+  context 'without options' do
+    let!(:request_item_1) do
+      stub_request(:get, 'http://depay.fi/v2/records/1')
+        .to_return(body: {
+          name: 'Steve'
+        }.to_json)
+    end
+
+    let!(:request_item_2) do
+      stub_request(:get, 'http://depay.fi/v2/records/2')
+        .to_return(body: {
+          name: 'John'
+        }.to_json)
+    end
+
+    it 'works also without options' do
+      records = Record.where(color: 'blue').expanded
+      expect(records[0].name).to eq 'Steve'
+      expect(records[1].name).to eq 'John'
+      assert_requested request_collection
+      assert_requested request_item_1
+      assert_requested request_item_2
+    end
+  end
+end

data/spec/record/fetch_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  before do
+    class Record < DHS::Record
+      endpoint 'http://datastore/records/'
+    end
+  end
+
+  context 'fetch' do
+    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
+
+    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/record/find_by_chains_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  before do
+    class Record < DHS::Record
+      endpoint 'http://datastore/records/'
+    end
+    stub_request(:get, 'http://datastore/records/?limit=1&name=Steve&color=blue')
+      .to_return(body: [{ name: 'Steve', color: 'blue' }].to_json)
+  end
+
+  it 'allows chaining find_by' do
+    Record.options(params: { color: 'blue' }).find_by(name: 'Steve')
+  end
+
+  it 'allows chaining find_by!' do
+    Record.options(params: { color: 'blue' }).find_by!(name: 'Steve')
+  end
+end

data/spec/record/find_by_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:datastore) { 'http://depay.fi/v2' }
+
+  before do
+    DHC.config.placeholder(:datastore, datastore)
+    class Record < DHS::Record
+      endpoint '{+datastore}/content-ads/{campaign_id}/feedbacks'
+      endpoint '{+datastore}/content-ads/{campaign_id}/feedbacks/{id}'
+      endpoint '{+datastore}/feedbacks'
+      endpoint '{+datastore}/feedbacks/{id}'
+    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))
+      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(
+        Record.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(
+        Record.find_by(has_reviews: true).id
+      ).to eq json['items'].first['id']
+    end
+
+    it 'returns nil if empty id' do
+      expect { Record.find_by(id: '') }.to raise_error DHS::Unprocessable
+    end
+
+    context 'when record has custom configurations for limit_key' do
+      before do
+        class Record < DHS::Record
+          endpoint '{+datastore}/feedbacks/{id}'
+          configuration(
+            limit_key: { body: %i[response max], parameter: :max }
+          )
+        end
+      end
+
+      it 'finds a single record with max parameter' do
+        stub_request(:get, "#{datastore}/feedbacks/z12f-3asm3ngals?max=1")
+          .to_return(status: 200, body: load_json(:feedback))
+        record = Record.find_by(id: 'z12f-3asm3ngals')
+        expect(record.source_id).to be_kind_of String
+        expect(record).to be_kind_of Record
+      end
+    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 { Record.find_by!(has_reviews: true) }
+        .to raise_error DHC::NotFound
+    end
+  end
+end

data/spec/record/find_each_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::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://depay.fi/v2' }
+
+  before do
+    DHC.config.placeholder('datastore', datastore)
+    class Record < DHS::Record
+      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
+      Record.find_each do |record|
+        count += 1
+        expect(record.id).to eq(count)
+        expect(record).to be_kind_of Record
+        expect(record._proxy).to be_kind_of DHS::Item
+      end
+      expect(count).to eq total
+    end
+
+    it 'passes options to the requests made' do
+      request = stub_request(:get, 'http://depay.fi/v2/feedbacks?limit=100&offset=1')
+        .with(headers: { 'Authorization' => 'Bearer 123' })
+        .to_return(body: {
+          items: []
+        }.to_json)
+      Record.find_each(headers: { 'Authorization' => 'Bearer 123' }) { |record| }
+      expect(request).to have_been_made
+    end
+  end
+end

data/spec/record/find_in_batches_spec.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Collection do
+  let(:total) { 443 }
+
+  let(:limit) { 100 }
+
+  def api_response(ids, offset, options = {})
+    records = ids.map { |i| { id: i } }
+    {
+      options.fetch(:items_key, :items) => records,
+      options.fetch(:total_key, :total) => total,
+      options.fetch(:limit_key, :limit) => limit,
+      options.fetch(:pagination_key, :offset) => offset
+    }.to_json
+  end
+
+  let(:datastore) { 'http://depay.fi/v2' }
+
+  before do
+    DHC.config.placeholder('datastore', datastore)
+    class Record < DHS::Record
+      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))
+      length = 0
+      Record.find_in_batches do |records|
+        length += records.length
+        expect(records).to be_kind_of Record
+        expect(records._proxy).to be_kind_of DHS::Collection
+      end
+      expect(length).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))
+      length = 0
+      Record.find_in_batches(batch_size: 230) do |records|
+        length += records.length
+        expect(records).to be_kind_of Record
+        expect(records._proxy).to be_kind_of DHS::Collection
+      end
+      expect(length).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))
+      Record.find_in_batches(start: 401) do |records|
+        expect(records.length).to eq(total - 400)
+      end
+    end
+  end
+
+  context 'configured pagination' do
+    before do
+      class Record < DHS::Record
+        endpoint '{+datastore}/{campaign_id}/feedbacks'
+        endpoint '{+datastore}/feedbacks'
+        configuration items_key: 'docs', limit_key: 'size', pagination_key: 'start', pagination_strategy: 'start', total_key: 'totalResults'
+      end
+    end
+
+    let(:options) { { items_key: 'docs', limit_key: 'size', pagination_key: 'start', total_key: 'totalResults' } }
+
+    it 'capable to do batch processing with configured pagination' do
+      stub_request(:get, "#{datastore}/feedbacks?size=230&start=1").to_return(status: 200, body: api_response((1..100).to_a, 1, options))
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=101").to_return(status: 200, body: api_response((101..200).to_a, 101, options))
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=201").to_return(status: 200, body: api_response((201..300).to_a, 201, options))
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=301").to_return(status: 200, body: api_response((301..400).to_a, 301, options))
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=401").to_return(status: 200, body: api_response((401..total).to_a, 401, options))
+      length = 0
+      Record.find_in_batches(batch_size: 230) do |records|
+        length += records.length
+        expect(records).to be_kind_of Record
+        expect(records._proxy).to be_kind_of DHS::Collection
+      end
+      expect(length).to eq total
+    end
+  end
+
+  context 'pagination with nested response' do
+    before do
+      class Record < DHS::Record
+        endpoint '{+datastore}/{campaign_id}/feedbacks'
+        endpoint '{+datastore}/feedbacks'
+        configuration items_key: %i[response docs], limit_key: { body: %i[response size], parameter: :size }, pagination_key: { body: %i[response start], parameter: :start }, pagination_strategy: :start, total_key: %i[response totalResults]
+      end
+    end
+
+    let(:options) { { items_key: 'docs', limit_key: 'size', pagination_key: 'start', total_key: 'totalResults' } }
+
+    it 'capable to do batch processing with configured pagination' do
+      stub_request(:get, "#{datastore}/feedbacks?size=230&start=1").to_return(status: 200, body: "{\"response\":#{api_response((1..100).to_a, 1, options)}}")
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=101").to_return(status: 200, body: "{\"response\":#{api_response((101..200).to_a, 101, options)}}")
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=201").to_return(status: 200, body: "{\"response\":#{api_response((201..300).to_a, 201, options)}}")
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=301").to_return(status: 200, body: "{\"response\":#{api_response((301..400).to_a, 301, options)}}")
+      stub_request(:get, "#{datastore}/feedbacks?size=100&start=401").to_return(status: 200, body: "{\"response\":#{api_response((401..total).to_a, 401, options)}}")
+      length = 0
+      Record.find_in_batches(batch_size: 230) do |records|
+        length += records.length
+        expect(records).to be_kind_of Record
+        expect(records._proxy).to be_kind_of DHS::Collection
+      end
+      expect(length).to eq total
+    end
+  end
+end