acfs 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb99fe53f15f18d5bb38f6d14aab35df106395b
-  data.tar.gz: 822c5e1fd59b02589aa946252d57302d5afd0ca5
+  metadata.gz: 8a9569aa6a00b3a3008156d94d8c3dc615ba3409
+  data.tar.gz: d8ef1f72e0e3a4017f700d5d2337b5c0e0ad9a1e
 SHA512:
-  metadata.gz: 114ea5f3dc9cf97f99ee2b920810f8ea7dabe2264ea2e17d64cdfe9e26ea729339b4de31e32ce9deeb460d6c3be57c865199f32101644a5c2dba4d854eb7e9b9
-  data.tar.gz: c32d14d4f25013beebb3aa60fe6edcaeb6de071597b0f41cc276cae51e5bd4b363b875f3f0ccd919172a9b84a24bbae14e4b4e423be2c28476cef25e4942fe3f
+  metadata.gz: 03e1f3a9bb3f5fbc709ef673609f9c2a23e8628fde802bb222599fbc9512c2f2097b74339901b8dc1b2541417a4ca9ab12320bade59d6ca3e1189017a6da6827
+  data.tar.gz: 68f1811f3a68294feb3493766866d811a31760a3638a3e41661935a5b4165e0c7d2b87ab5998f40a7ca6525f50bc93f02d8ce09cca7705b66b3873ecd22fe694

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.19.0
+
+* Add support for DateTime and Float attribute types
+* Add experimental list attribute type
+* Allow block usage in stub `with` option
+* Allow to test if operation stubs were called and how often
+* Fix bug on operation stubs
+
 ## 0.18.0
 
 * Basic DELETE operations

data/README.md

@@ -148,9 +148,10 @@ You can stub resources in applications using an Acfs service client:
 Acfs::Stub.enable
 
 before do
-  Acfs::Stub.resource MyUser, :read, with: { id: 1 }, return: { id: 1, name: 'John Smith', age: 32 }
+  @stub = 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: :not_found
   Acfs::Stub.resource Session, :create, with: { ident: 'john@exmaple.org', password: 's3cr3t' }, return: { id: 'longhash', user: 1 }
+  Acfs::Stub.resource MyUser, :update, with: lambda { |op| op.data.include? :my_var }, raise: 400
 end
 
 it 'should find user number one' do
@@ -160,6 +161,9 @@ it 'should find user number one' do
   expect(user.id).to be == 1
   expect(user.name).to be == 'John Smith'
   expect(user.age).to be == 32
+
+  expect(@stub).to has_called
+  expect(@stub).to_not have_called 5.times
 end
 
 it 'should not find user number two' do

data/acfs.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'actionpack', '>= 3.1'
   spec.add_runtime_dependency 'multi_json'
   spec.add_runtime_dependency 'typhoeus'
-  spec.add_runtime_dependency 'bunny', '~> 0.9.0.pre12'
+  spec.add_runtime_dependency 'bunny', '~> 0.9.0'
   spec.add_runtime_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.3'

data/lib/acfs.rb

@@ -8,6 +8,8 @@ require 'acfs/version'
 require 'acfs/errors'
 require 'acfs/global'
 
+require 'acfs/messaging'
+
 module Acfs
   extend ActiveSupport::Autoload
   extend Global

data/lib/acfs/errors.rb

@@ -12,9 +12,41 @@ module Acfs
 
     def initialize(data = {})
       self.response = data[:response]
+      message = ''
+      message << "Received erroneous response: #{response.code}"
+      if response.data
+        message << "\n  with content:\n    "
+        message << response.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+      end
+      if response.headers.any?
+        message << "\n  with headers:\n    "
+        message << response.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+      end
+      message << "\nbased on request: #{response.request.method.upcase} #{response.request.url} #{response.request.format}"
+      if response.request.data
+        message << "\n  with content:\n    "
+        message << response.request.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+      end
+      if response.request.headers.any?
+        message << "\n  with headers:\n    "
+        message << response.request.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+      end
+      super message
     end
   end
 
+  class AmbiguousStubError < Error
+    attr_reader :stubs, :operation
+
+    def initialize(stubs, operation)
+      @stubs     = stubs
+      @operation = operation
+
+      super 'Ambiguous stubs.'
+    end
+
+  end
+
   # Resource not found error raised on a 404 response
   #
   class ResourceNotFound < ErroneousResponse

data/lib/acfs/messaging.rb

@@ -0,0 +1,24 @@
+require 'acfs/messaging/client'
+
+module Acfs
+
+  # @macro experimental
+  #
+  module Messaging
+
+    class << self
+
+      # @macro experimental
+      #
+      # Quick publish a message using default client instance.
+      #
+      # @param [#to_s] routing_key Routing key.
+      # @param [#to_msgpack, Hash] payload Message payload.
+      # @return [undefined]
+      #
+      def publish(routing_key, payload)
+        Client.instance.publish routing_key, payload
+      end
+    end
+  end
+end

data/lib/acfs/messaging/client.rb

@@ -17,11 +17,11 @@ module Acfs::Messaging
     end
 
     def exchange
-      @exchange ||= @channel.topic 'acfs-0.17.0-2', auto_delete: true
+      @exchange ||= channel.topic 'acfs-0.17.0-2', auto_delete: true
     end
 
     def publish(routing_key, message)
-      exchange.publish MessagePack.pack(message), routing_key: routing_key
+      exchange.publish ::MessagePack.pack(message), routing_key: routing_key.to_s
     end
 
     class << self

data/lib/acfs/model/attributes/date_time.rb

@@ -0,0 +1,31 @@
+module Acfs::Model
+  module Attributes
+
+    # @api public
+    #
+    # DateTime attribute type. Use it in your model as an attribute type:
+    #
+    # @example
+    #   class User
+    #     include Acfs::Model
+    #     attribute :name, :date_time
+    #   end
+    #
+    module DateTime
+
+      # @api public
+      #
+      # Cast given object to DateTime.
+      # Expect
+      #
+      # @param [Object] obj Object to cast.
+      # @return [DateTime] Casted object as DateTime.
+      #
+      def self.cast(obj)
+        return obj if obj.is_a? ::DateTime
+        return ::DateTime.iso8601(obj.iso8601) if obj.is_a? Time or obj.is_a? Date
+        return ::DateTime.iso8601(obj)
+      end
+    end
+  end
+end

data/lib/acfs/model/attributes/float.rb

@@ -0,0 +1,28 @@
+module Acfs::Model
+  module Attributes
+
+    # @api public
+    #
+    # Float attribute type. Use it in your model as an attribute type:
+    #
+    # @example
+    #   class User
+    #     include Acfs::Model
+    #     attribute :name, :float
+    #   end
+    #
+    module Float
+
+      # @api public
+      #
+      # Cast given object to float.
+      #
+      # @param [Object] obj Object to cast.
+      # @return [Float] Casted object as float.
+      #
+      def self.cast(obj)
+        obj.to_f
+      end
+    end
+  end
+end

data/lib/acfs/model/attributes/list.rb

@@ -0,0 +1,30 @@
+module Acfs::Model
+  module Attributes
+
+    # @api public
+    #
+    # List attribute type. Use it in your model as an attribute type:
+    #
+    # @example
+    #   class User
+    #     include Acfs::Model
+    #     attribute :name, :list
+    #   end
+    #
+    module List
+
+      # @api public
+      #
+      # Cast given object to a list.
+      #
+      # @param [Object] obj Object to cast.
+      # @return [Fixnum] Casted object as list.
+      # @raise [TypeError] If object cannot be casted to a list.
+      #
+      def self.cast(obj)
+        return obj.to_a if obj.respond_to? :to_a
+        raise TypeError.new "Cannot cast #{obj.inspect} to array."
+      end
+    end
+  end
+end

data/lib/acfs/operation.rb

