faastruby 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca9d4cec0bdbdaefb83ad63a578a211a5fb186f118f2e9c7f4bb8f81f4b2ac08
-  data.tar.gz: 5857b9257bafe182fb38f89a6a1290d3a7fc148e75bc405e48a9cd51e6acbb80
+  metadata.gz: 2d752da5ce5767b5c7b97f6e53e884ab2ba0123f36f713f6a70ba82fc8055acf
+  data.tar.gz: d9c3038e42ca26f6b3de8953c06c7724a046549ae49942040ab8d9c3344536d2
 SHA512:
-  metadata.gz: f6fdbc0c311dc686ef5f1aa2f8310d4cef9fdf7c77d304bb42edc8069da4603b30d033df29d2b4743e5891f1ef90a34460ffb49cebcf927bbbad02c6860b8eff
-  data.tar.gz: 8aeb14ace46c50277eff7a9a9f29d7dda88f302674a96a5d5ece6930072698a3eff8a3816984f91944d39f359594b643caf0c1605e8ec8e2f1c6c02e515d4062
+  metadata.gz: 60085ed613203a88e39cbcc17aba0de3ed3884d6794255385e887c042097a871af5cb00069f422bcf96d855a969ec0e9253c98baf37c2819cefaf32737b8c6a0
+  data.tar.gz: 2e50627ab43fd3fa0a6eabd702211d9df7759d810fa1691ef57177d390f4fa74730412b2c0c2c40a4429f05b83977520213a9fcac579766bf4c44bb459c61562

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.3.2 - Dec 15 2018
+- Better output for tests
+- `bundle check && bundle install` runs before building a package to make sure Gemfile.lock is updated.
+- New command: `faastruby deploy`. This command is meant to be run in a FaaStRuby Project folder, and will deploy all workspaces and their functions.
+- Updated spec templates with new helper that stubs calls to FaaStRuby server when using `faastruby-rpc`.
+- `render` is now the preferred method to set the return value of functions.
+- Upgraded dependency `faastruby-rpc` to version 0.1.3.
+- Removed region SFO2 (sorry, but the usage was minimal.)
+
 ## 0.3.1 - Dec 9 2018
 - Add faastruby-rpc to Gemfile template and runtime dependencies
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    faastruby (0.3.0)
+    faastruby (0.3.2)
       colorize (~> 0.8)
-      faastruby-rpc (~> 0.1)
+      faastruby-rpc (~> 0.1.3)
       oj (~> 3.6)
       puma (~> 3.12)
       rest-client (~> 2.0)
@@ -32,12 +32,12 @@ GEM
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     equatable (0.5.0)
-    faastruby-rpc (0.1.1)
+    faastruby-rpc (0.1.3)
       oj (~> 3.6)
     hashdiff (0.3.7)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.1.1)
+    i18n (1.2.0)
       concurrent-ruby (~> 1.0)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)

data/example-blank/handler.rb

@@ -1,4 +1,18 @@
 def handler event
-  # Do the magic here
-  # Use respond_with RESPONSE, where RESPONSE is a Hash, String or Array.
+  # FUNCTION RESPONSE
+  #
+  # You can render text, json, yaml, html or js. Example:
+  # render html: '<p>Hello World!</p>'
+  # render yaml: {hello: 'world!'}
+  #
+  # Status:
+  # The default status is 200. You can set a custom status like this:
+  # render json: {error: 'Could not perform the action'}, status: 422
+  #
+  # Headers:
+  # The 'Content-Type' header is automatically set when you use 'render'.
+  # You can set custom headers using a hash with string keys. Example:
+  # render text: 'It Works!', headers: {'TransactionId' => 23928}
+
+  # Write code here
 end

data/example-blank/spec/handler_spec.rb

@@ -5,7 +5,7 @@ describe 'handler(event)' do
   let(:event) {SpecHelper::Event.new}
 
   it 'should return Hash, String or Array' do
-    body = handler(event).body
-    expect([String, Hash, Array].include? body.class).to be true
+    body = handler(event).call.body
+    expect([String, Hash, Array, ].include? body.class).to be true
   end
 end

