acfs 1.3.3 → 1.6.0

data/spec/acfs/stub_spec.rb

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class SpecialCustomError < StandardError; end
+
+describe Acfs::Stub do
+  let(:stub) { Class.new(Acfs::Stub) }
+
+  before(:all) { Acfs::Stub.enable }
+  after(:all) { Acfs::Stub.disable }
+
+  before do
+    Acfs::Stub.allow_requests = false
+  end
+
+  describe '#called?' do
+    context 'without specified number' do
+      let!(:operation) { Acfs::Stub.resource MyUser, :read, with: {id: 1}, return: {id: 1, name: 'John Smith', age: 32} }
+
+      it 'should allow to test if stub was called' do
+        MyUser.find 1
+        Acfs.run
+
+        expect(operation).to be_called
+      end
+
+      it 'should allow to test if stub was called a specific number of times' do
+        MyUser.find 1
+        Acfs.run
+
+        MyUser.find 1
+        Acfs.run
+
+        expect(operation).to be_called 2.times
+      end
+    end
+  end
+
+  describe '.resource' do
+    context 'with ambiguous stubs' do
+      before do
+        Acfs::Stub.resource MyUser, :read, with: {id: 1}, return: {id: 1, name: 'John Smith', age: 32}
+        Acfs::Stub.resource MyUser, :read, with: {id: 1}, raise: :not_found
+      end
+
+      it 'should raise error' do
+        MyUser.find 1
+
+        expect { Acfs.run }.to raise_error(Acfs::AmbiguousStubError)
+      end
+    end
+
+    context 'with read action' do
+      before do
+        Acfs::Stub.resource MyUser, :read, with: {id: 1}, return: {id: 1, name: 'John Smith', age: 32}
+        Acfs::Stub.resource MyUser, :read, with: {id: 2}, raise: SpecialCustomError
+        Acfs::Stub.resource MyUser, :read, with: {id: 3}, raise: :not_found
+      end
+
+      it 'should allow to stub resource reads' do
+        user = MyUser.find 1
+        Acfs.run
+
+        expect(user.id).to be == 1
+        expect(user.name).to be == 'John Smith'
+        expect(user.age).to be == 32
+      end
+
+      context 'with error' do
+        it 'should allow to raise errors' do
+          MyUser.find 2
+
+          expect { Acfs.run }.to raise_error(SpecialCustomError)
+        end
+
+        it 'should allow to raise symbolic errors' do
+          MyUser.find 3
+
+          expect { Acfs.run }.to raise_error(Acfs::ResourceNotFound)
+        end
+      end
+
+      context 'with type parameter' do
+        before do
+          Acfs::Stub.resource Computer, :read, with: {id: 1}, return: {id: 1, type: 'PC'}
+          Acfs::Stub.resource Computer, :read, with: {id: 2}, return: {id: 2, type: 'Mac'}
+        end
+
+        it 'should create inherited type' do
+          pc = Computer.find 1
+          mac = Computer.find 2
+
+          Acfs.run
+
+          expect(pc).to be_a PC
+          expect(mac).to be_a Mac
+        end
+      end
+    end
+
+    context 'with create action' do
+      before do
+        Acfs::Stub.resource Session, :create, with: {ident: 'john@exmaple.org', password: 's3cr3t'}, return: {id: 'longhash', user: 1}
+        Acfs::Stub.resource Session, :create, with: ->(op) { op.data[:ident] == 'john@exmaple.org' && op.data[:password] == 'wrong' }, raise: 422
+      end
+
+      it 'should allow stub resource creation' do
+        session = Session.create! ident: 'john@exmaple.org', password: 's3cr3t'
+
+        expect(session.id).to be == 'longhash'
+        expect(session.user).to be == 1
+      end
+
+      it 'should allow to raise error' do
+        expect do
+          Session.create! ident: 'john@exmaple.org', password: 'wrong'
+        end.to raise_error(::Acfs::InvalidResource)
+      end
+    end
+
+    context 'with list action' do
+      before do
+        Acfs::Stub.resource MyUser, :list,
+          return: [{id: 1, name: 'John Smith', age: 32}, {id: 2, name: 'Anon', age: 12}]
+      end
+
+      it 'should return collection' do
+        users = MyUser.all
+        Acfs.run
+
+        expect(users).to have(2).items
+      end
+
+      it 'should return defined resources' do
+        users = MyUser.all
+        Acfs.run
+
+        expect(users[0].id).to eq 1
+        expect(users[1].id).to eq 2
+        expect(users[0].name).to eq 'John Smith'
+        expect(users[1].name).to eq 'Anon'
+      end
+
+      context 'with type parameter' do
+        before do
+          Acfs::Stub.resource Computer, :list,
+            return: [{id: 1, type: 'PC'}, {id: 2, type: 'Mac'}]
+        end
+
+        it 'should create inherited type' do
+          computers = Computer.all
+          Acfs.run
+
+          expect(computers.first).to be_a PC
+          expect(computers.last).to be_a Mac
+        end
+      end
+
+      context 'with header' do
+        before do
+          Acfs::Stub.resource Comment, :list,
+            return: [{id: 1, text: 'Foo'}, {id: 2, text: 'Bar'}],
+            headers: headers
+        end
+
+        let!(:comments) { Comment.all }
+        let(:headers) do
+          {
+            'X-Total-Pages' => '2',
+            'X-Total-Count' => '10'
+          }
+        end
+        subject { Acfs.run; comments }
+
+        its(:total_pages) { should eq 2 }
+        its(:total_count) { should eq 10 }
+      end
+    end
+
+    context 'with update action' do
+      before do
+        Acfs::Stub.resource MyUser, :read, with: {id: 1}, return: {id: 1, name: 'John Smith', age: 32}
+        Acfs::Stub.resource MyUser, :update, with: {id: 1, name: 'John Smith', age: 22}, return: {id: 1, name: 'John Smith', age: 23}
+        Acfs::Stub.resource MyUser, :update, with: {id: 1, name: 'John Smith', age: 0}, raise: 422
+      end
+
+      let!(:update_stub) do
+        Acfs::Stub.resource MyUser, :update,
+          with: {id: 1, name: 'Jane Smith'},
+          return: ->(op) { Hash[op.data.map {|k, v| [k, v.to_s.upcase] }] }
+      end
+
+      it 'should allow stub resource update' do
+        user = MyUser.find 1
+        Acfs.run
+
+        user.age = 22
+        user.save!
+
+        expect(user.age).to be == 23
+      end
+
+      it 'should allow to raise error' do
+        user = MyUser.find 1
+        Acfs.run
+
+        user.age = 0
+        user.save
+
+        expect do
+          user.save!
+        end.to raise_error(::Acfs::InvalidResource)
+      end
+
+      it 'should match partial :with' do
+        user = MyUser.find 1
+        Acfs.run
+
+        user.age = 5
+        user.name = 'Jane Smith'
+        user.save!
+
+        expect(update_stub).to be_called
+      end
+
+      it 'should process response body' do
+        user = MyUser.find 1
+        Acfs.run
+
+        user.age = 5
+        user.name = 'Jane Smith'
+        user.save!
+
+        expect(user.name).to eq 'JANE SMITH'
+      end
+    end
+
+    context 'with create action' do
+      before do
+        Acfs::Stub.resource MyUser, :create, with: {name: 'John Smith', age: 0}, raise: 422
+      end
+
+      it 'should allow to raise error' do
+        expect do
+          MyUser.create! name: 'John Smith', age: 0
+        end.to raise_error(::Acfs::InvalidResource)
+      end
+    end
+  end
+
+  describe '.allow_requests=' do
+    context 'when enabled' do
+      before do
+        Acfs::Stub.allow_requests = true
+        stub_request(:get, 'http://users.example.org/users/2').to_return response(id: 2, name: 'John', age: 26)
+      end
+
+      it 'should allow real requests' do
+        @user = MyUser.find 2
+        expect { Acfs.run }.to_not raise_error
+      end
+    end
+
+    context 'when disabled' do
+      before do
+        Acfs::Stub.allow_requests = false
+      end
+
+      it 'should not allow real requests' do
+        @user = MyUser.find 2
+        expect { Acfs.run }.to raise_error(Acfs::RealRequestsNotAllowedError)
+      end
+    end
+  end
+
+  describe 'accept?' do
+    subject { stub.accept?(op) }
+
+    context 'with a match in params' do
+      let(:op) do
+        double('operation').tap do |op|
+          allow(op).to receive(:full_params).and_return(id: 1337, blub: 'abc')
+          allow(op).to receive(:data).and_return({})
+        end
+      end
+
+      let(:stub) { Acfs::Stub.resource MyUser, :read, with: {id: 1337} }
+
+      it { is_expected.to be true }
+    end
+
+    context 'with a match in data' do
+      let(:op) do
+        double('operation').tap do |op|
+          allow(op).to receive(:full_params).and_return({})
+          allow(op).to receive(:data).and_return(id: 1337, blub: 'abc')
+        end
+      end
+
+      let(:stub) { Acfs::Stub.resource MyUser, :read, with: {id: 1337} }
+
+      it { is_expected.to be true }
+    end
+
+    context 'with no match in params nor data' do
+      let(:op) do
+        double('operation').tap do |op|
+          allow(op).to receive(:full_params).and_return(id: 1337)
+          allow(op).to receive(:data).and_return({})
+        end
+      end
+
+      let(:stub) { Acfs::Stub.resource MyUser, :read, with: {abc: '123'} }
+
+      it { is_expected.to be false }
+    end
+
+    context 'with a wrong match' do
+      let(:op) do
+        double('operation').tap do |op|
+          allow(op).to receive(:full_params).and_return(id: 1337, blub: 'abc')
+          allow(op).to receive(:data).and_return({})
+        end
+      end
+
+      let(:stub) { Acfs::Stub.resource MyUser, :read, with: {id: 1337, blub: '123'} }
+
+      it { is_expected.to be false }
+    end
+
+    context 'with a missing match' do
+      let(:op) do
+        double('operation').tap do |op|
+          allow(op).to receive(:full_params).and_return(id: 1337, blub: 'abc')
+          allow(op).to receive(:data).and_return({})
+        end
+      end
+
+      let(:stub) { Acfs::Stub.resource MyUser, :read, with: {id: 1337, answer: 42} }
+
+      it { is_expected.to be false }
+    end
+  end
+end

