acfs 0.34.1.1.b289 → 0.35.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzMwYWExMzE2YWUwZmUwNGYwZWJjMThhZjBjYjY3MWFhMWM4ZTViOQ==
-  data.tar.gz: !binary |-
-    ZjMzOWUzMDZlMTM1YzFhNDM1N2RiMTIwYjA3MDVlOTFmY2RlMjUxYw==
+SHA1:
+  metadata.gz: 919254c61d25773af3b9b6c1934ed6c3408de728
+  data.tar.gz: bf6c875f6f333afbc41e1c7fd5437825f071e6e4
 SHA512:
-  metadata.gz: !binary |-
-    NDM0ZGRiZGJjODc3ZjA0ODMzNTFjNjI1YWJjZjcyYjI3N2ExM2YwMjg3MzVh
-    OGFiNjQ4N2JkYmM3NTg0MTA5Y2I1ZmVlMGRiMTE1ODViMThlOGM3OGY3OWVi
-    MjY0M2U3MGYwOGI5ZjA5YWU4OWVlZWNjYzIzZmM5NWFiZmZlMWY=
-  data.tar.gz: !binary |-
-    NGNkZmM1OTRjZjgxZTFiN2Y1YWVkNjE1NmM3NTk3MTVkOGU5ZjFlM2VmMGJi
-    YjJmZjE3NjcyZjU5YjdkMGUzNDFkODUwNWU3NTRkYWI4ZWY1NDQ0Y2ExNjBl
-    YTA3MjMwODg4ZmYyNmZmNzI5MjFiZTUwMzA3YWVlMzM0OWUzMGQ=
+  metadata.gz: 35a9773eab8ad35f27cc8b2cc16958cbc54183a83da2fcc3d1af0b9849d7d04e797973c277b3b9a4bb95c71d8521701bbef2a1faf80391051951eddeccbca406
+  data.tar.gz: 892a2af5af7b42eaca158bd41a49485bd9a2aef2e81bcd9e100b3f1e0fdd1a097d2ec47943fa5b96cb5352debca86fdbac672bd9756314b8c3d3ccdda1b62df7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.35.0
+
+* Add instrumentation support
+
 ## 0.34.1
 
 * Fix leaking failed requests in request queues

data/README.md