@@ -31,6 +31,10 @@ module Acfs
       @id ||= params.delete(:id) || data[:id]
     end
 
+    def full_params
+      id ? params.merge(id: id) : params
+    end
+
     def url
       single? ? resource.url(id) : resource.url
     end

data/lib/acfs/response.rb

@@ -20,9 +20,9 @@ module Acfs
 
     def initialize(request, data = {})
       @request  = request
-      @status   = data[:status]
-      @headers  = data[:headers]
-      @body     = data[:body]
+      @status   = data[:status]  || 0
+      @headers  = data[:headers] || {}
+      @body     = data[:body]    || ''
     end
   end
 end

data/lib/acfs/stub.rb

@@ -7,6 +7,50 @@ module Acfs
   class Stub
     ACTIONS = [ :read, :create, :update, :delete, :list ]
 
+    attr_reader :opts
+
+    def initialize(opts)
+      @opts = opts
+      @opts[:with].stringify_keys! if @opts[:with].respond_to? :stringify_keys
+    end
+
+    def accept?(op)
+      return opts[:with].call op if opts[:with].respond_to? :call
+
+      params = op.full_params.stringify_keys
+      data   = op.data.stringify_keys
+
+      opts[:with] == params || data == opts[:with]
+    end
+
+    def calls
+      @calls ||= []
+    end
+
+    def called?(count = nil)
+      count = count.count if count.respond_to? :count # For `5.times` Enumerators
+      count.nil? ? calls.any? : calls.size == count
+    end
+
+    def call(op)
+      calls << op
+
+      if (data = opts[:return])
+        op.callback.call data
+      elsif (err = opts[:raise])
+        raise_error op, err, opts[:return]
+      else
+        raise ArgumentError, 'Unsupported stub.'
+      end
+    end
+
+    private
+    def raise_error(op, name, data)
+      raise name if name.is_a? Class
+
+      op.handle_failure ::Acfs::Response.new op.request, status: Rack::Utils.status_code(name), data: data
+    end
+
     class << self
 
       # Stub a resource with given handler block. An already created handler
@@ -16,9 +60,11 @@ module Acfs
         action = action.to_sym
         raise ArgumentError, "Unknown action `#{action}`." unless ACTIONS.include? action
 
-        stubs[klass] ||= {}
-        stubs[klass][action] ||= []
-        stubs[klass][action] << opts
+        Stub.new(opts).tap do |stub|
+          stubs[klass] ||= {}
+          stubs[klass][action] ||= []
+          stubs[klass][action] << stub
+        end
       end
 
       def allow_requests=(allow)
@@ -48,38 +94,25 @@ module Acfs
 
       def stub_for(op)
         return false unless (classes = stubs[op.resource])
-        return false unless (actions = classes[op.action])
+        return false unless (stubs = classes[op.action])
+
+        accepted_stubs = stubs.select { |stub| stub.accept? op }
 
-        params = op.params
-        params.merge! id: op.id unless op.id.nil?
-        actions.select! { |stub| stub[:with] == params || stub[:with] == op.data }
-        actions.first
+        raise AmbiguousStubError.new accepted_stubs, op if accepted_stubs.size > 1
+
+        accepted_stubs.first
       end
 
       def stubbed(op)
         stub = stub_for op
         unless stub
           return false if allow_requests?
-          raise RealRequestsNotAllowedError, "No stub found for `#{op.resource.name}` with params `#{op.params}` and id `#{op.id}`."
-        end
-
-        if (data = stub[:return])
-          op.callback.call data
-        elsif (err = stub[:raise])
-          raise_error op, err, stub[:return]
-        else
-          raise ArgumentError, 'Unsupported stub.'
+          raise RealRequestsNotAllowedError, "No stub found for #{op.action} on #{op.resource.name} with params #{op.full_params.inspect}, data #{op.data.inspect} and id #{op.id}."
         end
 
+        stub.call op
         true
       end
