mural-ruby 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a608bc7d2068d3dc93b5fe418056e3cd0984aa2b52a816fae303ed12fee0b79e
-  data.tar.gz: ab8c92e86470e8097b412ffaf00c1f2623b514880aad9f91eb6aed4db5793608
+  metadata.gz: cffa4ff400827dc5d5dd6393b9d4486db9343d61a36d99741115fc08f94b8631
+  data.tar.gz: 65d63349f8a62417a9331cdd9fc35d7116705d61b4e296b306ddd740f6ae0d19
 SHA512:
-  metadata.gz: 6e07b3ceb356a332fdc05e7617f918ddc6d6252e62d1a6eb5ce80f8dd90520e24b1fd1a7dbbc49a2c63280181efb7d0604eded0721068dfde4a3c12c798fd2e0
-  data.tar.gz: ed42dc8b9b6445d3c239638a822aebff449c0472261171d5f5d1b9c7abfaf6ac9c68dd3eef6dc62e93ca394be7b9c3b69dfedd9bad0e3307903b142cc1238e42
+  metadata.gz: ec31b430792736408b1fbd14a474b223e232ea598e252af91dbc34b4952d53774fdabd5d6baaba6d0f2b21da1193a3323f578d7b7565cb99e36326803ff4fc95
+  data.tar.gz: dc81671b72f2d394d91c09a85699757ef7552b92532ef754d0e53fba88209444755a5042d23fa7ab58ed4204894ebf7344689ca12d0847231f102220e63ef907

data/README.md

@@ -4,12 +4,15 @@
 [![Gem Version](https://img.shields.io/gem/v/mural-ruby?style=for-the-badge)](https://rubygems.org/gems/mural-ruby)
 [![GitHub License](https://img.shields.io/github/license/mickaelpham/mural-ruby?style=for-the-badge)](https://github.com/mickaelpham/mural-ruby/blob/main/UNLICENSE)
 
-
 Ruby library for the [Mural](https://app.mural.co) public API.
 
-**Disclaimer: the views and opinions expressed in this repository are solelythose of the individual contributors and do not represent the official view of Tactivos, Inc. d/b/a Mural.**
-
-**Mural does not endorse this repository in any way.**
+> **Disclaimer**
+>
+> The views and opinions expressed in this repository are solely hose of the
+> individual contributors and do not represent the official view of
+> [Tactivos, Inc. d/b/a Mural](https://www.mural.co/).
+>
+> **Mural does not endorse this repository in any way.**
 
 ## Installation
 
@@ -74,8 +77,8 @@ irb(main):002> mural.users.current_user
 
 ### Upload a file to a mural
 
-To upload a `my.pdf` file that's located in the same directory as where you
-are running the script:
+To upload a `my.pdf` file that's located in the same directory as where you are
+running the script:
 
 ```rb
 MURAL_ID = 'workspace-1.mural-1'
@@ -112,6 +115,37 @@ end
 client.mural_content.create_file(MURAL_ID, params)
 ```
 
+## Mentioning someone in a comment
+
+- You can reply to a comment by passing a `replies` array of `String` message.
+  Each message will be added as a reply to the original comment.
+- You can "\[at\] mention" someone in a comment or in a reply by using the
+  following pattern in the `message` or the `replies`:
+
+```
+@[<USER FULL NAME> @<USER ID>](<USER ID>)
+```
+
+Example replying to a thread:
+
+```rb
+MURAL_ID = 'mural-1'
+COMMENT_ID = 'comment-1'
+
+reply_to_params = Mural::Widget::UpdateCommentParams.new.tap do |c|
+  c.replies = ["Can you have a look @[John Doe @user-1](user-1)]?"]
+end
+
+client.mural_content.update_comment(MURAL_ID, COMMENT_ID, reply_to_params)
+```
+
+![comment thread](./img/comment-thread.png)
+
+Note that the user must already be a **mural member** for the mention to trigger
+an email notification.
+
+![comment email notification](./img/comment-email-notification.png)
+
 ## Known limitations
 
 - `DrawWidget`, AKA sketches, are not returned by the `GET widgets` endpoint.

data/lib/mural/client/mural_content/areas.rb

@@ -11,7 +11,7 @@ module Mural
             create_area_params.encode
           )
 
-          Mural::Widget::Area.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
 
         # https://developers.mural.co/public/reference/updatearea
@@ -21,7 +21,7 @@ module Mural
             update_area_params.encode
           )
 
-          Mural::Widget::Area.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/arrows.rb

@@ -11,7 +11,7 @@ module Mural
             create_arrow_params.encode
           )
 
-          Mural::Widget::Arrow.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
 
         # https://developers.mural.co/public/reference/updatearrow
@@ -21,7 +21,7 @@ module Mural
             update_arrow_params.encode
           )
 
-          Mural::Widget::Arrow.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/comments.rb

@@ -15,7 +15,7 @@ module Mural
             create_comment_params.encode
           )
 
-          Mural::Widget::Comment.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
 
         # Update a comment widget on a mural.
@@ -29,7 +29,7 @@ module Mural
             update_comment_params.encode
           )
 
