mural-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d1d5b409d40946faea660284f87875d36785f57278c967c93a645effe6fa24
-  data.tar.gz: 589cdad5b6ef75573fbca62b86de32b43bc084723c4c3a4a8a7589d46e81b82d
+  metadata.gz: c96aa829320e65007b67de1032c65f7e29ca09fc81065db1aceef1329f599d85
+  data.tar.gz: 9fdfb66565796a17c330b95c687c71b1d96d2c9c15d0221860d57bcd683524f8
 SHA512:
-  metadata.gz: a2ed7a6155ab38a55199c17442a07dfb23db5e2191df44096668b1ec73d52a860b80abd0e62439611d726b0f4e95e8eb29e6e75c8b72b840a0ee684fb5d74cf8
-  data.tar.gz: 7ca63988d68d1f4c3e9099121229582244295aa605e4928c71cdee185432aad202c3206ba457299ddaf41de40112703340158033a0ab3da183ab05b45e3f0201
+  metadata.gz: e4525e0df9345817de48a1d114defb147743b94ec6dcebfb026257aef7464b2d465172edbcd19b645c48e254cc47fdc2eaa312b547d5ad3eb16bbeea5db99ee6
+  data.tar.gz: b40ef34256eda180e34dcebfc2d88c02737a892dc467cb02f545118fc291d8fcbcc702cd0d0f5320187f1285750cf3f4c0ac931f069aa11d9f192ecbfc5bfbdd

data/README.md

@@ -1,5 +1,10 @@
 # Mural Ruby
 
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mickaelpham/mural-ruby/ruby.yml?branch=main&style=for-the-badge)](https://github.com/mickaelpham/mural-ruby/actions/workflows/ruby.yml?query=branch%3Amain)
+[![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.
 
 ## Installation

data/lib/mural/chat.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mural
+  class Chat
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getmuralchat
+    define_attributes(
+      # The ID of the chat message.
+      id: 'id',
+      # The content of the chat message.
+      message: 'message',
+      # The timestamp of the chat message.
+      created_on: 'createdOn',
+      # The user object
+      user: 'user'
+    )
+
+    def self.decode(json)
+      super.tap do |chat|
+        chat.user = User.decode(chat.user)
+      end
+    end
+
+    class User
+      include Mural::Codec
+
+      define_attributes(
+        # First name of the member or guest in the chat.
+        first_name: 'firstName',
+        # Last name of the member or guest in the chat.
+        last_name: 'lastName',
+        # ID of a user.
+        id: 'id'
+      )
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module Chats
+        # https://developers.mural.co/public/reference/getmuralchat
+        def list_chats(mural_id, next_page: nil)
+          json = get(
+            "/api/public/v1/murals/#{mural_id}/chat",
+            { next: next_page }
+          )
+
+          chats = json['value'].map { |c| Mural::Chat.decode(c) }
+          [chats, json['next']]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class MuralContent
+      module FacilitationFeatures
+        # https://developers.mural.co/public/reference/startprivatemode
+        def start_private_mode(mural_id, hide_authors: false)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/private-mode/start",
+            { hideAuthors: hide_authors }
+          )
+
+          Mural::PrivateMode.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/stopprivatemode
+        def end_private_mode(mural_id)
+          post("/api/public/v1/murals/#{mural_id}/private-mode/end")
+        end
+
+        # https://developers.mural.co/public/reference/getprivatemode
+        def retrieve_private_mode(mural_id)
+          json = get("/api/public/v1/murals/#{mural_id}/private-mode")
+
+          Mural::PrivateMode.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/getmuralvotingsessions
+        def list_voting_sessions(mural_id, next_page: nil)
+          json = get(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions",
+            { next: next_page }
+          )
+
+          voting_sessions = json['value'].map do |session|
+            Mural::VotingSession.decode(session)
+          end
+
+          [voting_sessions, json['next']]
+        end
+
+        # https://developers.mural.co/public/reference/getmuralvotingsessionresults
+        def list_voting_session_results(
+          mural_id,
+          voting_session_id,
+          next_page: nil
+        )
+          json = get(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions" \
+            "/#{voting_session_id}/results",
+            { next: next_page }
+          )
+
+          voting_session_results = json['value'].map do |result|
+            Mural::VotingSessionResult.decode(result)
+          end
+
+          [voting_session_results, json['next']]
+        end
+
+        # https://developers.mural.co/public/reference/getmuralvotingsessionbyid
+        def retrieve_voting_session(mural_id, voting_session_id)
+          json = get(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions" \
+            "/#{voting_session_id}"
+          )
+
+          Mural::VotingSession.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/deletemuralvotingsessionbyid
+        def destroy_voting_session(mural_id, voting_session_id)
+          delete(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions" \
+            "/#{voting_session_id}"
+          )
+        end
+
+        # https://developers.mural.co/public/reference/startmuralvotingsession
+        def start_voting_session(mural_id, start_voting_session_params)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions/start",
+            start_voting_session_params.encode
+          )
+
+          Mural::VotingSession.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/endmuralvotingsession
+        def end_voting_session(mural_id)
+          post("/api/public/v1/murals/#{mural_id}/voting-sessions/end")
+        end
+
+        # https://developers.mural.co/public/reference/votewidgetmuralvotingsession
+        def vote_for_widget(mural_id, widget_id)
+          post(
+            "/api/public/v1/murals/#{mural_id}/voting-sessions" \
+            "/vote/#{widget_id}"
+          )
+        end
+
+        # https://developers.mural.co/public/reference/getmuraltimer
+        def retrieve_timer(mural_id)
+          json = get("/api/public/v1/murals/#{mural_id}/timer")
+
+          Mural::Timer.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/startmuraltimer
+        def start_timer(mural_id, duration:, sound_enabled: true)
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/timer/start",
+            { duration: duration, soundEnabled: sound_enabled }
+          )
+
+          Mural::Timer.decode(json['value'])
+        end
+
+        # https://developers.mural.co/public/reference/stopmuraltimer
+        def end_timer(mural_id)
+          post("/api/public/v1/murals/#{mural_id}/timer/end")
+        end
+
+        # https://developers.mural.co/public/reference/updatemuraltimer
+        def update_timer(mural_id, update_timer_params)
+          json = patch(
+            "/api/public/v1/murals/#{mural_id}/timer",
+            update_timer_params.encode
+          )
+
+          Mural::Timer.decode(json['value'])
+        end
+      end
+    end
+  end
+end

