aws_cron 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88227d9707b558a66849fbceb6c225d9fee670ad
+  data.tar.gz: 98dd86126cd1ae0510f19e7705e173723ee440d6
+SHA512:
+  metadata.gz: f5cd9edf9b232fa8821b4aface5b11a82dd3025c395c2f9c216c96741370dfcb549c7c1a69b869f4c5bcbefcf674b70fc5a46cabbcf3efd3cd50504eb77878a2
+  data.tar.gz: 6b63c62787fd8acfd7adafe54a04e4470ace07ef09422fb43e6b9d4a1f37ce651a0007e793fbf4681b4eb30c8e9dc2a01be97497e264b57fd85491e483916c5e

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Wealthsimple
+
+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,89 @@
+# AwsCron
+
+[![CircleCI](https://circleci.com/gh/wealthsimple/aws_cron.svg?style=svg)](https://circleci.com/gh/wealthsimple/aws_cron) [![Gem Version](https://badge.fury.io/rb/aws_cron.svg)](http://badge.fury.io/rb/aws_cron)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Screencasts](#screencasts)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+# Screencasts
+
+# Requirements
+
+0. [Ruby 2.3.1](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl --location --silent /gem-public.pem)
+    gem install aws_cron --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
+while allowing the installation of unsigned dependencies since they are beyond the scope of this
+gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install aws_cron
+
+Add the following to your Gemfile:
+
+    gem "aws_cron"
+
+# Usage
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2016 []().
+Read [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read [CHANGES](CHANGES.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Marco Costa]() at
+[]().

data/lib/aws_cron.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "aws_cron/identity"
+require "aws_cron/controller"
+require "aws_cron/runner"
+require "aws_cron/configuration"
+require "aws_cron/exception_handler"
+require "aws_cron/logger"

data/lib/aws_cron/configuration.rb

@@ -0,0 +1,26 @@
+module AwsCron
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    ATTRIBUTES = [:logger, :exception_handler]
+    attr_accessor *ATTRIBUTES
+
+    def initialize
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/aws_cron/controller.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+# Controller helper concern
+module AwsCron
+  module Controller
+    extend ActiveSupport::Concern
+
+    # Runs block and ensures error logging and proper JSON return
+    def run(&block)
+      yield
+    rescue => exception
+      AwsCron::log(:error, exception)
+    ensure
+      self.return_object
+    end
+
+    # Runs block using defined timezone for cron scheduling
+    # and ensures error logging and proper JSON return
+    #
+    # For tasks that call this method, make sure to have
+    # cron.yaml call this task in way that allows it to
+    # check programmatically if it needs to be triggered
+    def run_in_tz(cron_str, &block)
+      run do
+        CronRunner.new(cron_str, time_provider).run do
+          yield
+        end
+      end
+    end
+
+    protected
+
+    def return_object
+      raise SecurityError('You must implement return_object with a 200 HTTP response using your preferred web framework')
+    end
+
+    def time_provider
+      Time
+    end
+  end
+end

data/lib/aws_cron/exception_handler.rb

@@ -0,0 +1,6 @@
+module AwsCron
+  def self.exception_handler(exception, message, data={})
+    return  if configuration.exception_handler.nil?
+    configuration.exception_handler.error(exception, message, data)
+  end
+end

data/lib/aws_cron/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AwsCron
+  # Gem identity information.
+  module Identity
+    def self.name
+      "aws_cron"
+    end
+
+    def self.label
+      "AwsCron"
+    end
+
+    def self.version
+      "0.1.1"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

data/lib/aws_cron/logger.rb

@@ -0,0 +1,7 @@
+module AwsCron
+  def self.log(method, text)
+    @logger ||= ActiveSupport::TaggedLogging.new(configuration.logger)
+    @tag ||= "aws_cron_#{SecureRandom.uuid}"
+    @logger.tagged(@tag) { @logger.send(method, text) }
+  end
+end

data/lib/aws_cron/runner.rb

@@ -0,0 +1,26 @@
+require 'parse-cron'
+
+module AwsCron
+
+  # Cron runner that runs a schedule based on provided time_provider
+  # You should avoid using this class directly
+  class CronRunner
+    def initialize(cron_str, time_provider=Time, leniency_secs=30*60)
+      @cron = ::CronParser.new(cron_str, time_provider)
+      @time_provider = time_provider
+      @leniency_secs = leniency_secs
+    end
+
+    def run(time=@time_provider.now, &block)
+      if should_run(time)
+        yield
+      end
+    end
+
+    def should_run(time)
+      last_execution_time = @cron.last(time)
+
+      time >= last_execution_time - @leniency_secs && time < last_execution_time + @leniency_secs
+    end
+  end
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "reek/rake/task"
+  Reek::Rake::Task.new
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: aws_cron
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marco Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: parse-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+description: 
+email:
+- marco@marcotc.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/aws_cron.rb
+- lib/aws_cron/configuration.rb
+- lib/aws_cron/controller.rb
+- lib/aws_cron/exception_handler.rb
+- lib/aws_cron/identity.rb
+- lib/aws_cron/logger.rb
+- lib/aws_cron/runner.rb
+- lib/tasks/reek.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/wealthsimple/aws_cron
+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.5.1
+signing_key: 
+specification_version: 4
+summary: AWS Elastic Beanstalk cron scheduling support
+test_files: []