active_spy 1.0.0.rc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cd2e2fa1963b0d3b0245286259ecada944cbf39
+  data.tar.gz: 4b0265ce9d275414da3ae3e43da3661a5f22dfc0
+SHA512:
+  metadata.gz: 7ee7527b4f6057a9b45a3edd0587c3fcbbc33b94f0fba7cae2ac6c4b8c3b606cf277a40b5a7d13455bb02c47f293a455599ea1c5db5a3006a658aad49e0674c5
+  data.tar.gz: e533299e79224fb191e0464c19290204596adc873054654cbb834f8de3f1d494354276ac30ccb5bdecb0df949bcd044781273fe4715323b42d9e60107cebca35

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,22 @@
+source 'http://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'activesupport', '~> 4.1.2'
+gem 'rest-client', '1.6.7'
+gem 'hashie'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'activerecord', '~> 4.1.2'
+  gem 'rails', '~> 4.1.2'
+  gem 'rubocop', '~> 0.24.0'
+  gem 'pry', '~> 0.10.0'
+  gem 'rspec', '~> 3.0.0'
+  gem 'yard', '0.8.7.4'
+  gem 'rdoc', '~> 4.1.1'
+  gem 'bundler', '~> 1.6.3'
+  gem 'jeweler', '~> 2.0.1'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,177 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.1.2)
+      actionpack (= 4.1.2)
+      actionview (= 4.1.2)
+      mail (~> 2.5.4)
+    actionpack (4.1.2)
+      actionview (= 4.1.2)
+      activesupport (= 4.1.2)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.2)
+      activesupport (= 4.1.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.2)
+      activesupport (= 4.1.2)
+      builder (~> 3.1)
+    activerecord (4.1.2)
+      activemodel (= 4.1.2)
+      activesupport (= 4.1.2)
+      arel (~> 5.0.0)
+    activesupport (4.1.2)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    ast (2.0.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.1.0)
+    highline (1.6.21)
+    hike (1.2.3)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parser (2.2.0.pre.2)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    polyglot (0.3.5)
+    powerpack (0.0.9)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.2)
+      actionmailer (= 4.1.2)
+      actionpack (= 4.1.2)
+      actionview (= 4.1.2)
+      activemodel (= 4.1.2)
+      activerecord (= 4.1.2)
+      activesupport (= 4.1.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.2)
+      sprockets-rails (~> 2.0)
+    railties (4.1.2)
+      actionpack (= 4.1.2)
+      activesupport (= 4.1.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    rubocop (0.24.0)
+      json (>= 1.7.7, < 2)
+      parser (>= 2.2.0.pre.2, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.1.2)
+  activesupport (~> 4.1.2)
+  bundler (~> 1.6.3)
+  hashie
+  jeweler (~> 2.0.1)
+  pry (~> 0.10.0)
+  rails (~> 4.1.2)
+  rdoc (~> 4.1.1)
+  rest-client (= 1.6.7)
+  rspec (~> 3.0.0)
+  rubocop (~> 0.24.0)
+  simplecov
+  yard (= 0.8.7.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Douglas Camata
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# active_spy
+
+Watch for a method call in any class and run before/after callbacks.
+You can even watch your Rails models for events (like create, update,
+destroy), send these events to a event-runner instance and it redirect these
+events to other apps that are subscrived for them. This gem also provides
+classes that you can use to process the received events too.
+
+## Examples
+
+### Pure Ruby
+
+```ruby
+require 'active_spy'
+
+class Chair
+  include ActiveSpy::Spy
+
+  watch_method :break!
+
+  def initialize
+    @broken = false
+  end
+
+  def break!
+    @broken = true
+    puts 'Crack!!!'
+  end
+end
+
+class ChairEvents < ActiveSpy::Base
+
+    def before_break!
+      puts 'OMG! You are going to break the chair!'
+    end
+
+    def after_break!
+      puts 'You broke that chair, man.'
+    end
+end
+
+ActiveSpy::SpyList.activate
+Chair.new.break!
+```
+
+### Rails app
+
+First of all, run the install generator: `rails g active_spy:install`.
+This command will generate `config/initializers/active_spy.rb` and
+`config/active_spy.yml`. You must edit the YAML file to use your own app
+parameters.
+
+Then, create a `ProductEvent` class at  `RAILS_ROOT/app/events`
+
+```ruby
+class ProductEvents < ActiveSpy::Rails::Base
+end
+```
+
+Declare ActiveSpy's `model_realm`, `model_actor`, and `watch_model_changes`
+methods in the model that is being watched:
+
+```ruby
+
+class User < ActiveRecord::Base
+  belong_to :project
+  belongs_to :project_group
+
+  model_realm { :project }
+  model_actor :get_actor
+  watch_model_changes
+
+  def get_actor
+    self
+  end
+
+  # ActiveSpy's payload_for method override
+  #
+  # def payload_for(method)
+  #   { user: attributes }
+  # end
+
+  # ActiveSpy's realm method override
+  #
+  # def realm
+  #   return project_group if project_group.admin == self
+  #   project
+  # end
+end
+```
+
+You may override `payload_for(method)`, `realm` and `actor` for more complex
+use cases.
+
+Now, when you can create, update or delete instances of User, a request will be
+sent to the `event_host` and `event_port` defined in the configuration YAML file.
+The body will be filled with a hash like this, as json:
+
+```
+{
+  type:     'User',         # object's class name
+  actor:    user.actor,     # object's actor (who made that action)
+  realm:    user.realm,     # object's realm
+  action: action            # the action executed in the object
+  payload:  {
+    user: user.attributes,  # a hash with the user attributes inside the 'user'
+                            # key
+  }
+}
+```
+
+Just to remember, you can override `#realm`, `#actor` and `#payload_for(method)`
+to suit your own needs.
+
+#### Handling the request received by the event runner
+
+To handle the request received by the event-runner, you will need to mount
+the `ActiveSpy::Engine` in your `routes.rb` file:
+
+```ruby
+Rails.application.routes.draw do
+  mount ActiveSpy::Engine => 'active_spy', as: :active_spy
+end
+```
+
+Then, you need to create a listener class, inheriting from
+`ActiveSpy::Rails::Listener` and named using the watched model's name
+plus the `Listener` postfix, like this:
+
+```ruby
+class UserListener < ActiveSpy::Rails::Listener
+end
+```
+
+The default behavior will automatically try to sync the model that was sent
+with the app own database. If you need a different behavior, you can override
+the `create`, `update` and `delete` methods to match your needs:
+
+```ruby
+class UserListener < ActiveSpy::Rails::Listener
+
+  def create(object_type, payload, actor, realm)
+  end
+
+  def update(object_type, payload, actor, realm)
+  end
+
+  def destroy(object_type, payload, actor, realm)
+  end
+end
+```
+
+## Contributing to active_spy
+
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Douglas Camata. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see
+  # http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'active_spy'
+  gem.homepage = 'http://github.com/edools/active_spy'
+  gem.license = 'MIT'
+  gem.summary = <<-SUMMARY
+    Watch for a method call in any class and run before/after callbacks.
+    Has good integration with Rails.
+  SUMMARY
+  gem.description = <<-DESC
+    Watch for a method call in any class and run before/after callbacks.
+    You can even watch your Rails models for events (like create, update,
+    destroy), send these events to a event-runner instance and it redirect these
+    events to other apps that are subscrived for them. This gem also provides
+    classes that you can use to process the received events too.
+  DESC
+  gem.email = 'd.camata@gmail.com'
+  gem.authors = ['Douglas Camata']
+  gem.files = Dir['lib/**/*'] + Dir['app/**/*.rb'] + Dir['config/**/*.rb'] +
+    Dir['.document'] + Dir['README.md'] + Dir['LICENSE.txt'] + Dir['VERSION'] +
+    Dir['Rakefile'] + Dir['active_spy.gemspec'] + Dir['Gemfile*']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/active_spy/**/*_spec.rb']
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task default: :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0.rc

data/active_spy.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: active_spy 1.0.0.rc ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "active_spy"
+  s.version = "1.0.0.rc"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Douglas Camata"]
+  s.date = "2014-07-10"
+  s.description = "    Watch for a method call in any class and run before/after callbacks.\n    You can even watch your Rails models for events (like create, update,\n    destroy), send these events to a event-runner instance and it redirect these\n    events to other apps that are subscrived for them. This gem also provides\n    classes that you can use to process the received events too.\n"
+  s.email = "d.camata@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "active_spy.gemspec",
+    "app/controllers/active_event/notifications_controller.rb",
+    "config/initializers/active_event_configuration_loader.rb",
+    "config/routes.rb",
+    "lib/active_spy.rb",
+    "lib/active_spy/base.rb",
+    "lib/active_spy/configuration.rb",
+    "lib/active_spy/rails/base.rb",
+    "lib/active_spy/rails/engine.rb",
+    "lib/active_spy/rails/hook_list.rb",
+    "lib/active_spy/rails/listener.rb",
+    "lib/active_spy/rails/railtie.rb",
+    "lib/active_spy/rails/spy.rb",
+    "lib/active_spy/spy/spy.rb",
+    "lib/active_spy/spy/spy_list.rb",
+    "lib/rails/generators/active_event/install/install_generator.rb",
+    "lib/rails/generators/active_event/install/templates/active_event.yml",
+    "lib/rails/generators/active_event/install/templates/initializer.rb"
+  ]
+  s.homepage = "http://github.com/edools/active_spy"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Watch for a method call in any class and run before/after callbacks. Has good integration with Rails."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 4.1.2"])
+      s.add_runtime_dependency(%q<rest-client>, ["= 1.6.7"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 4.1.2"])
+      s.add_development_dependency(%q<rails>, ["~> 4.1.2"])
+      s.add_development_dependency(%q<rubocop>, ["~> 0.24.0"])
+      s.add_development_dependency(%q<pry>, ["~> 0.10.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<yard>, ["= 0.8.7.4"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.1.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.6.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 4.1.2"])
+      s.add_dependency(%q<rest-client>, ["= 1.6.7"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 4.1.2"])
+      s.add_dependency(%q<rails>, ["~> 4.1.2"])
+      s.add_dependency(%q<rubocop>, ["~> 0.24.0"])
+      s.add_dependency(%q<pry>, ["~> 0.10.0"])
+      s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_dependency(%q<yard>, ["= 0.8.7.4"])
+      s.add_dependency(%q<rdoc>, ["~> 4.1.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.6.3"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 4.1.2"])
+    s.add_dependency(%q<rest-client>, ["= 1.6.7"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 4.1.2"])
+    s.add_dependency(%q<rails>, ["~> 4.1.2"])
+    s.add_dependency(%q<rubocop>, ["~> 0.24.0"])
+    s.add_dependency(%q<pry>, ["~> 0.10.0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+    s.add_dependency(%q<yard>, ["= 0.8.7.4"])
+    s.add_dependency(%q<rdoc>, ["~> 4.1.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.6.3"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/app/controllers/active_event/notifications_controller.rb

@@ -0,0 +1,6 @@
+module ActiveSpy
+  class NotificationsController < ActionController::Base
+    def handle
+    end
+  end
+end

data/config/initializers/active_event_configuration_loader.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+
+yml_path = Rails.root.join('config', 'active_spy.yml')
+all_settings = YAML.load_file(yml_path)
+env_settings = Hashie::Mash.new(all_settings[Rails.env])
+
+ActiveSpy.configure do |config|
+  config.name env_settings['name']
+  config.host env_settings['host']
+  config.port env_settings['port'].to_s
+
+  config.event_host env_settings['event_host']
+  config.event_port env_settings['event_port'].to_s
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActiveSpy::Engine.routes.draw do
+  post '/notifications/:class' => 'notifications#handle', as: :notifications
+end

data/lib/active_spy/base.rb

@@ -0,0 +1,9 @@
+module ActiveSpy
+  # Default template for callbacks handlers.
+  #
+  class Base
+    def initialize(object)
+      @object = object
+    end
+  end
+end

data/lib/active_spy/configuration.rb

@@ -0,0 +1,71 @@
+module ActiveSpy
+  # Defines a class to hold the configuration used to send events.
+  #
+  class Configuration
+    class << self
+      # Set the application host
+      #
+      # @param [String] host to set
+      #
+      # @return [String] the host set
+      def host(host = nil)
+        @host = host unless host.nil?
+        @host
+      end
+
+      # Set the application port
+      #
+      # @param [String] port to set
+      #
+      # @return [String] the port set
+      def port(port = nil)
+        @port = port unless port.nil?
+        @port
+      end
+
+      # Set the application name
+      #
+      # @param [String] name to set
+      #
+      # @return [String] the name set
+      def name(name = nil)
+        @name = name unless name.nil?
+        @name
+      end
+
+      # Set the default event-runner host
+      #
+      # @param [String] host to set
+      #
+      # @return [String] the host set
+      def event_host(host = nil)
+        @event_host = host unless host.nil?
+        @event_host
+      end
+
+      # Set the default event-runner port
+      #
+      # @param [String] port to set
+      #
+      # @return [String] the port set
+      def event_port(port = nil)
+        @event_port = port unless port.nil?
+        @event_port
+      end
+
+      # See how are the settings
+      #
+      # @return [Hash] actual settings
+      def settings
+        { name: @name, hostname: @host, port: @port }
+      end
+
+      # See how are the event settings
+      #
+      # @return [Hash] actual event settings
+      def event_settings
+        { host: @event_host, port: @event_port }
+      end
+    end
+  end
+end