doctor_doug 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f00066984dbab4c4ae5d85e5be6674e3aeaf0cc5
-  data.tar.gz: 7bcd7d99b698a517e7ae8d4dba8c7278131f0b7b
+  metadata.gz: 42cf84aa1d3cbf3284ca1f61cb7a3754f1efcc9a
+  data.tar.gz: '002287f99d8c70417f2d64a96b4b68fb05a1b8b9'
 SHA512:
-  metadata.gz: 04b9be8641b37b1258f586fbf35849ad57df2ad930f307057e1c30474dcc91d47a9299289eaa1fc3de8452e90d1a72525a1cee754cde1725f907f1ae6adacc75
-  data.tar.gz: c86934167717183b51fe1a5743eb7121fc9713fc34ee16a51069e2fb3adbf0f9192862f29a48826a04b2ebe5fe7f098ca7b6ce5ac6b7cbe0abba7513ce9148dc
+  metadata.gz: 948e853a0f0635426c4ac0cd7727963fa17558cbf8cf53df38e300950f7151d72eb10a08fa73fad0b62ba923ee99463f666b4d34ea8ba3288e242f9e3ceb704e
+  data.tar.gz: c019d8343b714f4071f478ab63bf49a048267d4bb21d025655b709a7253a39cda7b1e21530dfe77d22d449f6a313508870632e49898010a80821e9565ed228e7

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
+coverage
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/SymbolArray:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile.lock

@@ -1,13 +1,24 @@
 PATH
   remote: .
   specs:
-    doctor_doug (0.1.1)
+    doctor_doug (0.1.2)
+      mail
 
 GEM
   remote: https://rubygems.org/
   specs:
+    docile (1.3.0)
+    json (2.1.0)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.0)
     minitest (5.11.3)
     rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
 
 PLATFORMS
   ruby
@@ -17,6 +28,7 @@ DEPENDENCIES
   doctor_doug!
   minitest (~> 5.0)
   rake (~> 10.0)
+  simplecov
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,8 +1,6 @@
 # DoctorDoug
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/doctor_doug`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Run checkup and notify you by mail when there are violations 
 
 ## Installation
 
@@ -22,7 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+# config/initializers/doctor_doug.rb
+
+DoctorDoug.configure do |config|
+  config.strategies = [:mail]
+  config.mail_options = {
+      address: 'smtp.gmail.com',
+      port: 587,
+      domain: 'gmail.com',
+      user_name: 'youremail@gmail.com',
+      password: 'password',
+      authentication: 'plain',
+      from: 'from@gmail.com',
+      to: 'to@gmail.com'
+  }
+end
+```
+
+```
+DoctorDoug.checkup "user name should not be blank" do
+  users = User.where(updated_at: 1.hour.ago..Time.now)
+  notify :if, any: users do |user|
+    user.name.blank? # to make this work, the block must reutrn a boolean value
+  end
+end
+
+```
 
 ## Development
 
@@ -32,4 +56,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/doctor_doug.
+Bug reports and pull requests are welcome on GitHub at https://github.com/gaotongfei/doctor_doug.

data/doctor_doug.gemspec

@@ -1,35 +1,38 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "doctor_doug/version"
+require 'doctor_doug/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "doctor_doug"
+  spec.name          = 'doctor_doug'
   spec.version       = DoctorDoug::VERSION
-  spec.authors       = ["Tongfei Gao"]
-  spec.email         = ["gaotongfei1995@gmail.com"]
+  spec.authors       = ['Tongfei Gao']
+  spec.email         = ['gaotongfei1995@gmail.com']
 
   spec.summary       = %q{Checkups}
   spec.description   = %q{Checks}
-  spec.homepage      = "https://github.com/gaotongfei/doctor_doug"
+  spec.homepage      = 'https://github.com/gaotongfei/doctor_doug'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency 'mail'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

