active_spy 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd704eba64b7ad9be006ae4589345b8b9ff82506
-  data.tar.gz: 71563505e25eefc826a221fb41d38bb12ee64bf7
+  metadata.gz: 60c31bd6d9203cda5c3e771fe53fd1963562ba19
+  data.tar.gz: 3fa992ecbb2b3b5d255776df58890f0eccc4cafd
 SHA512:
-  metadata.gz: e864cca0551ed4fe9d75a1ae201edbb6e8136aced51e727d1fa69eba2b0ace9959e9cccb673f68b41fced069639dc1e6aa0bab3a469e8644cec77bd078e12c24
-  data.tar.gz: 14686a64308ae92bcb4ab7058ff14b6e38b5b2a64e08e0192a92d1ae425ad4c662eb063fc511e9dc6c0b740ab48654e88a89cdab5a9307a9d65822f8c7fecc0f
+  metadata.gz: 524b7de465121d72f2157620b84795cef249deb1d62d07bbb166287fa190401a211dbae46b46a86a76207636a1e171dbc6d078b39c2fa7dc2312669c8299424a
+  data.tar.gz: 8bf369915690be1c13311c59572b30cbd7579bdd1d49ca09719c93c43ee7187c3548e92d7410a4138a3063df6dd5ecf892f9f96408e8ed2cf387135a447b195e

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.2.0

