embed_workflow 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50470d806c76f8fec49b69641c744584af88283540280c638f66852466765672
+  data.tar.gz: 9851ef47251788644528ab4c61f8f499b8e0e2a107ac2a80a87f0a6ca7e517c9
+SHA512:
+  metadata.gz: fb89462e3bf6ccd86625e79350aed45111e2bed6715b21acc8d26380ce4277a5e18be3c6320db043bb5b0cce20225183f318ecd21598fada159cb33a4b11b366
+  data.tar.gz: 32533f7fb689caf90ad62a4c8ccaae900a47d25c20407923f144d83595b17766e7ead4b24559e9447732a8504ea970d14cd368e5b375a2fac5a154c762d26490

data/lib/embed_workflow/actions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module EmbedWorkflow
+  module Actions
+    class << self
+      include Base
+      include Client
+
+      RESOURCE_BASE_PATH = "#{BASE_API_PATH}/actions".freeze
+
+      def activities(hashid:)
+        get_request(path: "#{RESOURCE_BASE_PATH}/activities")
+      end
+    end
+  end
+end

data/lib/embed_workflow/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EmbedWorkflow
+  module Base
+    attr_accessor :skey
+
+    class << self
+      attr_accessor :skey
+    end
+  end
+end

data/lib/embed_workflow/client.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module EmbedWorkflow
+  module Client
+    include Kernel
+    BASE_API_PATH = "/api/v1".freeze
+    BASE_API_URL  = "https://embedworkflow.com/".freeze
+
+    def client
+      return @client if defined?(@client)
+      @client         = create_connection(URI.parse(BASE_API_URL))
+      @client.use_ssl = true
+
+      @client
+    end
+
+    def get_request(path:, auth: true, params: {})
+      request = build_get_request(path: path, auth: auth, params: params)
+      execute_request(request)
+    end
+
+    def post_request(path:, auth: true, body: nil)
+      request = build_post_request(path: path, auth: auth, body: body)
+      execute_request(request)
+    end
+
+    def delete_request(path:, auth: true, params: {})
+      request = build_delete_request(path: path, auth: auth, params: params)
+      execute_request(request)
+    end
+
+    def put_request(path:, auth: true, body: nil)
+      request = build_put_request(path: path, auth: auth, body: body)
+      execute_request(request)
+    end
+
+    private
+
+      def execute_request(request)
+        response = client.request(request)
+        check_errors!(response)
+
+        JSON.parse(response.body) if response.body && (response.body != "")
+      end
+
+      def check_errors!(response)
+        case response.code.to_i
+        when 400
+          raise InvalidRequestError.new(
+            http_status: 400,
+            request_id: response["x-request-id"]
+          )
+        when 401
+          raise AuthenticationError.new(
+            http_status: 401,
+            request_id: response["x-request-id"]
+          )
+        when 404
+          raise APIError.new(
+            http_status: 404,
+            request_id: response["x-request-id"]
+          )
+        when 422
+          raise InvalidRequestError.new(
+            http_status: 422,
+            request_id: response["x-request-id"]
+          )
+        end
+      end
+
+      def create_connection(uri)
+        Net::HTTP.new(uri.host, uri.port)
+      end
+
+      def build_get_request(path:, auth: false, params: {})
+        uri       = URI(path)
+        uri.query = URI.encode_www_form(params) if params
+
+        request = Net::HTTP::Get.new(
+          uri.to_s,
+          "Content-Type" => "application/json"
+        )
+
+        add_request_auth_headers(request) if auth
+        add_request_headers(request)
+        request
+      end
+
+      def build_post_request(path:, auth: false, body: nil)
+        request      = Net::HTTP::Post.new(path, "Content-Type" => "application/json")
+        request.body = body.to_json if body
+
+        add_request_auth_headers(request) if auth
+        add_request_headers(request)
+        request
+      end
+
+      def build_delete_request(path:, auth: false, params: {})
+        uri       = URI(path)
+        uri.query = URI.encode_www_form(params) if params
+
+        request = Net::HTTP::Delete.new(
+          uri.to_s,
+          "Content-Type" => "application/json"
+        )
+
+        add_request_auth_headers(request) if auth
+        add_request_headers(request)
+        request
+      end
+
+      def build_put_request(path:, auth: false, body: nil)
+        request      = Net::HTTP::Put.new(path, "Content-Type" => "application/json")
+        request.body = body.to_json if body
+        add_request_auth_headers(request) if auth
+        add_request_headers(request)
+        request
+      end
+
+      def add_request_auth_headers(request)
+        request["Authorization"] = "Bearer #{EmbedWorkflow.skey!}"
+        request
+      end
+
+      def add_request_headers(request)
+        request["User-Agent"] = "Embed Workflow Ruby - v#{EmbedWorkflow::VERSION}"
+        request
+      end
+  end
+end

data/lib/embed_workflow/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EmbedWorkflow
+  class BaseError < StandardError
+    attr_reader :http_status, :request_id
+
+    def initialize(http_status: nil, request_id: nil)
+      super
+      @http_status       = http_status
+      @request_id        = request_id
+    end
+  end
+
+  class APIError < BaseError; end
+  class AuthenticationError < BaseError; end
+  class InvalidRequestError < BaseError; end
+end

data/lib/embed_workflow/executions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module EmbedWorkflow
+  module Executions
+    class << self
+      include Base
+      include Client
+
+      RESOURCE_BASE_PATH = "#{BASE_API_PATH}/executions".freeze
+
+      def stop(stop_event:, user_key: nil, filters: nil)
+        attrs = {
+          stop_event: stop_event,
+          user_key: user_key,
+          filters: filters
+        }
+
+        post_request(
+          path: "#{RESOURCE_BASE_PATH}/stop",
+          body: attrs
+        )
+      end
+    end
+  end
+end