data/lib/doctor_doug/checkup.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DoctorDoug # :nodoc:
+  def self.checkup(name, &block)
+    checkup_proxy = CheckupProxy.new(name)
+    checkup_proxy.instance_eval(&block)
+  end
+
+end
+
+class CheckupProxy # :nodoc:
+  def initialize(checkup_name)
+    @checkup_name = checkup_name
+  end
+
+  def notify(condition, any:)
+    raise NoneBlockGivenError unless block_given?
+    collections = any
+    violations = collections.map do |c|
+      need_notify = false
+      block_result = yield c
+      if !!block_result == block_result
+        need_notify = block_result if condition == :if
+        need_notify = !block_result if condition == :unless
+      end
+      c if need_notify
+    end
+
+    DoctorDoug::Notify.perform(checkup_name, violations)
+  end
+
+  private
+
+  attr_reader :checkup_name
+
+end

data/lib/doctor_doug/configuration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DoctorDoug
+  # Configure doctor_doug using block style
+  #
+  # For example:
+  #
+  #   # config/initializers/doctor_doug.rb
+  #   DoctorDoug.configure do |config|
+  #     config.strategies = [:mail]
+  #     config.mail_options = {
+  #       address: "smtp.gmail.com",
+  #       port: 587,
+  #       domain: 'gmail.com',
+  #       user_name: 'youremail@gmail.com',
+  #       password: 'password',
+  #       authentication: 'plain',
+  #       from: 'from@gmail.com',
+  #       to: 'to@gmail.com'
+  #     }
+  #   end
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration # :nodoc:
+    attr_accessor :strategies, :mail_options
+
+    def initialize
+      @strategies = [:mail]
+    end
+  end
+end

data/lib/doctor_doug/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class NoneBlockGivenError < StandardError # :nodoc:
+  def message
+    'None block is given'
+  end
+end

data/lib/doctor_doug/notify/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DoctorDoug
+  module Notify # :nodoc:
+    def self.perform(checkup_name, violations)
+      unless violations.empty?
+        strategies = DoctorDoug.configuration.strategies
+        strategies = valid_strategies(strategies)
+        strategies.each do |strategy|
+          if strategy == :mail
+            DoctorDoug::Notify::Mail.new(DoctorDoug.configuration, violations: violations).deliver(checkup_name: checkup_name)
+          end
+        end
+      end
+    end
+
+    class << self
+      def valid_strategies(strategies)
+        [:mail] & strategies
+      end
+    end
+  end
+end
+
+module DoctorDoug
+  module Notify
+    class Base # :nodoc:
+      def initialize(violations)
+        @violations = violations
+      end
+
+      def message
+        "#{@violations.inspect}"
+      end
+    end
+  end
+end

data/lib/doctor_doug/notify/mail.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'mail'
+
+module DoctorDoug
+  module Notify
+    class Mail < Base # :nodoc:
+      def initialize(configuration, violations:)
+        super(violations)
+        @configuration = configuration
+
+        ::Mail.defaults do
+          delivery_method :smtp, configuration.mail_options.slice(:address, :port, :domain, :user_name,
+                                                                  :password, :authentication)
+        end
+      end
+
+      def deliver(checkup_name:)
+        configuration = @configuration
+        message = self.message
+        mail = ::Mail.new do
+          from configuration.mail_options[:from]
+          to configuration.mail_options[:to]
+          subject "Checkup: #{checkup_name} failed"
+          body message
+        end
+        mail.deliver!
+      end
+    end
+  end
+end

data/lib/doctor_doug/version.rb

@@ -1,3 +1,3 @@
 module DoctorDoug
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/doctor_doug.rb

@@ -1,5 +1,13 @@
-require "doctor_doug/version"
+# frozen_string_literal: true
 
-module DoctorDoug
-  # Your code goes here...
+require 'doctor_doug/version'
+require 'doctor_doug/checkup'
+require 'doctor_doug/errors'
+require 'doctor_doug/configuration'
+require 'doctor_doug/notify/base'
+require 'doctor_doug/notify/mail'
+
+require 'mail'
+
+module DoctorDoug # :nodoc:
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: doctor_doug
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tongfei Gao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -69,6 +99,11 @@ files:
 - bin/setup
 - doctor_doug.gemspec
 - lib/doctor_doug.rb
+- lib/doctor_doug/checkup.rb
+- lib/doctor_doug/configuration.rb
+- lib/doctor_doug/errors.rb
+- lib/doctor_doug/notify/base.rb
+- lib/doctor_doug/notify/mail.rb
 - lib/doctor_doug/version.rb
 homepage: https://github.com/gaotongfei/doctor_doug
 licenses: []