jarbs 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8aee7bfc746ed5e58dfd6577850abab88c2c09d4
+  data.tar.gz: 5fb103e40bce30237c937ef469b35830a83253fc
+SHA512:
+  metadata.gz: 5e9bb53cf84b6df0e0da406859c7a6ad48b8a94c531997888010154b86e39f6bfac5774372e7acea2e8eb9f777047959135dbace13ff78ff3d886588ee03591f
+  data.tar.gz: 12d91612386943a5172caee840032a3896283d85f479f646083dffd4d33c846625153a2db9fe7017ed3cf8fdeb51f496e98da6b6619acc7aaea67acc3663a4b9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+# JARBS
+
+## Opinionated Lambda Tooling
+
+![Jarbs](http://d.pr/i/12xTT/45aKDrvM+)
+
+## Install
+
+Currently we distributed the `jarbs` runtime via gems hosted by RubyGems.org.
+
+`gem install jarbs`
+
+If this is a new machine or you haven't had to install any C extentions for Ruby yet, you may also need `cmake` before this gem will install: `brew install cmake`. We're looking at options for eliminating this step.
+
+## Usage
+
+For the most up-to-date documentation and usage, run `jarbs -h`
+
+### Generate a new lambda project:
+
+`lambda new my-function`
+
+This produces:
+
+```
+- my-function/
+  package.json (for build and dev deps)
+  - lambdas/
+    - my-function/
+      - src/
+        index.js (placeholder handler function)
+        package.json (for lambda dependencies)
+```
+
+### Generate another lambda in the same project
+
+(while in the project folder created above):
+
+`lambda new other-function`
+
+Your project will then look like:
+
+```
+- my-function/
+  package.json
+  - lambdas/
+    - my-function/
+      - src/
+        index.js
+        package.json
+    - other-function/
+      - src/
+        index.js
+        package.json
+```
+
+### Deploy to Lambda
+
+`jarbs deploy my-function`
+
+You can provide the ARN role via `--role` at invocation, or it will ask you for one during runtime. This will perform the following:
+
+1. Build code using [BabelJS](http://babeljs.io/) via the default `npm build:function` step as defined in the function's `package.json`. This build step also copies the compiled code from `src` to `dest`. If you customize the `npm build:function` step, the customization will also need to perform this same copy.
+2. Install npm dependecies via `npm install --production` in the `dest` directory.
+3. Package the `dest` dir as a zip archive (in memory).
+4. Upload to S3
+5. Destroy `dest` artifacts.
+
+If you have already deployed this function to lambda before, it will update the code with your changes.
+
+All functions are prefixed with the `--env` provided (i.e. 'dev', 'prod'). The env defaults to 'dev'.
+
+### Remove from Lambda
+
+`jarbs rm my-function`
+
+Will destroy the lambda function on AWS (will still leave files in your lambdas directory). You can specify multiple functions here if you wish.
+
+## License
+
+*MIT*
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'jarbs/version'
+# require "rake/testtask"
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << "test"
+#   t.libs << "lib"
+#   t.test_files = FileList['test/**/*_test.rb']
+# end
+
+# task :default => :test

data/bin/console

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require "bundler/setup"
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require "jarbs"
+
+Jarbs::CLI.new.run

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jarbs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jarbs"
+  spec.version       = Jarbs::VERSION
+  spec.authors       = ["Luke van der Hoeven"]
+  spec.email         = ["hungerandthirst@gmail.com"]
+
+  spec.summary       = %q{Jarbs: CLI Tooling for Lambda}
+  spec.description   = %q{Jarbs: They took em.}
+  spec.homepage      = "https://docs.articulate.zone/tools/jarbs.html"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = %w{ jarbs }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "commander"
+  spec.add_dependency "aws-sdk", "~> 2"
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "rugged"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

data/lib/jarbs.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'fileutils'
+require 'commander'
+
+require 'jarbs/version'
+require 'jarbs/lambda'
+
+module Jarbs
+  class CLI
+    include Commander::Methods
+
+    GLOBAL_DEFAULTS = { env: 'dev' }
+
+    def run
+      program :version, Jarbs::VERSION
+      program :description, 'Lambda Tooling'
+
+      global_option('-e', '--env ENV', String, 'Set deployment environment [Default to dev]')
+      global_option('-d', '--debug', 'Enable debug mode') { $debug = true }
+
+      command :new do |c|
+        c.syntax = 'jarbs new [options] name'
+        c.summary = "Generate a new lambda function skeleton"
+        c.option "-f", "--force", "Force overwrite of existing function definition"
+        c.action do |args, options|
+          name = args.shift || abort("Must provide a lambda name")
+          options.default GLOBAL_DEFAULTS
+
+          if Dir.exists? name
+            if options.force
+              FileUtils.rm_r name
+            else
+              abort("Function exists. Use the -f flag to force overwrite.")
+            end
+          end
+
+          # create project dir if doesn't exist yet
+          if !Dir.exists?('lambdas')
+            ProjectGenerator.new(name).generate
+            Dir.chdir name
+          end
+
+          Lambda.new(name, options).generate
+        end
+      end
+
+      command :deploy do |c|
+        c.syntax = 'jarbs deploy [options] directory'
+        c.summary = 'Deploy a lambda function to AWS'
+        c.option "--role [STRING]", String, "IAM role for Lambda execution"
+        c.action do |args, options|
+          name = args.shift || abort('Name argument required')
+          options.default GLOBAL_DEFAULTS
+
+          Lambda.new(name, options).deploy
+        end
+      end
+
+      command :rm do |c|
+        c.syntax = 'jarbs rm NAME [NAME...]'
+        c.summary = "Delete a lambda function"
+        c.action do |args, options|
+          name = args.shift || abort('Name argument required')
+          options.default GLOBAL_DEFAULTS
+
+          begin
+            args.each do |fn|
+              begin
+                Lambda.new(fn, options).delete
+              rescue Aws::Lambda::Errors::ResourceNotFoundException => e
+                say_error "Function \"#{fn}\" does not exists. Ignoring."
+                next
+              end
+            end
+          end
+        end
+      end
+
+      run!
+    end
+  end
+end

data/lib/jarbs/fixtures/index.js

@@ -0,0 +1,10 @@
+// Lambda will use `index.handler` as it's entrypoint.
+// If you rename this file or the handler function,
+// you will need to update the Lambda configs.
+
+export function handler(event, context) {
+
+  // Your code here
+
+  context.done(null, { msg: "Hello from Lambda!" });
+};

data/lib/jarbs/function_definition.rb

@@ -0,0 +1,45 @@
+module Jarbs
+  class FunctionDefinition
+    attr_reader :env, :name, :root_path
+
+    def initialize(name, env='dev')
+      @env = env
+      @name = name
+      @root_path = File.join('lambdas', name)
+    end
+
+    def manifest
+      @manifest ||= JSON.parse File.read(manifest_file)
+    end
+
+    def manifest_file
+      File.join(source_path, 'package.json')
+    end
+
+    def env_name
+      "#{env}-#{name}"
+    end
+
+    def files
+      path = File.join build_path, "**", "*"
+      Dir.glob(path, File::FNM_DOTMATCH)
+          .reject {|f| File.directory? f }
+    end
+
+    def each_file(&block)
+      files.each {|file| yield basename(file), File.read(file) }
+    end
+
+    def build_path
+      File.join(root_path, 'dest')
+    end
+
+    def source_path
+      File.join(root_path, 'src')
+    end
+
+    def basename(filename)
+      filename.gsub(build_path + '/', '')
+    end
+  end
+end

data/lib/jarbs/function_generator.rb

@@ -0,0 +1,47 @@
+module Jarbs
+  class FunctionGenerator
+    include Commander::UI
+    include ManifestHelpers
+
+    def initialize(function)
+      @function = function
+    end
+
+    def generate
+      say_ok "Generating function skeleton at #{@function.root_path}"
+
+      FileUtils.mkdir_p @function.source_path
+      install_manifest
+      install_handler
+    end
+
+    private
+
+    def install_manifest
+      package_manifest = {
+          name: @function.name,
+          version: '0.0.0',
+          description: ask('Function description: '),
+          author: whoami,
+          repository: {
+              type: 'git',
+              url: repo_url
+          },
+          license: 'UNLICENSED',
+          engines: {
+              node: '0.10.36'
+          },
+          main: 'index.js',
+          dependencies: {
+              'babel-runtime' => '< 6'
+          }
+      }
+
+      write_package(package_manifest, @function.source_path)
+    end
+
+    def install_handler
+      FileUtils.cp File.join(File.dirname(__FILE__), 'fixtures', 'index.js'), @function.source_path
+    end
+  end
+end

data/lib/jarbs/lambda.rb

@@ -0,0 +1,84 @@
+require 'aws-sdk'
+
+require 'jarbs/function_definition'
+require 'jarbs/manifest_helpers'
+require 'jarbs/project_generator'
+require 'jarbs/function_generator'
+require 'jarbs/node_build'
+require 'jarbs/packager'
+
+module Jarbs
+  class Lambda
+    include Commander::UI
+
+    def initialize(name, options)
+      @options = options
+
+      @function = FunctionDefinition.new(name, @options.env)
+      @client = Aws::Lambda::Client.new region: default_region
+    end
+
+    def generate
+      FunctionGenerator.new(@function).generate
+    end
+
+    def deploy
+      exists? ? update : create
+    end
+
+    def create
+      data = prepare_for_aws
+      role = @options[:role] || ask("IAM role for function: ")
+
+      say "Creating #{@function.env_name} on Lambda..."
+      @client.create_function function_name: @function.env_name,
+        runtime: 'nodejs',
+        handler: 'index.handler',
+        role: role,
+        memory_size: 128,
+        timeout: 10,
+        code: { zip_file: data }
+
+      say_ok "Complete!"
+    end
+
+    def update
+      data = prepare_for_aws
+
+      say "Updating #{@function.env_name} on Lambda..."
+      @client.update_function_code function_name: @function.env_name, zip_file: data
+      say_ok "Complete!"
+    end
+
+    def delete
+      res = @client.delete_function function_name: @function.env_name
+      say_ok "Removed #{@function.env_name}." if res.successful?
+    end
+
+    def info
+      @client.get_function(function_name: @function.env_name)
+    end
+
+    def exists?
+      true if info
+    rescue Aws::Lambda::Errors::ResourceNotFoundException => e
+      false
+    end
+
+    private
+
+    def prepare_for_aws
+      node = NodeBuild.new(@function)
+
+      node.npm_build
+      package = Packager.new(@function).package
+    ensure
+      node.clean
+      package
+    end
+
+    def default_region
+      `aws configure get region`.chomp
+    end
+  end
+end

data/lib/jarbs/manifest_helpers.rb

@@ -0,0 +1,22 @@
+require 'rugged'
+
+module Jarbs
+  module ManifestHelpers
+
+    def write_package(manifest, path)
+      File.open(File.join(path, 'package.json'), 'w') do |f|
+        f.write JSON.pretty_generate(manifest)
+      end
+    end
+
+    def whoami
+      @whoami ||= `whoami`.chomp
+    end
+
+    def repo_url
+      Rugged::Repository.discover(".").remotes.first.url
+    rescue Rugged::RepositoryError => e
+      nil
+    end
+  end
+end

data/lib/jarbs/node_build.rb

@@ -0,0 +1,38 @@
+module Jarbs
+  class NodeBuild
+    include Commander::UI
+
+    def initialize(function)
+      @function = function
+    end
+
+    def npm_install(path, flags="")
+      run_in path, "npm install #{flags}"
+    end
+
+    def npm_build
+      say_ok 'Building function...'
+
+      # Copy source dir to build location and build in-place
+      FileUtils.cp_r @function.source_path, @function.build_path
+      abortable_run "npm run build:function -- --out-dir #{@function.build_path} #{@function.source_path}"
+
+      npm_install @function.build_path, '--production'
+    end
+
+    def clean
+      FileUtils.rm_r @function.build_path if Dir.exists?(@function.build_path)
+    end
+
+    private
+
+    def run_in(location, cmd)
+      Dir.chdir(location) { abortable_run(cmd) }
+    end
+
+    def abortable_run(cmd)
+      success = system(cmd)
+      abort("cpm runtime exited with non-zero status code: #{$?.exitstatus}") unless success
+    end
+  end
+end

data/lib/jarbs/packager.rb

@@ -0,0 +1,34 @@
+require 'zip'
+
+module Jarbs
+  class Packager
+    include Commander::UI
+
+    def initialize(function)
+      @function = function
+    end
+
+    def package
+      say_ok "Packaging..."
+
+      stream = Zip::OutputStream.write_buffer do |out|
+        @function.each_file do |filename, contents|
+          out.put_next_entry(filename)
+          out.write contents
+        end
+      end
+
+      write_zip(stream.string) if $debug
+
+      # return the generated zip data
+      stream.string
+    end
+
+    def write_zip(data)
+      zipname = File.join(@function.root_path, "#{@function.name}.zip")
+
+      File.open(zipname, 'w') {|zip| zip.write(data) }
+      say_warning "DEBUG: Output debug package to #{zipname}"
+    end
+  end
+end

data/lib/jarbs/project_generator.rb

@@ -0,0 +1,38 @@
+module Jarbs
+  class ProjectGenerator
+    include ManifestHelpers
+
+    def initialize(name)
+      @name = name
+    end
+
+    def generate
+      FileUtils.mkdir @name
+
+      manifest = {
+          name: @name,
+          version: '0.0.0',
+          author: whoami,
+          repository: {
+              type: 'git',
+              url: repo_url
+          },
+          license: 'UNLICENSED',
+          engines: {
+              node: '0.10.36'
+          },
+          main: 'index.js',
+          scripts: {
+              'build:function' => 'babel --optional runtime',
+          },
+          devDependencies: {
+              'babel' => '< 6',
+              'babel-runtime' => '< 6'
+          }
+      }
+
+      write_package(manifest, @name)
+      NodeBuild.new(nil).npm_install(@name)
+    end
+  end
+end

data/lib/jarbs/version.rb

@@ -0,0 +1,3 @@
+module Jarbs
+  VERSION = "0.5.0"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: jarbs
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Luke van der Hoeven
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Jarbs: They took em.'
+email:
+- hungerandthirst@gmail.com
+executables:
+- jarbs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/jarbs
+- bin/setup
+- jarbs.gemspec
+- lib/jarbs.rb
+- lib/jarbs/fixtures/index.js
+- lib/jarbs/function_definition.rb
+- lib/jarbs/function_generator.rb
+- lib/jarbs/lambda.rb
+- lib/jarbs/manifest_helpers.rb
+- lib/jarbs/node_build.rb
+- lib/jarbs/packager.rb
+- lib/jarbs/project_generator.rb
+- lib/jarbs/version.rb
+homepage: https://docs.articulate.zone/tools/jarbs.html
+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.4.8
+signing_key: 
+specification_version: 4
+summary: 'Jarbs: CLI Tooling for Lambda'
+test_files: []