dhs 1.0.0

data/spec/record/update_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'update' do
+    before do
+      class Record < DHS::Record
+        endpoint 'http://datastore/records/{id}'
+      end
+    end
+
+    it 'allows to directly update a record without fetching it first' do
+      stub_request(:post, 'http://datastore/records/123')
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 200, body: {}.to_json)
+
+      Record.update(
+        id: '123',
+        name: 'Steve'
+      )
+    end
+
+    it 'does not fail during an error with update' do
+      stub_request(:post, 'http://datastore/records/123')
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 404, body: {}.to_json)
+
+      record = Record.update(
+        id: '123',
+        name: 'Steve'
+      )
+
+      expect(record.errors.status_code).to eq 404
+    end
+
+    it 'allows to directly update! a record without fetching it first' do
+      stub_request(:post, 'http://datastore/records/123')
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 200)
+
+      Record.update!(
+        id: '123',
+        name: 'Steve'
+      )
+    end
+
+    it 'raises an error when trying to update! but retrieving an error status' do
+      stub_request(:post, 'http://datastore/records/123')
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 404)
+
+      expect(-> {
+        Record.update!(
+          id: '123',
+          name: 'Steve'
+        )
+      }).to raise_error(DHC::NotFound)
+    end
+  end
+end

data/spec/record/where_chains_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  let(:response) do
+    { body: [{ name: 'Steve' }] }
+  end
+
+  before do
+    DHC.config.placeholder('datastore', datastore)
+    class Record < DHS::Record
+      endpoint '{+datastore}/records/'
+
+      def uppercase_name
+        name.upcase
+      end
+    end
+  end
+
+  context 'where chains' do
+    before do
+      stub_request(:get, 'http://datastore/v2/records/?available=true&color=blue&range=%3E26')
+        .to_return(response)
+    end
+
+    let(:records) { Record.where(color: 'blue').where(range: '>26').where(available: true) }
+
+    it 'allows chaining where statements' do
+      expect(records.class).to eq Record
+      expect(records._raw).to eq [{ name: 'Steve' }]
+      expect(records.first.uppercase_name).to eq 'STEVE'
+    end
+
+    it 'resolves triggered by method missing' do
+      expect(records._raw).to eq [{ name: 'Steve' }]
+      expect(
+        Record.where(color: 'blue').where(range: '>26', available: true).first.name
+      ).to eq 'Steve'
+    end
+  end
+
+  context 'multiple parameters' do
+    before do
+      stub_request(:get, 'http://datastore/v2/records/?parameter=last').to_return(response)
+    end
+
+    it 'takes the last value for chains with same name parameters' do
+      records = Record.where(parameter: 'first').where(parameter: 'last')
+      records.first
+    end
+  end
+end

data/spec/record/where_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  before do
+    DHC.config.placeholder('datastore', datastore)
+    class Record < DHS::Record
+      endpoint '{+datastore}/content-ads/{campaign_id}/feedbacks'
+      endpoint '{+datastore}/feedbacks'
+    end
+  end
+
+  context 'where' do
+    it 'is querying relevant endpoint when using where' do
+      stub_request(:get, "#{datastore}/feedbacks?has_review=true").to_return(status: 200, body: { items: [] }.to_json)
+      Record.where(has_review: true)
+      stub_request(:get, "#{datastore}/content-ads/123/feedbacks?has_review=true").to_return(status: 200, body: [].to_json)
+      Record.where(campaign_id: '123', has_review: true)
+      stub_request(:get, "#{datastore}/feedbacks").to_return(status: 200, body: [].to_json)
+      records = Record.where
+      expect(records).to be_kind_of Record
+    end
+
+    it 'is using params as query params explicitly when provided in params namespace' do
+      stub_request(:get, "#{datastore}/content-ads/123/feedbacks?campaign_id=456").to_return(status: 200, body: [].to_json)
+      Record.where(campaign_id: '123', params: { campaign_id: '456' })
+    end
+
+    context 'where with href' do
+      let(:return_body) { [email: 'steve@depay.fi'].to_json }
+
+      context 'chain initialization' do
+        before do
+          stub_request(:get, 'https://localch-accounts/?from_user_id=123')
+            .to_return(body: return_body)
+        end
+
+        it 'queries api with provided href' do
+          records = Record.where('https://localch-accounts?from_user_id=123').fetch
+          expect(records.first.email).to eq 'steve@depay.fi'
+        end
+      end
+
+      context 'after chain initialization' do
+        before do
+          stub_request(:get, 'https://localch-accounts/?color=blue&from_user_id=123')
+            .to_return(body: return_body)
+        end
+
+        it 'queries api with provided href also when passed after chain is initialized' do
+          records = Record.where(color: 'blue').where('https://localch-accounts?from_user_id=123').fetch
+          expect(records.first.email).to eq 'steve@depay.fi'
+        end
+      end
+    end
+  end
+end