data/example-blank/spec/helpers/faastruby.rb

@@ -1,8 +1,12 @@
+require 'yaml'
+require 'oj'
+
 module FaaStRuby
   def self.included(base)
     base.extend(SpecHelper)
     $LOAD_PATH << Dir.pwd
   end
+  class DoubleRenderError < StandardError; end
   module SpecHelper
     class Event
       @@event = Struct.new(:body, :query_params, :headers, :context)
@@ -11,13 +15,52 @@ module FaaStRuby
       end
     end
     class Response
-      @@response = Struct.new(:body, :status, :headers)
-      def self.new(body, status, headers)
-        @@response.new(body, status, headers)
+      # @@response = Struct.new(:body, :status, :headers)
+      attr_accessor :body, :status, :headers
+      @@rendered = false
+      def initialize(body, status, headers)
+        if @@rendered
+          raise FaaStRuby::DoubleRenderError.new("You called 'render' or 'respond_with' multiple times in your handler method.")
+        end
+        @@rendered = true
+        @body = body
+        @status = status
+        @headers = headers
+      end
+
+      def call
+        @@rendered = false
+        self
       end
     end
   end
+
   def respond_with(body, status: 200, headers: {})
     SpecHelper::Response.new(body, status, headers)
   end
+
+  def render(js: nil, body: nil, inline: nil, html: nil, json: nil, yaml: nil, text: nil, status: 200, headers: {}, content_type: nil)
+    headers["Content-Type"] = content_type if content_type
+    case
+    when json
+      headers["Content-Type"] ||= "application/json"
+      resp_body = json.is_a?(String) ? json : Oj.dump(json)
+    when html, inline
+      headers["Content-Type"] ||= "text/html"
+      resp_body = html
+    when text
+      headers["Content-Type"] ||= "text/plain"
+      resp_body = text
+    when yaml
+      headers["Content-Type"] ||= "application/yaml"
+      resp_body = yaml.to_yaml
+    when body
+      headers["Content-Type"] ||= "application/octet-stream"
+      resp_body = raw
+    when js
+      headers["Content-Type"] ||= "text/javascript"
+      resp_body = js
+    end
+    respond_with(resp_body, status: status, headers: headers)
+  end
 end

data/example-blank/spec/spec_helper.rb

@@ -1,3 +1,3 @@
-require 'faastruby-rpc'
+require 'faastruby-rpc/test_helper'
 require 'helpers/faastruby'
 include FaaStRuby

data/example/handler.rb

@@ -4,14 +4,22 @@ require 'json'
 # 1) If you don't have a workspace, create one by running:
 # faastruby create-workspace WORKSPACE_NAME
 # 2) To deploy this function, cd into its folder and run:
-# faastruby deploy WORKSPACE_NAME
+# faastruby deploy-to WORKSPACE_NAME
 def handler event
-  headers = {
-    'Content-Type' => 'text/plain',
-    'My-Custom-Header' => 'Value'
-  }
   data = event.body ? JSON.parse(event.body) : {}
-  # The response must be a Hash, Array or String.
-  response = "Hello, #{data['name'] || 'World'}!"
-  respond_with response, status: 200, headers: headers
+  # FUNCTION RESPONSE
+  #
+  # You can render text, json, yaml, html or js. Example:
+  # render html: '<p>Hello World!</p>'
+  # render yaml: {hello: 'world!'}
+  #
+  # Status:
+  # The default status is 200. You can set a custom status like this:
+  # render json: {error: 'Could not perform the action'}, status: 422
+  #
+  # Headers:
+  # The 'Content-Type' header is automatically set when you use 'render'.
+  # You can set custom headers using a hash with string keys. Example:
+  # render text: 'It Works!', headers: {'TransactionId' => 23928}
+  render text: "Hello, #{data['name'] || 'World'}!"
 end

data/example/spec/handler_spec.rb

@@ -5,16 +5,16 @@ describe 'handler(event)' do
   let(:event) {SpecHelper::Event.new(body: '{"name": "Ruby"}')}
 
   it 'should return Hash, String or Array' do
-    body = handler(event).body
+    body = handler(event).call.body
     expect([String, Hash, Array].include? body.class).to be true
   end
   it 'should add the name to the response string' do
-    body = handler(event).body
+    body = handler(event).call.body
     expect(body).to be == 'Hello, Ruby!'
   end
   it 'should say Hello, World! when name is not present' do
     event = SpecHelper::Event.new(body: nil)
-    body = handler(event).body
+    body = handler(event).call.body
     expect(body).to be == 'Hello, World!'
   end
 end

data/example/spec/helpers/faastruby.rb

@@ -1,8 +1,12 @@
+require 'yaml'
+require 'oj'
+
 module FaaStRuby
   def self.included(base)
     base.extend(SpecHelper)
     $LOAD_PATH << Dir.pwd
   end
+  class DoubleRenderError < StandardError; end
   module SpecHelper
     class Event
       @@event = Struct.new(:body, :query_params, :headers, :context)
@@ -11,13 +15,52 @@ module FaaStRuby
       end
     end
     class Response
-      @@response = Struct.new(:body, :status, :headers)
-      def self.new(body, status, headers)
-        @@response.new(body, status, headers)
+      # @@response = Struct.new(:body, :status, :headers)
+      attr_accessor :body, :status, :headers
+      @@rendered = false
+      def initialize(body, status, headers)
+        if @@rendered
+          raise FaaStRuby::DoubleRenderError.new("You called 'render' or 'respond_with' multiple times in your handler method.")
+        end
+        @@rendered = true
+        @body = body
+        @status = status
+        @headers = headers
+      end
+
+      def call
+        @@rendered = false
+        self
       end
     end
   end
+
   def respond_with(body, status: 200, headers: {})
     SpecHelper::Response.new(body, status, headers)
   end
+
+  def render(js: nil, body: nil, inline: nil, html: nil, json: nil, yaml: nil, text: nil, status: 200, headers: {}, content_type: nil)
+    headers["Content-Type"] = content_type if content_type
+    case
+    when json
+      headers["Content-Type"] ||= "application/json"
+      resp_body = json.is_a?(String) ? json : Oj.dump(json)
+    when html, inline
+      headers["Content-Type"] ||= "text/html"
+      resp_body = html
+    when text
+      headers["Content-Type"] ||= "text/plain"
+      resp_body = text
+    when yaml
+      headers["Content-Type"] ||= "application/yaml"
+      resp_body = yaml.to_yaml
+    when body
+      headers["Content-Type"] ||= "application/octet-stream"
+      resp_body = raw
+    when js
+      headers["Content-Type"] ||= "text/javascript"
+      resp_body = js
+    end
+    respond_with(resp_body, status: status, headers: headers)
+  end
 end

data/example/spec/spec_helper.rb

@@ -1,3 +1,3 @@
-require 'faastruby-rpc'
+require 'faastruby-rpc/test_helper'
 require 'helpers/faastruby'
 include FaaStRuby

data/faastruby.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sinatra', '~> 2.0'
   spec.add_runtime_dependency 'sinatra-contrib', '~> 2.0'
   spec.add_runtime_dependency 'puma', '~> 3.12'
-  spec.add_runtime_dependency 'faastruby-rpc', '~> 0.1'
+  spec.add_runtime_dependency 'faastruby-rpc', '~> 0.1.3'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

data/lib/faastruby/base.rb

@@ -2,8 +2,7 @@ module FaaStRuby
   ROOT_DOMAIN = ENV['FAASTRUBY_ROOT_DOMAIN'] || 'faastruby.io'
   DEFAULT_REGION = 'tor1'
   REGIONS = [
-    'tor1',
-    'sfo2'
+    'tor1'
   ]
   class << self
     attr_accessor :configuration

data/lib/faastruby/cli/commands.rb

