dhs 1.0.0

data/spec/item/fetch_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Record < DHS::Record
+      endpoint '{+datastore}/records'
+    end
+  end
+
+  let(:json) do
+    {
+      local_entry_id: 'ABC123'
+    }
+  end
+
+  let(:item) do
+    DHS::Data.new(json, nil, Record)
+  end
+
+  it 'is possible to fetch data' do
+    expect(
+      item.fetch(:local_entry_id)
+    ).to eq 'ABC123'
+  end
+
+  context 'empty data' do
+    let(:json) do
+      {}
+    end
+
+    it 'is possible to get a default when fetched data is nil' do
+      expect(
+        item.fetch(:local_entry_id, 'DEFAULT')
+      ).to eq 'DEFAULT'
+    end
+  end
+end

data/spec/item/getter_spec.rb

@@ -0,0 +1,24 @@
+# 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(:data) do
+    DHS::Data.new({ addresses: [{ business: { identities: [{ name: 'Löwenzorn' }] } }] }, nil, Record)
+  end
+
+  context 'item getter' do
+    it 'returns a collection if you access an array' do
+      expect(data.addresses).to be_kind_of(DHS::Data)
+      expect(data.addresses._proxy).to be_kind_of(DHS::Collection)
+      expect(data.addresses.first.business.identities.first.name).to eq 'Löwenzorn'
+    end
+  end
+end

data/spec/item/internal_data_structure_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Feedback < DHS::Record
+      endpoint '{+datastore}/v2/feedbacks'
+      endpoint '{+datastore}/v2/feedbacks/{id}'
+    end
+  end
+
+  let(:hash) do
+    { 'addresses' => [{ 'businesses' => { 'identities' => [{ 'name' => 'Löwenzorn' }] } }] }
+  end
+
+  let(:data) do
+    DHS::Data.new(hash, nil, Feedback)
+  end
+
+  it 'deep symbolizes keys internaly when new data is initalized' do
+    expect(data._raw[:addresses].first[:businesses][:identities].first[:name]).to eq 'Löwenzorn'
+    data.id = 'YZ12'
+    expect(data._raw.keys).to include(:id)
+  end
+
+  it 'deep symbolizes internal data' do
+    feedback = Feedback.build(hash)
+    expect(feedback._raw.keys).to include(:addresses)
+    expect(feedback._raw[:addresses].first[:businesses][:identities].first[:name]).to eq 'Löwenzorn'
+  end
+
+  it 'deep symbolizes internal data when building new objects' do
+    feedback = Feedback.build('name' => 'BB8')
+    expect(feedback._data._raw.keys).to include(:name)
+  end
+end

data/spec/item/map_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  before do
+    class Record < DHS::Record
+      endpoint '{+datastore}/records'
+    end
+  end
+
+  let(:json) do
+    {
+      key: 'value'
+    }
+  end
+
+  let(:item) do
+    DHS::Data.new(json, nil, Record)
+  end
+
+  it 'is possible to map' do
+    mapped_data = item.map do |key, value|
+      { value => key }
+    end
+    expect(mapped_data).to eq([{ 'value' => :key }])
+  end
+
+  context 'nested' do
+    let(:json) do
+      {
+        languages: {
+          de: { key: 'german value' },
+          en: { key: 'english value' }
+        }
+      }
+    end
+
+    it 'also maps nested data' do
+      mapped_data = item.languages.map do |_language, value|
+        value[:key]
+      end
+      expect(mapped_data).to eq(['german value', 'english value'])
+    end
+  end
+end

data/spec/item/nested_errors_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  context 'nested data' do
+    before do
+      class Presence < DHS::Record
+        endpoint 'http://opm/presences'
+      end
+      stub_request(:post, 'http://opm/presences')
+        .to_return(
+          body: {
+            listings: [{ status: 'CONNECTED' }],
+            field_errors: []
+          }.to_json
+        )
+    end
+
+    it 'does not raise when accessing nested data' do
+      presence = Presence.create
+      expect(lambda {
+        presence.listings.first
+      }).not_to raise_error NoMethodError
+    end
+  end
+end

data/spec/item/partial_update_spec.rb

