dhs 1.0.0

data/spec/record/find_in_parallel_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  before do
+    class Record < DHS::Record
+      endpoint 'http://datastore/records/{id}'
+    end
+  end
+
+  context 'find in parallel' do
+    before do
+      stub_request(:get, 'http://datastore/records/1').to_return(status: 200, body: { id: 1 }.to_json)
+      stub_request(:get, 'http://datastore/records/3').to_return(status: 200, body: { id: 3 }.to_json)
+    end
+
+    it 'finds records in parallel' do
+      stub_request(:get, 'http://datastore/records/2').to_return(status: 200, body: { id: 2 }.to_json)
+      allow(Record).to receive(:request).and_call_original
+      data = Record.find([1, 2, 3])
+      expect(Record).to have_received(:request).once
+      expect(data[0].id).to eq 1
+      expect(data[1].id).to eq 2
+      expect(data[2].id).to eq 3
+    end
+
+    it 'raises an exeption if one of the parallel request fails' do
+      stub_request(:get, 'http://datastore/records/2').to_return(status: 401)
+      expect(-> { Record.find([1, 2, 3]) }).to raise_error(DHC::Unauthorized)
+    end
+
+    it 'applies error handlers from the chain and returns whatever the error handler returns' do
+      stub_request(:get, 'http://datastore/records/2').to_return(status: 401)
+      data = Record
+        .rescue(DHC::Unauthorized, ->(_response) { Record.new(name: 'unknown') })
+        .find(1, 2, 3)
+      expect(data[1].name).to eq 'unknown'
+    end
+  end
+
+  context 'find in parallel with extra methods' do
+    before do
+      class Record < DHS::Record
+        endpoint 'http://datastore/records/{id}'
+
+        def identifier
+          123456
+        end
+      end
+
+      stub_request(:get, 'http://datastore/records/1').to_return(status: 200, body: { id: 1 }.to_json)
+      stub_request(:get, 'http://datastore/records/2').to_return(status: 200, body: { id: 2 }.to_json)
+      stub_request(:get, 'http://datastore/records/3').to_return(status: 200, body: { id: 3 }.to_json)
+    end
+
+    it 'finds single record in parallel' do
+      data = Record.find([1])
+      expect(data[0].identifier).to eq 123456
+    end
+
+    it 'finds records in parallel' do
+      data = Record.find([1, 2, 3])
+      expect(data[0].identifier).to eq 123456
+    end
+  end
+end

data/spec/record/find_spec.rb

@@ -0,0 +1,103 @@
+# 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' do
+    context 'finds a single unique record' do
+      before do
+        stub_request(:get, "#{datastore}/feedbacks/z12f-3asm3ngals")
+          .to_return(status: 200, body: load_json(:feedback))
+      end
+
+      it 'by id' do
+        record = Record.find('z12f-3asm3ngals')
+        expect(record).to be_kind_of Record
+        expect(record.source_id).to be_kind_of String
+      end
+
+      it 'by href' do
+        record = Record.find("#{datastore}/feedbacks/z12f-3asm3ngals")
+        expect(record).to be_kind_of Record
+        expect(record.source_id).to be_kind_of String
+      end
+    end
+
+    context 'endpoint without identifier' do
+      before do
+        class LatestAGB < DHS::Record
+          endpoint 'agbs/latest'
+        end
+      end
+
+      it 'finds a single unique record' do
+        stub_request(:get, 'http://agbs/latest')
+          .to_return(body: { pdf: 'http://depay.fi/1.pdf' }.to_json)
+
+        expect(LatestAGB.find.pdf).to eq 'http://depay.fi/1.pdf'
+      end
+    end
+  end
+
+  it 'raises if empty id' do
+    expect { Record.find('') }.to raise_error DHS::Unprocessable
+  end
+
+  it 'raises if nothing was found' do
+    stub_request(:get, "#{datastore}/feedbacks/not-existing")
+      .to_return(status: 404)
+    expect { Record.find('not-existing') }.to raise_error DHC::NotFound
+  end
+
+  it 'finds unique item by providing parameters' do
+    stub_request(:get, "#{datastore}/content-ads/123/feedbacks/123")
+      .to_return(body: '{}')
+    data = Record.find(campaign_id: '123', id: '123')
+    expect(data._proxy).to be_kind_of DHS::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 = Record.find(campaign_id: '123', id: '123')
+    expect(data._proxy).to be_kind_of DHS::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(lambda {
+      Record.find(campaign_id: '123', id: '123')
+    }).to raise_error DHC::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(lambda {
+      Record.find(campaign_id: '123', id: '123')
+    }).to raise_error DHC::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 { Record.find(campaign_id: '123', id: '123') }.to raise_error DHC::NotFound
+  end
+end

data/spec/record/first_spec.rb

