dhs 1.0.0

data/spec/record/creation_failed_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'creation failed' do
+    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
+
+    let(:error_message) { 'ratings must be set when review or name or review_title is set | The property value is required; it cannot be null, empty, or blank.' }
+
+    let(:creation_error) do
+      {
+        'status' => 400,
+        'message' => error_message,
+        'fields' => [
+          {
+            'name' => 'ratings',
+            'details' => [{ 'code' => 'REQUIRED_PROPERTY_VALUE' }]
+          }, {
+            'name' => 'recommended',
+            'details' => [{ 'code' => 'REQUIRED_PROPERTY_VALUE' }]
+          }
+        ]
+      }
+    end
+
+    it 'provides errors when creation failed' do
+      stub_request(:post, "#{datastore}/feedbacks")
+        .to_return(status: 400, body: creation_error.to_json)
+      record = Record.create(name: 'Steve')
+      expect(record).to be_kind_of Record
+      expect(record.errors).to be_present
+      expect(record.name).to eq 'Steve'
+      expect(record.errors.include?(:ratings)).to eq true
+      expect(record.errors.include?(:recommended)).to eq true
+      expect(record.errors[:ratings]).to eq ['REQUIRED_PROPERTY_VALUE']
+      expect(record.errors.messages).to eq('ratings' => ['REQUIRED_PROPERTY_VALUE'], 'recommended' => ['REQUIRED_PROPERTY_VALUE'])
+      expect(record.errors.message).to eq error_message
+    end
+
+    it 'doesnt fail when no fields are provided by the backend' do
+      stub_request(:post, "#{datastore}/feedbacks")
+        .to_return(status: 400, body: {}.to_json)
+      Record.create(name: 'Steve')
+    end
+  end
+end

data/spec/record/custom_setters_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'custom setters' do
+    context 'assigning values directly to other attributes' do
+      before do
+        Object.send(:remove_const, :Booking) if Object.const_defined?(:Booking) # make sure there is no other booking from previous tests around
+        class Booking < DHS::Record
+          endpoint 'https://bookings'
+
+          def appointment_attributes=(params)
+            self.appointments = params.map { |item| item[:id] }
+          end
+        end
+      end
+
+      it 'allows to change raw in custom setters' do
+        booking = Booking.new(appointment_attributes: [{ id: 1 }])
+        expect(booking.appointments.to_a).to eq [1]
+      end
+    end
+
+    context 'assign values directly by using square brackets' do
+      before do
+        class Booking < DHS::Record
+          endpoint 'https://bookings'
+
+          def appointment_attributes=(params)
+            self[:appointments] = params.map { |item| item[:id] }
+          end
+        end
+      end
+
+      it 'allows to change raw in custom setters' do
+        booking = Booking.new(appointment_attributes: [{ id: 1 }])
+        expect(booking.appointments.to_a).to eq [1]
+      end
+    end
+  end
+end

data/spec/record/definitions_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'definitions' do
+    let(:datastore) { 'http://depay.fi/v2' }
+
+    before do
+      DHC.config.placeholder('datastore', datastore)
+      class LocalEntry < DHS::Record
+        endpoint '{+datastore}/local-entries'
+        endpoint '{+datastore}/local-entries/{id}'
+      end
+    end
+
+    it 'allows mappings in all functions/defitions' do
+      class LocalEntry < DHS::Record
+        def name
+          addresses.first.business.identities.first.name
+        end
+      end
+      stub_request(:get, "#{datastore}/local-entries/1")
+        .to_return(status: 200, body: { addresses: [{ business: { identities: [{ name: 'Löwenzorn' }] } }] }.to_json)
+      entry = LocalEntry.find(1)
+      expect(entry.name).to eq 'Löwenzorn'
+    end
+  end
+end

data/spec/record/destroy_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'destroy' do
+    before do
+      class Record < DHS::Record
+        endpoint 'http://datastore/history'
+        endpoint 'http://datastore/history/{id}'
+      end
+    end
+
+    let(:entry) { { what: 'Cafe', where: 'Zurich' } }
+
+    it 'allows to destroy by parameters directly' do
+      stub_request(:delete, 'http://datastore/history?what=Cafe&where=Zurich')
+        .to_return(body: [entry].to_json)
+      deleted_entries = Record.destroy(what: 'Cafe', where: 'Zurich')
+      expect(deleted_entries.first.to_h).to eq entry
+    end
+
+    it 'allows to destroy by id' do
+      stub_request(:delete, 'http://datastore/history/1')
+        .to_return(body: entry.to_json)
+      deleted_entry = Record.destroy(1)
+      expect(deleted_entry.to_h).to eq entry
+    end
+
+    it 'chains' do
+      stub_request(:delete, 'http://datastore/history/1')
+        .with(headers: { 'Authorization' => 'Bearer 123' })
+        .to_return(body: entry.to_json)
+      deleted_entry = Record.options(headers: { 'Authorization' => 'Bearer 123' }).destroy(1)
+      expect(deleted_entry.to_h).to eq entry
+    end
+  end
+end

