mural-ruby 0.1.0

data/lib/mural/widget/area.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Area
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # Style properties of the widget.
+        style: 'style',
+
+        # The area layout type.
+        layout: 'layout',
+
+        # If true, the title is displayed.
+        show_title: 'showTitle',
+
+        # The title in the area widget and in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |area|
+          area.style = Style.decode(area.style)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          # The background color of the widget in hex with alpha format.
+          background_color: 'backgroundColor',
+
+          # The border color of the widget in hex with alpha format.
+          border_color: 'borderColor',
+
+          # The border style of the widget.
+          # ["solid", "dashed", "dotted-spaced", "dotted"]
+          border_style: 'borderStyle',
+
+          # The border width of the widget.
+          border_width: 'borderWidth',
+
+          # The font size of the title of the widget.
+          title_font_size: 'titleFontSize'
+        )
+      end
+    end
+  end
+end

data/lib/mural/widget/arrow.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Arrow
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The type of the arrow line.
+        # ["straight", "curved", "orthogonal"]
+        arrow_type: 'arrowType',
+
+        # The type of the arrow tip.
+        # ["no tip", "single", "double"]
+        tip: 'tip',
+
+        # If true, the widget is stackable.
+        stackable: 'stackable',
+
+        # Array of objects
+        points: 'points',
+
+        # Style properties of the widget.
+        style: 'style',
+
+        # The ID of the widget that the start point is connected to.
+        start_ref_id: 'startRefId',
+
+        # The ID of the widget that the end point is connected to.
+        end_ref_id: 'endRefId',
+
+        # label
+        label: 'label',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |arrow|
+          arrow.points = arrow.points&.map { |point| Point.decode(point) }
+          arrow.style = Style.decode(arrow.style)
+
+          # Making sure I'm calling the "right" Label class
+          arrow.label = Mural::Widget::Arrow::Label.decode(arrow.label)
+        end
+      end
+
+      class Point
+        include Mural::Codec
+
+        define_attributes(x: 'x', y: 'y')
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          # The stroke color of the connector in hex with alpha format.
+          stroke_color: 'strokeColor',
+
+          # The stroke style of the connector.
+          # ["solid", "dashed", "dotted-spaced", "dotted"]
+          stroke_style: 'strokeStyle',
+
+          # The stroke width of the connector.
+          stroke_width: 'strokeWidth'
+        )
+      end
+
+      class Label
+        include Mural::Codec
+
+        define_attributes(format: 'format', labels: 'labels')
+
+        def self.decode(json)
+          super.tap do |label|
+            next if label.nil?
+
+            label.labels = label.labels.map do |l|
+              # I'm not responsible for this naming…
+              Mural::Widget::Arrow::Label::Label.decode(l)
+            end
+
+            label.format = Format.decode(label.format)
+          end
+        end
+
+        class Format
+          include Mural::Codec
+
+          define_attributes(
+            # color
+            color: 'color',
+
+            # Font-family of the text.
+            font_family: 'fontFamily',
+
+            # If true, the text of the label on the connector is bold.
+            bold: 'bold',
+
+            # If true, the text of the label on the connector is italic.
+            italic: 'italic',
+
+            # The alignment of the text of the label on the connector.
+            # ["left", "center", "right"]
+            text_align: 'textAlign',
+
+            # The font size of the text of the label on the connector.
+            font_size: 'fontSize'
+          )
+        end
+
+        class Label
+          include Mural::Codec
+
+          define_attributes(
+            # The horizontal position of the label on the connector in px.
+            x: 'x',
+
+            # The vertical position of the label on the connector in px.
+            y: 'y',
+
+            # The height of the label on the connector in px.
+            height: 'height',
+
+            # The width of the label on the connector in px.
+            width: 'width',
+
+            # The text of the label on the connector.
+            text: 'text'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mural/widget/comment.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Comment
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The message text of the comment widget.
+        message: 'message',
+
+        # Array of replies
+        replies: 'replies',
+
+        # The timestamp for the creation of the comment in milliseconds.
+        timestamp: 'timestamp',
+
+        # The reference ID of the widget that the comment points to.
+        reference_widget_id: 'referenceWidgetId',
+
+        # The collaborator who resolved the comment.
+        resolved_by: 'resolvedBy',
+
+        # The timestamp when the comment was resolved, in milliseconds.
+        resolved_on: 'resolvedOn',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |comment|
+          comment.replies = comment.replies&.map { |r| Reply.decode(r) }
+          comment.resolved_by = ResolvedBy.decode(comment.resolved_by)
+        end
+      end
+
+      class ResolvedBy
+        include Mural::Codec
+
+        define_attributes(
+          # ID of a user.
+          id: 'id',
+
+          # When the user is a member
+          first_name: 'firstName',
+          last_name: 'lastName',
+
+          # When the user is a visitor
+          alias: 'alias'
+        )
+      end
+
+      class Reply
+        include Mural::Codec
+
+        define_attributes(
+          # The timestamp of the reply in milliseconds.
+          created: 'created',
+
+          # The text of the reply.
+          message: 'message',
+          user: 'user'
+        )
+
+        def self.decode(json)
+          super.tap do |reply|
+            reply.user = User.decode(reply.user)
+          end
+        end
+
+        class User
+          include Mural::Codec
+
+          define_attributes(
+            # ID of a user.
+            id: 'id',
+
+            # When the user is a member
+            first_name: 'firstName',
+            last_name: 'lastName',
+
+            # When the user is a visitor
+            alias: 'alias'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mural/widget/create_file_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateFileParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createfile
+      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 name of the file.
+        name: 'name',
+
+        # 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 z-index stacking order of the widget.
+        stacking_order: 'stackingOrder',
+
+        # 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/file.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class File
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createfile
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The number of minutes after which the file URL expires.
+        # May be null when download restriction is enabled.
+        expires_in_minutes: 'expiresInMinutes',
+
+        # The link to the file widget on a mural.
+        link: 'link',
+
+        # The download URL of the file. This URL has expiration time.
+        # May be null when download restriction is enabled.
+        url: 'url',
+
+        # Indicates that file was scanned by antivirus.
+        scanning: 'scanning',
+
+        # The URL of the file preview.
+        preview_url: 'previewUrl',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+    end
+  end
+end

data/lib/mural/widget/icon.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Icon
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The name of the icon.
+        name: 'name',
+
+        # Style properties of the widget.
+        style: 'style',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |icon|
+          icon.style = Style.decode(icon.style)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(color: 'color')
+      end
+    end
+  end
+end

data/lib/mural/widget/image.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Image
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The aspect ratio of the image.
+        aspect_ratio: 'aspectRatio',
+
+        # If true, a border is displayed around the image.
+        border: 'border',
+
+        # The caption of the image.
+        caption: 'caption',
+
+        # The description of the image.
+        description: 'description',
+
+        # The number of minutes after which the image URL may expire.
+        # May be null when download restriction is enabled.
+        expires_in_minutes: 'expiresInMinutes',
+
+        # The URL of the image link.
+        link: 'link',
+
+        # Mask object
+        mask: 'mask',
+
+        # The uncropped height of the image.
+        natural_height: 'naturalHeight',
+
+        # The uncropped width of the image.
+        natural_width: 'naturalWidth',
+
+        # If true, the caption and description are visible.
+        show_caption: 'showCaption',
+
+        # The URL of the image thumbnail.
+        thumbnailUrl: 'thumbnail_url',
+
+        # The download URL of the image. This URL has expiration time.
+        # May be null when download restriction is enabled.
+        url: 'url'
+      )
+
+      def self.decode(json)
+        super.tap do |image|
+          image.mask = Mask.decode(image.mask)
+        end
+      end
+
+      class Mask
+        include Mural::Codec
+
+        define_attributes(
+          # The vertical offset of the cropping mask from the upper-left corner
+          # of the image.
+          top: 'top',
+
+          # The horizontal offset of the cropping mask from the upper-left
+          # corner of the image.
+          left: 'left',
+
+          # The height of the cropping mask.
+          height: 'height',
+
+          # The width of the cropping mask.
+          widgth: 'width'
+        )
+      end
+    end
+  end
+end

data/lib/mural/widget/shape.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class Shape
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The text in the widget. It supports inline formatting using HTML tags.
+        html_text: 'htmlText',
+
+        # The type of shape of the shape widget.
+        shape: 'shape',
+
+        # Style properties of the widget.
+        style: 'style',
+
+        # The text in the widget.
+        text: 'text',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |shape|
+          shape.style = Style.decode(shape.style)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          # The background color of the widget in hex with alpha format.
+          background_color: 'backgroundColor',
+
+          # The border color of the widget in hex with alpha format.
+          border_color: 'borderColor',
+
+          # The border style of the widget.
+          # ["solid", "dotted"]
+          border_style: 'borderStyle',
+
+          # The border width of the widget.
+          # 1 to 7
+          border_width: 'borderWidth',
+
+          # If true, text is bold.
+          bold: 'bold',
+
+          # If true, text is italic.
+          italic: 'italic',
+
+          # If true, text is underlined.
+          underline: 'underline',
+
+          # If true, text is striked.
+          strike: 'strike',
+
+          # Font-family of the text.
+          font: 'font',
+
+          # The font color of the widget in hex with alpha format.
+          font_color: 'fontColor',
+
+          # Text size.
+          font_size: 'fontSize',
+
+          # The alignment of the text.
+          # ["left", "center", "right"]
+          text_align: 'textAlign'
+        )
+      end
+    end
+  end
+end

