lam 0.1.0 → 0.1.1

data/lib/lam/process/controller_processor.rb

@@ -0,0 +1,36 @@
+require_relative "base_processor"
+
+class Lam::Process
+  class ControllerProcessor < Lam::Process::BaseProcessor
+    def run
+      # Use the handler value (ie: posts.create) to deduce the user's business
+      # code to require and run.
+      deducer = ProcessorDeducer.new(handler)
+      path = deducer.controller[:path]
+      code = deducer.controller[:code]
+
+      begin
+        require path  # require "app/controllers/posts_controller.rb"
+        # Puts the return value of user's code to stdout because this is
+        # what eventually gets used by API Gateway.
+        # Explicitly using $stdout since puts redirected to $stderr.
+
+        # result = PostsController.new(event, context).create
+        result = instance_eval(code, path)
+
+        # JSON.dump is pretty robust.  If it cannot dump the structure into a
+        # json string, it just dumps it to a plain text string.
+        $stdout.puts JSON.dump(result) # only place where we write to stdout.
+      rescue Exception => e
+        # Customize error message slightly so nodejs shim can process the
+        # returned error message.
+        # The "RubyError: " is a marker that the javascript shim scans for.
+        $stderr.puts("RubyError: #{e.class}: #{e.message}") # js needs this as the first line
+        backtrace = e.backtrace.map {|l| "  #{l}" }
+        $stderr.puts(backtrace)
+        # $stderr.puts("END OF RUBY OUTPUT")
+        exit 1 # instead of re-raising to control the error backtrace output
+      end
+    end
+  end
+end

data/lib/lam/process/help.rb

@@ -0,0 +1,11 @@
+class Lam::Process::Help
+  class << self
+    def controller
+<<-EOL
+Examples:
+
+lam process controller '{ "we" : "love", "using" : "Lambda" }' '{"test": "1"}' "handlers/controllers/posts.create"
+EOL
+    end
+  end
+end

data/lib/lam/process/processor_deducer.rb

@@ -0,0 +1,52 @@
+class Lam::Process::ProcessorDeducer
+  def initialize(handler)
+    @handler = handler
+  end
+
+  # Deduces the path and method from the handler. Example:
+  #
+  #   ProcessorDeducer.new("handlers/functions/posts.create").function
+  #     => {path: "app/functions/posts.rb", code: "create(event, context)"}
+  #
+  # Summary:
+  #
+  # Input:
+  #   handler: handlers/functions/posts.create
+  # Output:
+  #   path: app/functions/posts.rb
+  #   code: create(event, context) # code to instance_eval
+  #
+  # Returns: {path: path, code: code}
+  def function
+    path, meth = @handler.split('.')
+    path = Lam.root + path.sub("handlers", "app") + ".rb"
+    code = "#{meth}(event, context)"
+    {path: path, code: code}
+  end
+
+  # Deduces the path and method from the handler. Example:
+  #
+  #   ProcessorDeducer.new("handlers/controllers/posts.create").controller
+  #     => {path: "controllers/posts_controller.rb", code: "create"}
+  #
+  # Summary:
+  #
+  # Input:
+  #   handler: handlers/controllers/posts.create
+  # Output:
+  #   path: app/controllers/posts_controller.rb
+  #   code: create # code to instance_eval
+  #
+  # Returns: {path: path, code: code}
+  def controller
+    handler_path, meth = @handler.split('.')
+
+    path = Lam.root + handler_path.sub("handlers", "app") + "_controller.rb"
+
+    controller_name = handler_path.sub(%r{.*handlers/controllers/}, "") + "_controller" # posts_controller
+    controller_class = controller_name.split('_').collect(&:capitalize).join # PostsController
+    code = "#{controller_class}.new(event, context).#{meth}" # PostsController.new(event, context).create
+
+    {path: path, code: code, class_name: controller_class}
+  end
+end

data/lib/lam/util.rb

@@ -0,0 +1,13 @@
+module Lam::Util
+  # Ensures trailing slash
+  # Useful for appending a './' in front of a path or leaving it alone.
+  # Returns: '/path/with/trailing/slash/' or './'
+  @@root = nil
+  def root
+    return @@root if @@root
+    @@root = ENV['PROJECT_ROOT'].to_s
+    @@root = '.' if @@root == ''
+    @@root = "#{@@root}/" unless @@root.ends_with?('/')
+    @@root
+  end
+end

data/lib/lam/version.rb

@@ -1,3 +1,3 @@
 module Lam
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/notes/design.md

@@ -0,0 +1,43 @@
+## Project Structure
+
+TODO: make this a table
+
+```sh
+app/controllers
+app/workers
+app/functions
+config/project.yml
+config/events.yml
+config/routes.rb
+```
+
+
+## Usage
+
+```sh
+lam build
+lam deploy
+```
+
+## Testing
+
+Testing controller processing without node shim.
+
+```
+lam process controller '{ "we" : "love", "using" : "Lambda" }' '{"test": "1"}' "handlers/controllers/posts.create"
+```
+
+Testing the generated node shim handler and the controller processing.
+
+```
+cd spec/fixtures/project
+lam build # generates the handlers
+node handlers/controllers/posts.js
+```
+
+VS
+
+```sh
+processors/controller_processor.rb '{ "we" : "love", "using" : "Lambda" }' '{"test": "1"}' "handlers/controllers/posts.create" | jq '.'
+```
+

