mural-ruby 0.4.0 → 0.5.1

data/lib/mural/widget/create_shape_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateShapeParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createshapewidget
+      define_attributes(
+        **Mural::Widget::Shape.attrs.filter do |attr|
+          %i[
+            height
+            hidden
+            html_text
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            shape
+            stacking_order
+            style
+            text
+            title
+            width
+            x
+            y
+          ].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Shape::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/create_sticky_note_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateStickyNoteParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createstickynote
+      define_attributes(
+        **Mural::Widget::StickyNote.attrs.filter do |attr|
+          %i[
+            height
+            hidden
+            html_text
+            hyperlink
+            hyperlink_title
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            shape
+            stacking_order
+            style
+            tags
+            text
+            title
+            width
+            x
+            y
+          ].include?(attr)
+        end
+      )
+
+      Style = Mural::Widget::StickyNote::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/create_table_cell_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateTableCellParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createtable
+      define_attributes(
+        **Mural::Widget::TableCell.attrs.filter do |attr|
+          %i[
+            col_span
+            column_id
+            height
+            rotation
+            row_id
+            row_span
+            style
+            text_content
+            width
+            x
+            y
+          ].include? attr
+        end
+      )
+
+      Style = Mural::Widget::TableCell::Style
+      TextContent = Mural::Widget::TableCell::TextContent
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+          json['textContent'] = json['textContent']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/create_table_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateTableParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createtable
+      define_attributes(
+        **Mural::Widget::Table.attrs.filter do |attr|
+          %i[
+            auto_resize
+            columns
+            height
+            hidden
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            rows
+            stacking_order
+            style
+            title
+            width
+            x
+            y
+          ].include? attr
+        end,
+
+        # The array of table cells.
+        cells: 'cells'
+      )
+
+      Row = Mural::Widget::Table::Row
+      Column = Mural::Widget::Table::Column
+      Style = Mural::Widget::Table::Style
+
+      def encode # rubocop:disable Metrics/CyclomaticComplexity
+        super.tap do |json|
+          json['cells']&.map!(&:encode)
+          json['rows']&.map!(&:encode)
+          json['columns']&.map!(&:encode)
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/create_text_box_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateTextBoxParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createtextbox
+      define_attributes(
+        **Mural::Widget::Text.attrs.filter do |attr|
+          %i[
+            height
+            hidden
+            hyperlink
+            hyperlink_title
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            stacking_order
+            style
+            text
+            title
+            width
+            x
+            y
+          ].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Text::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/create_title_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateTitleParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createtitle
+      define_attributes(
+        **Mural::Widget::Text.attrs.filter do |attr|
+          %i[
+            height
+            hidden
+            hyperlink
+            hyperlink_title
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            stacking_order
+            style
+            text
+            title
+            width
+            x
+            y
+          ].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Text::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/image.rb

@@ -40,7 +40,7 @@ module Mural
         show_caption: 'showCaption',
 
         # The URL of the image thumbnail.
-        thumbnailUrl: 'thumbnail_url',
+        thumbnail_url: 'thumbnailUrl',
 
         # The download URL of the image. This URL has expiration time.
         # May be null when download restriction is enabled.

data/lib/mural/widget/table.rb

@@ -2,25 +2,33 @@
 
 module Mural
   class Widget
-    # UNDOCUMENTED
-    # This widget is not documented within Mural public API documentation.
     class Table
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createtable
       define_attributes(
         **Mural::Widget.attrs,
 
-        title: 'title',
+        # If true, the widget will automatically resize to fit its content.
         auto_resize: 'autoResize',
+
+        # The title of the widget in the outline.
+        title: 'title',
+
+        # The array of columns definition.
         columns: 'columns',
+
+        # The array of rows definition.
         rows: 'rows',
+
+        # Style properties of the widget.
         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.columns&.map! { |col| Column.decode(col) }
+          table.rows&.map! { |row| Row.decode(row) }
           table.style = Style.decode(table.style)
         end
       end
@@ -28,16 +36,27 @@ module Mural
       class Column
         include Mural::Codec
 
-        define_attributes(column_id: 'columnId', width: 'width')
+        define_attributes(
+          # The ID of the column.
+          column_id: 'columnId',
+
+          # The width of the column.
+          width: 'width'
+        )
       end
 
       class Row
         include Mural::Codec
 
         define_attributes(
+          # The height of the row.
           height: 'height',
+
+          # The min height of the row.
           min_height: 'minHeight',
-          row_id: 'row_id'
+
+          # The ID of the row.
+          row_id: 'rowId'
         )
       end
 
@@ -45,7 +64,10 @@ module Mural
         include Mural::Codec
 
         define_attributes(
+          # The border color of the widget in hex with alpha format.
           border_color: 'borderColor',
+
+          # The border width
           border_width: 'borderWidth'
         )
       end

data/lib/mural/widget/table_cell.rb

@@ -2,21 +2,33 @@
 
 module Mural
   class Widget
-    # UNDOCUMENTED
-    # This widget is not documented within Mural public API documentation.
     class TableCell
       include Mural::Codec
 
+      # # https://developers.mural.co/public/reference/createtable
       define_attributes(
         **Mural::Widget.attrs,
 
-        title: 'title',
+        # Number of columns a cell can span.
         col_span: 'colSpan',
+
+        # The ID of the column.
         column_id: 'columnId',
-        row_id: 'rolId',
+
+        # The ID of the row.
+        row_id: 'rowId',
+
+        # Number of rows a cell can span.
         row_span: 'rowSpan',
+
+        # Style properties of the widget.
         style: 'style',
-        text_content: 'textContent'
+
+        # textContent properties of the widget.
+        text_content: 'textContent',
+
+        # The title of the widget in the outline.
+        title: 'title'
       )
 
       def self.decode(json)
@@ -29,6 +41,7 @@ module Mural
       class Style
         include Mural::Codec
 
+        # The backgroud color of the cell in hex with alpha format.
         define_attributes(background_color: 'backgroundColor')
       end
 
@@ -36,12 +49,29 @@ module Mural
         include Mural::Codec
 
         define_attributes(
+          # Font-family of the text.
           font_family: 'fontFamily',
+
+          # Text size.
           font_size: 'fontSize',
+
+          # The orientation of the text content.
+          # ["horizontal", "vertical-left", "vertical-right"]
           orientation: 'orientation',
+
+          # Padding of the text content.
           padding: 'padding',
+
+          # The text in the widget. It supports inline formatting using HTML
+          # tags.
           text: 'text',
+
+          # The alignment of the text.
+          # ["left", "center", "right"]
           text_align: 'textAlign',
+
+          # The vertical alignment of the text.
+          # ["top", "middle", "bottom"]
           vertical_align: 'verticalAlign'
         )
       end

data/lib/mural/widget/text.rb

@@ -18,7 +18,7 @@ module Mural
         hyperlink: 'hyperlink',
 
         # Text displayed on the hyperlink button.
-        hyperlinkTitle: 'hyperlinkTitle',
+        hyperlink_title: '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

data/lib/mural/widget/update_area_params.rb

@@ -5,8 +5,11 @@ module Mural
     class UpdateAreaParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/updatearea
       define_attributes(
-        **Mural::Widget::CreateAreaParams.attrs
+        **Mural::Widget::CreateAreaParams.attrs.reject do |attr|
+          %i[stacking_order].include? attr
+        end
       )
 
       Style = Mural::Widget::Area::Style

data/lib/mural/widget/update_arrow_params.rb

@@ -5,12 +5,17 @@ module Mural
     class UpdateArrowParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/updatearrow
       define_attributes(
         **Mural::Widget::CreateArrowParams.attrs.reject do |attr|
           %i[stacking_order].include? attr
         end
       )
 
+      Style = Mural::Widget::Arrow::Style
+      Label = Mural::Widget::Arrow::Label
+      Point = Mural::Widget::Arrow::Point
+
       def encode
         super.tap do |json|
           json['points']&.map!(&:encode)
@@ -18,10 +23,6 @@ module Mural
           json['style'] = json['style']&.encode
         end
       end
-
-      Style = Mural::Widget::Arrow::Style
-      Label = Mural::Widget::Arrow::Label
-      Point = Mural::Widget::Arrow::Point
     end
   end
 end

data/lib/mural/widget/update_comment_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateCommentParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updatecomment
+      define_attributes(
+        **Mural::Widget::CreateCommentParams.attrs.reject do |attr|
+          %i[stacking_order].include? attr
+        end,
+
+        replies: 'replies'
+      )
+    end
+  end
+end

data/lib/mural/widget/update_file_params.rb

@@ -7,43 +7,9 @@ module Mural
 
       # 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'
+        **Mural::Widget::CreateFileParams.attrs.reject do |attr|
+          %i[name stacking_order].include? attr
+        end
       )
     end
   end

data/lib/mural/widget/update_image_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateImageParams
+      include Mural::Codec
+
+      define_attributes(
+        **Mural::Widget::CreateImageParams.attrs.reject do |attr|
+          %i[name stacking_order].include? attr
+        end
+      )
+    end
+  end
+end

data/lib/mural/widget/update_shape_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateShapeParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updateshapewidget
+      define_attributes(
+        **Mural::Widget::CreateShapeParams.attrs.reject do |attr|
+          %i[shape stacking_order].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Shape::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/update_sticky_note_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateStickyNoteParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updatestickynote
+      define_attributes(
+        **Mural::Widget::CreateStickyNoteParams.attrs.reject do |attr|
+          %i[stacking_order shape].include? attr
+        end
+      )
+
+      Style = Mural::Widget::StickyNote::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end
+      end
+    end
+  end
+end

data/lib/mural/widget/update_text_box_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateTextBoxParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updatetextbox
+      define_attributes(
+        **Mural::Widget::CreateTextBoxParams.attrs.reject do |attr|
+          %i[stacking_order].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Text::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end

data/lib/mural/widget/update_title_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class UpdateTitleParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/updatetitle
+      define_attributes(
+        **Mural::Widget::CreateTitleParams.attrs.reject do |attr|
+          %i[stacking_order].include? attr
+        end
+      )
+
+      Style = Mural::Widget::Text::Style
+
+      def encode
+        super.tap do |json|
+          json['style'] = json['style']&.encode
+        end.compact
+      end
+    end
+  end
+end