data/spec/acfs_spec.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Acfs' do
+  before do
+    stub_request(:get, 'http://users.example.org/users').to_return response([{id: 1, name: 'Anon', age: 12}, {id: 2, name: 'John', age: 26}])
+    stub_request(:get, 'http://users.example.org/users/2').to_return response(id: 2, name: 'John', age: 26)
+    stub_request(:get, 'http://users.example.org/users/3').to_return response(id: 3, name: 'Miraculix', age: 122)
+    stub_request(:get, 'http://users.example.org/users/100').to_return response(id: 100, name: 'Jimmy', age: 45)
+    stub_request(:get, 'http://users.example.org/users/2/friends').to_return response([{id: 1, name: 'Anon', age: 12}])
+    stub_request(:get, 'http://comments.example.org/comments?user=2').to_return response([{id: 1, text: 'Comment #1'}, {id: 2, text: 'Comment #2'}])
+  end
+
+  it 'should update single resource synchronously' do
+    stub = stub_request(:put, 'http://users.example.org/users/2')
+           .to_return {|request| {body: request.body, headers: {'Content-Type' => request.headers['Content-Type']}} }
+
+    @user = MyUser.find 2
+    Acfs.run
+
+    expect(@user).to_not be_changed
+    expect(@user).to be_persisted
+
+    @user.name = 'Johnny'
+
+    expect(@user).to be_changed
+    expect(@user).to be_persisted
+
+    @user.save
+
+    expect(stub).to have_been_requested
+    expect(@user).to_not be_changed
+    expect(@user).to be_persisted
+  end
+
+  it 'should create a single resource synchronously' do
+    stub = stub_request(:post, 'http://users.example.org/sessions').to_return response(id: 'sessionhash', user: 1)
+
+    session = Session.create ident: 'Anon'
+
+    expect(stub).to have_been_requested
+    expect(session.id).to be == 'sessionhash'
+    expect(session.user).to be == 1
+  end
+
+  it 'should load single resource' do
+    @user = MyUser.find(2)
+
+    expect(@user).to_not be_loaded
+
+    Acfs.run
+
+    expect(@user).to be_loaded
+    expect(@user.id).to be == 2
+    expect(@user.name).to be == 'John'
+    expect(@user.age).to be == 26
+  end
+
+  describe 'singleton' do
+    before do
+      stub_request(:get, 'http://users.example.org/singles?user_id=5').to_return response(score: 250, user_id: 5)
+    end
+
+    it 'should create a singleton resource' do
+      stub = stub_request(:post, 'http://users.example.org/singles').to_return response(score: 250, user_id: 5)
+
+      @single = Single.new user_id: 5, score: 250
+      expect(@single.new?).to eq true
+
+      @single.save
+      expect(stub).to have_been_requested
+
+      expect(@single.new?).to eq false
+      expect(@single.user_id).to eq 5
+      expect(@single.score).to eq 250
+    end
+
+    it 'should load singleton resource' do
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.score).to eq 250
+    end
+
+    it 'should update singleton resource' do
+      stub = stub_request(:put, 'http://users.example.org/singles').to_return do |request|
+        {
+          body: request.body,
+          headers: {'Content-Type' => request.headers['Content-Type']}
+        }
+      end
+
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.score).to eq 250
+
+      @single.score = 300
+      @single.save
+
+      expect(stub).to have_been_requested
+
+      expect(@single.score).to eq 300
+    end
+
+    it 'should delete singleton resource' do
+      stub = stub_request(:delete, 'http://users.example.org/singles').to_return do |request|
+        {
+          body: request.body,
+          headers: {'Content-Type' => request.headers['Content-Type']}
+        }
+      end
+
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.new?).to eq false
+
+      @single.delete
+
+      expect(stub).to have_been_requested
+    end
+
+    it 'should raise error when calling `all\'' do
+      expect { Single.all }.to raise_error ::Acfs::UnsupportedOperation
+    end
+  end
+
+  it 'should load multiple single resources' do
+    @users = MyUser.find([2, 3, 100]) do |users|
+      # This block should be called only after *all* resources are loaded.
+      @john = users[0]
+      @mirx = users[1]
+      @jimy = users[2]
+    end
+
+    expect(@users).to_not be_loaded
+
+    Acfs.run
+
+    expect(@users).to be_loaded
+    expect(@users).to have(3).items
+
+    expect(@users[0].id).to be == 2
+    expect(@users[0].name).to be == 'John'
+    expect(@users[0].age).to be == 26
+    expect(@users[0]).to be == @john
+
+    expect(@users[1].id).to be == 3
+    expect(@users[1].name).to be == 'Miraculix'
+    expect(@users[1].age).to be == 122
+    expect(@users[1]).to be == @mirx
+
+    expect(@users[2].id).to be == 100
+    expect(@users[2].name).to be == 'Jimmy'
+    expect(@users[2].age).to be == 45
+    expect(@users[2]).to be == @jimy
+  end
+
+  it 'should load multiple resources' do
+    @users = MyUser.all
+
+    expect(@users).to_not be_loaded
+
+    Acfs.run
+
+    expect(@users).to be_loaded
+    expect(@users).to have(2).items
+    expect(@users[0].name).to be == 'Anon'
+    expect(@users[0].age).to be == 12
+    expect(@users[1].name).to be == 'John'
+    expect(@users[1].age).to be == 26
+  end
+
+  it 'should load associated resources' do
+    pending 'TODO: Implement high level feature'
+
+    @user = MyUser.find(2) do |user|
+      @friends = user.friends.all
+    end
+
+    Acfs.run
+
+    expect(@user.name).to be == 'John'
+    expect(@user.age).to be == 26
+
+    expect(@friends).to have(1).items
+  end
+
+  it 'should load associated resources from different service' do
+    @user = MyUser.find 2 do |user|
+      expect(user.id).to be == 2
+      @comments = Comment.where({user: user.id})
+    end
+
+    Acfs.run
+
+    expect(@user.id).to be == 2
+    expect(@user.name).to be == 'John'
+    expect(@user.age).to be == 26
+
+    expect(@comments).to have(2).items
+  end
+end