@@ -43,7 +43,8 @@ module FaaStRuby
   module Command
     COMMANDS = {
       'new' => FaaStRuby::Command::Function::New,
-      'deploy-to' => FaaStRuby::Command::Function::Deploy,
+      'deploy-to' => FaaStRuby::Command::Function::DeployTo,
+      'deploy' => FaaStRuby::Command::Workspace::Deploy,
       'remove-from' => FaaStRuby::Command::Function::RemoveFrom,
       'update-context' => FaaStRuby::Command::Function::UpdateContext,
       'upgrade' => FaaStRuby::Command::Function::Upgrade,

data/lib/faastruby/cli/commands/function.rb

@@ -22,7 +22,7 @@ module FaaStRuby
 end
 
 require 'faastruby/cli/commands/function/build'
-require 'faastruby/cli/commands/function/deploy'
+require 'faastruby/cli/commands/function/deploy_to'
 require 'faastruby/cli/commands/function/new'
 require 'faastruby/cli/commands/function/remove_from'
 require 'faastruby/cli/commands/function/test'

data/lib/faastruby/cli/commands/function/build.rb

@@ -21,6 +21,7 @@ module FaaStRuby
         end
 
         def run
+          FaaStRuby::CLI.error('Please fix the problems above and try again') unless bundle_install
           tests_passed = run_tests
           FaaStRuby::CLI.error("Build aborted because tests failed and you have 'abort_build_when_tests_fail: true' in 'faastruby.yml'") unless tests_passed || !@abort_when_tests_fail
           puts "Warning: Ignoring failed tests because you have 'abort_build_when_tests_fail: false' in 'faastruby.yml'".yellow if !tests_passed && !@abort_when_tests_fail
@@ -41,6 +42,12 @@ module FaaStRuby
           self.class.build(source, output_file)
         end
 
+        def bundle_install
+          puts '[build] Verifying dependencies'
+          return true unless File.file?('Gemfile')
+          system('bundle check') || system('bundle install')
+        end
+
         def run_tests
           FaaStRuby::Command::Function::Test.new(true).run(do_not_exit: true)
         end

data/lib/faastruby/cli/commands/function/{deploy.rb → deploy_to.rb}

@@ -1,7 +1,7 @@
 module FaaStRuby
   module Command
     module Function
-      class Deploy < FunctionBaseCommand
+      class DeployTo < FunctionBaseCommand
         def initialize(args)
           @args = args
           @missing_args = []
@@ -14,17 +14,19 @@ module FaaStRuby
         end
 
         def run
+          FaaStRuby::CLI.error('Please fix the problems above and try again') unless bundle_install
           tests_passed = run_tests
           FaaStRuby::CLI.error("Deploy aborted because tests failed and you have 'abort_deploy_when_tests_fail: true' in 'faastruby.yml'") unless tests_passed || !@abort_when_tests_fail
           puts "Warning: Ignoring failed tests because you have 'abort_deploy_when_tests_fail: false' in 'faastruby.yml'".yellow if !tests_passed && !@abort_when_tests_fail
           package_file_name = build_package
-          spinner = spin("Deploying to workspace '#{@workspace_name}'...")
+          spinner = spin("Deploying '#{@workspace_name}/#{@function_name}'")
           workspace = FaaStRuby::Workspace.new(name: @workspace_name).deploy(package_file_name)
           if workspace.errors.any?
             spinner.stop('Failed :(')
             FaaStRuby::CLI.error(workspace.errors)
           end
           spinner.stop('Done!')
+          exit 0
         end
 
         def self.help
@@ -37,6 +39,12 @@ module FaaStRuby
 
         private
 
+        def bundle_install
+          puts '[build] Verifying dependencies'
+          return true unless File.file?('Gemfile')
+          system('bundle check') || system('bundle install')
+        end
+
         def missing_args
           if @args.empty?
             @missing_args << "Missing argument: WORKSPACE_NAME".red

data/lib/faastruby/cli/commands/function/test.rb

@@ -15,18 +15,8 @@ module FaaStRuby
             puts "[skipped] You have no 'test_command' key/value in 'faastruby.yml'. Please consider using rspec!".yellow
             return true
           end
-          spinner = spin("Running tests...")
-          output, status = Open3.capture2e(@test_command)
-          if status == 0
-            spinner.stop('Passed!')
-            puts output
-            return true
-          else
-            spinner.stop('Failed :(')
-            FaaStRuby::CLI.error(output, color: nil) unless do_not_exit
-            puts output if do_not_exit
-            return false
-          end
+          puts "[test] Running tests"
+          system(@test_command)
         end
 
         def self.help

data/lib/faastruby/cli/commands/workspace.rb

@@ -9,4 +9,5 @@ end
 
 require 'faastruby/cli/commands/workspace/create'
 require 'faastruby/cli/commands/workspace/destroy'
-require 'faastruby/cli/commands/workspace/list'
+require 'faastruby/cli/commands/workspace/list'
+require 'faastruby/cli/commands/workspace/deploy'

data/lib/faastruby/cli/commands/workspace/create.rb

@@ -13,7 +13,6 @@ module FaaStRuby
         end
 
         def run
-          dir_exists? || FileUtils.mkdir_p(@base_dir)
           spinner = spin("Requesting credentials...")
           workspace = FaaStRuby::Workspace.create(name: @workspace_name, email: @options['email'])
           spinner.stop("Done!")
@@ -27,6 +26,7 @@ module FaaStRuby
             FaaStRuby::Credentials.add(@workspace_name, workspace.credentials, @options['credentials_file'])
           end
           puts "Workspace '#{@workspace_name}' created"
+          create_dir unless dir_exists?
         end
 
         def self.help
@@ -39,6 +39,11 @@ module FaaStRuby
 
         private
 
+        def create_dir
+          FileUtils.mkdir_p(@base_dir)
+          puts "+ d #{@base_dir}".green
+        end
+
         def dir_exists?
           return false unless File.directory?(@base_dir)
           puts "Local folder '#{@workspace_name}' already exists."

data/lib/faastruby/cli/commands/workspace/deploy.rb

@@ -0,0 +1,50 @@
+module FaaStRuby
+  module Command
+    module Workspace
+      class Deploy < WorkspaceBaseCommand
+        def initialize(args)
+          @errors = []
+          if args.any?
+            @args = args
+          else
+            @args = Dir.glob('*').select{|f| File.directory?(f)}
+          end
+        end
+
+        def run
+          result = []
+          errors = false
+          @args.each do |workspace|
+            Dir.chdir workspace
+            functions = Dir.glob('*').select{|f| File.directory?(f)}
+            functions.each do |function|
+              puts "[deploy] Entering folder #{workspace}/#{function}"
+              Dir.chdir function
+              if system("faastruby deploy-to #{workspace}")
+                result << "* #{workspace}/#{function} [Deploy OK]".green
+              else
+                result << "* #{workspace}/#{function} [Deploy FAILED]".red
+                errors = true
+              end
+              Dir.chdir '..'
+            end
+            Dir.chdir '..'
+          end
+          puts "\nResult:"
+          FaaStRuby::CLI.error(result, color: nil) if errors
+          puts result
+          exit 0
+        end
+
+        def self.help
+          "deploy".blue + " [WORKSPACE_FOLDER1] [WORKSPACE_FOLDER2]...    # Deploy all workspaces in the current directory and their functions"
+        end
+
+        def usage
+          "Usage: faastruby #{self.class.help}"
+        end
+
+      end
+    end
+  end
+end

data/lib/faastruby/version.rb

@@ -1,3 +1,3 @@
 module FaaStRuby
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faastruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Paulo Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +249,7 @@ files:
 - lib/faastruby/cli/commands/credentials/list.rb
 - lib/faastruby/cli/commands/function.rb
 - lib/faastruby/cli/commands/function/build.rb
-- lib/faastruby/cli/commands/function/deploy.rb
+- lib/faastruby/cli/commands/function/deploy_to.rb
 - lib/faastruby/cli/commands/function/new.rb
 - lib/faastruby/cli/commands/function/remove_from.rb
 - lib/faastruby/cli/commands/function/run.rb
@@ -260,6 +260,7 @@ files:
 - lib/faastruby/cli/commands/version.rb
 - lib/faastruby/cli/commands/workspace.rb
 - lib/faastruby/cli/commands/workspace/create.rb
+- lib/faastruby/cli/commands/workspace/deploy.rb
 - lib/faastruby/cli/commands/workspace/destroy.rb
 - lib/faastruby/cli/commands/workspace/list.rb
 - lib/faastruby/cli/credentials.rb