funktor 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 154286564dee4cc895ef3515dcacfa515a91ecde743862e36c833d6db0389447
+  data.tar.gz: e1786a3bdda966cd7d1fdda07ae3faf12f3ec2ca27b51506257520b3d13b02dd
+SHA512:
+  metadata.gz: c6b7de2400aceac0dcad12d2ad4093a07be595a120f88c58eddf7fa63f3a353e7637c47963cca8e79263b1ec29838ee5c26147a0e924cc7508092ac968e104b2
+  data.tar.gz: c5cf1bdea5c9ad86415d7da9350b28699900b623a05d4860ecfb11c77daa773fbdd4b1c33a166cfa7c7025a238c268d3748b8a9b9989043e0f29cae6a8446d99

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# The funktor dir isn't a real part of the gem, it's where things
+# get generated as I'm testing the gem locally. It doesn't need to be in git.
+/funktor/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 jeremy@octolabs.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in funktor.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    funktor (0.2.1)
+      activesupport
+      aws-sdk-sqs (~> 1.37)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.465.0)
+    aws-sdk-core (3.114.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-sqs (1.39.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    hashdiff (1.0.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    minitest (5.14.4)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  funktor!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeremy Green
+
+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,154 @@
+# Funktor
+
+It's like [Sidekiq](https://sidekiq.org/) for [AWS Lambda](https://aws.amazon.com/lambda/).
+
+Execute your background jobs in Lambda for nearly instant and infinite scalability. This is ideal for
+applications with uneven, unpredictable, or bursty usage patterns.
+
+Coming Soon: Funktor Pro & Funktor Enterprise
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'funktor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install funktor
+
+## Initializing a new `funktor` app
+
+Funktor uses [serverless](https://www.serverless.com/) to provision AWS resources and to deploy your
+code to Lambda. You can install serverless by doing:
+
+```
+npm install -g serverless
+```
+
+Then you can initialize a new app by doing:
+
+
+```bash
+funktor init
+```
+
+This will create a `funktor` directory that is ready to deploy to AWS. If you've already configured
+your aws tools via `~/.aws/credentials` you should be ready to deploy.
+
+`funktor/serverless.yml` is the main file that ties everything together.
+
+`funktor/config` contains a few files that you can use to configure your `funktor` application.
+
+`funktor/resources` contains a few files that provision some AWS resources that are used by `funktor`.
+* An SQS Queue for the "incoming jobs queue"
+* A Dynamo DB table to allow queueing of jobs more than 15 minutes in the future (Funktor Pro)
+* One or more SQS Queues for active jobs (currently there is only the default queue, support for additional queues is coming soon)
+* An IAM User with permission to push jobs to the incoming jobs queue
+* A CloudWatch dashboard to let you keep tabs on your application
+
+`funktor/lambda_handlers` contains some scripts that receive events from Lambda, then invoke `funktor` to
+do various things:
+* `active_job_handler.rb` executes your jobs
+* `delayed_job_scheduler.rb` (Funktor Pro) pulls delayed jobs out of DynamoDB and places them on the active job queue.
+* `incoming_job_handler.rb` receives incoming jobs and pushes them to DynamoDB for delayed execution or to the active job queue as appropriate.
+
+`funktor/function_definitions` contains details about hooking up the `lambda_handlers` to events.
+
+`funktor/iam_permissions` contains some details about giving your lambda functions the appropriate permissions
+to interact with SQS.
+
+`funktor/workers` is where your workers will live.
+
+`funktor/Gemfile` is the `Gemfile` that contains the gems that are needed for your workers to execute
+jobs. This should be the minimal set of gems you can get away with so that cold start times remain reasonable.
+This file will already contain `funktor`. (Don't remove it or `funktor` won't work!)
+
+## Deploying
+
+After initialiing your app you can deploy it by `cd`ing into the `funktor` directory and using
+`serverless deploy`.
+
+```
+cd funktor
+serverless deploy --verbose
+```
+
+This will deploy to the `dev` stage. To deploy to a differnt stage you can use the `--stage` flag:
+
+```
+serverless deploy --stage production --verbose
+```
+
+After your app is deployed you'll see some outputs containing details about your AWS resources. The
+primary ones you should look for are `IncomingJobQueueUrl`, `AccessKeyID`, and `SecretAccessKey`.
+Those three pieces of info represent the primary interface to your `funktor` app from the outside world.
+
+To push your first job to `funktor` you can make note of those values and then do something like this
+in a `rails console`.
+
+```ruby
+ENV['FUNKTOR_INCOMING_JOB_QUEUE'] = "<Your IncomingJobQueueUrl>"
+ENV['AWS_ACCESS_KEY_ID'] = "<Your AccessKeyID>"
+ENV['AWS_SECRET_ACCESS_KEY'] = "<Your SecretAccessKey>"
+ENV['AWS_REGION'] = "<Your AWS Region>" # 'us-east-1' by default
+
+require_relative 'funktor/workers/hello_worker'
+HelloWorker.perform_async
+```
+
+If everything went well you should see something like this:
+
+```ruby
+=> #<struct Aws::SQS::Types::SendMessageResult md5_of_message_body="...",
+  md5_of_message_attributes=nil, md5_of_message_system_attributes=nil,
+  message_id="...", sequence_number=nil>
+```
+
+## Writing Workers
+
+```ruby
+class HelloWorker
+  include Funktor::Worker
+
+  def perform(name)
+    puts "hello #{name}"
+  end
+end
+```
+
+The arguments to your `perform` methos must be plain Ruby objects, and not complex objects like ActiveRecord
+models. Funktor will dump the arguments to JSON when pushing the job onto the queue, so you need to make sure
+that your arguments can be dumped to JSON and loaded back again without losing any information.
+
+## Calling Workers
+
+```ruby
+HelloWorker.perform_async(name)
+HelloWorker.perform_in(5.minutes, name)
+```
+
+## 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 tags, 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/Octo-Labs/funktor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/funktor/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Funktor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Octo-Labs/funktor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "funktor"
+
+# 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/exe/funktor

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require_relative "../lib/funktor/cli/application"
+
+# Scratch pad:
+#
+# funktor init => serverless.yml Gemfile Dockerfile a few resources (default queue)
+# funktor init --dir=some_dir => serverless.yml Gemfile Dockerfile a few resources (default queue)
+# funktor generate work_queue --name=high_priority => resource + handler for a work queue
+# funktor deploy ????
+#
+# funktor-pro init => additional resources + handler
+
+Funktor::CLI::Application.start(ARGV)

data/exe/funktor-deploy

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/funktor/deploy/cli'
+
+cli = Funktor::Deploy::CLI.new
+cli.parse
+cli.run
+

data/funktor.gemspec

@@ -0,0 +1,38 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'funktor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "funktor"
+  spec.version       = Funktor::VERSION
+  spec.authors       = ["Jeremy Green"]
+  spec.email         = ["jeremy@octolabs.com"]
+
+  spec.summary       = %q{Background processing in AWS Lambda.}
+  spec.description   = %q{Background processing in AWS Lambda.}
+  spec.homepage      = "https://github.com/Octo-Labs/funktor"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Octo-Labs/funktor"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'aws-sdk-sqs', '~> 1.37'
+  spec.add_dependency "activesupport" # TODO - Can we build our own verison of cattr_accessor to avoid this?
+  spec.add_dependency "thor" # TODO - Can we build our own verison of cattr_accessor to avoid this?
+
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end