eventline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56cd182c51702104d9373178ba4ccf90b980d347a599c25ba7355558aa971f7a
+  data.tar.gz: 99b125a4950034ee3e9c0e7a154c142a35d2ea90e984b0800ca859c31363624e
+SHA512:
+  metadata.gz: '0778b80c81259626f335a5cbcf021960a55e37d118d6fa34fcfc70741bae4ab3172df81226d2dc31bbc6ab31f985defa9cb2546d98806c0609d7be42ad342b05'
+  data.tar.gz: 3f31538d02f8779c2436a23bbacf0e5f5252d7a9a483c0e0046fae6e6ab2fd152db51512774897524f27a0939fe0093ade72c3620d0c4c459b46e8ba97e14855

data/lib/eventline/account.rb

@@ -0,0 +1,95 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require("eventline/client")
+
+module Eventline
+  class Account
+    attr_accessor(:id, :org_id, :creation_time, :disabled, :email_address, :name, :role,
+      :last_login_time, :last_project_id, :settings)
+
+    # Fetch a list of accounts.
+    #
+    # @param [Eventline::Client] client
+    # @param [Hash] data
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Client::ListResponse
+    def self.list(client, data = nil)
+      request = Net::HTTP::Get.new("/v0/accounts")
+      response = client.call(request)
+
+      elements = response.fetch("elements", []).map do |element|
+        account = new
+        account.from_h(element)
+        account
+      end
+
+      Client::ListResponse.new(elements, response["next"], response["previous"])
+    end
+
+    # Fetch an account by identifier.
+    #
+    # @param [Eventline::Client] client
+    # @param [String] id
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Account
+    def self.retrieve(client, id)
+      request = Net::HTTP::Get.new(File.join("/v0/accounts/id", id))
+      response = client.call(request)
+      account = new
+      account.from_h(response)
+      account
+    end
+
+    # Fetch the current account.
+    #
+    # @param [Eventline::Client] client
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Account
+    def self.current_account(client)
+      request = Net::HTTP::Get.new("/v0/account")
+      response = client.call(request)
+      account = new
+      account.from_h(response)
+      account
+    end
+
+    def initialize
+    end
+
+    # Load account from a hash object.
+    #
+    # @raise [KeyError]
+    #
+    # @return Eventline::Account
+    def from_h(data)
+      @id = data.fetch("id")
+      @org_id = data.fetch("org_id")
+      @creation_time = data.fetch("creation_time")
+      @disabled = data.fetch("disabled")
+      @email_address = data.fetch("email_address")
+      @name = data["name"]
+      @role = data.fetch("role")
+      @last_login_time = data["last_login_time"]
+      @last_project_id = data["last_project_id"]
+      @settings = data.fetch("settings")
+    end
+  end
+end

data/lib/eventline/client.rb

@@ -0,0 +1,165 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require("net/https")
+require("openssl")
+require("set")
+require("json")
+
+module Eventline
+  class Client
+    class ListResponse
+      attr_reader(:elements, :next, :previous)
+
+      def initialize(elements, next0, previous0)
+        @elements = elements
+
+        @next = Pagination.new(next0.to_h)
+        @previous = Pagination.new(previous0.to_h)
+      end
+    end
+
+    class Pagination
+      attr_reader(:after, :before, :sort, :size, :order)
+
+      def initialize(opts)
+        @after = opts["after"]
+        @before = opts["before"]
+        @sort = opts["sort"]
+        @size = opts["size"]
+        @order = opts["order"]
+      end
+    end
+
+    # @attr_reader status [Integer] The HTTP response status code.
+    # @attr_reader code [String] The API error code.
+    # @attr_reader data [String, Hash] The HTTP response body.
+    # @attr_reader message [String] The human readable message.
+    class RequestError < StandardError
+      attr_reader(:status, :code, :data)
+
+      # @param status [Integer]
+      # @param code [String]
+      # @param data [String,Hash]
+      # @param message [String]
+      def initialize(status, code, data, message)
+        super(message)
+        @status = status
+        @code = code
+        @data = data
+      end
+    end
+
+    PUBLIC_KEY_PIN_SET = Set[
+      "820df1ed4e14ad67d352960dcbdc0bdbe198390862ddf8395139f9a7303aee07"
+    ].freeze
+
+    # @param project_id [String]
+    # @param host [String]
+    # @param port [Integer]
+    # @param token [String]
+    def initialize(project_id:, host: "api.eventline.net", port: 443, token: "")
+      store = OpenSSL::X509::Store.new
+      store.add_file(File.expand_path("cacert.pem", __dir__ + "/../data"))
+
+      @token = ENV.fetch("EVENTLINE_API_KEY", token.to_s)
+
+      @project_id = project_id.to_s
+
+      @mut = Mutex.new
+      @conn = Net::HTTP.new(host, port)
+
+      @conn.keep_alive_timeout = 30
+
+      @conn.open_timeout = 30
+      @conn.read_timeout = 30
+      @conn.write_timeout = 30
+
+      @conn.use_ssl = true
+      @conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      @conn.cert_store = store
+      @conn.verify_callback = lambda do |preverify_ok, cert_store|
+        return false if !preverify_ok
+
+        public_key = cert_store.chain.first.public_key.to_der
+        fingerprint = OpenSSL::Digest::SHA256.new(public_key).hexdigest
+        PUBLIC_KEY_PIN_SET.include?(fingerprint)
+      end
+    end
+
+    # Execute an HTTP request on the connection.
+    #
+    # @param request [HTTPRequest] the HTTP request to execute
+    #
+    # @raise [RequestError] if the server not responds with 2xx status.
+    # @raise [SocketError]
+    # @raise [Timeout::Error]
+    #
+    # @return [String, Hash]
+    def call(request)
+      request.content_type = "application/json"
+      request.content_length = request.body.to_s.bytesize
+
+      request["Accept"] = "application/json"
+      request["User-Agent"] = "Eventline/1.0 (platform; ruby) eventline-sdk"
+      request["Authorization"] = "Bearer #{@token}"
+      request["X-Eventline-Project-Id"] = @project_id
+
+      response = @mut.synchronize do
+        @conn.request(request)
+      end
+
+      data = if response.content_type == "application/json"
+        begin
+          JSON.parse(response.body)
+        rescue
+          raise(
+            RequestError.new(
+              response.code.to_i,
+              "invalid_json",
+              response.body,
+              "invalid json body"
+            )
+          )
+        end
+      else
+        response.body
+      end
+
+      if response.code.to_i < 200 || response.code.to_i >= 300
+        if response.content_type == "application/json"
+          raise(
+            RequestError.new(
+              response.code.to_i,
+              data.fetch("code", "unknown_error"),
+              data.fetch("data", {}),
+              data.fetch("error")
+            )
+          )
+        else
+          raise(
+            RequestError.new(
+              response.code.to_i,
+              "invalid_json",
+              response.body,
+              "invalid json body"
+            )
+          )
+        end
+      end
+
+      data
+    end
+  end
+end

data/lib/eventline/context.rb

@@ -0,0 +1,106 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require("json")
+require("eventline/event")
+
+module Eventline
+  class Context
+    attr_reader(:event, :task_parameters, :instance_id, :identities)
+
+    # Returns `true` when the function is called in an Eventline instance.
+    #
+    # @return Boolean
+    def self.executed_in_eventline?
+      ENV["EVENTLINE"].to_s.eql?("true")
+    end
+
+    # Returns the current project id when the function is called in an Eventline instance.
+    #
+    # @return String
+    def self.current_project_id
+      ENV["EVENTLINE_PROJECT_ID"].to_s
+    end
+
+    # Returns the current project name when the function is called in an Eventline
+    # instance.
+    #
+    # @return String
+    def self.current_project_name
+      ENV["EVENTLINE_PROJECT_NAME"].to_s
+    end
+
+    # Returns the current pipeline id when the function is called in an Eventline
+    # instance.
+    #
+    # @return String
+    def self.current_pipeline_id
+      ENV["EVENTLINE_PIPELINE_ID"].to_s
+    end
+
+    # Returns the current task id when the function is called in an Eventline instance.
+    #
+    # @return String
+    def self.current_task_id
+      ENV["EVENTLINE_TASK_ID"].to_s
+    end
+
+    # Load and return a context object.
+    #
+    # @raise [Errno::ENOENT]
+    # @raise [Errno::EACCES]
+    # @raise [JSON::ParserError]
+    #
+    # @return Eventline::Context
+    def self.load
+      filename = ENV.fetch("EVENTLINE_CONTEXT_PATH", "/eventline/task/context")
+      file = IO.read(filename)
+      data = JSON.parse(file)
+      context = new
+      context.from_h(data)
+      context
+    end
+
+    def initialize
+    end
+
+    # Load context from a hash object.
+    #
+    # @raise [KeyError]
+    # @raise [ArgumentError]
+    #
+    # @return Eventline::Context
+    def from_h(data)
+      @event = Eventline::Event.new.from_h(data.fetch("event"))
+      @task_parameters = data.fetch("task_parameters")
+      @instance_id = Integer(data.fetch("instance_id"))
+      @identities = data.fetch("identities")
+      self
+    end
+
+    # Returns `true` when the pipeline is launch by an event.
+    #
+    # @return Boolean
+    def launch_by_event?
+      @event.trigger_id.nil?
+    end
+
+    # Returns `true` when the pipeline is launch by a command.
+    #
+    # @return Boolean
+    def launch_by_command?
+      @event.command_id.nil?
+    end
+  end
+end

data/lib/eventline/event.rb

@@ -0,0 +1,117 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require("eventline/client")
+
+module Eventline
+  class Event
+    attr_accessor(:id, :org_id, :trigger_id, :command_id, :creation_time, :event, :name,
+      :data, :original_event_id)
+
+    # Fetch a list of events.
+    #
+    # @param [Eventline::Client] client
+    # @param [Hash] data
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Client::ListResponse
+    def self.list(client, data = nil)
+      request = Net::HTTP::Get.new("/v0/events")
+      response = client.call(request)
+
+      elements = response.fetch("elements", []).map do |element|
+        event = new
+        event.from_h(element)
+        event
+      end
+
+      Client::ListResponse.new(elements, response["next"], response["previous"])
+    end
+
+    # Fetch an event by identifier.
+    #
+    # @param [Eventline::Client] client
+    # @param [String] id
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Event
+    def self.retrive(client, id)
+      request = Net::HTTP::Get.new(File.join("/v0/events/id", id))
+      response = client.call(request)
+      event = new
+      event.from_h(response)
+      event
+    end
+
+    # Create a new custom event.
+    #
+    #
+    # @param [Eventline::Client] client
+    # @param [Hash] data
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return [Eventline::Event]
+    def self.create(client, data)
+      request = Net::HTTP::Post.new("/v0/events")
+      request.body = JSON.dump(data)
+      response = client.call(request)
+
+      response.map do |element|
+        event = new
+        event.from_h(element)
+        event
+      end
+    end
+
+    # Replay an existing event.
+    #
+    # @param [Eventline::Client] client
+    # @param [String] id
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Event
+    def self.replay(client, id)
+      request = Net::HTTP::Post.new(File.join("/v0/events", id, "replay"))
+      response = client.call(request)
+      event = new
+      event.from_h(response)
+      event
+    end
+
+    def initialize
+    end
+
+    # Load event from a hash object.
+    #
+    # @raise [KeyError]
+    #
+    # @return Eventline::Event
+    def from_h(data)
+      @id = data.fetch("id")
+      @org_id = data.fetch("org_id")
+      @trigger_id = data.fetch("trigger_id", nil)
+      @command_id = data.fetch("command_id", nil)
+      @creation_time = data.fetch("creation_time")
+      @event_time = data.fetch("event_time")
+      @name = data.fetch("name")
+      @data = data.fetch("data")
+      @original_event_id = data.fetch("original_event_id", nil)
+      self
+    end
+  end
+end

data/lib/eventline/organization.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require("eventline/client")
+
+module Eventline
+  class Organization
+    attr_accessor(:id, :name, :address, :postal_code, :city, :country,
+      :contact_email_address, :non_essential_mail_opt_in, :vat_id_number)
+
+    # Fetch the organization associated with the credentials currently used by the client.
+    #
+    # @param [Eventline::Client] client
+    #
+    # @raise [Eventline::Client::RequestError]
+    #
+    # @return Eventline::Organization
+    def self.retrieve(client)
+      request = Net::HTTP::Get.new("/v0/org")
+      response = client.call(request)
+      organization = new
+      organization.from_h(response)
+      organization
+    end
+
+    def initialize
+    end
+
+    # Load organization from a hash object.
+    #
+    # @raise [KeyError]
+    #
+    # @return Eventline::Organization
+    def from_h(data)
+      @id = data.fetch("id")
+      @name = data.fetch("name")
+      @address = data["address"]
+      @postal_code = data["postal_code"]
+      @city = data["city"]
+      @country = data["country"]
+      @contact_email_address = data.fetch("contact_email_address")
+      @non_essential_mail_opt_in = data.fetch("non_essential_mail_opt_in")
+      @vat_id_number = data["vat_id_number"]
+    end
+  end
+end

data/lib/eventline/version.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2021-2022 Exograd SAS.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+module Eventline
+  VERSION = "0.1.0"
+end

data/lib/eventline.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "eventline/version"
+require "eventline/client"
+require "eventline/context"
+require "eventline/event"
+require "eventline/organization"
+require "eventline/account"
+
+module Eventline
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: eventline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Exograd SAS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-20 00:00:00.000000000 Z
+dependencies: []
+description: Eventline is a scheduling platform where you can define and run custom
+  tasks in a safe environment.
+email:
+- support@exograd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eventline.rb
+- lib/eventline/account.rb
+- lib/eventline/client.rb
+- lib/eventline/context.rb
+- lib/eventline/event.rb
+- lib/eventline/organization.rb
+- lib/eventline/version.rb
+homepage: https://docs.eventline.net
+licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/exograd/rb-eventline/issues
+  changelog_uri: https://github.com/exograd/rb-eventline/blob/master/CHANGELOG.md
+  github_repo: ssh://github.com/exograd/rb-eventline
+  homepage_uri: https://docs.eventline.net
+  source_code_uri: https://github.com/exograd/rb-eventline
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Eventline Ruby SDK.
+test_files: []