fdk 0.0.16 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 65e2394fdcb3ded2289d375557641ce03ad38781
-  data.tar.gz: 6587cea06ad9da035c853218d52ffc6af9733fae
+SHA256:
+  metadata.gz: 82337a2e0152a4b8e145e5b7e14f4ec76cbbbf64a4f698ddf0b5b87ca0c329e0
+  data.tar.gz: 36ec9f76404c426a30f81732709aee3bc2b55beebea4fd67ec4fc3c9724ff968
 SHA512:
-  metadata.gz: 85cf5dd30e50be0b4301ceda4954f2fce48c978c69584d10d0e282f5036da583a2ff49bc5610d2b676b511fd929f1410f9e882fa81aac6cad7862cfb7a8855c1
-  data.tar.gz: 89d8e019779503fd53d00026dfa412fccc87b4c75eae36f11ff1568b124e287a331338b0a192ed2de62f5e322f96779798c58363f43152a488fba4a4e0048c2a
+  metadata.gz: 4657ece9b952b4f3a15c5e0e26ccf0e36991def60f94c0255fa7b8aef4e00b6e06580653396df32c8b8d534fb31d728dea794bff9a18009b956f6b58162f426c
+  data.tar.gz: 9a4a9eb7ec981dbaa009c1d5d919255f4fd5439309e9fa0fd2fd1be2d8c9f00084677c45676d582461272f115475b854e8060f89e904e476a98a1f07a3f03ef8

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.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"

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

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
@@ -32,29 +53,35 @@ module FDK
     end
 
     def listen(&block)
-      local_socket = socket.accept
-      begin
-        raise StandardError("No block given") unless block_given?
+      raise StandardError("No block given") unless block_given?
 
-        handle_requests(socket: local_socket, fn_block: block)
+      begin
+        loop do
+          handle_request(fn_block: block)
+        end
       rescue StandardError => e
         FDK.log(entry: "Error in request handling #{e}")
         FDK.log(entry: e.backtrace)
       end
+    end
+
+    def handle_request(fn_block:)
+      local_socket = socket.accept
+      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)
+      FDK.debug "sending resp  #{resp.status}, #{resp.header}"
       local_socket.close
     end
 
-    def handle_requests(socket:, fn_block:)
-      loop do
-        req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
-        resp = WEBrick::HTTPResponse.new(WEBrick::Config::HTTP)
-        req.parse(socket)
-        FDK.debug "got request #{req}"
-        fn_block.call(req, resp)
-        resp.send_response(socket)
-        FDK.debug "sending resp  #{resp.status}, #{resp.header}"
-        break unless req.keep_alive?
-      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
@@ -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
 
@@ -18,7 +36,7 @@ module FDK
   # Writes the entry to STDERR if the log_level >= log_threshold
   # If no log level is specified, 1 is assumed.
   def self.log(entry:, log_level: FDK_LOG_DEFAULT)
-    STDERR.puts(entry) if log_level >= log_threshold
+    warn(entry) if log_level >= log_threshold
   end
 
   def self.log_error(error:)

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.16".freeze
+  VERSION = "0.0.24"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdk
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.24
 platform: ruby
 authors:
 - Travis Reeder
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -32,6 +32,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: net_http_unix
   requirement: !ruby/object:Gem::Requirement
@@ -98,15 +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: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby FDK for Fn Project