@@ -0,0 +1,168 @@
+# 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: { name: 'Steve' }.to_json)
+      result = item.partial_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.partial_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.partial_update(name: 'Steve')
+      expect(item.name).to eq '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
+  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.partial_update(name: 'Steve')
+      expect(result).to eq true
+    end
+
+    it 'persists changes on the backend removing placeholder from body' do
+      stub_request(:post, 'http://host/v2/parents/bbb/children/ccc/grand_children/kkkk')
+        .with(body: { name: 'Steve' }.to_json)
+
+      result = item.partial_update(name: 'Steve', id: 'kkkk')
+      expect(result).to eq true
+    end
+  end
+
+  context 'update!' do
+    it 'raises if something goes wrong' do
+      stub_request(:post, item.href)
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 500)
+      expect(-> { item.partial_update!(name: 'Steve') }).to raise_error DHC::ServerError
+    end
+  end
+
+  context 'records without hrefs and nested items' do
+    before do
+      class Location < DHS::Record
+        endpoint 'http://uberall/locations'
+        endpoint 'http://uberall/locations/{id}'
+      end
+    end
+
+    it 'finds and compiles existing endpoints to determine update url' do
+      stub_request(:get, 'http://uberall/locations/1').to_return(body: { id: 1 }.to_json)
+      stub_request(:post, 'http://uberall/locations/1').to_return(body: { id: 1, listings: [{ directory: 'facebook' }] }.to_json)
+      location = Location.find(1)
+      location.partial_update(autoSync: true)
+      expect(location.autoSync).to eq true
+      expect(location.listings.first.directory).to eq 'facebook'
+    end
+
+    context 'records with nested items' do
+      before do
+        class Location < DHS::Record
+          endpoint 'http://uberall/locations'
+          endpoint 'http://uberall/locations/{id}'
+          configuration item_created_key: %i[response location], item_key: %i[response location]
+        end
+      end
+
+      it 'finds and compiles existing endpoints to determine update url' do
+        stub_request(:get, 'http://uberall/locations/1').to_return(body: { response: { location: { id: 1 } } }.to_json)
+        stub_request(:post, 'http://uberall/locations/1').to_return(body: { response: { location: { id: 1, listings: [{ directory: 'facebook' }] } } }.to_json)
+        location = Location.find(1)
+        location.partial_update(autoSync: true)
+        expect(location.autoSync).to eq true
+        expect(location.listings.first.directory).to eq 'facebook'
+      end
+
+      it 'use given update http method' do
+        stub_request(:get, 'http://uberall/locations/1').to_return(body: { response: { location: { id: 1 } } }.to_json)
+        stub_request(:patch, 'http://uberall/locations/1').to_return(body: { response: { location: { id: 1, listings: [{ directory: 'facebook' }] } } }.to_json)
+        location = Location.find(1)
+        location.partial_update({ autoSync: true }, { method: :patch })
+        expect(location.autoSync).to eq true
+        expect(location.listings.first.directory).to eq 'facebook'
+      end
+    end
+  end
+
+  context 'chainable' do
+    it 'allows to chain partial_update with options' do
+      stub_request(:put, item.href)
+        .with(body: { name: 'Steve' }.to_json)
+      result = item.options(method: :put).partial_update(name: 'Steve')
+      expect(result).to eq true
+    end
+
+    it 'allows to chain partial_update! with options' do
+      stub_request(:put, item.href)
+        .with(body: { name: 'Steve' }.to_json)
+      result = item.options(method: :put).partial_update!(name: 'Steve')
+      expect(result).to eq true
+    end
+  end
+end

data/spec/item/respond_to_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Item do
+  let(:item) do
+    DHS::Item.new(id: 1234)
+  end
+
+  context '#respond_to?' do
+    it 'is true for setters' do
+      expect(item.respond_to?(:id=)).to be(true)
+    end
+
+    it 'is true for getters' do
+      expect(item.respond_to?(:id)).to be(true)
+    end
+
+    it 'is true for brackets' do
+      expect(item.respond_to?(:[])).to be(true)
+    end
+
+    it 'is false for new' do
+      expect(item.respond_to?(:new)).to be(false)
+    end
+
+    it 'is false for proxy_association' do
+      expect(item.respond_to?(:proxy_association)).to be(false)
+    end
+  end
+end

data/spec/item/save_spec.rb

@@ -0,0 +1,115 @@
+# 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 'endpoint options' do
+    let(:headers) { { 'X-Header' => 'VALUE' } }
+
+    before do
+      class RecordWithOptions < DHS::Record
+        endpoint 'http://datastore/records', headers: { 'X-Header' => 'VALUE' }
+      end
+    end
+
+    it 'considers end point options when saving' do
+      data = { name: 'Steve' }
+      stub_request(:post, 'http://datastore/records')
+        .with(body: data.to_json, headers: headers)
+        .to_return(body: data.to_json)
+      RecordWithOptions.create!(data)
+    end
+  end
+
+  context 'save' do
+    it 'persists changes on the backend' do
+      stub_request(:post, item.href).with(body: item._raw.merge(name: 'Steve').to_json)
+      item.name = 'Steve'
+      expect(item.save).to eq true
+    end
+
+    it 'returns false if persting goes wrong' do
+      stub_request(:post, item.href)
+        .with(body: item._raw.to_json)
+        .to_return(status: 500)
+      expect(item.save).to eq false
+    end
+
+    it 'merges reponse data with object' do
+      stub_request(:post, item.href)
+        .with(body: item._raw.to_json)
+        .to_return(status: 200, body: item._raw.merge(name: 'Steve').to_json)
+      item.save
+      expect(item.name).to eq 'Steve'
+    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
+      {
+        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(:post, 'http://host/v2/parents/bbb/children/ccc/grand_children')
+        .with(body: { name: 'Lorem' }.to_json)
+
+      expect(item.save).to eq true
+    end
+  end
+
+  context 'save!' do
+    it 'raises if something goes wrong' do
+      stub_request(:post, item.href)
+        .with(body: item._raw.to_json)
+        .to_return(status: 500)
+      expect(-> { item.save! }).to raise_error DHC::ServerError
+    end
+
+    it 'keeps header psassed in the options' do
+      headers = { 'Stats' => 'first-access' }
+      request = stub_request(:post, item.href)
+        .with(
+          body: item._raw.to_json,
+          headers: headers
+        )
+        .to_return(status: 200, body: item._raw.to_json)
+
+      item.save!(headers: headers)
+      expect(request).to have_been_requested
+    end
+  end
+end