data/active_spy.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: active_spy 1.1.3 ruby lib
+# stub: active_spy 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "active_spy"
-  s.version = "1.1.3"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Douglas Camata"]
-  s.date = "2014-07-25"
+  s.date = "2014-07-29"
   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 = [
@@ -39,6 +39,7 @@ Gem::Specification.new do |s|
     "lib/active_spy/rails/listener.rb",
     "lib/active_spy/rails/railtie.rb",
     "lib/active_spy/rails/spy.rb",
+    "lib/active_spy/rails/validation.rb",
     "lib/active_spy/spy/spy.rb",
     "lib/active_spy/spy/spy_list.rb",
     "lib/rails/generators/active_spy/install/install_generator.rb",

data/app/controllers/active_spy/notifications_controller.rb

@@ -1,4 +1,7 @@
 module ActiveSpy
+  # Controller to handle notifications request coming from an event-runner
+  # instance.
+  #
   class NotificationsController < ActionController::Base
     def handle
       request.format = 'application/json'

data/lib/active_spy/configuration.rb

@@ -43,6 +43,22 @@ module ActiveSpy
         @event_host
       end
 
+      # Set if the gem is in development mode or not
+      #
+      # @param [Boolean] development moded state to set
+      #
+      # @return [Boolean] development moded state to set
+      def development_mode(mode = nil)
+        @development_mode = mode unless mode.nil?
+        @development_mode
+      end
+
+      # Imperative method to set development mode.
+      #
+      def development_mode!
+        @development_mode = true
+      end
+
       # Set the default event-runner port
       #
       # @param [String] port to set

data/lib/active_spy/rails/base.rb

@@ -1,5 +1,6 @@
 require 'rest-client'
 require 'singleton'
+require 'json'
 
 module ActiveSpy
   # Module to hold Rails specific classes and helpers.
@@ -40,13 +41,19 @@ module ActiveSpy
       # after callback is not explicitly defined.
       #
       def method_missing(method, *_args, &_block)
+        event_json = { event: get_request_params(method) }.to_json
+        ActiveSpy::Rails::Validation::Event.new(event_json).validate!
+        send_event_request(event_json) unless ActiveSpy::Configuration.development_mode
+        remove_is_new_method(@object)
+      end
+
+      # Sends the event request to the configured event-runner instance.
+      #
+      def send_event_request(event_json)
         host = ActiveSpy::Configuration.event_host
         port = ActiveSpy::Configuration.event_port
-
-        event_json = { event: get_request_params(method) }.to_json
         RestClient.post "#{host}:#{port}/events", event_json,
           content_type: :json
-        remove_is_new_method(@object)
       end
 
       # Get the event request params for a given +method+.

data/lib/active_spy/rails/hook_list.rb

@@ -107,8 +107,8 @@ module ActiveSpy
       def add_hooks(hooks_to_add)
         hooks_to_add.each do |hook|
           hook = {
-            'hook'=> {
-              'class'=> hook['class'],
+            'hook' => {
+              'class' => hook['class'],
               'post_path' => ActiveSpy::Engine.routes.url_helpers.notifications_path(hook['post_class'].downcase),
             }
           }

data/lib/active_spy/rails/listener.rb

@@ -24,13 +24,13 @@ module ActiveSpy
       # Set the external class of the model that we are listening to.
       #
       def self.external_class(klass)
-        @@external_classes = [klass]
+        @external_classes = [klass]
       end
 
       # Set the external classes which we are listening to.
       #
       def self.external_classes(*classes)
-        @@external_classes = classes
+        @external_classes = classes
       end
 
       # Convert the listener class into one or more hook hashes
@@ -38,7 +38,7 @@ module ActiveSpy
       def self.to_hook
         hooks = []
         hook_classes.each do |hook_class|
-          hooks << { 'class' => hook_class, 'post_class'=> name.split('Listener')[0] }
+          hooks << { 'class' => hook_class, 'post_class' => name.split('Listener')[0] }
         end
         hooks
       end
@@ -46,7 +46,7 @@ module ActiveSpy
       # Get the classes that we are listegnig to.
       #
       def self.hook_classes
-        return @@external_classes if defined? @@external_classes
+        return @external_classes if defined? @external_classes
         [name.split('Listener')[0]]
       end
 

data/lib/active_spy/rails/spy.rb

@@ -34,17 +34,15 @@ module ActiveSpy
         # instead, it will be returned.
         #
         def dynamically_define_method_or_call_block(abstract_name, method_name)
-          if method_name
-            if abstract_name == method_name
-              attr_accessor method_name
-            else
-              define_method method_name do
-                send(:instance_variable_get, "@#{abstract_name}")
-              end
-
-              define_method "#{method_name}=" do |new_value|
-                send(:instance_variable_set, "@#{abstract_name}", new_value)
-              end
+          return unless method_name
+          if abstract_name == method_name
+            attr_accessor method_name
+          else
+            define_method method_name do
+              send(:instance_variable_get, "@#{abstract_name}")
+            end
+            define_method "#{method_name}=" do |new_value|
+              send(:instance_variable_set, "@#{abstract_name}", new_value)
             end
           end
         end

data/lib/active_spy/rails/validation.rb

@@ -0,0 +1,87 @@
+require 'json'
+
+module ActiveSpy
+  module Rails
+    # Module to hold classes that are intended to validate something.
+    #
+    module Validation
+      # Class responsible to validate event that are send to event-runner
+      # instances.
+      #
+      class Event
+
+        def initialize(event_json)
+          @event = JSON.load(event_json)
+        end
+
+        # Validates the +event_json+ provided in the initializer
+        #
+        # (see #initialize)
+        def validate!
+          check_actor_key(@event['actor'])
+          check_realm_key(@event['realm'])
+        end
+
+        private
+
+        # Check if actor is valid.
+        #
+        def check_actor_key(actor)
+          fail ActorNotPresent if actor.nil?
+          errors = get_errors_from_hash(actor, :actor)
+          fail InvalidActor, errors unless errors.empty?
+        end
+
+        # Check if realm is valid.
+        #
+        def check_realm_key(realm)
+          fail RealmNotPresent if realm.nil?
+          errors = get_errors_from_hash(realm, :realm)
+          fail InvalidRealm, errors unless errors.empty?
+        end
+
+        # Get the error from +data+ regarding +hash_type+ checking if the
+        # required keys are being provided.
+        #
+        def get_errors_from_hash(data, hash_type)
+          keys = hash_type == :actor ? required_actor_keys : required_realm_keys
+          keys.map do |key|
+            "#{key} should not be empty." if data[key].nil?
+          end.compact.join(' ')
+        end
+
+        # Required keys for an actor to be valid.
+        #
+        def required_actor_keys
+          %w[id class login url avatar_url]
+        end
+
+        # Required keys for realm to be valid.
+        #
+        def required_realm_keys
+          %w[id class name url]
+        end
+      end
+
+      # Error when actor is not present.
+      #
+      class ActorNotPresent < RuntimeError
+      end
+
+      # Error when the actor is invalid.
+      #
+      class InvalidActor < RuntimeError
+      end
+
+      # Error when realm is not present.
+      #
+      class RealmNotPresent < RuntimeError
+      end
+
+      # Error when the realm is invalid.
+      #
+      class InvalidRealm < RuntimeError
+      end
+    end
+  end
+end

data/lib/active_spy/spy/spy_list.rb

@@ -62,7 +62,6 @@ module ActiveSpy
     def patch(klass, method)
       old_method = nil
       ActiveSupport::Inflector.constantize(klass).class_eval do
-
         old_method = instance_method(method)
         define_method method do |*args, &block|
           send(:invoke_callback, method, :before)

data/lib/active_spy.rb

@@ -2,13 +2,17 @@ require 'active_spy/configuration'
 require 'active_spy/base'
 require 'active_spy/spy/spy'
 require 'active_spy/spy/spy_list'
-require 'active_spy/rails/base' if defined?(Rails)
-require 'active_spy/rails/spy' if defined?(Rails)
-require 'active_spy/rails/railtie' if defined?(Rails)
-require 'active_spy/rails/engine' if defined?(Rails)
-require 'active_spy/rails/engine' if defined?(Rails)
-require 'active_spy/rails/hook_list' if defined?(Rails)
-require 'active_spy/rails/listener'
+
+if defined?(Rails)
+  require 'active_spy/rails/base'
+  require 'active_spy/rails/spy'
+  require 'active_spy/rails/railtie'
+  require 'active_spy/rails/engine'
+  require 'active_spy/rails/engine'
+  require 'active_spy/rails/hook_list'
+  require 'active_spy/rails/listener'
+  require 'active_spy/rails/validation'
+end
 
 # Base module for the gem
 #
@@ -29,11 +33,11 @@ module ActiveSpy
     def self.register_service
       host = ActiveSpy::Configuration.event_host
       port = ActiveSpy::Configuration.event_port
-      @@base_url = "#{host}:#{port}/services"
+      @base_url = "#{host}:#{port}/services"
 
       return if self.service_registered?
       service = { service: ActiveSpy::Configuration.settings }.to_json
-      RestClient.post(@@base_url, service, content_type: :json)
+      RestClient.post(@base_url, service, content_type: :json)
     end
 
     # @!method self.service_registered?
@@ -43,7 +47,7 @@ module ActiveSpy
     def self.service_registered?
       name = ActiveSpy::Configuration.name
       begin
-        r = RestClient.get "#{@@base_url}/#{name.downcase.gsub(' ', '-').strip}"
+        RestClient.get "#{@base_url}/#{name.downcase.gsub(' ', '-').strip}"
       rescue RestClient::ResourceNotFound
         return false
       else

data/lib/rails/generators/active_spy/install/install_generator.rb

@@ -12,7 +12,7 @@ module ActiveSpy
       # The source for templates
       #
       def self.source_root
-        @@_active_spy_source_root ||= File.expand_path("../templates", __FILE__)
+        @@_active_spy_source_root ||= File.expand_path('../templates', __FILE__)
       end
 
       # Creates a config file based in the +active_spy.yml+ file.
@@ -26,7 +26,7 @@ module ActiveSpy
       def inject_config_into_environment
         content = File.read(File.join(@@_active_spy_source_root, 'initializer.rb'))
 
-        File.open("config/environment.rb", "a+") do |f|
+        File.open('config/environment.rb', 'a+') do |f|
           f << content unless f.read.include?(content)
         end
       end

data/lib/rails/generators/active_spy/install/templates/initializer.rb

@@ -5,4 +5,3 @@ if Rails.env.production?
   ActiveSpy.register_service
   ActiveSpy::Rails::HookList.register
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_spy
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Douglas Camata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -225,6 +225,7 @@ files:
 - lib/active_spy/rails/listener.rb
 - lib/active_spy/rails/railtie.rb
 - lib/active_spy/rails/spy.rb
+- lib/active_spy/rails/validation.rb
 - lib/active_spy/spy/spy.rb
 - lib/active_spy/spy/spy_list.rb
 - lib/rails/generators/active_spy/install/install_generator.rb