data/spec/record/dig_configuration_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  before do
+    class Business < DHS::Record
+      configuration(
+        items_key: %i[response businesses],
+        total_key: %i[response count],
+        limit_key: { body: %i[response max] },
+        pagination_key: { body: %i[response offset] },
+        pagination_strategy: :offset
+      )
+      endpoint 'http://uberall/businesses'
+    end
+  end
+
+  let(:stub_single_business_request) do
+    stub_request(:get, 'http://uberall/businesses?identifier=ABC123&limit=1')
+      .to_return(body: {
+        status: 'SUCCESS',
+        response: {
+          offset: 0,
+          max: 50,
+          count: 1,
+          businesses: [
+            {
+              identifier: 'ABC123',
+              name: 'depay'
+            }
+          ]
+        }
+      }.to_json)
+  end
+
+  let(:stub_multiple_businesses_request) do
+    stub_request(:get, 'http://uberall/businesses?name=depay')
+      .to_return(body: {
+        status: 'SUCCESS',
+        response: {
+          offset: 0,
+          max: 50,
+          count: 2,
+          businesses: [
+            {
+              identifier: 'ABC123',
+              name: 'depay'
+            },
+            {
+              identifier: 'ABC121',
+              name: 'Swisscom'
+            }
+          ]
+        }
+      }.to_json)
+  end
+
+  context 'access nested keys for configuration' do
+    it 'uses paths from configuration to access nested values' do
+      stub_single_business_request
+      business = Business.find_by(identifier: 'ABC123')
+      expect(business.identifier).to eq 'ABC123'
+      expect(business.name).to eq 'depay'
+    end
+
+    it 'digs for meta data when meta information is nested' do
+      stub_multiple_businesses_request
+      businesses = Business.where(name: 'depay')
+      expect(businesses.length).to eq 2
+      expect(businesses.count).to eq 2
+      expect(businesses.offset).to eq 0
+    end
+  end
+end

data/spec/record/dup_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  describe '#dup' do
+    before do
+      class Appointment < DHS::Record
+      end
+    end
+
+    it 'returns a copy of an object' do
+      appointment = Appointment.new
+      copy = appointment.dup
+      expect(copy.inspect).to match(/Appointment/)
+      expect(copy).to be_kind_of(Appointment)
+      expect(copy.object_id).not_to eql(appointment.object_id)
+    end
+  end
+end

data/spec/record/endpoint_inheritance_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'inherit endpoints' do
+    before do
+      class Base < DHS::Record
+        endpoint 'records/{id}'
+      end
+
+      class Example < Base
+      end
+    end
+
+    it 'inherits endpoints based on ruby class_attribute behaviour' do
+      request = stub_request(:get, 'http://records/1').to_return(body: [].to_json)
+      Example.find(1)
+      Base.find(1)
+      assert_requested(request, times: 2)
+    end
+  end
+
+  context 'define endpoints in subclass' do
+    before do
+      class Base < DHS::Record
+        endpoint 'records/{id}'
+      end
+
+      class Example < Base
+        endpoint 'records'
+      end
+    end
+
+    it 'inherits endpoints based on ruby class_attribute behaviour' do
+      stub_request(:get, 'http://records?color=blue').to_return(body: [].to_json)
+      Example.where(color: 'blue')
+      expect(
+        -> { Base.all.first }
+      ).to raise_error(RuntimeError, 'Compilation incomplete. Unable to find value for id.')
+    end
+  end
+
+  context 'ambiguous endpoints between super and subclass' do
+    before do
+      class Base < DHS::Record
+        endpoint 'records'
+      end
+
+      class Example < Base
+        endpoint 'examples/{id}'
+      end
+    end
+
+    it 'inherits endpoints based on ruby class_attribute behaviour' do
+      request = stub_request(:get, 'http://records?limit=100').to_return(body: [].to_json)
+      Base.all.first
+      assert_requested(request)
+
+      request = stub_request(:get, 'http://examples/1').to_return(body: {}.to_json)
+      Example.find(1)
+      assert_requested(request)
+    end
+  end
+end