data/lib/embed_workflow/trigger.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module EmbedWorkflow
+  module Trigger
+    class << self
+      include Base
+      include Client
+
+      RESOURCE_BASE_PATH = "#{BASE_API_PATH}/trigger".freeze
+
+      def create(event:, all_workflows: false, workflow_hashids: nil, workflow_keys: nil, user_key: nil, execution_data: nil)
+        attrs = {
+          event: event,
+          all_workflows: all_workflows,
+          workflow_hashids: workflow_hashids,
+          workflow_keys: workflow_keys,
+          user_key: user_key,
+          execution_data: execution_data
+        }.compact
+
+        post_request(
+          path: RESOURCE_BASE_PATH,
+          body: attrs
+        )
+      end
+    end
+  end
+end

data/lib/embed_workflow/users.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module EmbedWorkflow
+  module Users
+    class << self
+      include Base
+      include Client
+
+      RESOURCE_BASE_PATH = "#{BASE_API_PATH}/users".freeze
+
+      def upsert(key:, name: nil, email: nil, config: nil)
+        attrs = {
+          key: key,
+          name: name,
+          email: email,
+          config: config
+        }.compact
+
+        put_request(
+          path: "#{RESOURCE_BASE_PATH}/#{key}",
+          body: attrs
+        )
+      end
+
+      def fetch(key:)
+        get_request(path: "#{RESOURCE_BASE_PATH}/#{key}")
+      end
+    end
+  end
+end

data/lib/embed_workflow/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EmbedWorkflow
+  VERSION = "0.0.1"
+end

data/lib/embed_workflow/workflows.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module EmbedWorkflow
+  module Workflows
+    class << self
+      include Base
+      include Client
+
+      RESOURCE_BASE_PATH = "#{BASE_API_PATH}/workflows"
+
+      def create(name:, template: nil, context: nil, auto_start: nil, tenant_key: nil)
+        attrs = {
+          name: name,
+          template: template,
+          auto_start: auto_start,
+          tenant_key: tenant_key,
+          context: context
+        }
+
+        post_request(
+          path: RESOURCE_BASE_PATH,
+          body: attrs
+        )
+      end
+
+      def fetch(hashid: nil, key: nil)
+        get_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid}"
+        )
+      end
+
+      def update(hashid:, name: nil, template: nil, tenant_key: nil, context: nil, auto_start: nil)
+        attrs = {
+          name: name,
+          template: template,
+          tenant_key: tenant_key,
+          context: context
+        }.compact
+
+        put_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid}",
+          body: attrs
+        )
+      end
+
+      def list(user_key: nil, starting_after: nil, ending_before: nil)
+        get_request(
+          path: RESOURCE_BASE_PATH,
+          params: { user_key: user_key, starting_after: starting_after, ending_before: ending_before }.compact
+        )
+      end
+
+      def execute(hashid: nil, key: nil, user_key: nil, execution_data: {})
+        raise ArgumentError, "Hashid or Key is required" if hashid.nil? && key.nil?
+
+        attrs = {
+          user_key: user_key,
+          id_type: hashid.nil? ? "key" : "hashid",
+          execution_data: execution_data,
+        }.compact
+
+        post_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid || key}/execute",
+          body: attrs
+        )
+      end
+
+      def clone(hashid:, user_key: nil)
+        attrs = { user_key: user_key }.compact
+
+        post_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid}/clone",
+          body: attrs
+        )
+      end
+
+      def activities(hashid:)
+        get_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid}/activities"
+        )
+      end
+
+      def delete(hashid: nil, key: nil, user_key: nil)
+        raise ArgumentError, "Hashid or Key is required" if hashid.nil? && key.nil?
+
+        attrs = {
+          user_key: user_key,
+          id_type: hashid.nil? ? "key" : "hashid"
+        }.compact
+
+        delete_request(
+          path: "#{RESOURCE_BASE_PATH}/#{hashid || key}",
+          params: attrs
+        )
+      end
+    end
+  end
+end

data/lib/embed_workflow.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "embed_workflow/version"
+require "json"
+
+module EmbedWorkflow
+  def self.skey=(value)
+    Base.skey = value
+  end
+
+  def self.skey
+    Base.skey
+  end
+
+  def self.skey!
+    skey || raise("EmbedWorkflow.skey not set")
+  end
+
+  autoload :Base, "embed_workflow/base"
+  autoload :Client, "embed_workflow/client"
+
+  autoload :Actions, "embed_workflow/actions"
+  autoload :Executions, "embed_workflow/executions"
+  autoload :Trigger, "embed_workflow/trigger"
+  autoload :Users, "embed_workflow/users"
+  autoload :Workflows, "embed_workflow/workflows"
+
+  autoload :APIError, "embed_workflow/errors"
+  autoload :AuthenticationError, "embed_workflow/errors"
+  autoload :InvalidRequestError, "embed_workflow/errors"
+
+  def self.trigger(**args)
+    Trigger.create(**args)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: embed_workflow
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Embed Workflow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client for Embed Workflow
+email:
+- devsupport@embedworkflow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/embed_workflow.rb
+- lib/embed_workflow/actions.rb
+- lib/embed_workflow/base.rb
+- lib/embed_workflow/client.rb
+- lib/embed_workflow/errors.rb
+- lib/embed_workflow/executions.rb
+- lib/embed_workflow/trigger.rb
+- lib/embed_workflow/users.rb
+- lib/embed_workflow/version.rb
+- lib/embed_workflow/workflows.rb
+homepage: https://github.com/embedworkflow/embed-workflow-ruby
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://api-docs.embedworkflow.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: API client for Embed Workflow
+test_files: []