mural-ruby 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb82932dd0ccbb4d24c3757001c13cbba96f7d4749d9a9d7c6b3af4c696e9a1a
-  data.tar.gz: 9e5f87168f3b1207c535923e2eeffb152b4ea2c25c1e175e5e71490aac91469e
+  metadata.gz: cffa4ff400827dc5d5dd6393b9d4486db9343d61a36d99741115fc08f94b8631
+  data.tar.gz: 65d63349f8a62417a9331cdd9fc35d7116705d61b4e296b306ddd740f6ae0d19
 SHA512:
-  metadata.gz: 1ecef1c87c8f60b6919fa881e32197a789aa1792bf231e45f7b2e88d285d92aad5294eadc06af85a581bbfd0c16b266ca3890f0b004cc3153726b0c299b49cb2
-  data.tar.gz: e3bf3aef7df48aaaca7d789af5a8617a4090d596acb1b38a1344c04dd6610cbdb2c70b2191688c687584da7181589d8282fa8e64a39967ba2feaf003fa90405d
+  metadata.gz: ec31b430792736408b1fbd14a474b223e232ea598e252af91dbc34b4952d53774fdabd5d6baaba6d0f2b21da1193a3323f578d7b7565cb99e36326803ff4fc95
+  data.tar.gz: dc81671b72f2d394d91c09a85699757ef7552b92532ef754d0e53fba88209444755a5042d23fa7ab58ed4204894ebf7344689ca12d0847231f102220e63ef907

data/README.md

@@ -4,9 +4,16 @@
 [![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 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
 
 ```sh
@@ -70,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'
@@ -108,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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Comments
+        # Create a comment widget on a mural.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/createcomment
+        def create_comment(mural_id, create_comment_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/comment",
+            create_comment_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+
+        # Update a comment widget on a mural.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/updatecomment
+        def update_comment(mural_id, comment_id, update_comment_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/widgets/comment/#{comment_id}",
+            update_comment_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+      end
+    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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Images
+        # https://developers.mural.co/public/reference/createimage
+        def create_image(mural_id, create_image_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/image",
+            create_image_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/createimage
+        def update_image(mural_id, image_id, update_image_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/widgets/image/#{image_id}",
+            update_image_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Shapes
+        # Create one or more shape widgets on a mural. Limit 1000.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/createshapewidget
+        def create_shapes(mural_id, create_shape_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/shape",
+            [*create_shape_params].map(&:encode)
+          )
+          json['value'].map do |json_shape|
+            Mural::Widget.decode(json_shape)
+          end
+        end
+
+        # Update a shape widget on a mural.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/updateshapewidget
+        def update_shape(mural_id, shape_id, update_shape_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/widgets/shape/#{shape_id}",
+            update_shape_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,10 @@ module Mural
   class Client
     class MuralContent
       module StickyNotes
+        # Create one or more sticky note widgets on a mural. Limit 1000.
+        #
+        # Authorization scope: murals:write
+        #
         # https://developers.mural.co/public/reference/createstickynote
         def create_sticky_notes(mural_id, create_sticky_note_params)
           json = post(
@@ -11,18 +15,24 @@ 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.
+        #
+        # Authorization scope: murals:write
+        #
         # https://developers.mural.co/public/reference/updatestickynote
-        def update_sticky_note(mural_id, widget_id, update_sticky_note_params)
+        def update_sticky_note(
+          mural_id, sticky_note_id, update_sticky_note_params
+        )
           json = patch(
             "/api/public/v1/murals/#{mural_id}/widgets/sticky-note" \
-            "/#{widget_id}",
+            "/#{sticky_note_id}",
             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/tables.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Tables
+        # Create a table widget on a mural.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/createtable
+        def create_table(mural_id, create_table_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/table",
+            create_table_params.encode
+          )
+
+          # We receive a mix of Table and TableCell widgets
+          json['value'].map { |widget| Mural::Widget.decode(widget) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module TextBoxes
+        # Create one or more text box widgets on a mural. Limit 1000.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/createtextbox
+        def create_text_boxes(mural_id, create_text_box_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/textbox",
+            [*create_text_box_params].map(&:encode)
+          )
+
+          json['value'].map { |text_box| Mural::Widget.decode(text_box) }
+        end
+
+        # Update a textbox on a mural
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/updatetextbox
+        def update_text_box(mural_id, text_box_id, update_text_box_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/widgets/textbox/#{text_box_id}",
+            update_text_box_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Titles
+        # Create one or more title widgets on a mural. Limit 1000.
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/createtitle
+        def create_titles(mural_id, create_title_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/widgets/title",
+            [*create_title_params].map(&:encode)
+          )
+
+          json['value'].map { |title| Mural::Widget.decode(title) }
+        end
+
+        # Update a title on a mural
+        #
+        # Authorization scope: murals:write
+        #
+        # https://developers.mural.co/public/reference/updatetitle
+        def update_title(mural_id, title_id, update_title_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/widgets/title/#{title_id}",
+            update_title_params.encode
+          )
+
+          Mural::Widget.decode(json['value'])
+        end
+      end
+    end
+  end
+end

data/lib/mural/client/mural_content.rb

@@ -8,10 +8,16 @@ module Mural
       include Areas
       include Arrows
       include Chats
+      include Comments
       include FacilitationFeatures
       include Files
+      include Images
+      include Shapes
       include StickyNotes
+      include Tables
       include Tags
+      include TextBoxes
+      include Titles
       include Widgets
 
       def_delegators :@client, :get, :post, :patch, :delete

data/lib/mural/client.rb

@@ -51,7 +51,6 @@ module Mural
       )
 
       req = Net::HTTP::Get.new uri
-      # retryable_request(req)
       retryable_request(req)
     end
 

data/lib/mural/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mural
-  VERSION = '0.4.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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mural
+  class Widget
+    class CreateImageParams
+      include Mural::Codec
+
+      # https://developers.mural.co/public/reference/createimage
+      define_attributes(
+        **Mural::Widget::Image.attrs.filter do |attr|
+          %i[
+            border
+            caption
+            description
+            height
+            hidden
+            instruction
+            parent_id
+            presentation_index
+            rotation
+            show_caption
+            stacking_order
+            width
+            x
+            y
+          ].include? attr
+        end,
+
+        # The name of the image.
+        # The allowed image formats are: bmp, ico, gif, jpeg, jpg, png, webp.
+        name: 'name',
+
+        # The URL used in the widget.
+        hyperlink: 'hyperlink'
+      )
+    end
+  end
+end