fdk 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f057f3e89f9eb850ed4985a5f6126c8e8bfa48d
-  data.tar.gz: 9cae6ab2bf5440ead52770fd6bd9169f3aa16827
+  metadata.gz: cd1f63ae8fc93bda3870e3ce780994e84b99e386
+  data.tar.gz: 045eebb796bd9eaae7a190dbd10c3bbb390c61a6
 SHA512:
-  metadata.gz: 53027dd0dc51188135be54f0d6a669cf5dbb3e32a5b6bcecc504c7e96312ecb3237f9c5572b0e7675171fbbd9c0705ee1ac079851503b72d41c405308d652bfe
-  data.tar.gz: 3e8f21b25c20dd5e8595c53a0cfa80fb1c7cef152a1f3f5914d628cd13b3b86a547a4a80494215ea11f52ba75ca0a3a8dc2ed5bc7fd259e01cace8203e6d8931
+  metadata.gz: 31677d766e3ae7d1dff6ccca614e5be549e5704dd2747406206496f3c2ec886fa48735d3fde66989b4840606b692f6b4cc2bde95da5c717f7ab5dedd2b70da57
+  data.tar.gz: 7a4d3a7d572e94f752ec2be0eacc44bcc49936643d7c9a63faf7ee57d4a832fa362a95c2daf095d5ad4718a06e469a853f1f2442bac21d6434157928983af2c3

data/README.md

@@ -1,19 +1,17 @@
 # Ruby Function Developer Kit (FDK)
-
-This provides a Ruby framework for deleloping functions for us with [Fn](https://fnproject.github.io).
+This provides a Ruby framework for developing functions for use with [Fn](https://fnproject.github.io).
 
 ## Function Handler
-
 To use this FDK, you simply need to require this gem.
 
 ```ruby
-require 'fdk`
+require 'fdk'
 ```
 
 Then create a function with with the following syntax:
 
 ```ruby
-def myfunc(context, input)
+def myfunction(context:, input:)
     # Do some work here
     return output
 end
@@ -22,16 +20,22 @@ end
 * context - provides runtime information for your function, such as configuration values, headers, etc.
 * input – This parameter is a string containing body of the request.
 * output - is where you can return data back to the caller. Whatever you return will be sent back to the caller. If `async`, this value is ignored.
-  * Default output format should be in JSON, as Content-Type header will be `application/json` by default. You can be more flexible if you create and return
-    an FDK::Response object instead of a string.
+* Default output format should be in JSON, as Content-Type header will be `application/json` by default. You can be more flexible if you create and return
+an FDK::Response object instead of a string.
 
 Then simply pass that function to the FDK:
 
 ```ruby
-FDK.handle(myfunction)
+FDK.handle(:myfunction)
 ```
 
-## Full Example
+## Examples
+
+See the [examples](examples) folder of this repo for code examples.
+
+### Hello World Example
+
+In the [hello-ruby](examples/hello-ruby) folder there is a traditional "Hello  World" example.  The code is found in [func.rb](examples/hello-ruby/func.rb):
 
 ```ruby
 require 'fdk'
@@ -45,44 +49,50 @@ end
 FDK.handle(function: :myfunction)
 ```
 
-## Running the example that is in the root directory of this repo
+## Deploying functions
 
-```sh
-$ echo '{"name":"coolio"}' | fn run
-{"message":"Hello coolio!"}
-```
+To use a function we need to deploy it to an fn server.
 
-You can also specify the format (the default is JSON)
+In fn an _app_ consist of one or more functions and each function is
+deployed as part of an app.
 
-```sh
-$ echo '{"name":"coolio"}' | fn run --format json
-{"message":"Hello coolio!"}
-```
+We're going to deploy the hello world example as part of the app
+`examples`.
 
-If you want to just pass plain text to the function, specify a format of __default__:
-
-```sh
-$ echo 'coolio' | fn run --format default
-{"message":"Hello coolio!"}
-```
+With an fn server running (see
+[Quickstart](https://github.com/fnproject/fn/blob/master/README.md) if you need instructions):
 
-Deploy:
+`cd` to the [hello-ruby](examples/hello-ruby) folder and run:
 
 ```sh
-fn deploy --app myapp --local && echo '{"name":"coolio"}' | fn call myapp /fdk-ruby
+fn deploy --app examples --local
 ```
 
-Change to hot:
+The `--app examples` option tells fn to deploy the function as part of
+the _app_ named _examples_.
+
+The `--local` option tells fn not to push the function image to Docker
+Hub.
 
-Update func.yaml: `format: json`
+## Invoking functions
+Once we have deployed a function we can invoke it using `fn invoke`.
 
+Running the [Hello World](examples/hello-ruby) example:
 ```sh
-fn deploy --app myapp --local && echo '{"name":"coolio"}' | fn call myapp /fdk-ruby
+$ fn invoke examples hello
+{"message":"Hello World!"}
+```
+To get a more personal message, send a name in a JSON format and set the
+`content-type 'application/json'`:
+```
+echo '{"name":"Joe"}' | fn invoke examples hello --content-type
+'application/json'
+{"message":"Hello Joe!"}
 ```
 
-## Compare cold and hot
+## Compare cold and hot functions
 
-Run
+Run [loop.rb](examples/loop.rb)
 
 ```sh
 ruby loop.rb

data/lib/fdk/runner.rb

@@ -63,7 +63,7 @@ module FDK
         'type' => 'http',
         'request_url' => ENV['FN_REQUEST_URL']
       }
-      output_stream.puts FDK.single_event(function: function, context: Context.new(event), input: input_stream.read).to_json
+      output_stream.puts FDK.single_event(function: function, context: Context.new(event), input: input_stream.read.chomp).to_json
     else
       raise "Format '#{format}' not supported in Ruby FDK."
     end

data/lib/fdk/version.rb

@@ -1,3 +1,3 @@
 module FDK
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdk
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Travis Reeder
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json