ductr 0.1.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ductr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    ductr (0.1.0)
+      activejob (~> 7.0)
+      annotable (~> 0.1)
+      colorize (~> 0.8)
+      kiba (~> 4.0)
+      rufus-scheduler (~> 3.8)
+      thor (~> 1.2)
+      zeitwerk (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    annotable (0.1.2)
+    ast (2.4.2)
+    colorize (0.8.1)
+    commander (4.6.0)
+      highline (~> 2.0.0)
+    concurrent-ruby (1.1.10)
+    debug (1.6.3)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    et-orbi (1.2.7)
+      tzinfo
+    fugit (1.7.1)
+      et-orbi (~> 1, >= 1.2.7)
+      raabro (~> 1.4)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    highline (2.0.3)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.2)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    kiba (4.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parlour (5.0.0)
+      commander (~> 4.5)
+      parser
+      rainbow (~> 3.0)
+      sorbet-runtime (>= 0.5)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    raabro (1.4.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rufus-scheduler (3.8.2)
+      fugit (~> 1.1, >= 1.1.6)
+    sorbet-runtime (0.5.10712)
+    sord (4.0.0)
+      commander (~> 4.5)
+      parlour (~> 5.0)
+      sorbet-runtime
+      yard
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.6)
+  ductr!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  sord (~> 4.0)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,37 @@
+# Ductr
+
+Ductr is a data pipeline and ETL framework built with efficiency, simplicity and testability in mind.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ductr"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ductr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ductr-io/ductr.
+
+## License
+
+The gem is available as open source under the terms of the [LGPLv3 or later](https://opensource.org/license/lgpl-3-0/).

data/Rakefile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "sord"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc "Generates RBS file from the yard documentation"
+task :sord do
+  options = {
+    rbs: true,
+    sord_comments: true,
+    regenerate: true,
+    break_params: 4,
+    replace_errors_with_untyped: false,
+    replace_unresolved_with_untyped: false,
+    exclude_messages: nil,
+    include_messages: nil,
+    keep_original_comments: false,
+    skip_constants: false,
+    use_original_initialize_return: false,
+    exclude_untyped: false
+  }
+
+  plugin = Sord::ParlourPlugin.new(options)
+  plugin.parlour = Parlour::RbsGenerator.new(break_params: options[:break_params])
+  plugin.generate(plugin.parlour.root)
+
+  File.write("sig/ductr.rbs", plugin.parlour.send(:rbs))
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ductr"
+
+# 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(__FILE__)

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/ductr.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "lib/ductr/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ductr"
+  spec.version = Ductr::VERSION
+  spec.authors = ["Mathieu Morel"]
+  spec.email = ["mathieu@lamanufacture.dev"]
+  spec.license = "LGPL-3.0-or-later"
+
+  spec.summary = "Data pipeline and ETL framework."
+  spec.description = "A data pipeline and ETL framework for ruby."
+  spec.homepage = "https://github.com/ductr-io/ductr"
+  spec.required_ruby_version = ">= 3.1.0"
+  # TODO: Change gem server URL for a real one
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "debug", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "sord", "~> 4.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  spec.add_dependency "activejob", "~> 7.0"
+  spec.add_dependency "annotable", "~> 0.1"
+  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_dependency "kiba", "~> 4.0"
+  spec.add_dependency "rufus-scheduler", "~> 3.8"
+  spec.add_dependency "thor", "~> 1.2"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+end

data/exe/ductr

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+
+EXEC_PATH = "bin/ductr"
+CURRENT_DIR = Dir.pwd.freeze
+
+loop do
+  if File.file?(EXEC_PATH)
+    exec Gem.ruby, EXEC_PATH, *ARGV
+    break
+  end
+
+  if Pathname.new(Dir.pwd).root?
+    Dir.chdir(CURRENT_DIR)
+    break
+  end
+
+  Dir.chdir("..")
+end
+
+require_relative "../lib/ductr"
+Ductr::CLI::Default.start

data/lib/ductr/adapter.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Ductr
+  #
+  # Base adapter class, your adapter should inherit of this class.
+  #
+  class Adapter
+    class << self
+      #
+      # All the sources declared for this adapter goes here.
+      #
+      # @return [Registry] The registry instance
+      #
+      def source_registry
+        @source_registry ||= Registry.new(:source)
+      end
+
+      #
+      # All the lookups declared for this adapter goes here.
+      #
+      # @return [Registry] The registry instance
+      #
+      def lookup_registry
+        @lookup_registry ||= Registry.new(:lookup)
+      end
+
+      #
+      # All the destinations declared for this adapter goes here.
+      #
+      # @return [Registry] The registry instance
+      #
+      def destination_registry
+        @destination_registry ||= Registry.new(:destination)
+      end
+
+      #
+      # All the triggers declared for this adapter goes here.
+      #
+      # @return [Registry] The registry instance
+      #
+      def trigger_registry
+        @trigger_registry ||= Registry.new(:trigger)
+      end
+    end
+
+    # @return [Symbol] the adapter instance name
+    attr_reader :name
+
+    # @return [Hash<Symbol: Object>] the adapter configuration hash
+    attr_reader :config
+
+    #
+    # Creates a new adapter instance.
+    #
+    # @param [Symbol] name The adapter instance name, mandatory, must be unique
+    # @param [Hash<Symbol: Object>] **config The adapter configuration hash
+    #
+    def initialize(name, **config)
+      @name = name
+      @config = config
+    end
+
+    #
+    # Allow use of adapter with block syntax, automatically closes on block exit.
+    #
+    # @yield a block to execute when the adapter is opened
+    # @return [void]
+    #
+    def open(&)
+      yield(open!)
+    ensure
+      close!
+    end
+
+    #
+    # Opens the adapter before using it e.g. open connection, authenticate to http endpoint, open file...
+    # This method may return something, as a connection object.
+    #
+    # @return [void]
+    #
+    def open!
+      raise NotImplementedError, "An adapter must implement the #open! method"
+    end
+
+    #
+    # Closes the adapter when finished e.g. close connection, drop http session, close file...
+    #
+    # @return [void]
+    #
+    def close!
+      raise NotImplementedError, "An adapter must implement the #close! method"
+    end
+  end
+end

data/lib/ductr/cli/default.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Ductr
+  module CLI
+    #
+    # The default CLI is started when no project folder was found.
+    # It expose project and adapter generation tasks.
+    #
+    class Default < Thor
+      desc "new", "Generates a new project"
+      #
+      # Generates a new project
+      #
+      # @param name [String] The project's name
+      #
+      # @return [void]
+      #
+      def new(name = nil)
+        NewProjectGenerator.start([name])
+      end
+    end
+  end
+end

data/lib/ductr/cli/main.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Ductr
+  module CLI
+    #
+    # The main CLI is started when used inside a ductr project folder.
+    # It exposes scheduling and monitoring tasks.
+    #
+    class Main < Thor
+      desc "perform, p [JOB]", "Queues the given job"
+      method_option :sync, type: :boolean, default: false, aliases: "-s",
+                           desc: "Runs the job synchronously instead of queueing it"
+      method_option :params, type: :array, aliases: "-p", desc: "Running the job with parameters"
+      def perform(job_name)
+        job = job_name.camelize.constantize.new(*options[:params])
+
+        job.is_a?(Pipeline) ? Store.register_pipeline(job) : Store.register_job(job)
+        return job.perform_now if options[:sync]
+
+        job.enqueue
+        return unless ActiveJob::Base.queue_adapter.is_a? ActiveJob::QueueAdapters::AsyncAdapter
+
+        sleep(0.1) until Store.all_done?
+      end
+
+      desc "schedule, s [SCHEDULERS]", "Run the given schedulers"
+      def schedule(*scheduler_names)
+        scheduler_names.each { |name| name.camelize.constantize.new }
+        Scheduler.start
+
+        sleep_until_interrupt do
+          Scheduler.stop
+        end
+      end
+
+      private
+
+      #
+      # Keeps the thread alive until Ctrl-C is pressed.
+      #
+      # @yield The block to execute when Ctrl-C is pressed
+      #
+      # @return [void]
+      #
+      def sleep_until_interrupt(&)
+        say "use Ctrl-C to stop"
+
+        trap "SIGINT" do
+          say "Exiting"
+          yield
+          exit 130
+        end
+
+        sleep
+      end
+    end
+  end
+end