@@ -0,0 +1,39 @@
+# 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}/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))
+      record = Record.first
+      expect(record).to be_kind_of Record
+      expect(record.source_id).to be_present
+    end
+
+    it 'returns nil if no record was found' do
+      stub_request(:get, "#{datastore}/feedbacks?limit=1")
+        .to_return(status: 404)
+      expect(Record.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 { Record.first! }.to raise_error DHC::NotFound
+    end
+  end
+end

data/spec/record/force_merge_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'merge' do
+    before do
+      class Change < DHS::Record
+        endpoint 'https://onboarding/places/{id}/change'
+      end
+    end
+
+    it 'merges a given hash' do
+      stub_request(:get, 'https://onboarding/places/1/change')
+        .to_return(body: { entry: { name: 'Steve', address: 'Zurich' }, products: ['LBP'] }.to_json)
+      record = Change.find(1)
+      record.merge!(entry: { name: 'Paul' })
+      expect(record.entry.name).to eq 'Paul'
+      expect(record.entry.address).to eq nil
+      expect(record.products.to_a).to eq ['LBP']
+    end
+
+    it 'merges! a given hash' do
+      stub_request(:get, 'https://onboarding/places/1/change')
+        .to_return(body: { entry: { name: 'Steve', address: 'Zurich' }, products: ['LBP'] }.to_json)
+      record = Change.find(1)
+      new_record = record.merge(entry: { name: 'Paul' })
+      expect(new_record.entry.name).to eq 'Paul'
+      expect(new_record.entry.address).to eq nil
+      expect(new_record.products.to_a).to eq ['LBP']
+      expect(record.entry.name).to eq 'Steve'
+      expect(record.entry.address).to eq 'Zurich'
+      expect(record.products.to_a).to eq ['LBP']
+    end
+
+    it 'deep_merge! a given hash' do
+      stub_request(:get, 'https://onboarding/places/1/change')
+        .to_return(body: { entry: { name: 'Steve', address: 'Zurich' } }.to_json)
+      record = Change.find(1)
+      record.deep_merge!(entry: { name: 'Paul' })
+      expect(record.entry.name).to eq 'Paul'
+      expect(record.entry.address).to eq 'Zurich'
+    end
+
+    it 'deep_merge a given hash' do
+      stub_request(:get, 'https://onboarding/places/1/change')
+        .to_return(body: { entry: { name: 'Steve', address: 'Zurich' } }.to_json)
+      record = Change.find(1)
+      new_record = record.deep_merge(entry: { name: 'Paul' })
+      expect(new_record.entry.name).to eq 'Paul'
+      expect(new_record.entry.address).to eq 'Zurich'
+      expect(record.entry.name).to eq 'Steve'
+    end
+  end
+end

data/spec/record/handle_includes_errors_spec.rb

@@ -0,0 +1,33 @@
+# 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/{id}'
+    end
+
+    class NestedRecord < DHS::Record
+      endpoint 'http://depay.fi/v2/other_records/{id}'
+    end
+    stub_request(:get, 'http://depay.fi/v2/records/1')
+      .to_return(body: {
+        href: 'http://depay.fi/v2/records/1',
+        other: {
+          href: 'http://depay.fi/v2/other_records/2'
+        }
+      }.to_json)
+    stub_request(:get, 'http://depay.fi/v2/other_records/2')
+      .to_return(status: 404)
+  end
+
+  it 'allows to pass error_handling for includes to DHC' do
+    handler = ->(_) { return { deleted: true } }
+    record = Record.includes_first_page(:other).references(other: { rescue: { DHC::NotFound => handler } }).find(id: 1)
+
+    expect(record.other.deleted).to be(true)
+  end
+end

data/spec/record/has_many_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:listing) { location.listings.first }
+
+  before do
+    stub_request(:get, 'http://uberall/locations/1')
+      .to_return(body: {
+        listings: [{
+          directory: { name: 'Instagram' }
+        }]
+      }.to_json)
+  end
+
+  context 'has_many' do
+    before do
+      class Location < DHS::Record
+        endpoint 'http://uberall/locations'
+        endpoint 'http://uberall/locations/{id}'
+        has_many :listings
+      end
+
+      class Listing < DHS::Record
+
+        def supported?
+          true
+        end
+      end
+    end
+
+    let(:location) { Location.find(1) }
+
+    it 'casts the relation into the correct type' do
+      expect(listing).to be_kind_of(Listing)
+      expect(listing.supported?).to eq true
+    end
+
+    it 'keeps hirachy when casting it to another class on access' do
+      expect(listing._root._raw).to eq location._raw
+      expect(listing.parent.parent._raw).to eq location._raw
+    end
+  end
+
+  context 'custom class_name' do
+    before do
+      module Uberall
+        class Location < DHS::Record
+          endpoint 'http://uberall/locations'
+          endpoint 'http://uberall/locations/{id}'
+          has_many :listings, class_name: 'Uberall::Listing'
+        end
+      end
+
+      module Uberall
+        class Listing < DHS::Record
+
+          def supported?
+            true
+          end
+        end
+      end
+    end
+
+    let(:location) { Uberall::Location.find(1) }
+
+    it 'casts the relation into the correct type' do
+      expect(listing).to be_kind_of(Uberall::Listing)
+      expect(listing.supported?).to eq true
+    end
+
+    it 'keeps hirachy when casting it to another class on access' do
+      expect(listing._root._raw).to eq location._raw
+      expect(listing.parent.parent._raw).to eq location._raw
+    end
+  end
+
+  context 'explicit association class configuration overrules href class casting' do
+    before do
+      class Place < DHS::Record
+        endpoint 'http://places/places/{id}'
+        has_many :categories, class_name: 'NewCategory'
+      end
+
+      class NewCategory < DHS::Record
+        endpoint 'http://newcategories/newcategories/{id}'
+
+        def name
+          self['category_name']
+        end
+      end
+
+      class Category < DHS::Record
+        endpoint 'http://categories/categories/{id}'
+      end
+
+      stub_request(:get, 'http://places/places/1')
+        .to_return(body: {
+          categories: [{
+            href: 'https://categories/categories/1'
+          }]
+        }.to_json)
+
+      stub_request(:get, 'https://categories/categories/1')
+        .to_return(body: {
+          href: 'https://categories/categories/1',
+          category_name: 'Pizza'
+        }.to_json)
+    end
+
+    it 'explicit association configuration overrules href class casting' do
+      place = Place.includes_first_page(:categories).find(1)
+      expect(place.categories.first).to be_kind_of NewCategory
+      expect(place.categories.first.name).to eq('Pizza')
+    end
+  end
+end

data/spec/record/has_one_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:transaction) { Transaction.find(1) }
+  let(:user) { transaction.user }
+
+  before do
+    [1, 2].each do |id|
+      stub_request(:get, "http://myservice/transactions/#{id}")
+        .to_return(body: {
+          user: {
+            email_address: 'steve@depay.fi',
+            comments: []
+          }
+        }.to_json)
+    end
+  end
+
+  context 'has_one' do
+    before do
+      class Transaction < DHS::Record
+        endpoint 'http://myservice/transactions'
+        endpoint 'http://myservice/transactions/{id}'
+        has_one :user
+      end
+
+      class User < DHS::Record
+        has_many :comments
+
+        def email
+          self[:email_address]
+        end
+      end
+
+      class Comment < DHS::Record
+      end
+    end
+
+    it 'casts the relation into the correct type' do
+      expect(user).to be_kind_of(User)
+      expect(user.email).to eq 'steve@depay.fi'
+    end
+
+    it 'keeps hirachy when casting it to another class on access' do
+      expect(user._root._raw).to eq transaction._raw
+      expect(user.parent._raw).to eq transaction._raw
+    end
+  end
+
+  context 'custom class_name' do
+    before do
+      class Transaction < DHS::Record
+        endpoint 'http://myservice/transactions'
+        endpoint 'http://myservice/transactions/{id}'
+        has_one :user, class_name: 'Custom::User'
+      end
+
+      module Custom
+        class User < DHS::Record
+          def email
+            self[:email_address]
+          end
+        end
+      end
+    end
+
+    it 'casts the relation into the correct type' do
+      expect(user).to be_kind_of(Custom::User)
+      expect(user.email).to eq 'steve@depay.fi'
+    end
+  end
+
+  context 'explicit association class configuration overrules href class casting' do
+    before do
+      class Place < DHS::Record
+        endpoint 'http://places/places/{id}'
+        has_one :category, class_name: 'NewCategory'
+      end
+
+      class NewCategory < DHS::Record
+        endpoint 'http://newcategories/newcategories/{id}'
+
+        def name
+          self['category_name']
+        end
+      end
+
+      class Category < DHS::Record
+        endpoint 'http://categories/categories/{id}'
+      end
+
+      stub_request(:get, 'http://places/places/1')
+        .to_return(body: {
+          category: {
+            href: 'https://categories/categories/1'
+          }
+        }.to_json)
+
+      stub_request(:get, 'https://categories/categories/1')
+        .to_return(body: {
+          href: 'https://categories/categories/1',
+          category_name: 'Pizza'
+        }.to_json)
+    end
+
+    it 'explicit association configuration overrules href class casting' do
+      place = Place.includes_first_page(:category).find(1)
+      expect(place.category).to be_kind_of NewCategory
+      expect(place.category.name).to eq('Pizza')
+    end
+  end
+end