acfs 0.28.0.1.b249 → 0.28.0.1.b253

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzM4MTNmYTA0MWFkMjAzMzA0Mjg4OGNiYjE0MzlkYTlhMDc5ZWY1Yw==
+    ZGQ1YTRhNGNiM2NiZjgyMGQ2ZWEwZjQwYmJjYTQ1OWNjZTY3Njk0Mg==
   data.tar.gz: !binary |-
-    YWZkOTQ4N2RiNDNkMmYwMjUwYmQxMmFlNTViNTM1NjQ4YjUwYWViMw==
+    NDJjZmFmMDUzY2VmODJkMGRjNDczZDFkMWI4ZTFkMDM0NTViNzc5YQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDg0ZjNhMTYxZDM0NDhmNjQ5NTJhMjBiNTYwMGNjOGFiYThmZjIxMzQ1NDVh
-    ODBmY2VhNWYzNmNjYjdhZDkzODk3OTdmYzJhNWE0YjQyNjVmNzU1YTJkNThh
-    ZGFjMzY2YWJmOGI4YmQ1Mzg4OWY0NDhkMjlkOTM1M2NmN2I1ZmE=
+    MGI3YzY0ZDE3ODFhNzRjYWZiZDM1OTg0MTdiYjhhN2FkNjNmZTZlZTg0Y2M2
+    NjE5ODNhOWM1ODc5ZTc2OGRmMGY0YTYxOTAyZjM2OTg5ZTBlMzY4N2M5MzY0
+    NDUxZDIwNTJkMTE3ZjYyNjI3YjhkMWQ2MmFkNTEyZDFjOTFlNzg=
   data.tar.gz: !binary |-
-    ZDRhZmRjYTU3MjRlMmEwMDM5MWMzY2ViMGM2NjI0MjBlYmVjODFiNjk1ZTA3
-    NWQxMWZiZmZkMTk3OGYyMTIyY2NiNGM5ZjRhN2I2MTc3NGRkOWZkMjdhYTgz
-    ZmQyYjdjYjJkYTdjOTU4MDRmNWE3MTc0NjdhM2FmMjg2M2U3NDM=
+    YmRmNTIwYzg1MTBiM2E0NTYwYjIwNzk4OTY1ZjY4ZTQ1YWFiMDMxZWQ4ZTNk
+    YWJiOTY2ZGY3N2I4NmI3Y2NkNmE2ZjUxYTkwNGZlMzRmOGI3NWE2M2E2NDhi
+    YjBiNDg5OWIxMjZjZjdmYWUyY2EwYWVkNDBiNTY0MGQzYzdhYjQ=

data/README.md

@@ -130,6 +130,7 @@ Acfs.run # Will request `http://users.myapp.org/users?age=24`
 
 @user # Contains the first user object returned by the index action
 ```
+If no object can be found, `.find_by` will return `nil`. The optional callback will then be called with `nil` as parameter. Use `.find_by!` to raise an `Acfs::ResourceNotFound` exception if no object can be found. `.find_by!` will only invoke the optional callback if an object was successfully loaded.
 
 Acfs has basic update support using `PUT` requests:
 

data/lib/acfs/model/query_methods.rb

@@ -88,11 +88,11 @@ module Acfs::Model
 
       # @api public
       #
-      # Try to load first resource.
+      # Try to load first resource. Return nil if no object can be loaded.
       #
       # @param [ Hash  ] params Request parameters that will be send to remote service.
       #
-      # @yield [ resource ] Callback block to be executed after resource was fetched successfully.
+      # @yield [ resource ] Callback block to be executed after resource was fetched (even if nil).
       # @yieldparam resource [ self ] Fetched resource, nil if empty list is returned
       #
       # @return [ self ] Resource object, nil if empty list is returned
@@ -112,6 +112,24 @@ module Acfs::Model
         model
       end
 
+      # @api public
+      #
+      # Try to load first resource. Raise Acfs::ResourceNotFound exception if no object can be loaded.
+      #
+      # @param [ Hash  ] params Request parameters that will be send to remote service.
+      #
+      # @yield [ resource ] Callback block to be executed after resource was fetched successfully.
+      # @yieldparam resource [ self ] Fetched resource, nil if empty list is returned
+      #
+      # @return [ self ] Resource object, nil if empty list is returned
+      #
+      def find_by!(params, &block)
+        find_by params do |m|
+          raise Acfs::ResourceNotFound.new message: "Recieved erronious response: no `#{self.name}` with params #{params.to_s} found" if m.nil?
+          block.call m unless block.nil?
+        end
+      end
+
       # TODO: Replace delegator with promise or future for the long run.
       class ResourceDelegator < SimpleDelegator
         delegate :class, :is_a?, :kind_of?, :nil?, to: :__getobj__

