batchmaker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e3307b2208f99ffe62096726ed2d86534fc8ef28ad3afb160f9353282c9af2a
+  data.tar.gz: a76355d448bb4fb726d5ffb4d7f2437d20afde8df33ce439542e9bc6c9c49ca1
+SHA512:
+  metadata.gz: a48cde0031613f8c67d41f3d4a3f8a49559353be20742b7245dd673c1fec8982aaf1e7a162f15e685fc325cfa0dda76e449a62cd3f54dae27d451b560a240808
+  data.tar.gz: 892a4a328f10eb62660af8d32cd28df42151e7a834411c202425647464f02d6559351c5917d2980d30bf9e5f9ea1895676fa5b84221808b10a0822ef4c9984b7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at krajagopalan@doximity.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Changelog

@@ -0,0 +1,2 @@
+0.1.3
+  - Log via debug instead of info

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Krish Rajagopalan
+
+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,60 @@
+# Batchmaker
+
+The Batchmaker is a simply utility that using a separate thread and an atomic queue, easily allows to
+store objects on the queue and perform a operation on a batch of the objects. The batch is
+controlled by a maximum size and a tick period, ensuring that the batch have at most N objects or
+that at most M time-unit have elapsed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'batchmaker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install batchmaker
+
+## Usage
+
+The batchmaker class requires several arguments on initialization:
+```
+batchmaker = Batchmaker.new(name, size, tick_period, on_error: nil, &block)
+```
+
+`name` - The name of the queue (for emails, referencing the priority of the worker, e.g. critical, default, low)
+
+`size` - Size of the queue
+
+`tick_period` - The amount of time to wait before processing the queue
+
+`on_error` - Optional error callback (Proc)
+
+`&block` - Action to occur when the queue is processed (In this case, enqueuing the message data to the specified send email worker)
+
+```
+BATCH_EXCEPTION_NOTIFIER = -> (err, ident_str) {
+  ExceptionNotification.log_and_notify(err, batchmaker_id: ident_str)
+}
+
+batchmaker = Batchmaker.new("email-default", 100, 20, on_error: BATCH_EXCEPTION_NOTIFIER) do |batch|
+  Emails::SendEmailDefaultWorker(batch.as_json)
+end
+
+# Add items to the batchmaker queue
+batchmaker << 1
+batchmaker << 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the VERSION number in lib/batchmaker.rb, and then follow the instructions for releasing it as a private gem on Gemfury.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/batchmaker.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batchmaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "batchmaker"
+  spec.version       = Batchmaker::VERSION
+  spec.authors       = ["Rodrigo Kochenburger", "Krish Rajagopalan"]
+  spec.email         = ["rodrigo@doximity.com", "krajagopalan@doximity.com"]
+
+  spec.summary       = %q{Async queue system that batches items together based on time and size}
+  spec.description   = %q{Async queue system that batches items together based on time and size}
+  spec.homepage      = "https://github.com/doximity/batchmaker"
+
+  # 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."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "batcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/batchmaker.rb

@@ -0,0 +1,144 @@
+require 'batchmaker/null_logger'
+
+class Batchmaker
+  StoppedError = Class.new(StandardError)
+
+  def initialize(name, size, tick_period, on_error: nil, &block)
+    @name     = name
+    @size     = size
+    @queue    = Queue.new
+    @mutex    = Mutex.new
+    @count    = 0
+    @action   = block
+    @on_error = on_error
+    @stopping  = false
+
+    # Main thread that process the batches
+    @thread = Thread.new(&method(:run))
+
+    # Thread that ticks on a specified frequency
+    @tick = Thread.new(tick_period, &method(:tick))
+    @tick.abort_on_exception = true
+    @tick.priority = 1
+  end
+
+  def running?
+    ["run", "sleep"].include?(@thread.status) && !@stopping
+  end
+
+  def <<(item)
+    if !running?
+      raise StoppedError, "failure to queue item, #{ident_str} has already stopped"
+    end
+
+    @mutex.synchronize do
+      @queue << [:add, item]
+      @count += 1
+
+      if @count >= @size
+        @count = 0
+        @queue << [:process, :size]
+      end
+    end
+
+    Thread.pass
+  end
+
+  def shutdown!
+    shutdown && wait
+  end
+
+  def shutdown
+    info "shutting down"
+
+    @mutex.synchronize do
+      @stopping = true
+      @queue << [:process]
+      @queue << [:stop]
+    end
+
+    @tick.exit
+  end
+
+  def wait
+    @thread.join
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger
+  end
+
+  self.logger = NullLogger.new
+
+  private
+
+  def run
+    batch = []
+
+    info "starting batch processing loop"
+    loop do
+      action, *args = @queue.pop
+
+      case action
+      when :add
+        batch << args.first
+        debug "item added to #{@name} batch: #{args.first.inspect}"
+
+      when :process
+        unless batch.empty?
+          begin
+            @action.(batch.freeze)
+            debug "batch processed with #{batch.size} items"
+          rescue => e
+            error "batch with #{batch.size} failed to process due to '#{e.message}' - batch: #{batch.inspect}"
+            @on_error.call(e, ident_str) if @on_error
+            next
+          ensure
+            batch = []
+          end
+        end
+
+      when :stop
+        break
+      end
+    end
+
+    info "exiting batch processing loop"
+  end
+
+  def tick(period)
+    loop do
+      sleep(period)
+
+      @mutex.synchronize do
+        @queue << [:process, :tick]
+      end
+    end
+  end
+
+  def ident_str
+    "[#{self.class.name}(#{@name}):#{Process.pid}]"
+  end
+
+  def error(msg)
+    logger.error "#{ident_str} error: #{msg}"
+  end
+
+  def info(msg)
+    logger.info "#{ident_str} info: #{msg}"
+  end
+
+  def debug(msg)
+    logger.debug "#{ident_str} debug: #{msg}"
+  end
+
+  def logger
+    self.class.logger
+  end
+end
+
+require 'batchmaker/railtie' if defined?(Rails)

data/lib/batchmaker/null_logger.rb

@@ -0,0 +1,12 @@
+class Batchmaker
+  class NullLogger
+    def error(msg)
+    end
+
+    def info(msg)
+    end
+
+    def debug(msg)
+    end
+  end
+end

data/lib/batchmaker/railtie.rb

@@ -0,0 +1,7 @@
+class Batchmaker
+  class Railtie < Rails::Railtie
+    initializer 'batcher.configure_logger' do
+      Batchmaker.logger = Rails.logger
+    end
+  end
+end

data/lib/batchmaker/version.rb

@@ -0,0 +1,3 @@
+class Batchmaker
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: batchmaker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rodrigo Kochenburger
+- Krish Rajagopalan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Async queue system that batches items together based on time and size
+email:
+- rodrigo@doximity.com
+- krajagopalan@doximity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Changelog
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- batchmaker.gemspec
+- bin/console
+- bin/setup
+- lib/batchmaker.rb
+- lib/batchmaker/null_logger.rb
+- lib/batchmaker/railtie.rb
+- lib/batchmaker/version.rb
+homepage: https://github.com/doximity/batchmaker
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Async queue system that batches items together based on time and size
+test_files: []