-          Mural::Widget::Comment.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/files.rb

@@ -11,7 +11,7 @@ module Mural
             params.encode
           )
 
-          Mural::Widget::File.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
 
         # https://developers.mural.co/public/reference/getmuralfilewidgets
@@ -21,7 +21,7 @@ module Mural
             { next: next_page }
           )
 
-          files = json['value'].map { |f| Mural::Widget::File.decode(f) }
+          files = json['value'].map { |f| Mural::Widget.decode(f) }
           [files, json['next']]
         end
 
@@ -32,7 +32,7 @@ module Mural
             update_file_params.encode
           )
 
-          Mural::Widget::File.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/images.rb

@@ -11,7 +11,7 @@ module Mural
             create_image_params.encode
           )
 
-          Mural::Widget::Image.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
 
         # https://developers.mural.co/public/reference/createimage
@@ -21,7 +21,7 @@ module Mural
             update_image_params.encode
           )
 
-          Mural::Widget::Image.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/shapes.rb

@@ -15,7 +15,7 @@ module Mural
             [*create_shape_params].map(&:encode)
           )
           json['value'].map do |json_shape|
-            Mural::Widget::Shape.decode(json_shape)
+            Mural::Widget.decode(json_shape)
           end
         end
 
@@ -30,7 +30,7 @@ module Mural
             update_shape_params.encode
           )
 
-          Mural::Widget::Shape.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/sticky_notes.rb

@@ -15,7 +15,7 @@ module Mural
             [*create_sticky_note_params].map(&:encode)
           )
 
-          json['value'].map { |s| Mural::Widget::StickyNote.decode(s) }
+          json['value'].map { |s| Mural::Widget.decode(s) }
         end
 
         # Update a sticky note widget on a mural.
@@ -32,7 +32,7 @@ module Mural
             update_sticky_note_params.encode
           )
 
-          Mural::Widget::StickyNote.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/text_boxes.rb

@@ -15,7 +15,7 @@ module Mural
             [*create_text_box_params].map(&:encode)
           )
 
-          json['value'].map { |text_box| Mural::Widget::Text.decode(text_box) }
+          json['value'].map { |text_box| Mural::Widget.decode(text_box) }
         end
 
         # Update a textbox on a mural
@@ -29,7 +29,7 @@ module Mural
             update_text_box_params.encode
           )
 
-          Mural::Widget::Text.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/client/mural_content/titles.rb

@@ -15,7 +15,7 @@ module Mural
             [*create_title_params].map(&:encode)
           )
 
-          json['value'].map { |title| Mural::Widget::Text.decode(title) }
+          json['value'].map { |title| Mural::Widget.decode(title) }
         end
 
         # Update a title on a mural
@@ -29,7 +29,7 @@ module Mural
             update_title_params.encode
           )
 
-          Mural::Widget::Text.decode(json['value'])
+          Mural::Widget.decode(json['value'])
         end
       end
     end

data/lib/mural/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mural
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/lib/mural/widget/create_area_params.rb

@@ -5,23 +5,23 @@ module Mural
     class CreateAreaParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createarea
       define_attributes(
-        **Mural::Widget::Area.attrs.reject do |attr|
+        **Mural::Widget::Area.attrs.filter do |attr|
           %i[
-            content_edited_by
-            content_edited_on
-            created_by
-            created_on
-            hide_editor
-            hide_owner
-            id
-            invisible
-            locked
-            locked_by_facilitator
-            rotation
-            type
-            updated_by
-            updated_on
+            height
+            hidden
+            instruction
+            layout
+            parent_id
+            presentation_index
+            show_title
+            stacking_order
+            style
+            title
+            width
+            x
+            y
           ].include? attr
         end
       )

data/lib/mural/widget/create_arrow_params.rb

@@ -7,26 +7,34 @@ module Mural
 
       # https://developers.mural.co/public/reference/createarrow
       define_attributes(
-        **Mural::Widget::Arrow.attrs.reject do |attr|
+        **Mural::Widget::Arrow.attrs.filter do |attr|
           %i[
-            content_edited_by
-            content_edited_on
-            created_by
-            created_on
-            hidden
-            hide_editor
-            hide_owner
-            id
-            invisible
-            locked
-            locked_by_facilitator
-            type
-            updated_by
-            updated_on
+            arrow_type
+            end_ref_id
+            height
+            instruction
+            label
+            parent_id
+            points
+            presentation_index
+            rotation
+            stackable
+            stacking_order
+            start_ref_id
+            style
+            tip
+            title
+            width
+            x
+            y
           ].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)
