reevoo-pipeline 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0e568fda1e586d6383aa4fc88cd1972af801064
+  data.tar.gz: 58dfeeefdd784898b0f1ef9abec90c4c54f212f6
+SHA512:
+  metadata.gz: 25da6c929200fb6478c559b607974caf0481725b1de09a73565ecd7979c13f2c827c370322a9094d4fd31a59216ac88af358b3a86af4f48db2e4e467a137fe7d
+  data.tar.gz: 58814d5916fd28b46b4bdce14bcbc581384c875674daeaeb67d2446b8f1821d18a94d5d2249ac7b4af0f9e8610de42985b8c0f24f98c177683e618b070d1d970

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+ - 2.1.2
+ - 2.0.0
+notifications:
+  hipchat:
+    rooms:
+      secure: TsK/bMZTm/izur4uaaJ0A8vJiY7929vyV2YgmyEMghlc8SxSdARKCubsbarTpc3kBMKexBPds4ve6BeRuC7iofRwKiRVJEqn7XFsOUXfeTiL+OS/f2Q5ydXQkrPpw6ELW84dSA/nrmhezVE7zMZoAy9jPourIAeBTxRynuYy9rw=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Philip Stevens
+
+MIT License
+
+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,33 @@
+# Reevoo Pipeline
+
+An agnostic extractor, transformer, and loader library
+
+[![Build Status](https://travis-ci.org/reevoo/pipeline.svg?branch=master)](https://travis-ci.org/reevoo/pipeline)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipeline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reevoo-pipeline
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pipeline/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,16 @@
+desc 'Run an IRB session with Pipeline pre-loaded'
+task :console do
+  exec 'irb -I lib -r pipeline'
+end
+
+unless %w(production staging integration).include?(ENV['PIPELINE_ENV'])
+  require 'rspec/core/rake_task'
+  desc 'Run the test suite'
+  RSpec::Core::RakeTask.new(:spec)
+
+  require 'rubocop/rake_task'
+  desc 'Run RuboCop on the lib directory'
+  RuboCop::RakeTask.new(:rubocop)
+
+  task default: [:spec, :rubocop]
+end

data/lib/pipeline.rb

@@ -0,0 +1,40 @@
+# Pipeline is a library that provides a common interface for implementing
+# pipeline (ETL) behaviour. You can register extractors that may use
+# transformations before pushing into specified loaders.
+module Pipeline
+  autoload :Extractor,    'pipeline/extractor'
+  autoload :Transformer,  'pipeline/transformer'
+  autoload :Loader,       'pipeline/loader'
+  autoload :Config,       'pipeline/config'
+  autoload :Logging,      'pipeline/logging'
+  autoload :Version,      'pipeline/version'
+
+  module_function
+  def register_extractor(extractor)
+    extractors << extractor
+  end
+
+  def extractors
+    @extractors ||= []
+  end
+
+  def register_transformer(transformer)
+    transformers << transformer
+  end
+
+  def transformers
+    @transformers ||= []
+  end
+
+  def register_loader(loader)
+    loaders << loader
+  end
+
+  def loaders
+    @loaders ||= []
+  end
+
+  def logger
+    Pipeline::Logging.logger
+  end
+end

data/lib/pipeline/config.rb

@@ -0,0 +1,50 @@
+# Based on: https://github.com/gocardless/hutch/blob/master/lib/hutch/config.rb
+require 'logger'
+
+module Pipeline
+  class UnknownAttributeError < StandardError; end
+
+  # This defines configuration for the pipeline.
+  module Config
+    def self.initialize(params = {})
+      @config = { log_level: Logger::INFO }.merge(params)
+    end
+
+    def self.get(attr)
+      check_attr(attr)
+      user_config[attr]
+    end
+
+    def self.set(attr, value)
+      check_attr(attr)
+      user_config[attr] = value
+    end
+
+    class << self
+      alias_method :[],  :get
+      alias_method :[]=, :set
+    end
+
+    def self.check_attr(attr)
+      unless user_config.key?(attr)
+        fail UnknownAttributeError, "#{attr} is not a valid config attribute"
+      end
+    end
+
+    def self.user_config
+      initialize unless @config
+      @config
+    end
+
+    def self.method_missing(method, *args, &block)
+      attr = method.to_s.sub(/=$/, '').to_sym
+      return super unless user_config.key?(attr)
+
+      if method =~ /=$/
+        set(attr, args.first)
+      else
+        get(attr)
+      end
+    end
+  end
+end

data/lib/pipeline/extractor.rb

@@ -0,0 +1,14 @@
+module Pipeline
+  # Include this module in a class to register it as an extractor.
+  module Extractor
+    def self.included(base)
+      base.extend(ClassMethods)
+      Pipeline.register_extractor(base)
+    end
+
+    # Class methods that you should use to construct your own extractor.
+    module ClassMethods
+      attr_writer :connection, :command, :transformations
+    end
+  end
+end

data/lib/pipeline/loader.rb

@@ -0,0 +1,13 @@
+module Pipeline
+  # Include this module in a class to register it as an loader.
+  module Loader
+    def self.included(base)
+      base.extend(ClassMethods)
+      Pipeline.register_loader(base)
+    end
+
+    # Class methods that you should use to construct your own loader.
+    module ClassMethods
+    end
+  end
+end

data/lib/pipeline/logging.rb

@@ -0,0 +1,38 @@
+
+# Based on: https://github.com/gocardless/hutch/blob/master/lib/hutch/logging.rb
+require 'logger'
+require 'time'
+
+module Pipeline
+  # Provides a customized logging module.
+  module Logging
+    # Pipeline logging format
+    class PipelineFormatter < Logger::Formatter
+      def call(severity, time, _, message)
+        "#{time.utc.iso8601} #{Process.pid} #{severity} -- #{message}\n"
+      end
+    end
+
+    def self.setup_logger(target = $stdout)
+      require 'pipeline/config'
+      @logger = Logger.new(target)
+      @logger.level = Pipeline::Config.log_level
+      @logger.formatter = PipelineFormatter.new
+      @logger
+    end
+
+    def self.logger
+      @logger || setup_logger
+    end
+
+    # rubocop:disable Style/TrivialAccessors
+    def self.logger=(logger)
+      @logger = logger
+    end
+    # rubocop:enable Style/TrivialAccessors
+
+    def logger
+      Pipeline::Logging.logger
+    end
+  end
+end

data/lib/pipeline/transformer.rb

@@ -0,0 +1,17 @@
+module Pipeline
+  # Include this module in a class to register it as an transformer.
+  module Transformer
+    def self.included(base)
+      base.extend(ClassMethods)
+      Pipeline.register_transformer(base)
+    end
+
+    # Class methods that you should use to construct your own transformer.
+    module ClassMethods
+      def position(value)
+        value = value.to_i
+        @position = value if value > 0
+      end
+    end
+  end
+end

data/lib/pipeline/version.rb

@@ -0,0 +1,4 @@
+# Semantic Versioning (http://semver.org/)
+module Pipeline
+  VERSION = '0.0.2'
+end

data/pipeline.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipeline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'reevoo-pipeline'
+  spec.version       = Pipeline::VERSION
+  spec.authors       = ['Reevoo Developers']
+  spec.email         = ['developers@reevoo.com']
+  spec.homepage      = 'http://reevoo.github.io/projects/pipeline'
+  spec.license       = 'MIT'
+  spec.summary       = 'An agnostic extractor, transformer, and loader library'
+  spec.description   = <<-DESCRIPTION
+Provides a common interface for creating all three parts to the ETL flow.
+DESCRIPTION
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep('bin') { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep('spec')
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # For tests
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.25'
+end

data/spec/pipeline/extractor_spec.rb

@@ -0,0 +1,26 @@
+describe Pipeline::Extractor do
+  around(:each) do |example|
+    isolate_constants do
+      example.run
+    end
+  end
+
+  let(:simple_extractor) do
+    unless defined? SimpleExtractor
+      class SimpleExtractor
+        include Pipeline::Extractor
+      end
+    end
+    SimpleExtractor
+  end
+
+  describe 'module inclusion' do
+    it 'registers the class as a extractor' do
+      expect(Pipeline).to receive(:register_extractor) do |klass|
+        expect(klass).to eq(simple_extractor)
+      end
+
+      simple_extractor
+    end
+  end
+end

data/spec/pipeline/loader_spec.rb

@@ -0,0 +1,26 @@
+describe Pipeline::Loader do
+  around(:each) do |example|
+    isolate_constants do
+      example.run
+    end
+  end
+
+  let(:simple_loader) do
+    unless defined? SimpleLoader
+      class SimpleLoader
+        include Pipeline::Loader
+      end
+    end
+    SimpleLoader
+  end
+
+  describe 'module inclusion' do
+    it 'registers the class as a loader' do
+      expect(Pipeline).to receive(:register_loader) do |klass|
+        expect(klass).to eq(simple_loader)
+      end
+
+      simple_loader
+    end
+  end
+end

data/spec/pipeline/logger_spec.rb

@@ -0,0 +1,27 @@
+describe Pipeline::Logging do
+  let(:dummy_object) do
+    class DummyObject
+      include Pipeline::Logging
+    end
+  end
+
+  describe '#logger' do
+    context 'with the default logger' do
+      subject { Pipeline::Logging.logger }
+
+      specify do
+        is_expected.to be_instance_of(Logger)
+      end
+    end
+
+    context 'with a custom logger' do
+      let(:dummy_logger) { double('Dummy logger', warn: true, info: true) }
+      after { Pipeline::Logging.setup_logger }
+
+      it 'users the custom logger' do
+        Pipeline::Logging.logger = dummy_logger
+        expect(Pipeline::Logging.logger).to eq(dummy_logger)
+      end
+    end
+  end
+end

data/spec/pipeline/transformer_spec.rb

@@ -0,0 +1,23 @@
+describe Pipeline::Transformer do
+  around(:each) do |example|
+    isolate_constants do
+      example.run
+    end
+  end
+
+  let(:simple_transformer) do
+    unless defined? SimpleTransformer
+      class SimpleTransformer
+        include Pipeline::Transformer
+      end
+    end
+    SimpleTransformer
+  end
+
+  describe 'module inclusion' do
+    it 'registers the class as a transformer' do
+      simple_transformer
+      expect(Pipeline.transformers.count).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+SimpleCov.start { add_filter '/spec/' }
+
+require 'pry'
+require 'pipeline'
+require 'logger'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+RSpec.configure do |config|
+  config.before(:all) { Pipeline::Config.log_level = Logger::FATAL }
+  config.raise_errors_for_deprecations!
+end

data/spec/support/deep_copy.rb

@@ -0,0 +1,3 @@
+def deep_copy(obj)
+  Marshal.load(Marshal.dump(obj))
+end

data/spec/support/isolate_constants.rb

@@ -0,0 +1,10 @@
+# Constants (classes, etc) defined within a block passed to this method
+# will be removed from the global namespace after the block as run.
+def isolate_constants
+  existing_constants = Object.constants
+  yield
+ensure
+  (Object.constants - existing_constants).each do |constant|
+    Object.send(:remove_const, constant)
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: reevoo-pipeline
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Reevoo Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+description: |
+  Provides a common interface for creating all three parts to the ETL flow.
+email:
+- developers@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pipeline.rb
+- lib/pipeline/config.rb
+- lib/pipeline/extractor.rb
+- lib/pipeline/loader.rb
+- lib/pipeline/logging.rb
+- lib/pipeline/transformer.rb
+- lib/pipeline/version.rb
+- pipeline.gemspec
+- spec/pipeline/config_spec.rb
+- spec/pipeline/extractor_spec.rb
+- spec/pipeline/loader_spec.rb
+- spec/pipeline/logger_spec.rb
+- spec/pipeline/transformer_spec.rb
+- spec/spec_helper.rb
+- spec/support/deep_copy.rb
+- spec/support/isolate_constants.rb
+homepage: http://reevoo.github.io/projects/pipeline
+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.4.1
+signing_key: 
+specification_version: 4
+summary: An agnostic extractor, transformer, and loader library
+test_files: []
+has_rdoc: