mural-ruby 0.1.0

data/lib/mural/widget/table_cell.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    # UNDOCUMENTED
+    # This widget is not documented within Mural public API documentation.
+    class TableCell
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        title: 'title',
+        col_span: 'colSpan',
+        column_id: 'columnId',
+        row_id: 'rolId',
+        row_span: 'rowSpan',
+        style: 'style',
+        text_content: 'textContent'
+      )
+
+      def self.decode(json)
+        super.tap do |cell|
+          cell.style = Style.decode(cell.style)
+          cell.text_content = TextContent.decode(cell.text_content)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(background_color: 'backgroundColor')
+      end
+
+      class TextContent
+        include Mural::Codec
+
+        define_attributes(
+          font_family: 'fontFamily',
+          font_size: 'fontSize',
+          orientation: 'orientation',
+          padding: 'padding',
+          text: 'text',
+          text_align: 'textAlign',
+          vertical_align: 'verticalAlign'
+        )
+      end
+    end
+  end
+end

data/lib/mural/widget/text.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Text
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # Style properties of the widget.
+        style: 'style',
+
+        # The text in the widget.
+        text: 'text',
+
+        # The URL used in the widget.
+        hyperlink: 'hyperlink',
+
+        # Text displayed on the hyperlink button.
+        hyperlinkTitle: 'hyperlinkTitle',
+
+        # When true, the text wraps to fit the widget. When false, the widget
+        # grows to fit the text. True when widget is created as a textbox and
+        # false when widget is created as a title.
+        fixed_width: 'fixedWidth',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |text|
+          text.style = Style.decode(text.style)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          # The background color of the widget in hex with alpha format.
+          background_color: 'backgroundColor',
+
+          # Font-family of the text.
+          font: 'font',
+
+          # Text size.
+          font_size: 'fontSize',
+
+          # The alignment of the text.
+          # ["left", "center", "right"]
+          text_align: 'textAlign'
+        )
+      end
+    end
+  end
+end

data/lib/mural/widget/update_file_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateFileParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updatefile
+      define_attributes(
+        # The height of the widget in px. This value will be overwritten if the
+        # file has a preview from which the final value will be extracted.
+        height: 'height',
+
+        # If true, the widget is hidden from non-facilitators. Applies only when
+        # the widget is in the outline.
+        hidden: 'hidden',
+
+        # The instructions for a section of the outline. This text can only be
+        # added and modified by a facilitator.
+        instruction: 'instruction',
+
+        # The ID of the area widget that contains the widget.
+        parent_id: 'parentId',
+
+        # The list order of the widget in the outline.
+        presentation_index: 'presentationIndex',
+
+        # The angle of widget rotation in degrees.
+        rotation: 'rotation',
+
+        # The title in the file widget and in the outline.
+        title: 'title',
+
+        # The width of the widget in px. This value will be overwritten if the
+        # file has a preview from which the final value will be extracted.
+        width: 'width',
+
+        # The horizontal position of the widget in px. This is the distance from
+        # the left of the parent widget, such as an area. If the widget has no
+        # parent widget, this is the distance from the left of the mural.
+        x: 'x',
+
+        # The vertical position of the widget in px. This is the distance from
+        # the top of the parent widget, such as an area. If the widget has no
+        # parent widget, this is the distance from the top of the mural.
+        y: 'y'
+      )
+    end
+  end
+end