data/lib/mural/widget/sticky_note.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class StickyNote
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        # The text in the widget. It supports inline formatting using HTML tags.
+        html_text: 'htmlText',
+
+        # The shape of the sticky note widget.
+        # ["circle", "rectangle"]
+        shape: 'shape',
+
+        # 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.
+        hyperlink_title: 'hyperlinkTitle',
+
+        # The minimum number of lines in the sticky note widget.
+        min_lines: 'minLines',
+
+        # Unique identifiers of the tags in the widget.
+        tags: 'tags',
+
+        # The title of the widget in the outline.
+        title: 'title'
+      )
+
+      def self.decode(json)
+        super.tap do |sticky_note|
+          sticky_note.style = Style.decode(sticky_note.style)
+        end
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          # The background color of the widget in hex with alpha format.
+          background_color: 'backgroundColor',
+
+          # If true, text is bold.
+          bold: 'bold',
+
+          # If true, a black border is displayed around the widget.
+          border: 'border',
+
+          # If true, text is italic.
+          italic: 'italic',
+
+          # If true, text is underlined.
+          underline: 'underline',
+
+          # If true, text is striked.
+          strike: 'strike',
+
+          # 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/table.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    # UNDOCUMENTED
+    # This widget is not documented within Mural public API documentation.
+    class Table
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget.attrs,
+
+        title: 'title',
+        auto_resize: 'autoResize',
+        columns: 'columns',
+        rows: 'rows',
+        style: 'style'
+      )
+
+      def self.decode(json)
+        super.tap do |table|
+          table.columns = table.columns&.map { |col| Column.decode(col) }
+          table.rows = table.rows&.map { |row| Row.decode(row) }
+          table.style = Style.decode(table.style)
+        end
+      end
+
+      class Column
+        include Mural::Codec
+
+        define_attributes(column_id: 'columnId', width: 'width')
+      end
+
+      class Row
+        include Mural::Codec
+
+        define_attributes(
+          height: 'height',
+          min_height: 'minHeight',
+          row_id: 'row_id'
+        )
+      end
+
+      class Style
+        include Mural::Codec
+
+        define_attributes(
+          border_color: 'borderColor',
+          border_width: 'borderWidth'
+        )
+      end
+    end
+  end
+end