fdk 0.0.19 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78e0e2f31ccc1881218c6a3ecfe5fc8a98bab525c4710ffb8e63ffec58bcaaa0
-  data.tar.gz: ed342e0ba43d13b0cced1488bb111a9de258fedf77df2105f3ea4ef9bfd59aaf
+  metadata.gz: 11bde0cbeae6808c95696bc9068aa90c4fe1cdd191878ac72a1560688f01064c
+  data.tar.gz: e3265d7ef4e04cbd6a5f91bed6091d96c29fb3eebd052fb8bda161f0f2026c96
 SHA512:
-  metadata.gz: eb1b8a8c907a33fd5d40ff70e8346c52352ccebcda056923707285bf8a13127664b7bb6cbb3e6170503beb7d479262053b6fb043e3000fef81cec410d5d7d021
-  data.tar.gz: 401cdd0d0e13ffba1155e4a54c61281c0d8f07d7d8754395df92807f596595cd599eb0aa43c3224ee33ac8a2d40527b16cd777a0968debc722647933c6ae9632
+  metadata.gz: 0577ca1a919505807e9c1662b96bba8238eee65e26042541b93160039dd898501cbfb137e09e291d86bbb050a4d4619b7e9b2ed518f4c4119943bf3de3ced33b
+  data.tar.gz: 356dc9aa5da12d54e18603c6a7ffed2ff798902b2e7940e22320718e34d5d759c79c944a1e4ecb5d6ede8b0537bd49b7f7e59cce54987429358b537ce86d71f2

data/README.md

@@ -1,5 +1,5 @@
-# Ruby Function Developer Kit (FDK)
-This provides a Ruby framework for developing functions for use with [Fn](https://fnproject.github.io).
+# Function Development Kit for Ruby
+The Function Development Kit for Ruby (FDK for Ruby) provides a Ruby framework for developing functions for use with [Fn](https://fnproject.github.io).
 
 [![CircleCI](https://circleci.com/gh/fnproject/fdk-ruby.svg?style=svg)](https://circleci.com/gh/fnproject/fdk-ruby)
 

data/lib/fdk/call.rb

@@ -1,8 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module FDK
   # Call represents a call to the target function or lambda
   class Call
-    FILTER_HEADERS = ["content-length", "te", "transfer-encoding",
-                      "upgrade", "trailer"].freeze
+    FILTER_HEADERS = %w[content-length te transfer-encoding upgrade trailer].freeze
 
     attr_reader :request, :response
     attr_accessor :error

data/lib/fdk/context.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require "date"
 
 module FDK
@@ -33,6 +51,8 @@ module FDK
   # Represents outbound HTTP headers
   class OutHeaders < InHeaders
     def initialize(headers, key_in_fn)
+      headers["Fn-Fdk-Version"] = ["fdk-ruby/#{FDK::VERSION}"]
+      headers["Fn-Fdk-Runtime"] = ["ruby/#{RUBY_VERSION}"]
       super(headers, key_in_fn)
     end
 

data/lib/fdk/function.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module FDK
   # Function represents a function function or lambda
   class Function

data/lib/fdk/listener.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module FDK
   # Represents the socket that Fn uses to communicate
   # with the FDK (and thence the function)
@@ -9,13 +27,16 @@ module FDK
   #
   # Fn waits for the socket_path to be created and then connects
   class Listener
-    attr_reader :url, :private_socket
+    attr_reader :url, :private_socket, :fn_logframe_name, :fn_logframe_hdr
 
     def initialize(url:)
       if url.nil? || !url.start_with?("unix:/")
         raise "Missing or invalid socket URL in FN_LISTENER."
       end
 
+      @fn_logframe_name = ENV["FN_LOGFRAME_NAME"]
+      @fn_logframe_hdr = ENV["FN_LOGFRAME_HDR"]
+
       @url = url
       @private_socket = UNIXServer.open(private_socket_path)
     end
@@ -46,10 +67,10 @@ module FDK
 
     def handle_request(fn_block:)
       local_socket = socket.accept
-      req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
-      resp = WEBrick::HTTPResponse.new(WEBrick::Config::HTTP)
+      req, resp = new_req_resp
       req.parse(local_socket)
       FDK.debug "got request #{req}"
+      log_frame_header(req.header)
       fn_block.call(req, resp)
       resp["Connection"] = "close" # we're not using keep alives sadly
       resp.send_response(local_socket)
@@ -57,6 +78,12 @@ module FDK
       local_socket.close
     end
 
+    def new_req_resp
+      req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
+      resp = WEBrick::HTTPResponse.new(WEBrick::Config::HTTP)
+      [req, resp]
+    end
+
     def socket_path
       @socket_path ||= url[5..url.length]
     end
@@ -64,5 +91,26 @@ module FDK
     def private_socket_path
       socket_path + ".private"
     end
+
+    def log_frame_header(headers)
+      return unless logframe_vars_exist
+
+      k = @fn_logframe_hdr.downcase
+      v = headers[k]
+      return if v.nil? || v.empty?
+
+      frm = "\n#{@fn_logframe_name}=#{v[0]}\n"
+      $stderr.print frm
+      $stderr.flush
+      $stdout.print frm
+      $stdout.flush
+    end
+
+    def logframe_vars_exist
+      return false if @fn_logframe_name.nil? || @fn_logframe_name.empty? ||
+                      @fn_logframe_hdr.nil? || @fn_logframe_hdr.empty?
+
+      true
+    end
   end
 end

data/lib/fdk/runner.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require "webrick"
 require "fileutils"
 require "json"
@@ -7,7 +25,7 @@ require "set"
 # Executes it with input
 # Responds with output
 module FDK
-  FDK_LOG_THRESHOLD = "FDK_LOG_THRESHOLD".freeze
+  FDK_LOG_THRESHOLD = "FDK_LOG_THRESHOLD"
   FDK_LOG_DEBUG = 0
   FDK_LOG_DEFAULT = 1
 

data/lib/fdk/support_classes.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module FDK
   # ParsedInput stores raw input and can parse it as
   # JSON (add extra formats as required)

data/lib/fdk/version.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module FDK
-  VERSION = "0.0.19".freeze
+  VERSION = "0.0.26"
 end

data/lib/fdk.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require_relative "fdk/version"
 require_relative "fdk/runner"
 require_relative "fdk/context"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdk
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.26
 platform: ruby
 authors:
 - Travis Reeder
@@ -10,28 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -118,14 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby FDK for Fn Project