data/lib/mural/widget.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    include Mural::Codec
+
+    SPECIALIZED = {
+      'area' => 'Mural::Widget::Area',
+      'arrow' => 'Mural::Widget::Arrow',
+      'comment' => 'Mural::Widget::Comment',
+      'file' => 'Mural::Widget::File',
+      'icon' => 'Mural::Widget::Icon',
+      'image' => 'Mural::Widget::Image',
+      'shape' => 'Mural::Widget::Shape',
+      'sticky note' => 'Mural::Widget::StickyNote',
+      'table cell' => 'Mural::Widget::TableCell',
+      'table' => 'Mural::Widget::Table',
+      'text' => 'Mural::Widget::Text'
+    }.freeze
+
+    define_attributes(
+      # The unique ID of the widget.
+      id: 'id',
+
+      # The height of the widget in px.
+      height: 'height',
+
+      # The width of the widget in px.
+      width: 'width',
+
+      # The horizontal position of the widget in px. This is the distance from
+      # the left of the parent widget, such as an area. If the widget has no
+      # parent widget, this is the distance from the left of the mural.
+      x: 'x',
+
+      # The vertical position of the widget in px. This is the distance from
+      # the top of the parent widget, such as an area. If the widget has no
+      # parent widget, this is the distance from the top of the mural.
+      y: 'y',
+
+      # Indicates whether the widget is invisible, defaults to `false`.
+      invisible: 'invisible',
+
+      # Timestamp in milliseconds.
+      content_edited_on: 'contentEditedOn',
+
+      # The collaborator who last edited content on the widget.
+      content_edited_by: 'contentEditedBy',
+
+      # Timestamp in milliseconds.
+      created_on: 'createdOn',
+
+      # The collaborator who created the widget.
+      created_by: 'createdBy',
+
+      # Timestamp in milliseconds.
+      updated_on: 'updatedOn',
+
+      # The collaborator who last updated the widget.
+      updated_by: 'updatedBy',
+
+      # The angle of widget rotation, in degrees.
+      rotation: 'rotation',
+
+      # The z-index stacking order of the widget.
+      stacking_order: 'stackingOrder',
+
+      # If true, the widget is hidden from non-facilitators. Applies only when
+      # the widget is in the outline.
+      hidden: 'hidden',
+
+      # If true, the name of the collaborator who updated the widget is not
+      # recorded (because Private Mode is enabled).
+      hide_editor: 'hideEditor',
+
+      # If true, the name of the collaborator who created the widget is not
+      # recorded (because Private Mode is enabled).
+      hide_owner: 'hideOwner',
+
+      # The instructions for a section of the outline. This text can only be
+      # added and modified by a facilitator.
+      instruction: 'instruction',
+
+      # If true, the widget is locked and cannot be updated by a
+      # non-facilitator. Any collaborator can unlock a locked widget.
+      locked: 'locked',
+
+      # If true, the widget is locked by a facilitator. Only a facilitator can
+      # unlock it.
+      locked_by_facilitator: 'lockedByFacilitator',
+
+      # The ID of the area widget that contains the widget.
+      parent_id: 'parentId',
+
+      # The list order of the widget in the outline.
+      presentation_index: 'presentationIndex',
+
+      # The type of the widget (`file`).
+      type: 'type'
+    )
+
+    def self.decode(json)
+      specialized = SPECIALIZED[json['type']]
+      widget = specialized ? Object.const_get(specialized).decode(json) : super
+
+      widget.tap do |f|
+        f.content_edited_by = ContentEditedBy.decode(f.content_edited_by)
+        f.created_by = CreatedBy.decode(f.created_by)
+        f.updated_by = UpdatedBy.decode(f.updated_by)
+      end
+    end
+
+    class ContentEditedBy
+      include Mural::Codec
+
+      define_attributes(
+        id: 'id',
+
+        # when edited by a member
+        first_name: 'firstName',
+        last_name: 'lastName',
+
+        # when edited by a visitor
+        alias: 'alias'
+      )
+    end
+
+    class CreatedBy
+      include Mural::Codec
+
+      define_attributes(
+        id: 'id',
+
+        # when edited by a member
+        first_name: 'firstName',
+        last_name: 'lastName',
+
+        # when edited by a visitor
+        alias: 'alias'
+      )
+    end
+
+    class UpdatedBy
+      include Mural::Codec
+
+      define_attributes(
+        id: 'id',
+
+        # when edited by a member
+        first_name: 'firstName',
+        last_name: 'lastName',
+
+        # when edited by a visitor
+        alias: 'alias'
+      )
+    end
+  end
+end

data/lib/mural/workspace.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Mural
+  class Workspace
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getworkspaces
+    # https://developers.mural.co/public/reference/getworkspace
+    define_attributes(
+      id: 'id',
+      name: 'name',
+      description: 'description',
+      sharing_settings: 'sharingSettings',
+      locked: 'locked',
+      suspended: 'suspended',
+      company_id: 'companyId',
+      created_on: 'createdOn',
+      trial_ends: 'trialEnds',
+      trial_extended: 'trialExtended',
+      # 👇 Only available when retrieving a single workspace
+      created_by: 'createdBy'
+    )
+
+    def self.decode(json)
+      super.tap do |w|
+        w.created_by = CreatedBy.decode(w.created_by)
+        w.sharing_settings = SharingSettings.decode(w.sharing_settings)
+      end
+    end
+
+    class SharingSettings
+      include Mural::Codec
+
+      define_attributes(link: 'link')
+    end
+
+    class CreatedBy
+      include Mural::Codec
+
+      define_attributes(
+        id: 'id',
+        first_name: 'firstName',
+        last_name: 'lastName'
+      )
+    end
+  end
+end

data/lib/mural/workspace_invitation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class WorkspaceInvitation
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/inviteuserstoworkspace
+    define_attributes(
+      email: 'email',
+      ref_code: 'refCode',
+      rejected: 'rejected',
+      reason: 'reason',
+      username: 'username'
+    )
+  end
+end

data/lib/mural.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'json'
+require 'net/http'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Mural
+  class Error < StandardError
+    attr_reader :code, :details
+
+    def initialize(message, code:, details: nil)
+      @code = code
+      @details = details
+
+      super(message)
+    end
+
+    def inspect
+      "#<Mural::Error message=#{message.inspect} code=#{code.inspect} " \
+        "details=#{details.inspect}>"
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: mural-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mickaël Pham
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description:
+email:
+- inbox@mickael.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".ruby-version"
+- README.md
+- Rakefile
+- UNLICENSE
+- img/draw-widget.png
+- img/inking-widget.png
+- img/mind-map.png
+- img/smart-planner.png
+- lib/mural.rb
+- lib/mural/asset.rb
+- lib/mural/client.rb
+- lib/mural/client/authentication.rb
+- lib/mural/client/mural_content.rb
+- lib/mural/client/mural_content/files.rb
+- lib/mural/client/mural_content/sticky_notes.rb
+- lib/mural/client/mural_content/tags.rb
+- lib/mural/client/mural_content/widgets.rb
+- lib/mural/client/murals.rb
+- lib/mural/client/rooms.rb
+- lib/mural/client/search.rb
+- lib/mural/client/templates.rb
+- lib/mural/client/users.rb
+- lib/mural/client/users/mural_users.rb
+- lib/mural/client/users/room_users.rb
+- lib/mural/client/workspaces.rb
+- lib/mural/codec.rb
+- lib/mural/create_mural_params.rb
+- lib/mural/create_room_params.rb
+- lib/mural/create_sticky_note_params.rb
+- lib/mural/create_tag_params.rb
+- lib/mural/current_user.rb
+- lib/mural/duplicate_mural_params.rb
+- lib/mural/mural_board.rb
+- lib/mural/mural_export.rb
+- lib/mural/mural_invitation.rb
+- lib/mural/mural_invitation_params.rb
+- lib/mural/mural_user.rb
+- lib/mural/removed_mural_user.rb
+- lib/mural/removed_room_user.rb
+- lib/mural/room.rb
+- lib/mural/room_folder.rb
+- lib/mural/room_invitation.rb
+- lib/mural/room_invitation_params.rb
+- lib/mural/room_user.rb
+- lib/mural/search_mural_result.rb
+- lib/mural/search_room_result.rb
+- lib/mural/search_template_result.rb
+- lib/mural/tag.rb
+- lib/mural/template.rb
+- lib/mural/update_mural_params.rb
+- lib/mural/update_room_params.rb
+- lib/mural/update_room_user_params.rb
+- lib/mural/update_sticky_note_params.rb
+- lib/mural/update_tag_params.rb
+- lib/mural/version.rb
+- lib/mural/widget.rb
+- lib/mural/widget/area.rb
+- lib/mural/widget/arrow.rb
+- lib/mural/widget/comment.rb
+- lib/mural/widget/create_file_params.rb
+- lib/mural/widget/file.rb
+- lib/mural/widget/icon.rb
+- lib/mural/widget/image.rb
+- lib/mural/widget/shape.rb
+- lib/mural/widget/sticky_note.rb
+- lib/mural/widget/table.rb
+- lib/mural/widget/table_cell.rb
+- lib/mural/widget/text.rb
+- lib/mural/widget/update_file_params.rb
+- lib/mural/workspace.rb
+- lib/mural/workspace_invitation.rb
+homepage: https://github.com/mickaelpham/mural-ruby
+licenses:
+- Unlicense
+metadata:
+  homepage_uri: https://github.com/mickaelpham/mural-ruby
+  source_code_uri: https://github.com/mickaelpham/mural-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby library for the Mural public API
+test_files: []