data/lib/mural/client/mural_content.rb

@@ -5,6 +5,8 @@ module Mural
     class MuralContent
       extend Forwardable
 
+      include Chats
+      include FacilitationFeatures
       include Files
       include StickyNotes
       include Tags

data/lib/mural/private_mode.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mural
+  class PrivateMode
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/startprivatemode
+    define_attributes(
+      # If true, the private mode is active.
+      active: 'active',
+      # The timestamp when private mode started.
+      initial_timestamp: 'initialTimestamp',
+      # The user who started the private mode.
+      started_by: 'startedBy',
+      # If true, the authors of the content will be hidden.
+      hide_authors: 'hideAuthors'
+    )
+  end
+end

data/lib/mural/start_voting_session_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mural
+  class StartVotingSessionParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/startmuralvotingsession
+    define_attributes(
+      # The title of the voting session.
+      title: 'title',
+      # The number of votes allowed in the session.
+      number_of_votes: 'numberOfVotes',
+      # The types of widgets that can be voted on in this session.
+      widget_types: 'widgetTypes',
+      # If true, anyone can end the voting session.
+      anyone_can_end: 'anyoneCanEnd',
+      # The area on the mural where the voting session will take place.
+      area: 'area'
+    )
+
+    def encode
+      super.tap do |json|
+        json['area'] = json['area']&.encode
+      end
+    end
+
+    class Area
+      include Mural::Codec
+
+      define_attributes(
+        # The top coordinate of the area.
+        top: 'top',
+        # The left coordinate of the area.
+        left: 'left',
+        # The width of the area.
+        width: 'width',
+        # The height of the area.
+        height: 'height'
+      )
+    end
+  end
+end

data/lib/mural/timer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mural
+  class Timer
+    include Mural::Codec
+
+    define_attributes(
+      # Timer duration in seconds.
+      duration: 'duration',
+      # The initial timestamp of the timer in ms.
+      initial_timestamp: 'initialTimestamp',
+      # The current timestamp of the timer in ms.
+      now: 'now',
+      # The paused timestamp of the timer in ms. Null if no pause action was
+      # performed.
+      paused_timestamp: 'pausedTimestamp',
+      # If true, the timer will play a sound when it ends.
+      sound_enabled: 'soundEnabled'
+    )
+  end
+end

data/lib/mural/update_timer_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class UpdateTimerParams
+    include Mural::Codec
+
+    define_attributes(
+      # Add +/- extra time to the running timer in seconds.
+      delta: 'delta',
+      # If true, the timer will pause.
+      paused: 'paused',
+      # If true, the timer will play a sound when it ends.
+      sound_enabled: 'soundEnabled'
+    )
+  end
+end

data/lib/mural/version.rb

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

data/lib/mural/voting_session.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mural
+  class VotingSession
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getmuralvotingsessions
+    define_attributes(
+      # The ID of the voting session.
+      id: 'id',
+      # The title of the voting session.
+      title: 'title'
+    )
+  end
+end

data/lib/mural/voting_session_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class VotingSessionResult
+    include Mural::Codec
+
+    define_attributes(
+      # Unique identifier of a widget.
+      widget_id: 'widgetId',
+      # The total number of votes for the widget.
+      total_votes: 'totalVotes',
+      # The number of unique collaborators that voted for the widget.
+      unique_voters: 'uniqueVoters'
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mural-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mickaël Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-06 00:00:00.000000000 Z
+date: 2025-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -42,9 +42,12 @@ files:
 - img/smart-planner.png
 - lib/mural.rb
 - lib/mural/asset.rb
+- lib/mural/chat.rb
 - lib/mural/client.rb
 - lib/mural/client/authentication.rb
 - lib/mural/client/mural_content.rb
+- lib/mural/client/mural_content/chats.rb
+- lib/mural/client/mural_content/facilitation_features.rb
 - lib/mural/client/mural_content/files.rb
 - lib/mural/client/mural_content/sticky_notes.rb
 - lib/mural/client/mural_content/tags.rb
@@ -69,6 +72,7 @@ files:
 - lib/mural/mural_invitation.rb
 - lib/mural/mural_invitation_params.rb
 - lib/mural/mural_user.rb
+- lib/mural/private_mode.rb
 - lib/mural/removed_mural_user.rb
 - lib/mural/removed_room_user.rb
 - lib/mural/room.rb
@@ -79,14 +83,19 @@ files:
 - lib/mural/search_mural_result.rb
 - lib/mural/search_room_result.rb
 - lib/mural/search_template_result.rb
+- lib/mural/start_voting_session_params.rb
 - lib/mural/tag.rb
 - lib/mural/template.rb
+- lib/mural/timer.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/update_timer_params.rb
 - lib/mural/version.rb
+- lib/mural/voting_session.rb
+- lib/mural/voting_session_result.rb
 - lib/mural/widget.rb
 - lib/mural/widget/area.rb
 - lib/mural/widget/arrow.rb