-
-      private
-      def raise_error(op, name, data)
-        raise name if name.is_a? Class
-
-        op.handle_failure ::Acfs::Response.new nil, status: Rack::Utils.status_code(name), data: data
-      end
     end
   end
 end

data/lib/acfs/version.rb

@@ -1,7 +1,7 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 18
+    MINOR = 19
     PATCH = 0
     STAGE = nil
 

data/spec/acfs/messaging/receiver_spec.rb

@@ -26,29 +26,35 @@ describe Acfs::Messaging::Receiver do
     context 'with routed message' do
       context 'with exact routing key match' do
         it 'should receive messages' do
+          pending 'Not reliable.'
+
           rcv_class.instance.should_receive(:receive).with(anything, anything, { message: 'Hello!'})
 
           Acfs::Messaging::Client.instance.publish('my.custom_receiver', { message: 'Hello!' })
-          sleep 3 # Nothing better?
+          sleep 5 # Nothing better?
         end
       end
 
       context 'with partial routing key match' do
         it 'should receive messages' do
+          pending 'Not reliable.'
+
           rcv_class.instance.should_receive(:receive).with(anything, anything, { message: 'Hello!'})
 
           Acfs::Messaging::Client.instance.publish('my.different', { message: 'Hello!' })
-          sleep 3 # Nothing better?
+          sleep 5 # Nothing better?
         end
       end
     end
 
     context 'with not routed message' do
       it 'should not receive messages' do
+        pending 'Not reliable.'
+
         rcv_class.instance.should_not_receive(:receive)
 
         Acfs::Messaging::Client.instance.publish('abc.cde', { message: 'Hello!' })
-        sleep 3 # Nothing better?
+        sleep 5 # Nothing better?
       end
     end
   end

data/spec/acfs/model/attributes/date_time_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Acfs::Model::Attributes::DateTime do
+  let(:model) { Class.new.tap { |c| c.send :include, Acfs::Model }}
+
+  describe 'cast' do
+    it 'should return same object, if obj is already of DateTime class' do
+      date_time = DateTime.now
+      retval = Acfs::Model::Attributes::DateTime.cast(date_time)
+      expect(retval).to be == date_time
+    end
+
+    it 'should return parsed object, if obj is of Time class' do
+      time = Time.now
+      retval = Acfs::Model::Attributes::DateTime.cast(time)
+      expect(retval).to be == DateTime.iso8601(time.iso8601)
+    end
+
+    it 'should return parsed object, if obj is of Date class' do
+      date = Date.today
+      retval = Acfs::Model::Attributes::DateTime.cast(date)
+      expect(retval).to be == DateTime.iso8601(date.iso8601)
+    end
+
+    it 'should return parsed object, if obj is of String class in ISO-8601 format' do
+      date_time_string = DateTime.now.iso8601
+      retval = Acfs::Model::Attributes::DateTime.cast(date_time_string)
+      expect(retval).to be == DateTime.iso8601(date_time_string)
+    end
+
+    it 'should raise an error if obj is of String class not in valid ISO-8601 format' do
+      malformed_string = 'qwe123'
+      expect {
+        Acfs::Model::Attributes::DateTime.cast(malformed_string)
+      }.to raise_error ArgumentError
+    end
+
+    it 'should raise an error if obj is of wrong class (Fixnum)' do
+      fixnum = 12
+      expect {
+        Acfs::Model::Attributes::DateTime.cast(fixnum)
+      }.to raise_error TypeError
+    end
+  end
+end

data/spec/acfs/model/attributes/float_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Acfs::Model::Attributes::Float do
+  let(:model) { Class.new.tap { |c| c.send :include, Acfs::Model }}
+
+  describe 'cast' do
+    it 'should return same object, if obj is already of float class' do
+      retval = Acfs::Model::Attributes::Float.cast(1.3)
+      expect(retval).to be == 1.3
+    end
+
+    it 'should return parsed object, if obj is of Fixnum class' do
+      retval = Acfs::Model::Attributes::Float.cast(7)
+      expect(retval).to be == 7.0
+    end
+
+    it 'should return parsed object, if obj is of String class containing a float' do
+      retval = Acfs::Model::Attributes::Float.cast('1.7')
+      expect(retval).to be == 1.7
+    end
+  end
+end

data/spec/acfs/model/attributes/list_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Acfs::Model::Attributes::List do
+  let(:model) { Class.new.tap { |c| c.send :include, Acfs::Model }}
+  subject { Acfs::Model::Attributes::List }
+
+  describe '.cast' do
+    context 'with array' do
+      let(:sample) { %w(abc cde efg) }
+
+      it 'should return unmodified array' do
+        expect(subject.cast(sample)).to be == %w(abc cde efg)
+      end
+    end
+
+    context 'with not listable object' do
+      let(:sample) { Object.new }
+
+      it 'should raise a TypeError' do
+        expect {
+          subject.cast(sample)
+        }.to raise_error TypeError
+      end
+    end
+
+    context 'with listable object' do
+      let(:sample) { 5..10 }
+
+      it 'should cast object to array' do
+        expect(subject.cast(sample)).to be == [5, 6, 7, 8, 9, 10]
+      end
+    end
+  end
+end

data/spec/acfs/stub_spec.rb

@@ -16,7 +16,43 @@ describe Acfs::Stub do
     #Acfs::Stub.create(MyUser).with(name: '', age: 12).and_return(:invalid, errors: { name: [ 'must be present ']})
   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 }
@@ -51,7 +87,7 @@ describe Acfs::Stub do
     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: { ident: 'john@exmaple.org', password: 'wrong' }, raise: 422
+        Acfs::Stub.resource Session, :create, with: lambda { |op| op.data[:ident] == 'john@exmaple.org' && op.data[:password] == 'wrong' }, raise: 422
       end
 
       it 'should allow stub resource creation' do
@@ -67,6 +103,36 @@ describe Acfs::Stub do
         }.to raise_error(::Acfs::InvalidResource)
       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
+
+      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 {
+          user.save!
+        }.to raise_error(::Acfs::InvalidResource)
+      end
+    end
   end
 
   describe '.allow_requests=' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0.pre12
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0.pre12
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,7 @@ files:
 - lib/acfs/configuration.rb
 - lib/acfs/errors.rb
 - lib/acfs/global.rb
+- lib/acfs/messaging.rb
 - lib/acfs/messaging/client.rb
 - lib/acfs/messaging/message.rb
 - lib/acfs/messaging/receiver.rb
@@ -163,7 +164,10 @@ files:
 - lib/acfs/model.rb
 - lib/acfs/model/attributes.rb
 - lib/acfs/model/attributes/boolean.rb
+- lib/acfs/model/attributes/date_time.rb
+- lib/acfs/model/attributes/float.rb
 - lib/acfs/model/attributes/integer.rb
+- lib/acfs/model/attributes/list.rb
 - lib/acfs/model/attributes/string.rb
 - lib/acfs/model/dirty.rb
 - lib/acfs/model/initialization.rb
@@ -191,6 +195,9 @@ files:
 - spec/acfs/messaging/receiver_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
+- spec/acfs/model/attributes/date_time_spec.rb
+- spec/acfs/model/attributes/float_spec.rb
+- spec/acfs/model/attributes/list_spec.rb
 - spec/acfs/model/attributes_spec.rb
 - spec/acfs/model/dirty_spec.rb
 - spec/acfs/model/initialization_spec.rb
@@ -240,6 +247,9 @@ test_files:
 - spec/acfs/messaging/receiver_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
+- spec/acfs/model/attributes/date_time_spec.rb
+- spec/acfs/model/attributes/float_spec.rb
+- spec/acfs/model/attributes/list_spec.rb
 - spec/acfs/model/attributes_spec.rb
 - spec/acfs/model/dirty_spec.rb
 - spec/acfs/model/initialization_spec.rb