data/spec/record/where_values_hash_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  let(:response) do
+    { body: [{ name: 'Steve' }] }
+  end
+
+  before do
+    DHC.config.placeholder('datastore', datastore)
+    class Record < DHS::Record
+      endpoint '{+datastore}/records/'
+    end
+  end
+
+  context 'where values hash' do
+    it 'provides the hash or where parameters that have been requested' do
+      stub_request(:get, 'http://datastore/v2/records/?available=true&color=blue').to_return(response)
+      expect(
+        Record.where(available: true).where(color: 'blue').where_values_hash
+      ).to eq(available: true, color: 'blue')
+      expect(
+        Record.where(available: true, color: 'red').where(color: 'blue').where_values_hash
+      ).to eq(available: true, color: 'blue')
+    end
+  end
+end

data/spec/request_cycle_cache_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'dhc/rspec'
+
+describe 'Request Cycle Cache', type: :request do
+  let!(:request) do
+    stub_request(:get, 'http://datastore/v2/users/1').to_return(body: { name: 'Steve' }.to_json)
+  end
+
+  let!(:second_request) do
+    stub_request(:get, 'http://datastore/v2/users/2').to_return(body: { name: 'Peter' }.to_json)
+  end
+
+  before do
+    class User < DHS::Record
+      endpoint 'http://datastore/v2/users'
+      endpoint 'http://datastore/v2/users/{id}'
+    end
+    DHC.configure do |config|
+      config.interceptors = [DHC::Caching]
+    end
+  end
+
+  it 'serves requests that are exactly the same during one request cycle from the cache',
+  dummy_models: true, request_cycle_cache: true do
+    get '/request_cycle_cache/simple'
+    expect(request).to have_been_made.once
+
+    # Second Request, Second Cycle, requests again
+    get '/request_cycle_cache/simple'
+    expect(request).to have_been_made.times(2)
+  end
+
+  it 'does not serve from request cycle cache when cache interceptor is not hooked in, but logs a warning',
+  dummy_models: true, request_cycle_cache: true do
+    expect(lambda do
+      get '/request_cycle_cache/no_caching_interceptor'
+    end).to output(
+      %r{\[WARNING\] Can't enable request cycle cache as DHC::Caching interceptor is not enabled/configured \(see https://github.com/DePayFi/dhc/blob/master/README.md#caching-interceptor\)!}
+    ).to_stderr
+    expect(request).to have_been_made.times(2)
+  end
+
+  it 'serves requests also from cache when DHS/DHC makes requests in parallel',
+  dummy_models: true, request_cycle_cache: true do
+    get '/request_cycle_cache/parallel'
+    expect(request).to have_been_made.once
+    expect(second_request).to have_been_made.once
+  end
+
+  it 'sets different uniq request ids as base for request cycle caching for different requests',
+  dummy_models: true, request_cycle_cache: true do
+    get '/request_cycle_cache/simple'
+    first_request_id = DHS::Interceptors::RequestCycleCache::ThreadRegistry.request_id
+    second_request_id = nil
+    thread = Thread.new do
+      get '/request_cycle_cache/simple'
+      second_request_id = DHS::Interceptors::RequestCycleCache::ThreadRegistry.request_id
+    end
+    thread.join
+    expect(first_request_id).not_to be_nil
+    expect(second_request_id).not_to be_nil
+    expect(first_request_id).not_to eq second_request_id
+  end
+
+  context 'disabled request cycle cache' do
+    it 'does not serve from request cycle cache when cache interceptor is not hooked in, and does not warn if request cycle cache is explicitly disabled',
+    dummy_models: true do
+      expect(lambda do
+        get '/request_cycle_cache/no_caching_interceptor'
+      end).not_to output(
+        %r{\[WARNING\] Can't enable request cycle cache as DHC::Caching interceptor is not enabled/configured \(see https://github.com/DePayFi/dhc/blob/master/README.md#caching-interceptor\)!}
+      ).to_stderr
+      expect(request).to have_been_made.times(2)
+    end
+
+    it 'DOES NOT serve requests that are exactly the same during one request cycle from the cache, when request cycle cache is disabled',
+    dummy_models: true do
+      get '/request_cycle_cache/simple'
+      expect(request).to have_been_made.times(2)
+    end
+  end
+
+  context 'headers' do
+    it 'considers the request headers when setting the cache key',
+    dummy_models: true, request_cycle_cache: true do
+      get '/request_cycle_cache/headers_are_different'
+      expect(request).to have_been_made.times(2)
+    end
+  end
+
+  context 'use: cache' do
+    let!(:old_cache) { DHS.config.request_cycle_cache }
+
+    before { DHS.config.request_cycle_cache = double('cache', fetch: nil, write: nil) }
+    after { DHS.config.request_cycle_cache = old_cache }
+
+    it 'uses the cache passed in',
+    dummy_models: true, request_cycle_cache: true do
+      expect(DHS.config.request_cycle_cache).to receive(:fetch).at_least(:once)
+      expect(DHS.config.request_cycle_cache).to receive(:write).at_least(:once)
+      get '/request_cycle_cache/simple'
+    end
+  end
+end

data/spec/require_dhs_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe DHS do
+  context 'when requiring dhs' do
+    it 'does not raise an exception' do
+      expect { require 'dhs' }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'webmock/rspec'
+
+Dir[File.join(__dir__, 'support/**/*.rb')].each { |f| require f }

data/spec/stubs/all_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'dhs/rspec'
+
+describe DHS do
+  before do
+    class Record < DHS::Record
+      endpoint 'https://records'
+    end
+
+    Record.stub_all(
+      'https://records',
+      200.times.map { |index| { name: "Item #{index}" } },
+      headers: {
+        'Authorization' => 'Bearer 123'
+      }
+    )
+  end
+
+  it 'stubs all requests' do
+    records = Record.options(headers: { 'Authorization' => 'Bearer 123' }).all.fetch
+    expect(records.count).to eq 200
+    expect(records.length).to eq 200
+    expect(records.first.name).to eq 'Item 0'
+  end
+
+  context 'without conditions' do
+    before do
+      class Record < DHS::Record
+        endpoint 'https://records'
+      end
+
+      Record.stub_all(
+        'https://records',
+        200.times.map { |index| { name: "Item #{index}" } }
+      )
+    end
+
+    it 'stubs all requests without a webmock "with"' do
+      records = Record.all.fetch
+      expect(records.count).to eq 200
+      expect(records.length).to eq 200
+      expect(records.first.name).to eq 'Item 0'
+    end
+  end
+
+  context 'with configured record' do
+    before do
+      class Record < DHS::Record
+        configuration limit_key: :per_page, pagination_strategy: :page, pagination_key: :page
+
+        endpoint 'https://records'
+      end
+
+      Record.stub_all(
+        'https://records',
+        200.times.map { |index| { name: "Item #{index}" } }
+      )
+    end
+
+    it 'stubs all requests with record configurations for pagination' do
+      records = Record.all.fetch
+      expect(records.count).to eq 200
+      expect(records.length).to eq 200
+      expect(records.first.name).to eq 'Item 0'
+    end
+  end
+end

data/spec/support/fixtures/json/feedback.json

@@ -0,0 +1,11 @@
+{
+    "href": "http://depay.fi/v2/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
+    "campaign": {
+        "href": "http://depay.fi/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id": "aaa",
+    "recommended": true,
+    "modified": "2014-09-19T14:03:35.599+02:00",
+    "created_date": "2014-09-19T14:03:35.597+02:00",
+    "comments": []
+}

data/spec/support/fixtures/json/feedbacks.json

@@ -0,0 +1,174 @@
+{
+  "href" : "http://depay.fi/v2/feedbacks/?exclude_hidden=false&offset=0&limit=10",
+  "items" : [ {
+    "href" : "http://depay.fi/v2/feedbacks/0sdaetZ-OWVg4oBiBJ-7IQ",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id" : "aaa",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 4,
+      "service" : 2,
+      "food" : 3
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-18T16:13:32.987+02:00",
+    "created_date" : "2014-09-18T16:13:31.496+02:00",
+    "average_rating" : 3.0,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/QsUOQWNJoB-GFUNsX7z0jg",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc5690cf271c375c5a11f"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-18T15:43:12.134+02:00",
+    "created_date" : "2014-09-18T15:42:57.892+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/QynNtmpXlsEGvUJ0ekDKVw",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc56b0cf271c375c5a14d"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-17T11:17:39.660+02:00",
+    "created_date" : "2014-09-17T11:17:34.234+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/INmminYWNZwW_qNFx5peJQ",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc56b0cf271c375c5a153"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-16T11:20:32.600+02:00",
+    "created_date" : "2014-09-16T11:20:30.194+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/ltgfr0VRYDN2nxyC119wTg",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc56b0cf271c375c5a14c"
+    },
+    "source_id" : "aaa",
+    "recommended" : false,
+    "ratings" : {
+      "ambiente" : 2,
+      "service" : 1,
+      "food" : 1
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-15T16:23:54.898+02:00",
+    "created_date" : "2014-09-15T16:23:40.355+02:00",
+    "average_rating" : 1.3333333333333333,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/5dUdQP-kZ6sulN8NtpGXTw",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc56b0cf271c375c5a14c"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-12T13:10:51.220+02:00",
+    "created_date" : "2014-09-12T13:10:48.813+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/Z3KfWzIEQ3ZVCUj2IdrSNQ",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc5690cf271c375c5a12e"
+    },
+    "source_id" : "abcdefghs",
+    "recommended" : true,
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-10T16:57:36.255+02:00",
+    "created_date" : "2014-09-10T16:57:36.254+02:00",
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/ZUUUeiw-Stw5Zb1baHDUzQ",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id" : "abcdefghs",
+    "recommended" : true,
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-10T16:57:32.792+02:00",
+    "created_date" : "2014-09-10T16:57:32.791+02:00",
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/GyeWvhEtU4cYN_5T2FX2UA",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/539266ec0cf2cd754583cfa0"
+    },
+    "source_id" : "abcdefghs",
+    "name" : "aa",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 2,
+      "service" : 4,
+      "food" : 3
+    },
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-11T09:48:19.096+02:00",
+    "created_date" : "2014-09-10T16:35:39.201+02:00",
+    "review_title" : "bbb",
+    "review" : "fff",
+    "average_rating" : 3.0,
+    "comments" : [ ]
+  }, {
+    "href" : "http://depay.fi/v2/feedbacks/o-qTRqQGFS3Z_RPJm1f8SA",
+    "campaign" : {
+      "href" : "http://depay.fi/v2/content-ads/51dfc56c0cf271c375c5a160"
+    },
+    "source_id" : "abcdefghs12345",
+    "recommended" : true,
+    "valid_from" : "2014-10-01",
+    "modified" : "2014-09-10T16:31:52.493+02:00",
+    "created_date" : "2014-09-10T16:31:52.492+02:00",
+    "comments" : [ ]
+  } ],
+  "total" : 98,
+  "offset" : 0,
+  "limit" : 10
+}