data/notes/traveling-ruby-packaging-lam.md

@@ -0,0 +1,26 @@
+# start off at project root
+
+mkdir -p /tmp/lam_build
+cp Gemfile* /tmp/lam_build/
+cd /tmp/lam_build # cd into there to build TravelingRuby
+
+wget http://d6r77u77i8pq3.cloudfront.net/releases/traveling-ruby-20150715-2.2.2-linux-x86_64.tar.gz .
+mkdir -p bundled/ruby # tmp/lam_build/bundled/ruby
+tar -xvf traveling-ruby-20150715-2.2.2-linux-x86_64.tar.gz -C bundled/ruby
+# ls ruby => bin  bin.real  info  lib
+# bundled/ruby/bin/ruby -v # works now :)
+
+# had to modify Gemfile and update the local path for linux
+bundle install --path bundled/gems
+
+# DONT THINK THAT I NEED TO COPY THE Gemfile into bundled/gems...
+# mv Gemfile* bundled/gems/ # copy Gemfile from the project to bundled/gems
+# IMPORTANT: the Gemfile must be in the same bundled/gems folder
+
+# now we have both bundled/gems bundled/ruby :)
+bundled/gems/ruby/2.2.0/bin/print_ruby_info # should work
+
+
+# Let's move back to the project and test the wrapper, it should work also
+mv bundled ~/lam-test/lam/spec/fixtures/project/
+cd ~/lam-test/lam/spec/fixtures/project # back to project root

data/notes/traveling-ruby-packaging.md

