safetynet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2572c7d4bb6b380f19be2ac509527dd742d3f1ee
+  data.tar.gz: 4fd376f510b59f5d3a44a6462aa67622a2b1d4ff
+SHA512:
+  metadata.gz: 36b3699df9defb2a5926a544a2bc0737c57f1083826d83b265e395e9a11732db4ad592faebc7300162044ca0f9399022abf74af71d2c1516888aea66d6eb68c4
+  data.tar.gz: 869a7e230e379985b11ae7f014bc0127a83479e34928c04512e023c19c92e786e2331bee6bff0e2d20a74fc91a7722e9a422c39386af886311dfd9d2612c43a3

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safetynet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 arktisklada
+
+MIT License
+
+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,29 @@
+# Safetynet
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'safetynet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safetynet
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/safetynet/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/safetynet/version.rb

@@ -0,0 +1,3 @@
+module Safetynet
+  VERSION = "0.0.1"
+end

data/lib/safetynet.rb

@@ -0,0 +1,149 @@
+require "safetynet/version"
+require 'active_support/concern'
+
+module Safetynet
+  extend ActiveSupport::Concern
+
+  # Saves a record for the current method
+  def safe_safetynet_delivery(user, channel, method)
+    options = self.class.safetynet_options
+    log = SafetynetLog.new({
+      user_id: user.id,
+      method: method,
+      channel: channel.to_s
+    })
+    log.save
+  end
+
+  # Returns true if delivery is permitted through the given channel
+  #   user        A model to monitor
+  #   channel     email|sms (symbol)
+  #   method      Name of watched method
+  #   limit       Maximum # of methods for this channel
+  #   timeframe   Minimum allowed timeframe between last method and next (default: 30.minutes)
+  # 
+  # Standalone usage on a User model
+  #   * Defaults to configured channel, caller method,
+  #   * and rails configuration limit & timeframe for the channel
+  #
+  #   class User < ActiveRecord::Base
+  #     include Safetynet
+  #     safetynet :sms
+  #
+  #     def send_sms
+  #       if permit_delivery?(self)
+  #         ...
+  #       end
+  #     end
+  #   end
+  def permit_delivery?(address, channel=nil, method=nil, limit=nil, timeframe=nil)
+    # Skip check if email is whitelisted
+    return true if is_whitelisted?(address)
+
+    options = self.class.safetynet_options
+    # Set defaults from current config and call stack
+    channel = self.class.safetynet_channel if channel.nil?
+    method = caller_locations(1, 1)[0].label if method.nil?
+    limit = options[channel][:limit] if limit.nil?
+    timeframe = options[channel][:timeframe] if timeframe.nil?
+
+    # Query the model to determine if delivery is permitted
+    permit_delivery = true
+    if limit != false
+      count_query = SafetynetLog.where({
+        address: address,
+        channel: channel,
+        method: method
+      })
+      if timeframe != false
+        count_query = count_query.where('created_at >= ?', Time.now - timeframe)
+      end
+
+      # If our sending is over the limit, deny
+      if count_query.count >= limit
+        permit_delivery = false
+      end
+    end
+
+    if permit_delivery
+      safe_safetynet_delivery(address, channel, method)
+    else
+      AdminMailer.delivery_denied_notification(address, channel, method, {
+        limit: limit,
+        timeframe: timeframe,
+        message: 'Safetynet has caught a method!'
+      }).deliver
+    end
+    permit_delivery
+  end
+
+  # Hook added to after_filter to disable current action or mail delivery
+  def check_safetynet_window
+    # Skip check if email is already stopped
+    return false if mail.perform_deliveries == false
+
+    channel = self.class.safetynet_channel
+    options = self.class.safetynet_options
+    method = action_name
+    limit = options[channel][:limit]
+    timeframe = options[channel][:timeframe]
+
+    # Update the mail.to array with those who are whitelisted and permitted
+    mail.to = mail.to.keep_if do |email|
+      next true if is_whitelisted?(email) || !defined?(@user) || email == @user.email
+      permit_delivery?(address, channel, method, limit, timeframe)
+    end
+
+    permit_delivery = mail.to.any?
+
+    if channel == :email
+      mail.perform_deliveries = permit_delivery
+    end
+    permit_delivery
+  end
+
+  # All example.com emails are whitelisted
+  def is_whitelisted?(email)
+    !!(self.class.safetynet_options[:whitelist].match(email))
+  end
+
+  module ClassMethods
+    # safetynet
+    #   channel                     email|sms (symbol)
+    #   filters                     Hash of method names to watch (email only) that fits after_action requirements
+    #   options = {
+    #     email: {                  Hash for each channel (matches to field on User model) and includes:
+    #       limit: 1,               Maximum # of methods for this channel (default: 1)
+    #       timeframe: 30.minutes   Minimum allowed timeframe between last method and next (default: 30.minutes)
+    #     }
+    #   }
+    #   Options merges Rails.configuration.safetynet before any class-specific options
+    def safetynet(channel, filters={}, options={})
+      @safetynet_channel = channel
+      @safetynet_options = {
+        whitelist: /@example.com/,
+        email: {
+          limit: 1,
+          timeframe: 30.minutes
+        }
+      }.merge(Rails.configuration.safetynet).merge(options)
+
+      # If class is a rails mailer, add after_action hook
+      if (self.ancestors & [ActionMailer::Base]).any?
+        if filters.empty?
+          after_action :check_safetynet_window
+        else
+          after_action :check_safetynet_window, filters
+        end
+      end
+    end
+    # Accessed in instance methods by calling self.class.safetynet_channel
+    def safetynet_channel
+      @safetynet_channel
+    end
+    # Accessed in instance methods by calling self.class.safetynet_options
+    def safetynet_options
+      @safetynet_options
+    end
+  end
+end

data/safetynet.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safetynet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safetynet"
+  spec.version       = Safetynet::VERSION
+  spec.authors       = ["arktisklada"]
+  spec.email         = ["mail@enorganik.com"]
+  spec.summary       = %q{Stop communication problems before they happen}
+  spec.description   = %q{Safetynet keeps track of email communications by user/email and ActionMailer message. If the same message is sent to the same user multiple times within the allowed timeframe, it will be blocked from delivery and notify system admins. The messages are filterable in a way similar to controller filters, and the checking method can be called by itself outside the normal hooks for additional throttling (i.e. SMS sending, push notifications, etc.). }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: safetynet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- arktisklada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Safetynet keeps track of email communications by user/email and ActionMailer
+  message. If the same message is sent to the same user multiple times within the
+  allowed timeframe, it will be blocked from delivery and notify system admins. The
+  messages are filterable in a way similar to controller filters, and the checking
+  method can be called by itself outside the normal hooks for additional throttling
+  (i.e. SMS sending, push notifications, etc.). '
+email:
+- mail@enorganik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/safetynet.rb
+- lib/safetynet/version.rb
+- safetynet.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Stop communication problems before they happen
+test_files: []