data/spec/record/endpoint_options_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'set options for an endpoint' do
+    before do
+      class Record < DHS::Record
+        endpoint 'backend/v2/feedbacks/{id}', cache_expires_in: 1.day, retry: 2, cache: true
+      end
+    end
+
+    it 'stores endpoints with options' do
+      expect(Record.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(DHC).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)
+      Record.find(1)
+    end
+
+    context 'deep merge endpoint options' do
+      before do
+        class Location < DHS::Record
+          endpoint 'http://uberall/locations', headers: { privateKey: '123' }
+        end
+      end
+
+      it 'deep merges options to not overwrite endpoint options' do
+        stub_request(:get, 'http://uberall/locations')
+          .with(
+            headers: {
+              'Privatekey' => '123',
+              'X-Custom' => '123'
+            }
+          )
+          .to_return(body: [].to_json)
+
+        Location.options(headers: { 'X-Custom' => '123' }).fetch
+      end
+    end
+  end
+end

data/spec/record/endpoint_priorities_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'endpoint priorities' do
+    before do
+      class Record < DHS::Record
+        endpoint 'https://api/v2/feedbacks'
+        endpoint 'https://api/v2/reviews'
+        endpoint 'https://api/v2/streets/{id}'
+        endpoint 'https://api/v2/feedbacks/{id}'
+        endpoint 'https://api/v2/reviews/{id}'
+      end
+    end
+
+    it 'always takes the first endpoint found' do
+      stub_request(:get, 'https://api/v2/feedbacks').to_return(status: 200)
+      Record.fetch
+      stub_request(:get, 'https://api/v2/streets/1').to_return(status: 200)
+      Record.find(1)
+    end
+  end
+end

data/spec/record/endpoints_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'endpoints' do
+    let(:datastore) { 'http://depay.fi/v2' }
+
+    before do
+      DHC.config.placeholder(:datastore, datastore)
+      class Record < DHS::Record
+        endpoint '{+datastore}/entries/{entry_id}/content-ads/{campaign_id}/feedbacks'
+        endpoint '{+datastore}/{campaign_id}/feedbacks'
+        endpoint '{+datastore}/feedbacks'
+      end
+    end
+
+    it 'stores all the endpoints by url' do
+      expect(DHS::Record::Endpoints.all['{+datastore}/entries/{entry_id}/content-ads/{campaign_id}/feedbacks']).to be_present
+      expect(DHS::Record::Endpoints.all['{+datastore}/{campaign_id}/feedbacks']).to be_present
+      expect(DHS::Record::Endpoints.all['{+datastore}/feedbacks']).to be_present
+    end
+
+    it 'stores the endpoints of the service' do
+      expect(Record.endpoints.count).to eq 3
+      expect(Record.endpoints[0].url).to eq '{+datastore}/entries/{entry_id}/content-ads/{campaign_id}/feedbacks'
+      expect(Record.endpoints[1].url).to eq '{+datastore}/{campaign_id}/feedbacks'
+      expect(Record.endpoints[2].url).to eq '{+datastore}/feedbacks'
+    end
+
+    it 'finds the endpoint by the one with the most route param hits' do
+      expect(
+        Record.find_endpoint(campaign_id: '12345').url
+      ).to eq '{+datastore}/{campaign_id}/feedbacks'
+      expect(
+        Record.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(
+        Record.find_endpoint.url
+      ).to eq '{+datastore}/feedbacks'
+    end
+
+    context 'compute url from endpoint' do
+      before do
+        class Feedback < DHS::Record
+          endpoint '{+datastore}/feedbacks'
+          endpoint '{+datastore}/feedbacks/{id}'
+        end
+      end
+
+      it 'computes urls WITHOUT handling id separate' do
+        stub_request(:get, "#{datastore}/feedbacks/1").to_return(status: 200)
+        Feedback.find(1)
+      end
+    end
+
+    context 'unsorted endpoints' do
+      before do
+        class AnotherRecord < DHS::Record
+          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)
+        AnotherRecord.where(campaign_id: 123, entry_id: 123)
+      end
+    end
+
+    context 'includes data without considering base endpoint of parent record if url is present' do
+      before do
+        class Contract < DHS::Record
+          endpoint '{+datastore}/contracts/:id'
+          endpoint '{+datastore}/entry/{entry_id}/contracts'
+        end
+      end
+
+      it 'uses urls instead of trying to find base endpoint of parent class' do
+        stub_request(:get, "#{datastore}/entry/123/contracts?limit=100")
+          .to_return(body: [{ product: { href: "#{datastore}/products/LBC" } }].to_json)
+        stub_request(:get, "#{datastore}/entry/123/contracts?limit=100&offset=100")
+          .to_return(body: [].to_json)
+        stub_request(:get, "#{datastore}/products/LBC")
+          .to_return(body: { name: 'Local Business Card' }.to_json)
+        expect(lambda {
+          Contract.includes_first_page(:product).where(entry_id: '123').all.first
+        }).not_to raise_error # Multiple base endpoints found
+      end
+    end
+  end
+end