@@ -0,0 +1,103 @@
+### Packaging Gems Info
+
+### Structure
+
+This is the structure that TravelingRuby uses in it's tutorial.
+
+```sh
+PROJECT/YOUR_BINARY_WRAPPER (hello)
+PROJECT/lib/ruby/bin/ruby -> PROJECT/lib/ruby/bin.real/ruby
+PROJECT/lib/vendor/ruby/2.2.0/bin/print_ruby_info # the gem binaries are here
+```
+
+* Instead calling the ruby binary `lam process` command directly.
+* Lam will require 'bundler/setup' so the user's gems will be required properly
+* Skip the overhead of having another wrapper
+
+```sh
+PROJECT/vendor/ruby/2.2.0/bin/lam # the gem binaries are here
+```
+
+### Packaging Gems Commands
+
+```
+mkdir packaging/tmp
+cp Gemfile Gemfile.lock packaging/tmp/ # this are from the user's project
+cd packaging/tmp
+
+# here's where the gems are instaleld into packaging/vendor/
+BUNDLE_IGNORE_CONFIG=1 bundle install --path ../vendor --without development
+# IMPORTANT: Think I'll make the user switch to 2.2.0 and error the build proccess.
+
+##############
+I can call ruby bin files directly.
+I was WRONG. Cannot call gem bin files directly because I need to make sure that
+bundler/setup gets loaded before calling the gem bin.
+Tried moving bundler/setup into the lam library itself but get all sorts of warnings.
+
+hello-1.0.0-linux-x86_64/lib/vendor/ruby/2.2.0/bin/lam help
+BUT the shabang line has: #!/usr/bin/env ruby2.0 .. but only on linux..
+Simply cannot rename the darn ruby version folder.
+#############
+
+
+cd ../..
+rm -rf packaging/tmp # remove working space
+
+# reduce the zip package size!
+rm -f packaging/vendor/*/*/cache/*
+```
+
+Now we can copy over the generated vendored files
+
+##################################
+# clean
+rm -rf packaging/vendor/
+
+bundle update
+rake package:linux:x86_64 DIR_ONLY=1
+
+mkdir packaging/tmp
+cp Gemfile Gemfile.lock packaging/tmp/
+cd packaging/tmp
+BUNDLE_IGNORE_CONFIG=1 bundle install --path ../vendor --without development
+cd ../..
+
+cp -pR packaging/vendor hello-1.0.0-linux-x86_64/lib/
+cp Gemfile Gemfile.lock hello-1.0.0-linux-x86_64/lib/vendor/
+mkdir hello-1.0.0-linux-x86_64/lib/vendor/.bundle
+cp packaging/bundler-config hello-1.0.0-linux-x86_64/lib/vendor/.bundle/config
+
+find . -name print_ruby_info
+
+
+# Wrapper script `lam`
+
+```bash
+#!/bin/bash
+set -e
+
+# Figure out where this script is located.
+SELFDIR="`dirname \"$0\"`"
+SELFDIR="`cd \"$SELFDIR\" && pwd`"
+
+# Tell Bundler where the Gemfile and gems are.
+export BUNDLE_GEMFILE="$SELFDIR/lib/vendor/Gemfile"
+unset BUNDLE_IGNORE_CONFIG
+
+# Run the actual app using the bundled Ruby interpreter, with Bundler activated.
+exec "$SELFDIR/lib/ruby/bin/ruby" -rbundler/setup "$SELFDIR/lib/app/hello.rb"
+```
+
+
+### Building Ruby
+http://cache.ruby-lang.org/pub/ruby/2.2/
+
+```sh
+wget http://cache.ruby-lang.org/pub/ruby/2.2/ruby-2.2.2.tar.gz
+tar xvfvz ruby-2.2.2.tar.gz
+cd ruby-2.2.2
+./configure
+make
+sudo make install
+```

data/notes/traveling-ruby.md

@@ -0,0 +1,82 @@
+## Overview
+
+There are 2 things to point out:
+
+1. What the user's environment contains - cannot control this, can only suggest
+2. What the lambda environment contains - can fully control this
+
+* User can develop with ruby 2.4 and bundle gems and test and be happy. Hopefully they eventually learn to test with ruby 2.2.0 (when they run into bugs).
+* When `lam build` runs it will bundle it in ruby 2.2.0 though.
+* When lambda runs it will call `lam` with ruby 2.2.0. The gems will be installed in 2.2.0
+	* Hope all works
+
+## Download ruby commands
+
+```sh
+# linux 64bit
+wget http://d6r77u77i8pq3.cloudfront.net/releases/traveling-ruby-20150715-2.2.2-linux-x86_64.tar.gz .
+mkdir ruby-linux
+tar -xvf traveling-ruby-20150715-2.2.2-linux-x86_64.tar.gz -C ruby-linux
+# mac
+wget http://d6r77u77i8pq3.cloudfront.net/releases/traveling-ruby-20150715-2.2.2-osx.tar.gz
+mkdir ruby-mac
+tar -xvf traveling-ruby-20150715-2.2.2-osx.tar.gz -C ruby-mac
+
+# another version
+mkdir hello-1.0.0-linux-x86_64/lib/ruby && tar -xzf packaging/traveling-ruby-20150715-2.2.2-linux-x86_64.tar.gz -C hello-1.0.0-linux-x86_64/lib/ruby
+```
+
+## Launch Instance for Testing
+
+```sh
+aws ec2 run-instances --image-id ami-8c1be5f6 --count 1 --instance-type t2.micro --key-name default --security-groups demo
+```
+
+## Tree Structure
+
+```sh
+lib/
+├── app
+│   └── hello.rb
+├── ruby
+│   ├── bin
+│   │   ├── gem
+│   │   ├── irb
+│   │   ├── rake
+│   │   ├── ruby
+│   │   └── ruby_environment
+│   ├── bin.real
+│   │   ├── bundle
+│   │   ├── bundler
+│   │   ├── gem
+│   │   ├── irb
+│   │   ├── rake
+│   │   └── ruby
+│   └── lib
+│       └── ruby
+│           ├── 2.2.0
+...
+│           │   └── yaml.rb
+│           ├── gems
+│           │   └── 2.2.0
+│           │       ├── gems
+│           │       │   ├── attr_extras-5.2.0
+│           │       │   │   ├── attr_extras.gemspec
+...
+│           │       │   ├── bundler-1.9.9
+...
+│           │           └── rake-12.2.1.gemspec
+...
+└── vendor
+    ├── Gemfile
+    ├── Gemfile.lock
+    └── ruby
+        └── 2.2.0 <= IMPORTANT: bundler copies gems to folder with running ruby version
+            ├── gems
+            │   ├── concurrent-ruby-1.0.5
+            │   ├── faker-1.7.3
+            │   └── i18n-0.9.0
+...
+```
+
+* [Full tree](https://gist.github.com/tongueroo/c42f9d35b15b06eb810802243f4e2f6d)

data/spec/fixtures/project/.gitignore

@@ -0,0 +1,3 @@
+vendor
+bundled
+lam.zip

data/spec/fixtures/project/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/spec/fixtures/project/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "lam"
+gem "print_ruby_info" # test

data/spec/fixtures/project/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: /Users/tung/src/tongueroo/lam
+  specs:
+    lam (0.0.1)
+      activesupport
+      colorize
+      hashie
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    hashie (3.5.6)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    print_ruby_info (0.0.3)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lam!
+  print_ruby_info

data/spec/fixtures/project/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < Lam::BaseController
+end

data/spec/fixtures/project/app/controllers/posts_controller.rb

@@ -0,0 +1,12 @@
+class PostsController < Lam::BaseController
+  def create
+    # render text: "test2" # more consistent for web controllers
+
+    # render returns Lamba Proxy struture for web requests
+    render json: event, status: 200
+  end
+
+  # def update
+  #   render json: event, status: 200
+  # end
+end