faastruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a2b492f1a720606438bf41373fc04ef892932224b8272cc1ef9ee48a793d31e
+  data.tar.gz: c9489fbc690bd3ab685067852c7dda8115c0a7c6f075b145ebeb92558f83c8ab
+SHA512:
+  metadata.gz: 2ddf53f3d75310e788d2671a6939d2706f7658bb946b49dfc5828c52816d8a091c06cf815e2a93e31294c09ae93d475ea82525c825f6bd44f3466d36e7387b5a
+  data.tar.gz: 325b6fc49cb1168ac0522abdfaebad1bd06466d511e5271bcb9c0bdb03e5dda0dcac93a8abb990035b768997db52e1a864495234d61e98afa4fac84e050bec13

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 0.2.0 - Oct 12 2018
+- Full rewrite of the gem. All command line parameters have changed. Please see the documentation.
+- No more git dependence.
+- Functions are packaged and deployed individually, and also removed individually.
+- Functions have a YAML configuration file.
+- Functions can have tests and they can be configured to run before each deploy, aborting it if a failure happens.
+- Added option to print or save the workspace credentials into a different file upon creation, instead of saving it to ~/.faastruby
+- Read a different credentials file via FAASTRUBY_CREDENTIALS environment variable.
+- Read credentials via environment variables: FAASTRUBY_API_KEY and FAASTRUBY_API_SECRET.

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,67 @@
+PATH
+  remote: .
+  specs:
+    faastruby (0.2.0)
+      colorize
+      oj
+      rest-client
+      rubyzip
+      tty-spinner
+      tty-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    equatable (0.5.0)
+    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)
+    necromancer (0.4.0)
+    netrc (0.11.0)
+    oj (3.6.11)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    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)
+    rubyzip (1.2.2)
+    strings (0.1.4)
+      strings-ansi (~> 0.1.0)
+      unicode-display_width (~> 1.4.0)
+      unicode_utils (~> 1.4.0)
+    strings-ansi (0.1.0)
+    tty-color (0.4.3)
+    tty-cursor (0.6.0)
+    tty-screen (0.6.5)
+    tty-spinner (0.8.0)
+      tty-cursor (>= 0.5.0)
+    tty-table (0.10.0)
+      equatable (~> 0.5.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.0)
+      tty-screen (~> 0.6.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  faastruby!
+  rake (~> 10.0)
+
+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,39 @@
+# FaaSt Ruby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubyfaas`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faastruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faastruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faastruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/example-blank/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+end

data/example-blank/handler.rb

@@ -0,0 +1,4 @@
+def handler event
+  # Do the magic here
+  # Use respond_with RESPONSE, where RESPONSE is a Hash, String or Array.
+end

data/example-blank/spec/handler_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'handler'
+
+describe 'handler(event)' do
+  let(:event) {SpecHelper::Event.new}
+
+  it 'should return Hash, String or Array' do
+    body = handler(event).body
+    expect([String, Hash, Array].include? body.class).to be true
+  end
+end

data/example-blank/spec/helpers/faastruby.rb

@@ -0,0 +1,23 @@
+module FaaStRuby
+  def self.included(base)
+    base.extend(SpecHelper)
+    $LOAD_PATH << Dir.pwd
+  end
+  module SpecHelper
+    class Event
+      @@event = Struct.new(:body, :query_params, :headers, :context)
+      def self.new(body: 'example body', query_params: {'foo' => 'bar'}, headers: {'Foo' => 'Bar'}, context: '{"foo": "bar"}')
+        @@event.new(body, query_params, headers, context)
+      end
+    end
+    class Response
+      @@response = Struct.new(:body, :status, :headers)
+      def self.new(body, status, headers)
+        @@response.new(body, status, headers)
+      end
+    end
+  end
+  def respond_with(body, status: 200, headers: {})
+    SpecHelper::Response.new(body, status, headers)
+  end
+end

data/example-blank/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'helpers/faastruby'
+include FaaStRuby

data/example/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+end

data/example/handler.rb

@@ -0,0 +1,17 @@
+# require 'cool-gem'
+require 'json'
+
+# 1) If you don't have a workspace, create one by running:
+# faastruby create-workspace WORKSPACE_NAME
+# 2) To deploy this function, cd into its folder and run:
+# faastruby deploy WORKSPACE_NAME
+def handler event
+  headers = {
+    'Content-Type' => 'text/plain',
+    'My-Custom-Header' => 'Value'
+  }
+  data = event.body ? JSON.parse(event.body) : {}
+  # The response must be a Hash, Array or String.
+  response = "Hello, #{data['name'] || 'World'}!"
+  respond_with response, status: 200, headers: headers
+end

data/example/spec/handler_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'handler'
+
+describe 'handler(event)' do
+  let(:event) {SpecHelper::Event.new(body: '{"name": "Ruby"}')}
+
+  it 'should return Hash, String or Array' do
+    body = handler(event).body
+    expect([String, Hash, Array].include? body.class).to be true
+  end
+  it 'should add the name to the response string' do
+    body = handler(event).body
+    expect(body).to be == 'Hello, Ruby!'
+  end
+  it 'should say Hello, World! when name is not present' do
+    event = SpecHelper::Event.new(body: nil)
+    body = handler(event).body
+    expect(body).to be == 'Hello, World!'
+  end
+end

data/example/spec/helpers/faastruby.rb

@@ -0,0 +1,23 @@
+module FaaStRuby
+  def self.included(base)
+    base.extend(SpecHelper)
+    $LOAD_PATH << Dir.pwd
+  end
+  module SpecHelper
+    class Event
+      @@event = Struct.new(:body, :query_params, :headers, :context)
+      def self.new(body: 'example body', query_params: {'foo' => 'bar'}, headers: {'Foo' => 'Bar'}, context: '{"foo": "bar"}')
+        @@event.new(body, query_params, headers, context)
+      end
+    end
+    class Response
+      @@response = Struct.new(:body, :status, :headers)
+      def self.new(body, status, headers)
+        @@response.new(body, status, headers)
+      end
+    end
+  end
+  def respond_with(body, status: 200, headers: {})
+    SpecHelper::Response.new(body, status, headers)
+  end
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'helpers/faastruby'
+include FaaStRuby

data/exe/faastruby

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'faastruby'
+require 'faastruby/cli'
+command = ARGV.shift
+FaaStRuby::CLI.run(command, ARGV)

data/faastruby.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faastruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faastruby"
+  spec.version       = FaaStRuby::VERSION
+  spec.authors       = ["Paulo Arruda"]
+  spec.email         = ["parrudaj@gmail.com"]
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.summary       = %q{FaaStRuby CLI - Manage workspaces and functions hosted at faastruby.io.}
+  spec.homepage      = "https://faastruby.io"
+  spec.license       = "MIT"
+  spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_runtime_dependency 'oj', '~> 3.6'
+  spec.add_runtime_dependency 'tty-spinner', '~> 0.8'
+  spec.add_runtime_dependency 'tty-table', '~> 0.10'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.2'
+  spec.add_runtime_dependency 'colorize', '~> 0.8'
+
+  # 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"
+end

data/lib/faastruby.rb

@@ -0,0 +1,6 @@
+require 'oj'
+require 'faastruby/version'
+require 'faastruby/base'
+require 'faastruby/api'
+require 'faastruby/function'
+require 'faastruby/workspace'

data/lib/faastruby/api.rb

@@ -0,0 +1,94 @@
+require 'rest-client'
+
+module FaaStRuby
+  class API
+    @@api_version = 'v2'
+    def initialize
+      @api_url = "#{HOST}/#{@@api_version}"
+      @credentials = {'API-KEY' => FaaStRuby.api_key, 'API-SECRET' => FaaStRuby.api_secret}
+      @headers = {content_type: :json, accept: :json}.merge(@credentials)
+    end
+
+    def create_workspace(workspace_name:, email: nil)
+      url = "#{@api_url}/workspaces"
+      payload = {'name' => workspace_name}
+      payload['email'] = email if email
+      parse RestClient.post(url, Oj.dump(payload), @headers){|response, request, result| response }
+    end
+
+    def destroy_workspace(workspace_name)
+      url = "#{@api_url}/workspaces/#{workspace_name}"
+      parse RestClient.delete(url, @headers){|response, request, result| response }
+    end
+
+    # def update_workspace(workspace_name, payload)
+    #   url = "#{@api_url}/workspaces/#{workspace_name}"
+    #   parse RestClient.patch(url, Oj.dump(payload), @headers)
+    # end
+
+    def get_workspace_info(workspace_name)
+      url = "#{@api_url}/workspaces/#{workspace_name}"
+      parse RestClient.get(url, @headers){|response, request, result| response }
+    end
+
+    def deploy(workspace_name:, package:)
+      url = "#{@api_url}/workspaces/#{workspace_name}/deploy"
+      payload = {package: File.new(package, 'rb')}
+      parse RestClient.post(url, payload, @credentials){|response, request, result| response }
+    end
+
+    def delete_from_workspace(function:, workspace:)
+      url = "#{@api_url}/workspaces/#{workspace.name}/functions/#{function.name}"
+      parse RestClient.delete(url, @headers){|response, request, result| response }
+    end
+
+    def list_workspace_functions(workspace_name)
+      url = "#{@api_url}/workspaces/#{workspace_name}/functions"
+      parse RestClient.get(url, @headers){|response, request, result| response }
+    end
+
+    def run(function_name:, workspace_name:, payload:, method:, headers: {}, time: false, query: nil)
+      url = "#{HOST}/#{workspace_name}/#{function_name}#{query}"
+      headers['Benchmark'] = true if time
+      if method == 'get'
+        RestClient.public_send(method, url, headers){|response, request, result| response }
+      else
+        RestClient.public_send(method, url, payload, headers){|response, request, result| response }
+      end
+    end
+
+    def update_function_context(function:, workspace:, payload:)
+      # payload is a string
+      url = "#{@api_url}/workspaces/#{workspace.name}/functions/#{function.name}"
+      parse RestClient.patch(url, Oj.dump(payload), @headers){|response, request, result| response }
+    end
+
+    def parse(response)
+      struct = Struct.new(:response, :body, :errors, :code)
+      case response.code
+      when 401
+        body = Oj.load(response.body)
+        return struct.new(nil, nil, ["(401) Unauthorized - #{body['error']}"], 401)
+      when 404
+        body = Oj.load(response.body)
+        return struct.new(nil, nil, ["(404) Not Found - #{body['error']}"], 404)
+      when 409
+        body = Oj.load(response.body)
+        return struct.new(nil, nil, ["(409) Conflict - #{body['error']}"], 409)
+      when 500
+        return struct.new(nil, nil, ["(500) Error"], 500)
+      when 408
+        return struct.new(nil, nil, ["(408) Request Timeout"], 408)
+      when 422
+        body = Oj.load(response.body)
+        return struct.new(nil, nil, ["(422) Unprocessable Entity - #{body['error']}"], 422)
+      when 402 # Limit excedeed
+        body = Oj.load(response.body)
+        return struct.new(nil, nil, ["(402) Limit Exceeded - #{body['error']}"], 402)
+      else
+        body = Oj.load(response.body)
+        return struct.new(response, body, (body['errors'] || []), response.code)
+      end
+    end
+  end
+end