faastruby-rpc 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2abf85651d49e5de1fb2ab7f62cdad8b2a5033608f93e648a5dd1ccd5cbbf13
+  data.tar.gz: 906271fdcd72e2acd967bec7ff12a55d73285056754af0b73d64a300aa006c95
+SHA512:
+  metadata.gz: c9cb7ef8be2bb3c0b90b7c8690d913f2d93b619beadea3b5e377ed06f3f97b62a6169cdcfb87b5b96ddd1615415a383fb18696dabc63752aea856a71742ff94d
+  data.tar.gz: 92ee278e10983377186ffebabae90579bf37913dfdca841af035b18660309956e53371b22a3033478f5cba99f7dedf88b1fc6b0851a9f6d4ee2bec59cbf61e63

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+before_install:
+  - gem update --system
+  - gem update bundler
+rvm:
+  - 2.5.3
+script: bundle exec rspec
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.2 - Dec 9 2018 - First release
+- Disable SSLv2, v3 and compression when calling invoke.
+
+## 0.1.1 - Dec 9 2018 - First release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faastruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    faastruby-rpc (0.1.0)
+      oj (~> 3.6)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    oj (3.7.4)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  faastruby-rpc!
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paulo Arruda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# faastruby-rpc
+
+Wrapper to make it easy to call FaaStRuby functions.
+
+#### What is FaaStRuby?
+FaaStRuby is a serverless platform built for Ruby developers.
+
+* [Tutorial](https://faastruby.io/tutorial.html)
+
+## Calling functions from within a function
+
+To call a function, use the helper method `invoke`:
+
+```ruby
+# You need the function path, which is WORKSPACE_NAME/FUNCTION_NAME
+function = 'paulo/hello'
+# Invoke the function the get the result
+result = invoke(function).call
+# Or passing arguments:
+result = invoke(function).with('Paulo', likes_ruby: true)
+```
+
+`result` is a Struct with the following attributes:
+* result.body - The response body from the function you called
+* result.code - The HTTP status code returned by the function
+* result.headers - The headers returned by the functions
+
+The arguments in `with` are passed as arguments to your function (after the `event`). You can capture them with positional arguments, keyword arguments or just a generic `*args` if you want to have the flexibility of sending a variable number of arguments.
+
+Here is the source code of `paulo/hello`:
+
+```ruby
+def handler event, name = nil
+  response = name ? "Hello, #{name}!" : 'Hello, there!'
+  render text: response
+end
+```
+
+When you call `invoke`, a request is sent with the following properties:
+* method: POST
+* header `Content-Type: application/json`
+* header `Faastruby-Rpc: true`
+* body: JSON array
+
+`invoke` is just a helper to the following method:
+```ruby
+# Calling a function that way defaults to method=GET
+FaaStRuby::RPC::Function.new("FUNCTION_PATH").call(body: nil, query_params: {}, headers: {}, method: 'get')
+```
+
+This gem is already required when you run your functions in FaaStRuby, or using `faastruby server`.
+
+## Handling errors
+
+By default, an exception is raised if the invoked function HTTP status code is greater than 400. This is important to make your functions easier to debug, and you will always know what to expect from that function call.
+
+To disable this behaviour, pass `raise_errors: false` to the `invoke` method, or to `FaaStRuby::RPC::Function.new`. Example:
+
+```ruby
+invoke('paulo/hello', raise_errors: false).call
+# or
+FaaStRuby::RPC::Function.new("paulo/hello", raise_errors: false).call(body: nil)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubyfaas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faastruby-rpc.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faastruby-rpc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faastruby-rpc"
+  spec.version       = FaaStRuby::RPC::VERSION
+  spec.authors       = ["Paulo Arruda"]
+  spec.email         = ["parrudaj@gmail.com"]
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.summary       = %q{FaaStRuby RPC - Wrapper to make it easy to call FaaStRuby functions.}
+  spec.homepage      = "https://github.com/faastruby/faastruby-rpc"
+  spec.license       = "MIT"
+  spec.add_runtime_dependency 'oj', '~> 3.6'
+
+  # 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.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "webmock", "~> 3.4"
+end

data/lib/faastruby-rpc.rb

@@ -0,0 +1,16 @@
+require 'net/http'
+require 'oj'
+require 'yaml'
+require 'faastruby-rpc/version'
+require 'faastruby-rpc/function'
+
+(Net::HTTP::SSL_IVNAMES << :@ssl_options).uniq!
+(Net::HTTP::SSL_ATTRIBUTES << :options).uniq!
+
+Net::HTTP.class_eval do
+  attr_accessor :ssl_options
+end
+
+def invoke(function, raise_errors: true)
+  FaaStRuby::RPC::Function.new(function, raise_errors: raise_errors)
+end

data/lib/faastruby-rpc/function.rb

@@ -0,0 +1,88 @@
+module FaaStRuby
+  FAASTRUBY_HOST = ENV['FAASTRUBY_HOST'] || "http://localhost:3000"
+  module RPC
+    class ExecutionError < StandardError
+    end
+    class Function
+      def initialize(path, raise_errors: true)
+        @path = path
+        @methods = {
+          'post' => Net::HTTP::Post,
+          'get' => Net::HTTP::Get,
+          'put' => Net::HTTP::Put,
+          'patch' => Net::HTTP::Patch,
+          'delete' => Net::HTTP::Delete
+        }
+        @response = Struct.new(:body, :code, :headers, :klass)
+        @raise_errors = raise_errors
+      end
+      def with(*args)
+        call(body: Oj.dump(args), headers: {'Content-Type' => 'application/json', 'Faastruby-Rpc' => 'true'})
+      end
+
+      def call(body: nil, query_params: {}, headers: {}, method: 'post')
+        url = "#{FAASTRUBY_HOST}/#{@path}#{convert_query_params(query_params)}"
+        uri = URI.parse(url)
+        use_ssl = uri.scheme == 'https' ? true : false
+        response = fetch(use_ssl: use_ssl, uri: uri, headers: headers, method: @methods[method], body: body)
+        resp_headers = {}
+        response.each{|k,v| resp_headers[k] = v}
+        case resp_headers['content-type']
+        when 'application/json'
+          begin
+            resp_body = Oj.load(response.body)
+          rescue Oj::ParseError => e
+            if response.body.is_a?(String)
+              resp_body = response.body
+            else
+              raise e if @raise_errors
+              resp_body = {
+                'error' => e.message,
+                'location' => e.backtrace&.first
+              }
+            end
+          end
+        when 'application/yaml'
+          resp_body = YAML.load(response.body)
+        else
+          resp_body = response.body
+        end
+        raise FaaStRuby::RPC::ExecutionError.new("Function #{@path} returned status code #{response.code} - #{resp_body['error']} - #{resp_body['location']}") if response.code.to_i >= 400 && @raise_errors
+        @response.new(resp_body, response.code.to_i, resp_headers)
+      end
+
+      private
+      def convert_query_params(query_params)
+        return "" unless query_params.any?
+        "?#{URI.encode_www_form(query_params)}"
+      end
+
+      def fetch(use_ssl:, uri:, limit: 10, method: Net::HTTP::Post, headers: {}, body: nil)
+        # You should choose a better exception.
+        raise ArgumentError, 'too many HTTP redirects' if limit == 0
+        http = Net::HTTP.new(uri.host, uri.port)
+        if use_ssl
+          http.use_ssl = true
+          http.ssl_options = OpenSSL::SSL::OP_NO_SSLv2 + OpenSSL::SSL::OP_NO_SSLv3 + OpenSSL::SSL::OP_NO_COMPRESSION
+        end
+        request = method.new(uri.request_uri, headers)
+        request.body = body
+        response = http.request(request)
+
+        case response
+        when Net::HTTPSuccess then
+          response
+        when Net::HTTPRedirection then
+          location = URI.parse(response['location'])
+          warn "redirected to #{location}"
+          fetch(use_ssl: use_ssl, uri: location, limit: limit - 1, method: method, headers: headers, body: body)
+        else
+          response.value
+        end
+
+      rescue Net::HTTPServerException, Net::HTTPFatalError
+        return response
+      end
+    end
+  end
+end

data/lib/faastruby-rpc/version.rb

@@ -0,0 +1,5 @@
+module FaaStRuby
+  module RPC
+    VERSION = '0.1.2'
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: faastruby-rpc
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Paulo Arruda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- parrudaj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faastruby-rpc.gemspec
+- lib/faastruby-rpc.rb
+- lib/faastruby-rpc/function.rb
+- lib/faastruby-rpc/version.rb
+homepage: https://github.com/faastruby/faastruby-rpc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: FaaStRuby RPC - Wrapper to make it easy to call FaaStRuby functions.
+test_files: []