@@ -282,6 +282,23 @@ it 'should find user number one' do
 end
 ```
 
+## Instrumentation
+
+Acfs supports [instrumentation via active support][1].
+
+Acfs expose to following events
+
+* `acfs.operation.complete(operation, response)`: Acfs operation completed
+* `acfs.runner.sync_run(operation)`: Run operation right now skipping queue.
+* `acfs.runner.enqueue(operation)`: Enqueue operation to be run later.
+* `acfs.before_run`: directly before `acfs.run`
+* `acfs.run`: Run all queued operations.
+
+Read [official guide][2] to see to to subscribe.
+
+[1]: http://guides.rubyonrails.org/active_support_instrumentation.html
+[2]: http://guides.rubyonrails.org/active_support_instrumentation.html#subscribing-to-an-event
+
 ## Roadmap
 
 * Update
@@ -313,6 +330,7 @@ end
 
 * [Nicolas Fricke](https://github.com/nicolas-fricke)
 * [Tino Junge](https://github.com/tino-junge)
+* [Malte Swart](https://github.com/mswart)
 
 ## License
 

data/lib/acfs.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/class'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module'
+require 'active_support/notifications'
 
 module Acfs
   extend ActiveSupport::Autoload

data/lib/acfs/global.rb

@@ -18,7 +18,10 @@ module Acfs
     # @return [undefined]
     #
     def run
-      runner.start
+      ::ActiveSupport::Notifications.instrument 'acfs.before_run'
+      ::ActiveSupport::Notifications.instrument 'acfs.run' do
+        runner.start
+      end
     end
 
     # @api public
@@ -37,8 +40,10 @@ module Acfs
     # Reset all queues, stubs and internal state.
     #
     def reset
-      self.runner.clear
-      Acfs::Stub.clear
+      ::ActiveSupport::Notifications.instrument 'acfs.reset' do
+        self.runner.clear
+        Acfs::Stub.clear
+      end
     end
 
     # @api public

data/lib/acfs/operation.rb

@@ -57,6 +57,10 @@ module Acfs
     def request
       request = ::Acfs::Request.new url, method: method, params: params, data: data
       request.on_complete do |response|
+        ::ActiveSupport::Notifications.instrument 'acfs.operation.complete',
+                                                  operation: self,
+                                                  response: response
+
         handle_failure response unless response.success?
         callback.call response.data, response
       end

data/lib/acfs/runner.rb

@@ -23,7 +23,9 @@ module Acfs
     # Run operation right now skipping queue.
     #
     def run(op)
-      op_request(op) { |req| adapter.run req }
+      ::ActiveSupport::Notifications.instrument 'acfs.runner.sync_run', operation: op do
+        op_request(op) { |req| adapter.run req }
+      end
     end
 
     # List of current queued operations.
@@ -35,10 +37,12 @@ module Acfs
     # Enqueue operation to be run later.
     #
     def enqueue(op)
-      if running?
-        op_request(op) { |req| adapter.queue req }
-      else
-        queue << op
+      ::ActiveSupport::Notifications.instrument 'acfs.runner.enqueue', operation: op do
+        if running?
+          op_request(op) { |req| adapter.queue req }
+        else
+          queue << op
+        end
       end
     end
 

data/lib/acfs/version.rb

@@ -1,8 +1,8 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 34
-    PATCH = 1
+    MINOR = 35
+    PATCH = 0
     STAGE = nil
 
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')

data/spec/acfs/global_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class NotificationCollector
+  def call(*args)
+    events << ActiveSupport::Notifications::Event.new(*args)
+  end
+
+  def events
+    @events ||= []
+  end
+end
+
+describe ::Acfs::Global do
+  let(:adapter) { ::NullAdapter.new }
+  let(:runner) { double 'runner' }
+  let(:collector) { NotificationCollector.new }
+  let(:acfs) { Object.new.tap { |o| o.extend ::Acfs::Global } }
+
+  describe 'instrumentation' do
+    before do
+      #allow(runner).to receive(:start)
+      allow(acfs).to receive(:runner).and_return runner
+    end
+
+    describe '#run' do
+      before do
+        ::ActiveSupport::Notifications.subscribe 'acfs.run', collector
+      end
+      it 'should trigger event' do
+        Acfs.run
+        expect(collector.events).to have(1).items
+      end
+    end
+
+    describe '#reset' do
+      before do
+        ::ActiveSupport::Notifications.subscribe 'acfs.reset', collector
+      end
+      it 'should trigger event' do
+        Acfs.reset
+        expect(collector.events).to have(1).items
+      end
+    end
+  end
+end

data/spec/acfs/runner_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+class NullAdapter < Acfs::Adapter::Base
+
+  # Start processing queued requests.
+  #
+  def start
+  end
+
+  # Abort running and queued requests.
+  #
+  def abort
+  end
+
+  # Run request right now skipping queue.
+  #
+  def run(_)
+  end
+
+  # Enqueue request to be run later.
+  #
+  def queue(_)
+  end
+end
+
+class NotificationCollector
+  def call(*args)
+    events << ActiveSupport::Notifications::Event.new(*args)
+  end
+
+  def events
+    @events ||= []
+  end
+end
+
+describe ::Acfs::Runner do
+  let(:adapter) { ::NullAdapter.new }
+  let(:runner) { ::Acfs::Runner.new adapter }
+  let(:collector) { NotificationCollector.new }
+
+  after do
+    ::ActiveSupport::Notifications.notifier = \
+      ::ActiveSupport::Notifications::Fanout.new
+  end
+
+  describe '#instrumentation' do
+    before do
+      ::ActiveSupport::Notifications.subscribe /^acfs\.runner/, collector
+    end
+
+    describe '#process' do
+      it 'should trigger event' do
+        runner.process ::Acfs::Operation.new MyUser, :read, params: {id: 0}
+        expect(collector.events).to have(1).items
+      end
+    end
+
+    describe '#run' do
+      it 'should trigger event' do
+        runner.run ::Acfs::Operation.new MyUser, :read, params: {id: 0}
+        expect(collector.events).to have(1).items
+      end
+    end
+
+    describe '#enqueue' do
+      it 'should trigger event' do
+        runner.run ::Acfs::Operation.new MyUser, :read, params: {id: 0}
+        expect(collector.events).to have(1).items
+      end
+    end
+  end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.34.1.1.b289
+  version: 0.35.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.5
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -116,93 +116,95 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE
-- README.md
 - acfs.gemspec
-- lib/acfs.rb
+- lib/acfs/service.rb
+- lib/acfs/global.rb
+- lib/acfs/util.rb
+- lib/acfs/resource.rb
 - lib/acfs/adapter/base.rb
 - lib/acfs/adapter/typhoeus.rb
-- lib/acfs/collection.rb
-- lib/acfs/collections/paginatable.rb
-- lib/acfs/configuration.rb
-- lib/acfs/errors.rb
-- lib/acfs/global.rb
-- lib/acfs/location.rb
-- lib/acfs/middleware/base.rb
+- lib/acfs/stub.rb
+- lib/acfs/middleware/print.rb
+- lib/acfs/middleware/msgpack_encoder.rb
+- lib/acfs/middleware/logger.rb
 - lib/acfs/middleware/json_decoder.rb
+- lib/acfs/middleware/base.rb
 - lib/acfs/middleware/json_encoder.rb
-- lib/acfs/middleware/logger.rb
 - lib/acfs/middleware/msgpack_decoder.rb
-- lib/acfs/middleware/msgpack_encoder.rb
-- lib/acfs/middleware/print.rb
+- lib/acfs/collection.rb
+- lib/acfs/singleton_resource.rb
+- lib/acfs/runner.rb
+- lib/acfs/rspec.rb
+- lib/acfs/configuration.rb
+- lib/acfs/location.rb
 - lib/acfs/model.rb
-- lib/acfs/model/attributes.rb
-- lib/acfs/model/attributes/base.rb
+- lib/acfs/response.rb
+- lib/acfs/request/callbacks.rb
+- lib/acfs/errors.rb
+- lib/acfs/operation.rb
+- lib/acfs/request.rb
+- lib/acfs/version.rb
+- lib/acfs/response/status.rb
+- lib/acfs/response/formats.rb
+- lib/acfs/service/middleware.rb
+- lib/acfs/yard.rb
+- lib/acfs/model/query_methods.rb
+- lib/acfs/model/service.rb
 - lib/acfs/model/attributes/boolean.rb
-- lib/acfs/model/attributes/date_time.rb
+- lib/acfs/model/attributes/string.rb
+- lib/acfs/model/attributes/uuid.rb
 - lib/acfs/model/attributes/float.rb
+- lib/acfs/model/attributes/base.rb
 - lib/acfs/model/attributes/integer.rb
 - lib/acfs/model/attributes/list.rb
-- lib/acfs/model/attributes/string.rb
-- lib/acfs/model/attributes/uuid.rb
-- lib/acfs/model/dirty.rb
+- lib/acfs/model/attributes/date_time.rb
 - lib/acfs/model/initialization.rb
-- lib/acfs/model/loadable.rb
+- lib/acfs/model/attributes.rb
 - lib/acfs/model/locatable.rb
-- lib/acfs/model/operational.rb
 - lib/acfs/model/persistence.rb
-- lib/acfs/model/query_methods.rb
-- lib/acfs/model/relations.rb
-- lib/acfs/model/service.rb
 - lib/acfs/model/validation.rb
-- lib/acfs/operation.rb
-- lib/acfs/request.rb
-- lib/acfs/request/callbacks.rb
-- lib/acfs/resource.rb
-- lib/acfs/response.rb
-- lib/acfs/response/formats.rb
-- lib/acfs/response/status.rb
-- lib/acfs/rspec.rb
-- lib/acfs/runner.rb
-- lib/acfs/service.rb
-- lib/acfs/service/middleware.rb
-- lib/acfs/singleton_resource.rb
-- lib/acfs/stub.rb
-- lib/acfs/util.rb
-- lib/acfs/version.rb
-- lib/acfs/yard.rb
-- spec/acfs/adapter/typhoeus_spec.rb
+- lib/acfs/model/loadable.rb
+- lib/acfs/model/dirty.rb
+- lib/acfs/model/relations.rb
+- lib/acfs/model/operational.rb
+- lib/acfs/collections/paginatable.rb
+- lib/acfs.rb
+- README.md
+- LICENSE
 - spec/acfs/collection_spec.rb
-- spec/acfs/configuration_spec.rb
-- spec/acfs/middleware/json_decoder_spec.rb
+- spec/acfs/global_spec.rb
+- spec/acfs/adapter/typhoeus_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
+- spec/acfs/middleware/json_decoder_spec.rb
+- spec/acfs/runner_spec.rb
+- spec/acfs/configuration_spec.rb
+- spec/acfs/service_spec.rb
+- spec/acfs/stub_spec.rb
+- spec/acfs/request/callbacks_spec.rb
+- spec/acfs/response/formats_spec.rb
+- spec/acfs/response/status_spec.rb
+- spec/acfs/service/middleware_spec.rb
+- spec/acfs/singleton_resource_spec.rb
+- spec/acfs/request_spec.rb
+- spec/acfs/model/locatable_spec.rb
+- spec/acfs/model/attributes/float_spec.rb
 - spec/acfs/model/attributes/boolean_spec.rb
+- spec/acfs/model/attributes/uuid_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/uuid_spec.rb
-- spec/acfs/model/attributes_spec.rb
-- spec/acfs/model/dirty_spec.rb
+- spec/acfs/model/persistance_spec.rb
 - spec/acfs/model/initialization_spec.rb
 - spec/acfs/model/loadable_spec.rb
-- spec/acfs/model/locatable_spec.rb
-- spec/acfs/model/persistance_spec.rb
-- spec/acfs/model/query_methods_spec.rb
 - spec/acfs/model/validation_spec.rb
-- spec/acfs/request/callbacks_spec.rb
-- spec/acfs/request_spec.rb
-- spec/acfs/response/formats_spec.rb
-- spec/acfs/response/status_spec.rb
-- spec/acfs/service/middleware_spec.rb
-- spec/acfs/service_spec.rb
-- spec/acfs/singleton_resource_spec.rb
-- spec/acfs/stub_spec.rb
-- spec/acfs_spec.rb
-- spec/fixtures/config.yml
-- spec/spec_helper.rb
-- spec/support/response.rb
+- spec/acfs/model/attributes_spec.rb
+- spec/acfs/model/query_methods_spec.rb
+- spec/acfs/model/dirty_spec.rb
 - spec/support/service.rb
 - spec/support/shared/find_callbacks.rb
+- spec/support/response.rb
+- spec/spec_helper.rb
+- spec/fixtures/config.yml
+- spec/acfs_spec.rb
 homepage: https://github.com/jgraichen/acfs
 licenses:
 - MIT
@@ -213,50 +215,53 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: An abstract API base client for service oriented application.
 test_files:
-- spec/acfs/adapter/typhoeus_spec.rb
 - spec/acfs/collection_spec.rb
-- spec/acfs/configuration_spec.rb
-- spec/acfs/middleware/json_decoder_spec.rb
+- spec/acfs/global_spec.rb
+- spec/acfs/adapter/typhoeus_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
+- spec/acfs/middleware/json_decoder_spec.rb
+- spec/acfs/runner_spec.rb
+- spec/acfs/configuration_spec.rb
+- spec/acfs/service_spec.rb
+- spec/acfs/stub_spec.rb
+- spec/acfs/request/callbacks_spec.rb
+- spec/acfs/response/formats_spec.rb
+- spec/acfs/response/status_spec.rb
+- spec/acfs/service/middleware_spec.rb
+- spec/acfs/singleton_resource_spec.rb
+- spec/acfs/request_spec.rb
+- spec/acfs/model/locatable_spec.rb
+- spec/acfs/model/attributes/float_spec.rb
 - spec/acfs/model/attributes/boolean_spec.rb
+- spec/acfs/model/attributes/uuid_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/uuid_spec.rb
-- spec/acfs/model/attributes_spec.rb
-- spec/acfs/model/dirty_spec.rb
+- spec/acfs/model/persistance_spec.rb
 - spec/acfs/model/initialization_spec.rb
 - spec/acfs/model/loadable_spec.rb
-- spec/acfs/model/locatable_spec.rb
-- spec/acfs/model/persistance_spec.rb
-- spec/acfs/model/query_methods_spec.rb
 - spec/acfs/model/validation_spec.rb
-- spec/acfs/request/callbacks_spec.rb
-- spec/acfs/request_spec.rb
-- spec/acfs/response/formats_spec.rb
-- spec/acfs/response/status_spec.rb
-- spec/acfs/service/middleware_spec.rb
-- spec/acfs/service_spec.rb
-- spec/acfs/singleton_resource_spec.rb
-- spec/acfs/stub_spec.rb
-- spec/acfs_spec.rb
-- spec/fixtures/config.yml
-- spec/spec_helper.rb
-- spec/support/response.rb
+- spec/acfs/model/attributes_spec.rb
+- spec/acfs/model/query_methods_spec.rb
+- spec/acfs/model/dirty_spec.rb
 - spec/support/service.rb
 - spec/support/shared/find_callbacks.rb
+- spec/support/response.rb
+- spec/spec_helper.rb
+- spec/fixtures/config.yml
+- spec/acfs_spec.rb
+has_rdoc: