mural-ruby 0.1.0

data/lib/mural/create_tag_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mural
+  class CreateTagParams
+    include Mural::Codec
+
+    define_attributes(
+      # The text in the tag.
+      text: 'text',
+
+      # The background color of the tag in hex with alpha format.
+      background_color: 'backgroundColor',
+
+      # The border color of the tag in hex with alpha format.
+      border_color: 'borderColor',
+
+      # The text color of the tag in hex with alpha format.
+      color: 'color',
+
+      # The widgets to add the new tag to.
+      #
+      # ⚠️ This is rejected by Mural API with the following error:
+      # > Invalid "widgets" property type was sent. Type undefined was expected.
+      widgets: 'widgets'
+    )
+
+    def encode
+      super.tap do |json|
+        json['widgets']&.map!(&:encode)
+      end
+    end
+
+    class Widget
+      include Mural::Codec
+
+      define_attributes(
+        # The unique ID of the widget to add the new tag to.
+        id: 'id',
+
+        # Text size.
+        font_size: 'fontSize'
+      )
+    end
+  end
+end

data/lib/mural/current_user.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mural
+  class CurrentUser
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getcurrentmember
+    define_attributes(
+      id: 'id',
+      email: 'email',
+      avatar: 'avatar',
+      first_name: 'firstName',
+      last_name: 'lastName',
+      created_on: 'createdOn',
+      company_id: 'companyId',
+      company_name: 'companyName',
+      type: 'type',
+      last_active_workspace: 'lastActiveWorkspace'
+    )
+  end
+end

data/lib/mural/duplicate_mural_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mural
+  class DuplicateMuralParams
+    include Mural::Codec
+
+    define_attributes(
+      room_id: 'roomId',
+      folder_id: 'folderId',
+      infinite: 'infinite',
+      title: 'title'
+    )
+  end
+end

data/lib/mural/mural_board.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Mural
+  # Mural, the company, is also calling their main document a "mural" in lower
+  # case. Unfortunately, this doesn't translate well to a programming language
+  # and I'd rather have a #<Mural::MuralBoard> instance instead of a
+  # #<Mural::Mural> one, the repetition is driving me insane. And it's also
+  # what their main competitor (Miro) is calling the document, so it's not to
+  # far-fetched. I also believe that historically, a "mural" (the document) used
+  # to be called a board as well within Mural (the company/product).
+  class MuralBoard
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getmuralbyid
+    define_attributes(
+      background_color: 'backgroundColor',
+      created_by: 'createdBy',
+      created_on: 'createdOn',
+      embed_link: 'embedLink',
+      favorite: 'favorite',
+      folder_id: 'folderId',
+      height: 'height',
+      id: 'id',
+      infinite: 'infinite',
+      room_id: 'roomId',
+      sharing_settings: 'sharingSettings',
+      state: 'state',
+      status: 'status',
+      thumbnail_url: 'thumbnailUrl',
+      timer_sound_theme: 'timerSoundTheme',
+      title: 'title',
+      updated_by: 'updatedBy',
+      updated_on: 'updatedOn',
+      visitor_avatar_theme: 'visitorAvatarTheme',
+      visitors_settings: 'visitorsSettings', # spelling is on Mural side
+      width: 'width',
+      workspace_id: 'workspaceId'
+    )
+
+    def self.decode(json)
+      super.tap do |mural|
+        mural.created_by = CreatedBy.decode(mural.created_by)
+        mural.updated_by = UpdatedBy.decode(mural.updated_by)
+        mural.sharing_settings = SharingSettings.decode(mural.sharing_settings)
+        mural.visitors_settings =
+          VisitorsSettings.decode(mural.visitors_settings)
+      end
+    end
+
+    class AccessInformation
+      include Mural::Codec
+
+      define_attributes(
+        visitors: 'visitors',
+        workspace_members: 'workspaceMembers'
+      )
+    end
+
+    class CreatedBy
+      include Mural::Codec
+
+      define_attributes(
+        first_name: 'firstName',
+        id: 'id',
+        last_name: 'lastName'
+      )
+    end
+
+    class UpdatedBy
+      include Mural::Codec
+
+      define_attributes(
+        first_name: 'firstName',
+        id: 'id',
+        last_name: 'lastName'
+      )
+    end
+
+    class SharingSettings
+      include Mural::Codec
+
+      define_attributes(link: 'link')
+    end
+
+    class VisitorsSettings
+      include Mural::Codec
+
+      define_attributes(
+        visitors: 'visitors',
+        workspace_members: 'workspaceMembers',
+        link: 'link',
+        expires_on: 'expiresOn'
+      )
+    end
+  end
+end

data/lib/mural/mural_export.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class MuralExport
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/exporturlmural
+    define_attributes(
+      created_on: 'createdOn',
+      expire_on: 'expireOn',
+      export_id: 'exportId',
+      mural_id: 'muralId',
+      url: 'url'
+    )
+  end
+end

data/lib/mural/mural_invitation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class MuralInvitation
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/inviteuserstomural
+    define_attributes(
+      email: 'email',
+      ref_code: 'refCode',
+      rejected: 'rejected',
+      reason: 'reason',
+      username: 'username'
+    )
+  end
+end

data/lib/mural/mural_invitation_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mural
+  class MuralInvitationParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/inviteuserstomural
+    define_attributes(
+      edit_permission: 'editPermission',
+      email: 'email',
+      username: 'username'
+    )
+  end
+end

data/lib/mural/mural_user.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mural
+  class MuralUser
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getmuralusers
+    define_attributes(
+      id: 'id',
+      email: 'email',
+      avatar: 'avatar',
+      first_name: 'firstName',
+      last_name: 'lastName',
+      type: 'type',
+      permissions: 'permissions'
+    )
+
+    class Permissions
+      include Mural::Codec
+
+      define_attributes({ owner: 'owner', facilitator: 'facilitator' })
+    end
+
+    def self.decode(json)
+      super.tap do |mural_user|
+        mural_user.permissions = Permissions.decode(mural_user.permissions)
+      end
+    end
+  end
+end

data/lib/mural/removed_mural_user.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mural
+  class RemovedMuralUser
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/removemuralusers
+    define_attributes(
+      email: 'email',
+      rejected: 'rejected',
+      reason: 'reason'
+    )
+  end
+end

data/lib/mural/removed_room_user.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mural
+  class RemovedRoomUser
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/removeroomusers
+    define_attributes(
+      email: 'email',
+      rejected: 'rejected',
+      reason: 'reason'
+    )
+  end
+end

data/lib/mural/room.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Mural
+  class Room
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getroominfobyid
+    define_attributes(
+      id: 'id',
+      name: 'name',
+      description: 'description',
+      favorite: 'favorite',
+      created_by: 'createdBy',
+      created_on: 'createdOn',
+      updated_by: 'updatedBy',
+      updated_on: 'updatedOn',
+      type: 'type',
+      confidential: 'confidential',
+      workspace_id: 'workspaceId',
+      # 👇 Only visible when the logged in user is an admin ("owner" in Mural
+      #    terminology) of the room. Not returned on creation.
+      sharing_settings: 'sharingSettings'
+    )
+
+    def self.decode(json)
+      super.tap do |room|
+        room.created_by = CreatedBy.decode(room.created_by)
+        room.updated_by = CreatedBy.decode(room.updated_by)
+        room.sharing_settings = SharingSettings.decode(room.sharing_settings)
+      end
+    end
+
+    class CreatedBy
+      include Mural::Codec
+
+      define_attributes(
+        {
+          first_name: 'firstName',
+          id: 'id',
+          last_name: 'lastName'
+        }
+      )
+    end
+
+    class UpdatedBy
+      include Mural::Codec
+
+      define_attributes(
+        {
+          first_name: 'firstName',
+          id: 'id',
+          last_name: 'lastName'
+        }
+      )
+    end
+
+    class SharingSettings
+      include Mural::Codec
+
+      define_attributes({ link: 'link' })
+    end
+  end
+end

data/lib/mural/room_folder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mural
+  class RoomFolder
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getroomfolders
+    define_attributes(
+      children: 'children',
+      id: 'id',
+      name: 'name'
+    )
+
+    def self.decode(json)
+      super.tap do |folder|
+        # Recursively map out the children
+        folder.children&.map! { |child| decode(child) }
+      end
+    end
+  end
+end

data/lib/mural/room_invitation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class RoomInvitation
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/inviteuserstoroom
+    define_attributes(
+      email: 'email',
+      ref_code: 'refCode',
+      rejected: 'rejected',
+      reason: 'reason',
+      username: 'username'
+    )
+  end
+end

data/lib/mural/room_invitation_params.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mural
+  class RoomInvitationParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/inviteuserstoroom
+    define_attributes(
+      email: 'email',
+      username: 'username'
+    )
+  end
+end

data/lib/mural/room_user.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mural
+  class RoomUser
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getroommembers
+    define_attributes(
+      id: 'id',
+      email: 'email',
+      avatar: 'avatar',
+      first_name: 'firstName',
+      last_name: 'lastName',
+      type: 'type'
+    )
+  end
+end

data/lib/mural/search_mural_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mural
+  class SearchMuralResult
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/searchmurals
+    define_attributes(
+      id: 'id',
+      room_id: 'roomId',
+      workspace_id: 'workspaceId',
+      workspace_name: 'workspaceName',
+      created_by: 'createdBy',
+      created_on: 'createdOn',
+      updated_by: 'updatedBy',
+      status: 'status',
+      thumbnail_url: 'thumbnailUrl',
+      title: 'title'
+    )
+  end
+end

data/lib/mural/search_room_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class SearchRoomResult
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/searchrooms
+    define_attributes(
+      id: 'id',
+      name: 'name',
+      description: 'description',
+      type: 'type',
+      workspace_id: 'workspaceId'
+    )
+  end
+end

data/lib/mural/search_template_result.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mural
+  class SearchTemplateResult
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/searchtemplates
+    define_attributes(
+      id: 'id',
+      workspace_id: 'workspaceId',
+      created_on: 'createdOn',
+      thumb_url: 'thumbUrl',
+      view_link: 'viewLink',
+      type: 'type',
+      name: 'name'
+    )
+  end
+end

data/lib/mural/tag.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mural
+  class Tag
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getmuraltags
+    define_attributes(
+      # The ID of the tag.
+      id: 'id',
+
+      # The text in the tag.
+      text: 'text',
+
+      # The background color of the tag in hex with alpha format.
+      background_color: 'backgroundColor',
+
+      # The border color of the tag in hex with alpha format.
+      border_color: 'borderColor',
+
+      # The text color of the tag in hex with alpha format.
+      color: 'color'
+    )
+  end
+end

data/lib/mural/template.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mural
+  class Template
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/getdefaulttemplates
+    define_attributes(
+      id: 'id',
+      name: 'name',
+      description: 'description',
+      created_on: 'createdOn',
+      created_by: 'createdBy',
+      updated_on: 'updatedOn',
+      updated_by: 'updatedBy',
+      type: 'type',
+      workspace_id: 'workspaceId',
+      thumb_url: 'thumbUrl',
+      view_link: 'viewLink',
+      # 👇 only returned when creating a custom template
+      mural_id: 'muralId'
+    )
+  end
+end

data/lib/mural/update_mural_params.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Mural
+  class UpdateMuralParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/updatemuralbyid
+    define_attributes(
+      background_color: 'backgroundColor',
+      favorite: 'favorite',
+      folderId: 'folderId',
+      height: 'height',
+      infinite: 'infinite',
+      width: 'width',
+      title: 'title',
+      status: 'status',
+      timer_sound_theme: 'timerSoundTheme',
+      visitor_avatar_theme: 'visitorAvatarTheme',
+      visitors_permission: 'visitorsPermission',
+      workspace_members_permission: 'workspaceMembersPermission'
+    )
+  end
+end

data/lib/mural/update_room_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mural
+  class UpdateRoomParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/updateroombyid
+    define_attributes(
+      description: 'description',
+      favorite: 'favorite',
+      name: 'name',
+      type: 'type'
+    )
+  end
+end

data/lib/mural/update_room_user_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mural
+  class UpdateRoomUserParams
+    include Mural::Codec
+
+    define_attributes(
+      create_murals: 'createMurals',
+      duplicate_room: 'duplicateRoom',
+      invite_others: 'inviteOthers',
+      owner: 'owner',
+      username: 'username',
+      ref_code: 'refCode'
+    )
+  end
+end

data/lib/mural/update_sticky_note_params.rb

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

data/lib/mural/update_tag_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mural
+  class UpdateTagParams
+    include Mural::Codec
+
+    # https://developers.mural.co/public/reference/updatetagbyid
+    define_attributes(
+      # The text in the tag.
+      text: 'text',
+
+      # The background color of the tag in hex with alpha format.
+      background_color: 'backgroundColor',
+
+      # The border color of the tag in hex with alpha format.
+      border_color: 'borderColor',
+
+      # The text color of the tag in hex with alpha format.
+      color: 'color'
+    )
+  end
+end

data/lib/mural/version.rb

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