bulk-processor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81b6cbba22963959c1e355f71f78790cbc0b6592
+  data.tar.gz: 8859344abc19572527f69ba9259c5b1289bde273
+SHA512:
+  metadata.gz: 584baf85c25c5a741eb8392ab068a3e1798a71398dd3f53e0da6e24aca144648fb77c8442865a4f5c134193fbf255f4b5cf55f630bc1915241e1f2d229189ce7
+  data.tar.gz: 7a5cc788e2b8bc7caf6d4960aa28fd2233661b3e8f5d1b2d90ed4a474ba8885c35ee63fcf077b0b25a1a0c2cb9408ca1c22846105592a7de9a87b9330e04c93f

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+bulk-processor-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require 'spec_helper'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.3
+branches:
+  only: master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Apartment List Inc
+
+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,138 @@
+![Travis status for apartmentlist/bulk-processor](https://travis-ci.org/apartmentlist/bulk-processor.svg?branch=master)
+
+
+# BulkProcessor
+
+Bulk upload data in a file (e.g. CSV), process in the background, then send a
+success or failure report
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bulk-processor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bulk-processor
+
+## Usage
+
+Bulk processor requires the following configuration
+
+```ruby
+BulkProcessor.queue_adapter = <adapter>
+```
+
+The default is `:inline`, which skips queueing and processes synchronously. Since
+this is backed by ActiveJob, all of the adapters in [ActiveJob::QueueAdapters]( http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html ),
+including `:resque`.
+
+You will also need to supply a class for item processing and a class/module for completion handling.
+The item processor instance must respond to the following messages:
+
+```
+class PetItemProcessor
+  # @return [Array<String>] column headers that must be present
+  def self.required_columns
+    ['species', 'name', 'age']
+  end
+
+  # @return [Array<String>] column headers that may be present. If a column
+  #   header is present that is not in 'required_columns' or 'optional_columns',
+  #   the file will be considered invalid and no rows will be processed.
+  def self.optional_columns
+    ['favorite_toy', 'talents']
+  end
+
+  # Instantiate the processor with a single row from the CSV represented by
+  # a Hash<String, String>
+  def initialize(record_hash, payload)
+    @record_hash = record_hash
+    @payload = payload
+    @messages = []
+    @success = false
+  end
+
+  # Process the row, e.g. create a new record in the DB, send an email, etc
+  def process!
+    pet = Pet.new(record_hash)
+    if pet.save
+      @success = true
+    else
+      @messages = pet.errors.full_messages
+    end
+  end
+
+  # @return [true|false] true iff the item was processed completely
+  def success?
+    @success
+  end
+
+  # @return [Array<String>] list of messages for this item to pass back to the
+  #   completion handler.
+  def messages
+    @messages
+  end
+end
+```
+
+A completion handler must respond to the following messages
+
+```ruby
+module NotificationHandler
+  # Handle full or partial processing of records. Unless there was a fatal
+  # error, all row indexes will be present either successes or errors, but not
+  # both.
+  #
+  # @param payload [Hash] the payload passed into 'BulkProcessor.process', can
+  #   be used to pass metadata around, e.g. the email address to send a
+  #   completion report to
+  # @param successes [Hash<Fixnum, Array<String>>] keys are all successfully
+  #   processed rows, indexed from 0 (row 1 in the CSV is index 0 in this hash)
+  #   The values are arrays of messages the item processor generated for the row
+  #   (may be empty), e.g. { 0 => [], 1 => ['pet ID = 22 created'] }
+  # @param errors [Hash<Fixnum, Array<String>>] similar structure to successes,
+  #   but rows that were not completed successfully.
+  # @param fatal_error [StandardError] if nil, then all rows were processed,
+  #   else the error that was raise is passed in here
+  def self.complete(payload, successes, errors, fatal_error = nil)
+    if fatal_error
+      PetProcessorMailer.fail(payload['recipient'], successes, errors, fatal_error)
+    else
+      PetProcessorMailer.complete(payload['recipient'], successes, errors)
+    end
+  end
+end
+```
+
+Requesting file processing
+
+```ruby
+processor = BulkProcessor.new(file_stream, PetItemProcessor, NotificationHandler, {recipient: current_user.email})
+if processor.process
+  # The job has been enqueued, go get a coffee and wait
+else
+  handle_invalid_file(processor.errors)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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 `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/apartmentlist/bulk-processor/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,12 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bulk_processor'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bulk-processor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bulk_processor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bulk-processor'
+  spec.version       = BulkProcessor::VERSION
+  spec.authors       = ['Tom Collier, Justin Richard']
+  spec.email         = ['collier@apartmentlist.com, justin@apartmentlist.com']
+
+  spec.summary       = 'Background process CSV data'
+  spec.description   = <<-DESC
+Bulk upload data in a file (e.g. CSV), process in the background, then send a
+success or failure report
+                       DESC
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_runtime_dependency 'activejob', '~> 4'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug', '~> 3'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

data/lib/bulk_processor/config.rb

@@ -0,0 +1,9 @@
+class BulkProcessor
+  class Config
+    attr_reader :queue_adapter
+
+    def queue_adapter=(adapter)
+      ActiveJob::Base.queue_adapter = @queue_adapter = adapter
+    end
+  end
+end

data/lib/bulk_processor/job.rb

@@ -0,0 +1,26 @@
+class BulkProcessor
+  class Job < ActiveJob::Base
+    queue_as 'bulk_processor'
+
+    def perform(records, item_proccessor, handler, payload)
+      item_proccessor_class = item_proccessor.constantize
+      handler_class = handler.constantize
+
+      successes = {}
+      failures = {}
+      records.each_with_index do |record, index|
+        processor = item_proccessor_class.new(record, payload)
+        processor.process!
+        if processor.success?
+          successes[index] = processor.messages
+        else
+          failures[index] = processor.messages
+        end
+      end
+      handler_class.complete(payload, successes, failures, nil)
+    rescue Exception => exception
+      handler_class.complete(payload, successes, failures, exception)
+      raise unless exception.is_a?(StandardError)
+    end
+  end
+end

data/lib/bulk_processor/stream_encoder.rb

@@ -0,0 +1,26 @@
+class BulkProcessor
+  # Force encode a stream into UTF-8 by removing invalid and undefined
+  # characters.
+  class StreamEncoder
+    ENCODING_OPTIONS = { undef: :replace, invalid: :replace, replace: '' }
+    private_constant :ENCODING_OPTIONS
+
+    def initialize(stream)
+      @stream = stream
+    end
+
+    # Return the UTF-8 encoded string.
+    #
+    # Note: this method reads the stream, so it will need to be rewound before
+    # attempting to read again.
+    #
+    # @return [String] a UTF-8 encoded string
+    def encoded
+      stream.read.encode(Encoding::UTF_8, ENCODING_OPTIONS)
+    end
+
+    private
+
+    attr_reader :stream
+  end
+end

data/lib/bulk_processor/validated_csv.rb

@@ -0,0 +1,62 @@
+class BulkProcessor
+  class ValidatedCSV
+    PARSING_OPTIONS  = { headers: true, header_converters: :downcase }
+    private_constant :PARSING_OPTIONS
+
+    BAD_HEADERS_ERROR_MSG = "undefined method `encode' for nil:NilClass"
+    private_constant :BAD_HEADERS_ERROR_MSG
+
+    attr_reader :errors, :records
+
+    def initialize(stream, required_headers, optional_headers)
+      @stream = stream
+      @required_headers = required_headers
+      @optional_headers = optional_headers
+      @errors = []
+    end
+
+    def valid?
+      @errors = []
+
+      if missing_headers.any?
+        errors << "Missing required column(s): #{missing_headers.join(', ')}"
+      end
+
+      if extra_headers.any?
+        errors << "Unrecognized column(s) found: #{extra_headers.join(', ')}"
+      end
+
+      unless csv.headers.all?
+        errors << 'Missing or malformed column header, is one of them blank?'
+      end
+    rescue NoMethodError => error
+      if error.message == BAD_HEADERS_ERROR_MSG
+        errors << 'Missing or malformed column header, is one of them blank?'
+      else
+        raise error
+      end
+    ensure
+      return errors.empty?
+    end
+
+    def row_hashes
+      csv.map(&:to_hash)
+    end
+
+    private
+
+    attr_reader :stream, :required_headers, :optional_headers
+
+    def csv
+      @csv ||= CSV.parse(stream, PARSING_OPTIONS)
+    end
+
+    def missing_headers
+      required_headers - csv.headers
+    end
+
+    def extra_headers
+      csv.headers - [*required_headers, *optional_headers]
+    end
+  end
+end

data/lib/bulk_processor/version.rb

@@ -0,0 +1,3 @@
+class BulkProcessor
+  VERSION = '0.1.0'
+end

data/lib/bulk_processor.rb

@@ -0,0 +1,46 @@
+require 'active_job'
+require 'csv'
+
+require 'bulk_processor/config'
+require 'bulk_processor/job'
+require 'bulk_processor/stream_encoder'
+require 'bulk_processor/validated_csv'
+require 'bulk_processor/version'
+
+class BulkProcessor
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+  end
+
+  attr_reader :stream, :item_processor, :handler, :payload, :errors
+
+  def initialize(stream, item_processor, handler, payload = {})
+    @stream = stream
+    @item_processor = item_processor
+    @handler = handler
+    @payload = payload
+    @errors = []
+  end
+
+  def process
+    csv = ValidatedCSV.new(
+      StreamEncoder.new(stream).encoded,
+      item_processor.required_columns,
+      item_processor.optional_columns
+    )
+
+    if csv.valid?
+      Job.perform_later(csv.row_hashes, item_processor.to_s, handler.to_s, payload)
+    else
+      @errors = csv.errors
+    end
+    @errors.empty?
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bulk-processor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Collier, Justin Richard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: |
+  Bulk upload data in a file (e.g. CSV), process in the background, then send a
+  success or failure report
+email:
+- collier@apartmentlist.com, justin@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bulk-processor.gemspec
+- lib/bulk_processor.rb
+- lib/bulk_processor/config.rb
+- lib/bulk_processor/job.rb
+- lib/bulk_processor/stream_encoder.rb
+- lib/bulk_processor/validated_csv.rb
+- lib/bulk_processor/version.rb
+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: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Background process CSV data
+test_files: []