data/lib/acfs/singleton_resource.rb

@@ -89,6 +89,7 @@ module Acfs
       undef_method :all
       undef_method :where
       undef_method :find_by
+      undef_method :find_by!
     end
   end
 end

data/spec/acfs/model/query_methods_spec.rb

@@ -163,37 +163,30 @@ describe Acfs::Model::QueryMethods do
     end
   end
 
-  describe '.find_by' do
+  shared_examples 'find_by' do
     context 'standard resource' do
-      let(:model){ MyUser }
-
-      subject do
-        user = model.find_by age: 24
-        Acfs.run
-        user
-      end
+      let(:model) { MyUser }
+      let!(:user) { model.send described_method, age: 24 }
+      subject { Acfs.run; user }
 
       context 'return value' do
-        subject { model.find_by age: 24 }
+        subject { user }
 
         it { should be_a MyUser }
-
         it { should_not be_loaded }
       end
 
-      it 'should query the index action with params set' do
-        stub_request(:get, 'http://users.example.org/users?age=24').to_return response([])
+      context 'with params' do
+        let!(:request) { stub_request(:get, 'http://users.example.org/users?age=24').to_return response([{id: 1, name: 'Mike', age: 24}]) }
 
-        model.find_by age: 24
-        Acfs.run
-
-        assert_requested :get, 'http://users.example.org/users?age=24'
+        it 'should include params in URI to index action' do
+          subject
+          expect(request).to have_been_requested
+        end
       end
 
       context 'with non-empty response' do
-        before do
-          stub_request(:get, 'http://users.example.org/users?age=24').to_return response([{ id: 1, name: 'Mike', age: 24 }, { id: 4, type: 'Maria', age: 24 }, { id: 7, type: 'James', age: 24 }])
-        end
+        before { stub_request(:get, 'http://users.example.org/users?age=24').to_return response([{id: 1, name: 'Mike', age: 24}, {id: 4, type: 'Maria', age: 24}, {id: 7, type: 'James', age: 24}]) }
 
         it 'should invoke callback after model is loaded' do
           proc = Proc.new { }
@@ -204,7 +197,7 @@ describe Acfs::Model::QueryMethods do
             expect(user).to be_loaded
           end
 
-          @user = model.find_by age: 24, &proc
+          @user = model.send described_method, age: 24, &proc
           Acfs.run
         end
 
@@ -212,11 +205,28 @@ describe Acfs::Model::QueryMethods do
           expect(subject).to be_a MyUser
         end
       end
+    end
+
+    context 'singleton resource' do
+      let(:model) { Single }
+
+      it '.find_by should not be defined' do
+        expect{ model.find_by }.to raise_error NoMethodError
+      end
+    end
+  end
+
+  describe '.find_by' do
+    let(:described_method) { :find_by }
+    it_behaves_like 'find_by'
+
+    context 'standard resource' do
+      let(:model){ MyUser }
+      let!(:user) { model.send described_method, age: 24 }
+      subject { Acfs.run; user }
 
       context 'with empty response' do
-        before do
-          stub_request(:get, 'http://users.example.org/users?age=24').to_return response([])
-        end
+        before { stub_request(:get, 'http://users.example.org/users?age=24').to_return response([]) }
 
         it { should be_nil }
 
@@ -233,12 +243,33 @@ describe Acfs::Model::QueryMethods do
         end
       end
     end
+  end
 
-    context 'singleton resource' do
-      let(:model) { Single }
+  describe '.find_by!' do
+    let(:described_method) { :find_by! }
+    it_behaves_like 'find_by'
 
-      it '.find_by should not be defined' do
-        expect{ model.find_by }.to raise_error NoMethodError
+    context 'standard resource' do
+      let(:model){ MyUser }
+      let!(:user) { model.send described_method, age: 24 }
+      subject { Acfs.run; user }
+
+      context 'with empty response' do
+        before { stub_request(:get, 'http://users.example.org/users?age=24').to_return response([]) }
+
+        it 'should raise an ResourceNotFound error' do
+          model.find_by! age: 24
+          expect{ Acfs.run }.to raise_error Acfs::ResourceNotFound
+        end
+
+        it 'should not invoke callback after model could not be loaded' do
+          proc = Proc.new { }
+
+          expect(proc).not_to receive(:call)
+
+          model.find_by! age: 24, &proc
+          expect{ Acfs.run }.to raise_error
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.28.0.1.b249
+  version: 0.28.0.1.b253
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport