faastruby 0.5.15 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90642de9a37ebb95e7a59cc0d1814166c183ae077a84fc0eb89d413b91afde50
-  data.tar.gz: 1a8fc95eef7bb5faac20e14381d70c4201960aa2680d5cdefb2e1042a52af8f3
+  metadata.gz: 4c2140df8e1c0f5ab07372b83c80d26e7395b64a02d8e722b50e7acdfaa4a8a8
+  data.tar.gz: 73e3b0a89b4dea4393a09fc33ffec3fcadbdbfce2069ccc3cdb60d7e96ab064e
 SHA512:
-  metadata.gz: 782132facb71a4184825634a89eb14a11064cad0b189157fc61e2c88134d51a34927804657975e52716e1ad92d7bf85603be45057cb6ca9ec0ba288d5d4066a1
-  data.tar.gz: fb063c0d5f9944ad8ba14611b0c4d38e84152fb25532a2059e18cdcb5958e3741f2018865827e5fe34f1bb181424a8626716d3e0bbc68df53ee0a8214ae6ad96
+  metadata.gz: b5d46a540b29c8d43f15e939a455a7046caf501756eb3187e85116296b7dcc8ca96c3d8a6acb7f12fad506ad120d530845b5090651fa1896d822bc58fa2543c8
+  data.tar.gz: aca215d48d18df5ba9609205a90a849ce0dd6ebb247f4210f6885831691b3271dca813baa9e2a67be0e4cef18b5ede29909c5361ba97de3b904313985e9b4f17

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.5.16 - unreleased
+- Remove unused arguments from update workspace `run` method.
+- Update Help
+- Change the argument that measures the execution time on `run` to `--measure`
+- Add argument to read context from STDIN when running `deploy-to`
+- Switch default config files method from array to multiline string
+- Allow passwords with up to 50 characters.
+- Fix bug preventing `faastruby deploy` to deploy the secrets.
+
 ## 0.5.15 - Mar 18 2019
 - Remove `nil` entries from error array before trying to print error messages
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faastruby (0.5.15)
+    faastruby (0.5.16)
       colorize (~> 0.8)
       faastruby-rpc (~> 0.2.5)
       listen (~> 3.1)

data/lib/faastruby/cli/commands/account/signup.rb

@@ -1,7 +1,7 @@
 module FaaStRuby
   module Command
     module Account
-      PASSWORD_REGEX = /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,20}$/
+      PASSWORD_REGEX = /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,50}$/
       EMAIL_REGEX = /\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
       require 'faastruby/cli/commands/account/base_command'
       require 'io/console'
@@ -21,11 +21,11 @@ module FaaStRuby
             print "Email: "
             email = STDIN.gets.chomp
           end
-          puts "\nNow type in a password. It must contain 8 to 20 characters and have at least one uppercase letter, one lowercase letter, one number and one special character @ $ ! % * ? &"
+          puts "\nNow type in a password. It must contain 8 to 50 characters and have at least one uppercase letter, one lowercase letter, one number and one special character @ $ ! % * ? &"
           print "Password: "
           password = STDIN.noecho(&:gets).chomp
           until password_is_valid?(password) do
-            puts "\nYour password must contain 8 to 20 characters and have at least one uppercase letter, one lowercase letter, one number and one special character @ $ ! % * ? &\nPlease try again:".red
+            puts "\nYour password must contain 8 to 50 characters and have at least one uppercase letter, one lowercase letter, one number and one special character @ $ ! % * ? &\nPlease try again:".red
             print "Password: "
             password = STDIN.noecho(&:gets).chomp
           end

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

@@ -90,10 +90,14 @@ module FaaStRuby
           puts "\nUsage: faastruby #{self.class.help}"
           puts %(
 -f,--function PATH/TO/FUNCTION     # Specify the directory where the function is.
---context DATA                     # The data to be stored as context in the cloud,
-                                   # accessible via 'event.context' from within your function.
---set-root                         # Set the function as the root route of the workspace/
---set-catch-all                    # Set the function as the catch-all route of the workspace.
+--context 'JSON_STRING'            # The data to be stored as execution context
+                                   #  in the cloud, accessible via 'event.context'
+                                   #  from within your function.
+                                   #  The context data must be a JSON String, and
+                                   #  have maximum size of 4KB.
+--context-from-stdin               # Read context data from STDIN.
+--set-root                         # Set the function as the root route for the workspace.
+--set-catch-all                    # Set the function as the catch-all route for the workspace.
 --dont-create-workspace            # Don't try to create the workspace if it doesn't exist.
           )
         end
@@ -171,6 +175,8 @@ module FaaStRuby
               Dir.chdir @args.shift
             when '--context'
               @options['context'] = @args.shift
+            when '--context-from-stdin'
+              @options['context'] = STDIN.gets.chomp
             when '--quiet', '-q'
               @options['quiet'] = true
             when '--set-root'

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

@@ -39,15 +39,15 @@ module FaaStRuby
         def usage
           puts "\nUsage: faastruby #{self.class.help}"
           puts %(
--b,--body 'DATA'               # The request body
---stdin                        # Read the request body from STDIN
--m,--method METHOD             # The request method
+-b,--body 'DATA'               # The request body.
+--stdin                        # Read the request body from STDIN.
+-m,--method METHOD             # The request method.
 -h,--header 'Header: Value'    # Set a header. Can be used multiple times.
--f,--form 'a=1&b=2'            # Send form data and set header 'Content-Type: application/x-www-form-urlencoded'
--j,--json '{"a":"1"}'          # Send JSON data and set header 'Content-Type: application/json'
--t,--time                      # Return function run time in the response
+-f,--form 'a=1&b=2'            # Send form data and set header 'Content-Type: application/x-www-form-urlencoded'.
+-j,--json '{"a":"1"}'          # Send JSON data and set header 'Content-Type: application/json'.
+--measure                      # Return function execution time in the response headers.
 -q,--query 'foo=bar'           # Set a query parameter for the request. Can be used multiple times.
---curl                         # Return the CURL command equivalent for the request
+--curl                         # Print the equivalent CURL command for the request and exit.
           )
         end
 
@@ -69,8 +69,9 @@ module FaaStRuby
               @options['method'] = @args.shift.downcase
             when '-h', '--header'
               set_header
-            when '-t', '--time'
-              @options['time'] = true
+            when '--measure'
+              @options['headers'] ||= {}
+              @options['headers']['Benchmark'] = true
             when '--curl'
               @options['curl'] = true
             when '-q', '--query'

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

@@ -35,8 +35,12 @@ module FaaStRuby
         def usage
           puts "\nUsage: faastruby #{self.class.help}"
           puts %(
--d, --data 'STRING'    # The context data. Must be quoted.
---stdin                # Read context data from STDIN
+-d, --data JSON_STRING'     # The data to be stored as execution context
+                            #  in the cloud, accessible via 'event.context'
+                            #  from within your function.
+                            #  The context data must be a JSON String, and
+                            #  have maximum size of 4KB.
+--stdin                     # Read context data from STDIN
           )
         end
 

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

@@ -7,19 +7,22 @@ module FaaStRuby
       end
 
       def run
-        puts "faastRuby CLI - Manage workspaces and functions hosted at faastruby.io"
-        puts "Version: #{FaaStRuby::VERSION}"
-        puts
-        puts "Usage: faastruby [update] [OPTIONS] COMMAND [--help | -h] [ARGS]"
-        puts
-        puts "To update to the latest version, run: faastruby update"
-        puts
-        puts "OPTIONS:"
-        puts 'help, -h, --help     # Displays this help'
-        puts '-v                   # Print version and exit'
-        puts '--region tor1        # Specify a region. "tor1" (default) is the only region available'
-        puts "\nCOMMANDS:"
         puts %(
+faastRuby CLI - Manage workspaces and functions hosted at faastruby.io
+Version: #{FaaStRuby::VERSION}
+
+Usage: faastruby [update] [OPTIONS] COMMAND [--help | -h] [ARGS]
+
+To update to the latest version, run: faastruby update
+
+OPTIONS:
+  help, -h, --help     # Displays this help
+  -v                   # Print version and exit
+  --region tor1        # Specify a region. "tor1" (default) is the only
+                       #  region available at this time
+
+COMMANDS:
+
 Accounts:
   signup
   confirm-account      # Send a token over email for account confirmation
@@ -27,7 +30,7 @@ Accounts:
   logout
 
 Functions:
-  new                  # Initialize a function in your local machine
+  new                  # Initialize a directory with a function template
   deploy-to            # Deploy a function to a cloud workspace
   remove-from          # Remove a function from a cloud workspace
   run                  # Trigger the function via HTTP endpoint
@@ -36,17 +39,22 @@ Functions:
 Projects:
   new-project          # Initialize a project in your local machine
   deploy               # Deploy all functions and static files of a project
+  down                 # Remove a workspace from the cloud. Must be executed
+                       #  from within a project directory.
 
 Workspaces:
   create-workspace     # Create a cloud workspace
-  destroy-workspace    # Erase a workspace from the cloud
+  destroy-workspace    # Remove a workspace and all its functions
+                       #  from the cloud. Can't be undone.
   list-workspace       # List what's in a cloud workspace
-  cp                   # Copy a static file from your local machine to a cloud workspace
+  cp                   # Copy a static file from your local machine to
+                       #  a cloud workspace
   rm                   # Remove a static file from a cloud workspace
   update-workspace     # Update workspace settings
 
+Run faastruby COMMAND --help for more details.
+
 )
-        puts "Run faastruby COMMAND --help for more details."
       end
     end
   end

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

@@ -18,7 +18,7 @@ module FaaStRuby
           @options['functions'] += find_functions unless @options['functions'].any?
           @options['environment'] ||= 'stage'
           @project_yaml = YAML.load(File.read(PROJECT_YAML_FILE))['project'] rescue FaaStRuby::CLI.error("Could not find file 'project.yml'. Are you running this command from the project's folder?")
-          @project_secrets = YAML.load(File.read(PROJECT_SECRETS_FILE)) rescue {secrets: {}}
+          @project_secrets = YAML.load(File.read(PROJECT_SECRETS_FILE))['secrets'] rescue {secrets: {}}
           @project_name = @project_yaml['name']
           @root_to = @project_yaml['root_to'] || 'root'
           @catch_all = @project_yaml['catch_all'] || 'catch-all'
@@ -124,7 +124,7 @@ module FaaStRuby
 -f,--function FUNCTION_PATH    # Specify the path to the function directory in your local machine.
                                # This argument can be repeated many times for multiple functions. Example:
                                # -f path/to/function1 -f path/to/function2
--e,--env ENVIRONMENT           # ENVIRONMENT is added to the project name to compose the workspace name.
+-e,--env ENVIRONMENT           # ENVIRONMENT is added to the project's name to compose the workspace name.
           )
         end
 

data/lib/faastruby/cli/commands/project/down.rb

@@ -31,10 +31,17 @@ module FaaStRuby
         end
 
         def usage
-          puts "Usage: faastruby #{self.class.help}"
           puts %(
--e,--env ENVIRONMENT           # ENVIRONMENT is added to the project name to compose the workspace name.
-          )
+
+Remove a workspace from the cloud.
+Must be executed from within a project's directory.
+
+Usage: faastruby #{self.class.help}
+
+-e,--env ENVIRONMENT           # ENVIRONMENT is added to the project's name to compose the workspace name.
+                               # Defaults to 'stage'
+
+)
         end
 
         def parse_options

data/lib/faastruby/cli/commands/project/new.rb

@@ -121,54 +121,54 @@ module FaaStRuby
         end
 
         def default_secrets_file
-          [
-            'secrets:',
-            "  # Add secrets here and they will be available inside the function as \"event.context\"",
-            "  # Example:",
-            "  # prod:",
-            "  #   root:",
-            "  #     a_secret: bfe76f4557ffc2de901cb24e0f87436f",
-            "  #   another/function:",
-            "  #     another_secret: 4d1c281e.619a2489c.8b5d.dd945616d324",
-            "",
-            "  # 'stage' is the default environment when you start Local",
-            "  # stage:",
-            "  #   root:",
-            "  #     a_secret: bfe76f4557ffc2de901cb24e0f87436f",
-            "  #   another/function:",
-            "  #     another_secret: 4d1c281e.619a2489c.8b5d.dd945616d324"
-          ].join("\n")
+%(secrets:
+  # Add secrets here and they will be available inside the function as "event.context"
+  # Example:
+  # prod:
+  #   root:
+  #     a_secret: bfe76f4557ffc2de901cb24e0f87436f
+  #   another/function:
+  #     another_secret: 4d1c281e.619a2489c.8b5d.dd945616d324
+
+  # 'stage' is the default environment when you start Local
+  # stage:
+  #   root:
+  #     a_secret: bfe76f4557ffc2de901cb24e0f87436f
+  #   another/function:
+  #     another_secret: 4d1c281e.619a2489c.8b5d.dd945616d324
+)
         end
 
         def default_project_file
-          [
-            "project:",
-            "  # The project name",
-            "  name: #{@project_name}",
-            "  # The project identifier is used to ensure your workspaces will have unique names.",
-            "  # This is not a secret, but don't lose it!",
-            "  identifier: #{Digest::MD5.hexdigest(Time.now.to_s).slice(0..5)}",
-            "",
-            "  ## The 'public' directory, where you put static files.",
-            "  ## Files will be served from here first, meaning that if",
-            "  ## you have a function at '/product' and a folder '/product'",
-            "  ## inside the public folder, the public one will take precedence.",
-            "  ## Defaults to 'public'.",
-            "  # public_dir: public",
-            "",
-            "  ## The name of the folder containing your functions. Defaults to 'functions'",
-            "  # functions_dir: functions",
-            "",
-            "  ## The name of the function that will respond to requests made",
-            "  ## to '/'. Defaults to 'root'",
-            "  # root_to: root",
-            "",
-            "  ## The setting 'catch_all' allows you to capture requests to",
-            "  ## non-existing functions and send them to another function.",
-            "  ## This is useful for setting custom 404 pages, for example.",
-            "  ## Defaults to 'catch-all'.",
-            "  # catch_all: catch-all"
-          ].join("\n")
+%(project:
+  # The project name
+  name: #{@project_name}
+
+  # The project identifier is used to ensure your workspaces will have unique names.
+  # This is not a secret, but don't lose it!
+  identifier: #{Digest::MD5.hexdigest(Time.now.to_s).slice(0..5)}
+
+  ## The 'public' directory is where you put static files.
+  ## Files will be served from there first, meaning that if
+  ## you have a function at 'functions/product' and a folder
+  ## 'public/product', the public one will take precedence.
+  ## Defaults to 'public'.
+  # public_dir: public
+
+  ## The name of the folder containing the project's functions.
+  ## Defaults to 'functions'.
+  # functions_dir: functions
+
+  ## The name of the function that will respond to requests made
+  ## to '/'. Defaults to 'root'
+  # root_to: root
+
+  ## The setting 'catch_all' allows you to capture requests to
+  ## non-existing functions and send them to another function.
+  ## This is useful for setting custom 404 pages, for example.
+  ## Defaults to 'catch-all'.
+  # catch_all: catch-all
+)
         end
 
         def tmuxinator_config

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

@@ -39,8 +39,7 @@ module FaaStRuby
         def usage
           puts "\nUsage: faastruby #{self.class.help}"
           puts %(
---create-local-dir    # Create a local folder in addition to the cloud
---local-only          # Only create a local folder. Skip creating workspace on the cloud
+--create-local-dir    # Create a local directory with the workspace name.
           )
         end
 

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

@@ -14,7 +14,7 @@ module FaaStRuby
           load_credentials
         end
 
-        def run(create_directory: true, exit_on_error: true)
+        def run
           spinner = spin("Updating the number of runners to #{@options['runners_max']}...")
           workspace = FaaStRuby::Workspace.new(name: @workspace_name)
           workspace.update_runners(@options['runners_max'])
@@ -30,6 +30,10 @@ module FaaStRuby
           puts "\nUsage: faastruby #{self.class.help}"
           puts %(
 --runners N   # Assign N runners to the workspace.
+              #  N must be an integer between 0 and 100.
+              #  When set to 0, requests to any functions
+              #  whithin the workspace will return HTTP error
+              #  429 - Too Many Requests.
           )
         end
 

data/lib/faastruby/version.rb

@@ -1,3 +1,3 @@
 module FaaStRuby
-  VERSION = '0.5.15'
+  VERSION = '0.5.16'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faastruby
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.5.16
 platform: ruby
 authors:
 - Paulo Arruda