@@ -34,10 +42,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/create_comment_params.rb

@@ -5,17 +5,19 @@ module Mural
     class CreateCommentParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createcomment
       define_attributes(
         **Mural::Widget::Comment.attrs.filter do |attr|
           %i[
-            reference_widget_id
             message
+            reference_widget_id
             stacking_order
             x
             y
           ].include? attr
         end,
 
+        # If true, the comment is marked as resolved.
         resolved: 'resolved'
       )
     end

data/lib/mural/widget/create_file_params.rb

@@ -7,49 +7,24 @@ module Mural
 
       # 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',
+        **Mural::Widget::File.attrs.filter do |attr|
+          %i[
+            height
+            hidden
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            stacking_order
+            title
+            width
+            x
+            y
+          ].include? attr
+        end,
 
         # 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'
+        name: 'name'
       )
     end
   end

data/lib/mural/widget/create_image_params.rb

@@ -5,30 +5,24 @@ module Mural
     class CreateImageParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createimage
       define_attributes(
-        **Mural::Widget::Image.attrs.reject do |attr|
+        **Mural::Widget::Image.attrs.filter do |attr|
           %i[
-            aspect_ratio
-            content_edited_by
-            content_edited_on
-            created_by
-            created_on
-            expires_in_minutes
-            hide_editor
-            hide_owner
-            id
-            invisible
-            link
-            locked
-            locked_by_facilitator
-            mask
-            natural_height
-            natural_width
-            thumbnail_url
-            type
-            updated_by
-            updated_on
-            url
+            border
+            caption
+            description
+            height
+            hidden
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            show_caption
+            stacking_order
+            width
+            x
+            y
           ].include? attr
         end,
 

data/lib/mural/widget/create_shape_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateShapeParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createshapewidget
       define_attributes(
         **Mural::Widget::Shape.attrs.filter do |attr|
           %i[

data/lib/mural/widget/create_sticky_note_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateStickyNoteParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createstickynote
       define_attributes(
         **Mural::Widget::StickyNote.attrs.filter do |attr|
           %i[
@@ -30,14 +31,13 @@ module Mural
         end
       )
 
+      Style = Mural::Widget::StickyNote::Style
+
       def encode
         super.tap do |json|
           json['style'] = json['style']&.encode
         end.compact
       end
-
-      # Exact same values, no restrictions
-      Style = Mural::Widget::StickyNote::Style
     end
   end
 end

data/lib/mural/widget/create_table_cell_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateTableCellParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createtable
       define_attributes(
         **Mural::Widget::TableCell.attrs.filter do |attr|
           %i[
@@ -23,15 +24,15 @@ module Mural
         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
-
-      Style = Mural::Widget::TableCell::Style
-      TextContent = Mural::Widget::TableCell::TextContent
     end
   end
 end

data/lib/mural/widget/create_table_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateTableParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createtable
       define_attributes(
         **Mural::Widget::Table.attrs.filter do |attr|
           %i[

data/lib/mural/widget/create_text_box_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateTextBoxParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createtextbox
       define_attributes(
         **Mural::Widget::Text.attrs.filter do |attr|
           %i[

data/lib/mural/widget/create_title_params.rb

@@ -5,6 +5,7 @@ module Mural
     class CreateTitleParams
       include Mural::Codec
 
+      # https://developers.mural.co/public/reference/createtitle
       define_attributes(
         **Mural::Widget::Text.attrs.filter do |attr|
           %i[

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

@@ -5,6 +5,7 @@ module Mural
     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

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

@@ -7,7 +7,7 @@ module Mural
 
       define_attributes(
         **Mural::Widget::CreateImageParams.attrs.reject do |attr|
-          %i[name].include? attr
+          %i[name stacking_order].include? attr
         end
       )
     end

data/lib/mural/widget/update_shape_params.rb

@@ -5,6 +5,7 @@ module Mural
     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

data/lib/mural/widget/update_sticky_note_params.rb

@@ -5,22 +5,20 @@ module Mural
     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
+          %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
-
-      Style = Mural::Widget::StickyNote::Style
     end
   end
 end

data/lib/mural/widget/update_text_box_params.rb

@@ -5,6 +5,7 @@ module Mural
     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

data/lib/mural/widget/update_title_params.rb

@@ -5,6 +5,7 @@ module Mural
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mural-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mickaël Pham
@@ -36,6 +36,8 @@ files:
 - README.md
 - Rakefile
 - UNLICENSE
+- img/comment-email-notification.png
+- img/comment-thread.png
 - img/draw-widget.png
 - img/inking-widget.png
 - img/mind-map.png