acfs 0.27.0.1.b244 → 0.27.0.1.b248

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzQ4NGI5OTIwYTVkYTdiNGUyNGMzYzlmNDBiMzQ4YmNhYmIzZmFmMA==
+    ZTgwOTRmNjQ2MGNjY2M4MjBmYTBlMmVmOGIyYTAwNWRhMTlkNzFmOQ==
   data.tar.gz: !binary |-
-    MTNlZmVmMGExOTI4MzcyNjA3ODZhYWI3MDNkODkwODk5MjNlYzNlNA==
+    YjBkZTQ0ZWMzY2Q3OWQ4N2U1MjczZTdkYjhkMmI3NGMwMmExNWQ3ZA==
 SHA512:
   metadata.gz: !binary |-
-    MjVlOWNhMDE2MGFkZTcxODM2YWU4NWJlMDMyNjJmZmZmNzhkNjM5ZWUyMWI5
-    OGY2MWMzMDJiNTA3OWVlZGRmN2I0OTZhNmMxNDAzZGNjYTFiODhhODQxOGY1
-    ZWEwMjhmMzc1ZWIzOTdhODlhMjNiZjIwZDc3ZDM5YWZlNTA2ZGU=
+    ZWQ1NTgwOTE0MTMxY2RkN2ExMjEzN2M0MmUzZjkwODQ4MWMwODY0NzkyMDBm
+    NmNiZTNhZDRkOGJiM2Q1OGFjZGJlMWQxMGFkODA2MTg5NTg4YTQwNThhNTEx
+    Yjc5YTNlMzBlOWFlZDFjNzU3NDQxZDU2OWRlYTg3MTI5ZmExMzg=
   data.tar.gz: !binary |-
-    MmI5MGZlYWJlZDg4NzBlYjEyYzk3Nzg4ZGM0YjlmMTRkZjRjYWZiODY4NGNm
-    YmFhMWJiOTMzM2IxNmY3MGFlNzUxNmFkMTczNzQ5ZjgwYmY3YzgyNjA4YzMx
-    ZjVlYzEzYTc4MThmMWIyMDM2NzU3OWRiNmMyODkzYTc2OGZiNGU=
+    NDIwM2ZkYWZkNTZiZjJkNjVjZmY4NTZjN2VkYTI3NTY1YzhlYWZmYmY0YzI3
+    NjYwYzliNTgwMDM4NGIxZjhmMmJlMDQzYzJjNmIwZmVlN2I4ZWFmMWRkN2My
+    MzY2Y2IwMGQwM2Q4NDc5YmQ0OTYzYjg1Y2VjOWJjMmQwYTcyZjI=

data/README.md

@@ -122,6 +122,15 @@ Acfs.run # This call will fire all request as parallel as possible.
 @friends[0].name # => "Miraculix"
 ```
 
+Use `.find_by` to get first element only. `.find_by` will call the `index`-Action and return the first resource. Optionally passed params will be sent as `GET` parameters and can be used for filtering in the service's controller.
+```ruby
+@user = User.find_by age: 24
+
+Acfs.run # Will request `http://users.myapp.org/users?age=24`
+
+@user # Contains the first user object returned by the index action
+```
+
 Acfs has basic update support using `PUT` requests:
 
 ```ruby

data/lib/acfs/model/query_methods.rb

@@ -86,9 +86,35 @@ module Acfs::Model
       end
       alias :where :all
 
+      # @api public
+      #
+      # Try to load first resource.
+      #
+      # @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)
+        model = ResourceDelegator.new self.new
+
+        operation :list, params: params do |data|
+          unless data.empty?
+            model.__setobj__ create_resource data.first, origin: model.__getobj__
+          else
+            model.__setobj__ nil
+          end
+          block.call model unless block.nil?
+        end
+
+        model
+      end
+
       # TODO: Replace delegator with promise or future for the long run.
       class ResourceDelegator < SimpleDelegator
-        delegate :class, :is_a?, :kind_of?, to: :__getobj__
+        delegate :class, :is_a?, :kind_of?, :nil?, to: :__getobj__
       end
 
       private

data/lib/acfs/singleton_resource.rb

@@ -84,9 +84,11 @@ module Acfs
       # Undefined, raises NoMethodError.
       # A singleton always only returns one object, therefore the
       # methods :all and :where are not defined.
+      # :find_by is not defined on singletons, use :find instead
       #
       undef_method :all
       undef_method :where
+      undef_method :find_by
     end
   end
 end

data/spec/acfs/model/query_methods_spec.rb

@@ -162,4 +162,84 @@ describe Acfs::Model::QueryMethods do
       end
     end
   end
+
+  describe '.find_by' do
+    context 'standard resource' do
+      let(:model){ MyUser }
+
+      subject do
+        user = model.find_by age: 24
+        Acfs.run
+        user
+      end
+
+      context 'return value' do
+        subject { model.find_by age: 24 }
+
+        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([])
+
+        model.find_by age: 24
+        Acfs.run
+
+        assert_requested :get, 'http://users.example.org/users?age=24'
+      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
+
+        it 'should invoke callback after model is loaded' do
+          proc = Proc.new { }
+
+          expect(proc).to receive(:call) do |user|
+            expect(user).to eql @user.__getobj__
+            expect(user).to be_a MyUser
+            expect(user).to be_loaded
+          end
+
+          @user = model.find_by age: 24, &proc
+          Acfs.run
+        end
+
+        it 'should load a single MyUser object' do
+          expect(subject).to be_a MyUser
+        end
+      end
+
+      context 'with empty response' do
+        before do
+          stub_request(:get, 'http://users.example.org/users?age=24').to_return response([])
+        end
+
+        it { should be_nil }
+
+        it 'should invoke callback after model is loaded' do
+          proc = Proc.new { }
+
+          expect(proc).to receive(:call) do |user|
+            expect(user).to eql @user.__getobj__
+            expect(user).to be_a NilClass
+          end
+
+          @user = model.find_by age: 24, &proc
+          Acfs.run
+        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
 end

metadata

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