dhs 1.0.0

data/spec/item/setter_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Record < DHS::Record
+      endpoint '{+datastore}/v2/{campaign_id}/feedbacks'
+      endpoint '{+datastore}/v2/feedbacks'
+    end
+  end
+
+  let(:json) do
+    load_json(:feedbacks)
+  end
+
+  let(:data) do
+    DHS::Data.new(json, nil, Record)
+  end
+
+  let(:item) do
+    data[0]
+  end
+
+  context 'item setter' do
+    it 'sets the value for an existing attribute' do
+      expect((item.name = 'Steve')).to eq 'Steve'
+      expect(item.name).to eq 'Steve'
+      expect(item._raw[:name]).to eq 'Steve'
+    end
+
+    it 'sets things to nil' do
+      item.name = 'Steve'
+      expect((item.name = nil)).to eq nil
+      expect(item.name).to eq nil
+    end
+
+    it 'sets things to false' do
+      item.recommended = true
+      expect((item.recommended = false)).to eq false
+      expect(item.recommended).to eq false
+    end
+  end
+end

data/spec/item/translate_errors_spec.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Record < DHS::Record
+      endpoint 'http://dataste/records'
+    end
+
+    stub_request(:post, 'http://dataste/records')
+      .to_return(
+        status: 400,
+        body: {
+          field_errors: [{
+            'code' => 'UNSUPPORTED_PROPERTY_VALUE',
+            'path' => ['name']
+          }]
+        }.to_json
+      )
+
+    I18n.reload!
+    I18n.backend.store_translations(:en, YAML.safe_load(translation)) if translation.present?
+  end
+
+  let(:errors) { Record.create(name: 'Steve').errors }
+
+  context 'detailed error translation for record and attribute' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            records:
+              record:
+                attributes:
+                  name:
+                    unsupported_property_value: 'This value is not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is not supported']
+    end
+  end
+
+  context 'error translation for record' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is unfortunately not supported']
+    end
+  end
+
+  context 'error translation for message' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is sadly not supported']
+    end
+  end
+
+  context 'error translation for attributes' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is not supported – bummer']
+    end
+  end
+
+  context 'error translation for fallback message' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            fallback_message: 'This value is wrong'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is wrong']
+    end
+  end
+
+  context 'detailed record attribute over other translations' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+                attributes:
+                  name:
+                    unsupported_property_value: 'This value is not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is not supported']
+    end
+  end
+
+  context 'record translations over global messages, attributes and fallback' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is unfortunately not supported']
+    end
+  end
+
+  context 'global message translation over attributes and fallback' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is sadly not supported']
+    end
+  end
+
+  context 'global attributes over fallback' do
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is not supported – bummer']
+    end
+  end
+
+  context 'no translation' do
+    let(:translation) do
+      %q{}
+    end
+
+    it 'takes no translation but keeps on storing the error message/code' do
+      expect(errors[:name]).to eq ['UNSUPPORTED_PROPERTY_VALUE']
+    end
+  end
+
+  context 'error translation for nested record' do
+    before do
+      class AppointmentProposal < DHS::Record
+        endpoint 'http://dataste/appointment_proposals'
+        endpoint 'http://dataste/appointment_proposals/{id}'
+
+        has_many :appointments
+      end
+
+      class Appointment < DHS::Record
+      end
+
+      stub_request(:get, 'http://dataste/appointment_proposals/1')
+        .to_return(body: {
+          appointments: [
+            { 'date_time' => '13.12.2018' },
+            { 'date_time' => '18.10.2028' }
+          ]
+        }.to_json)
+
+      stub_request(:post, 'http://dataste/appointment_proposals')
+        .to_return(
+          status: 400,
+          body: {
+            field_errors: [{
+              'code' => 'DATE_PROPERTY_NOT_IN_FUTURE',
+              'path' => ['appointments', 0, 'date_time']
+            }]
+          }.to_json
+        )
+    end
+
+    let(:translation) do
+      %q{
+        dhs:
+          errors:
+            records:
+              appointment_proposal:
+                attributes:
+                  appointments:
+                    date_time:
+                      date_property_not_in_future: 'You cannot select a date in the past.'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      appointment_proposal = AppointmentProposal.find(1)
+      appointment_proposal.update(
+        'appointments_attributes' => {
+          '0' => { 'date_time' => '13.12.2018' },
+          '1' => { 'date_time' => '18.10.2028' }
+        }
+      )
+      expect(appointment_proposal.appointments[0].errors[:date_time]).to eql(['You cannot select a date in the past.'])
+      expect(appointment_proposal.appointments[1].errors[:date_time]).to eql([])
+    end
+  end
+end

data/spec/item/update_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Record < DHS::Record
+      endpoint '{+datastore}/v2/{campaign_id}/feedbacks'
+      endpoint '{+datastore}/v2/feedbacks'
+    end
+  end
+
+  let(:json) do
+    load_json(:feedbacks)
+  end
+
+  let(:data) do
+    DHS::Data.new(json, nil, Record)
+  end
+
+  let(:item) do
+    data[0]
+  end
+
+  context 'update' do
+    it 'persists changes on the backend' do
+      stub_request(:post, item.href)
+        .with(body: item._raw.merge(name: 'Steve').to_json)
+      result = item.update(name: 'Steve')
+      expect(result).to eq true
+    end
+
+    it 'returns false if persisting went wrong' do
+      stub_request(:post, item.href).to_return(status: 500)
+      result = item.update(name: 'Steve')
+      expect(result).to eq false
+    end
+
+    it 'merges reponse data with object' do
+      stub_request(:post, item.href)
+        .to_return(status: 200, body: item._raw.merge(likes: 'Banana').to_json)
+      item.update(name: 'Steve')
+      expect(item.likes).to eq 'Banana'
+    end
+
+    it 'updates local version of an object even if BE request fails' do
+      stub_request(:post, item.href)
+        .to_return(status: 400, body: item._raw.merge(likes: 'Banana').to_json)
+      item.update(name: 'Andrea')
+      expect(item.name).to eq 'Andrea'
+      expect(item.likes).not_to eq 'Banana'
+    end
+
+    context 'with custom setters' do
+      before do
+        class Booking < DHS::Record
+          endpoint 'http://bookings/bookings'
+
+          def appointments=(appointments)
+            super(
+              appointments.map { |appointment| appointment[:id] }
+            )
+          end
+        end
+      end
+
+      let(:item) do
+        Booking.new(id: 'abc')
+      end
+
+      it 'updates data using custom setters before send to backend' do
+        stub_request(:post, 'http://bookings/bookings')
+          .with(body: {
+            id: 'abc',
+            appointments: [1, 2, 3]
+          }.to_json)
+          .to_return(status: 200)
+        item.update(appointments: [{ id: 1 }, { id: 2 }, { id: 3 }])
+        expect(item.appointments.to_a).to eq([1, 2, 3])
+      end
+
+      context 'with nested items' do
+        before do
+          class Booking < DHS::Record
+            endpoint 'http://bookings/bookings'
+            has_one :appointment_proposal
+          end
+
+          class AppointmentProposal < DHS::Record
+            endpoint 'http://bookings/bookings'
+            has_many :appointments
+
+            def appointments_attributes=(attributes)
+              self.appointments = attributes.map { |attribute| Appointment.new('date_time': attribute[:date]) }
+            end
+          end
+
+          class Appointment < DHS::Record
+          end
+        end
+
+        let(:item) do
+          Booking.new(id: 'abc', appointment_proposal: { appointments: [] })
+        end
+
+        it 'updates data using custom setters before send to backend' do
+          stub_request(:post, 'http://bookings/bookings')
+            .with(body: {
+              appointments: [{ date_time: '2018-01-18' }]
+            }.to_json)
+            .to_return(status: 200)
+          item.appointment_proposal.update(appointments_attributes: [{ date: '2018-01-18' }])
+          expect(item.appointment_proposal.appointments.as_json).to eq([{ 'date_time' => '2018-01-18' }])
+        end
+      end
+    end
+
+    context 'with many placeholders' do
+      before do
+        class GrandChild < DHS::Record
+          endpoint 'http://host/v2/parents/{parent_id}/children/{child_id}/grand_children'
+          endpoint 'http://host/v2/parents/{parent_id}/children/{child_id}/grand_children/{id}'
+        end
+      end
+
+      let(:data) do
+        {
+          id: 'aaa',
+          parent_id: 'bbb',
+          child_id: 'ccc',
+          name: 'Lorem'
+        }
+      end
+
+      let(:item) do
+        GrandChild.new(data)
+      end
+
+      it 'persists changes on the backend' do
+        stub_request(:get, 'http://host/v2/parents/bbb/children/ccc/grand_children/aaa')
+          .to_return(status: 200, body: data.to_json)
+        stub_request(:post, 'http://host/v2/parents/bbb/children/ccc/grand_children/aaa')
+          .with(body: { name: 'Steve' }.to_json)
+
+        grand_child = GrandChild.find(parent_id: 'bbb', child_id: 'ccc', id: 'aaa')
+        expect(grand_child.name).to eq('Lorem')
+        result = grand_child.update(name: 'Steve')
+        expect(result).to eq true
+      end
+    end
+  end
+
+  context 'update!' do
+    it 'raises if something goes wrong' do
+      stub_request(:post, item.href)
+        .with(body: item._raw.merge(name: 'Steve').to_json)
+        .to_return(status: 500)
+      expect(-> { item.update!(name: 'Steve') }).to raise_error DHC::ServerError
+    end
+  end
+end