safetynet 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2572c7d4bb6b380f19be2ac509527dd742d3f1ee
-  data.tar.gz: 4fd376f510b59f5d3a44a6462aa67622a2b1d4ff
+  metadata.gz: c82ab26e4311dd4cee67b3512af96ce1a3cd871d
+  data.tar.gz: f7d833205366907799b196294574314e756a7694
 SHA512:
-  metadata.gz: 36b3699df9defb2a5926a544a2bc0737c57f1083826d83b265e395e9a11732db4ad592faebc7300162044ca0f9399022abf74af71d2c1516888aea66d6eb68c4
-  data.tar.gz: 869a7e230e379985b11ae7f014bc0127a83479e34928c04512e023c19c92e786e2331bee6bff0e2d20a74fc91a7722e9a422c39386af886311dfd9d2612c43a3
+  metadata.gz: 3413d6714950b1ea54811c4caae76bbb47c4ac0a2f14306f2e7700ede475fb99e9bfbf9510d8138c7df349208db86a745d121a71d67524c636d87c1ca7d10774
+  data.tar.gz: ae9511d5345b41d51991862041bf39e420e479f38167b64428a7481bb6f0f3efe5e121e3bce988e8ef7be65de1f0bc5ce50d95feba68826b899d1836f42d3a50

data/README.md

@@ -1,8 +1,10 @@
 # Safetynet
 
-TODO: Write a gem description
+Stop communication problems before they happen
 
-## Installation
+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.).
+
+## Rails Installation
 
 Add this line to your application's Gemfile:
 
@@ -11,19 +13,76 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
+    $ rails generate safetynet
+    $ rake db:migrate
+
+The generator creates two files:
 
-Or install it yourself as:
+  1. a file under `config/initializers/safetynet.rb` configuring Safetynet with project-specific settings.
+  2. a migration file to create the safetynet_histories table
 
-    $ gem install safetynet
 
 ## Usage
 
-TODO: Write usage instructions here
+###Applied to a mailer
+
+Add the safetynet method to an ActionMailer::Base class with the following structure:
+
+    safetynet({
+      channel,
+      filters,
+      options: {
+        email: {
+          limit: 1,
+          timeframe: 30.minutes
+        }
+      }
+    })
+
+And a description of each:
+
+|Field|Type|Description|
+|:-|:-|:-|
+|**channel**   |Symbol  |The category of methods to watch (email/sms/etc.) -- see options below|
+|**filters**   |Hash    |Hash of method names to watch (email only) that fits after_action requirements|
+|**options**   |Hash    |Contains a hash for each channel and includes the next 2 fields|
+|**limit**     |Integer |Maximum # of methods for this channel (default: 1)|
+|**timeframe** |Integer |Minimum allowed timeframe between last successful method call (default: 30.minutes)|
+
+
+**Note:** Defaults to configured channel, method, and Safetynet configuration limit & timeframe for the channel
+
+####Example:
+
+    class UserMailer < ActionMailer::Base
+      include Safetynet
+      safetynet :email, {except: [:user_registration_email, :forgot_password_email]}
+    end
+
+
+
+###Standalone usage on a class
+
+
+####Example:
+
+    class User < ActiveRecord::Base
+      include Safetynet
+    safetynet :sms
+
+      def send_sms
+        if permit_delivery?(self)
+          ...
+        end
+      end
+    end
+
 
 ## 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
+1. Create an issue
+2. Fork it ( https://github.com/arktisklada/safetynet/fork )
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,32 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Safetynet'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails/generators/safetynet/safetynet_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SafetynetGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  desc "Creates the Safetynet initializer file at config/initializers/safetynet.rb and a migration"
+
+
+  def self.next_migration_number(path)
+    unless @prev_migration_nr
+      @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+    else
+      @prev_migration_nr += 1
+    end
+    @prev_migration_nr.to_s
+  end
+
+  def install
+    generate_initializer
+    generate_migration
+  end
+
+
+  private
+
+  def generate_initializer
+    template 'initializer.rb', 'config/initializers/safetynet.rb'
+  end
+
+  def configuration_output
+    output = <<-eos
+Rails.configuration.safetynet = {
+  email: {
+    limit: Rails.env.development? ? 1000 : 1,
+    timeframe: 1.hour
+  }
+}
+    eos
+  end
+
+  def generate_migration
+    puts SafetynetGenerator.source_root
+    migration_template 'db/migrate/1_create_safetynet_histories.rb', 'db/migrate/create_safetynet_histories.rb'
+  end
+end

data/lib/rails/generators/safetynet/templates/db/migrate/1_create_safetynet_histories.rb

@@ -0,0 +1,16 @@
+class CreateSafetynetHistories < ActiveRecord::Migration
+  def self.up
+    create_table :safetynet_histories do |t|
+      t.string :address
+      t.string :channel
+      t.string :method
+      t.datetime :created_at
+    end
+
+    add_index :safetynet_histories, [:address, :channel, :method, :created_at], name: 'safetynet_histories_idx'
+  end
+
+  def self.down
+    drop_table :safetynet_histories
+  end
+end

data/lib/rails/generators/safetynet/templates/initializer.rb

@@ -0,0 +1,4 @@
+<% if Rails::VERSION::MAJOR < 3 && Rails::VERSION::MINOR < 2 -%>
+require 'safetynet'
+<% end -%>
+<%= configuration_output %>

data/lib/safetynet/engine.rb

@@ -0,0 +1,5 @@
+require 'rails/engine'
+module Safetynet
+  class Engine < Rails::Engine
+  end
+end

data/lib/safetynet/version.rb

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

data/lib/safetynet.rb

@@ -1,16 +1,19 @@
-require "safetynet/version"
+require 'safetynet/version'
 require 'active_support/concern'
+require 'active_support/core_ext/numeric/time'
 
 module Safetynet
   extend ActiveSupport::Concern
 
+
   # Saves a record for the current method
-  def safe_safetynet_delivery(user, channel, method)
+  def safe_safetynet_delivery(address, channel, method)
     options = self.class.safetynet_options
-    log = SafetynetLog.new({
-      user_id: user.id,
+    log = Safetynet::History.new({
+      address: address,
       method: method,
-      channel: channel.to_s
+      channel: channel.to_s,
+      created_at: Time.now
     })
     log.save
   end
@@ -37,7 +40,7 @@ module Safetynet
   #     end
   #   end
   def permit_delivery?(address, channel=nil, method=nil, limit=nil, timeframe=nil)
-    # Skip check if email is whitelisted
+    # Skip check if address is whitelisted
     return true if is_whitelisted?(address)
 
     options = self.class.safetynet_options
@@ -50,7 +53,7 @@ module Safetynet
     # Query the model to determine if delivery is permitted
     permit_delivery = true
     if limit != false
-      count_query = SafetynetLog.where({
+      count_query = Safetynet::History.where({
         address: address,
         channel: channel,
         method: method
@@ -102,9 +105,9 @@ module Safetynet
     permit_delivery
   end
 
-  # All example.com emails are whitelisted
-  def is_whitelisted?(email)
-    !!(self.class.safetynet_options[:whitelist].match(email))
+  # Permits all whitelisted addresses by regex
+  def is_whitelisted?(address)
+    !!(self.class.safetynet_options[:whitelist].match(address))
   end
 
   module ClassMethods
@@ -147,3 +150,5 @@ module Safetynet
     end
   end
 end
+
+ActiveRecord::Base.send :include, Safetynet

data/lib/tasks/safetynet_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :safetynet do
+#   # Task goes here
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safetynet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - arktisklada
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
@@ -50,15 +106,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
+- LICENSE.TXT
 - README.md
 - Rakefile
+- lib/rails/generators/safetynet/safetynet_generator.rb
+- lib/rails/generators/safetynet/templates/db/migrate/1_create_safetynet_histories.rb
+- lib/rails/generators/safetynet/templates/initializer.rb
 - lib/safetynet.rb
+- lib/safetynet/engine.rb
 - lib/safetynet/version.rb
-- safetynet.gemspec
-homepage: ''
+- lib/tasks/safetynet_tasks.rake
+homepage: https://github.com/arktisklada/safetynet
 licenses:
 - MIT
 metadata: {}

data/.gitignore

@@ -1,22 +0,0 @@
-*.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

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

data/safetynet.gemspec

@@ -1,23 +0,0 @@
-# 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