mural-ruby 0.1.0

data/lib/mural/client/rooms.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Rooms
+      extend Forwardable
+
+      def_delegators :@client, :get, :post, :patch, :delete
+
+      def initialize(client)
+        @client = client
+      end
+
+      # https://developers.mural.co/public/reference/createroom
+      def create(params)
+        json = post('/api/public/v1/rooms', params.encode)
+
+        Mural::Room.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/updateroombyid
+      def update(room_id, params)
+        json = patch("/api/public/v1/rooms/#{room_id}", params.encode)
+
+        Mural::Room.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/deleteroombyid
+      def destroy(room_id)
+        delete("/api/public/v1/rooms/#{room_id}")
+      end
+
+      # https://developers.mural.co/public/reference/createroomfolder
+      def create_folder(room_id, name:, parent_id: nil)
+        json = post(
+          "/api/public/v1/rooms/#{room_id}/folders",
+          { name: name, parentId: parent_id }
+        )
+
+        ::Mural::RoomFolder.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/getroomfolders
+      def list_folders(room_id, next_page: nil)
+        json = get(
+          "/api/public/v1/rooms/#{room_id}/folders",
+          { next: next_page }
+        )
+
+        folders = json['value'].map do |json_folder|
+          ::Mural::RoomFolder.decode(json_folder)
+        end
+
+        [folders, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/deleteroombyid
+      def destroy_folder(room_id, folder_id)
+        delete("/api/public/v1/rooms/#{room_id}/folders/#{folder_id}")
+      end
+
+      # https://developers.mural.co/public/reference/getroominfobyid
+      def retrieve(room_id)
+        json = get("/api/public/v1/rooms/#{room_id}")
+
+        Mural::Room.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/getworkspacerooms
+      def list(workspace_id, next_page: nil)
+        json = get(
+          "/api/public/v1/workspaces/#{workspace_id}/rooms",
+          { next: next_page }
+        )
+
+        rooms = json['value'].map { |json_room| Mural::Room.decode(json_room) }
+        [rooms, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/getworkspaceopenrooms
+      def list_open(workspace_id, next_page: nil)
+        json = get(
+          "/api/public/v1/workspaces/#{workspace_id}/rooms/open",
+          { next: next_page }
+        )
+
+        rooms = json['value'].map { |json_room| Mural::Room.decode(json_room) }
+        [rooms, json['next']]
+      end
+    end
+  end
+end

data/lib/mural/client/search.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Search
+      extend Forwardable
+
+      def_delegators :@client, :get
+
+      def initialize(client)
+        @client = client
+      end
+
+      # https://developers.mural.co/public/reference/searchmurals
+      def murals(query, workspace_id:, next_page: nil, room_id: nil)
+        json = get(
+          "/api/public/v1/search/#{workspace_id}/murals",
+          { next: next_page, q: query, roomId: room_id }
+        )
+
+        murals = json['value'].map do |hit|
+          Mural::SearchMuralResult.decode(hit)
+        end
+
+        [murals, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/searchrooms
+      def rooms(query, workspace_id:, next_page: nil)
+        json = get(
+          "/api/public/v1/search/#{workspace_id}/rooms",
+          { next: next_page, q: query }
+        )
+
+        rooms = json['value'].map { |hit| Mural::SearchRoomResult.decode(hit) }
+
+        [rooms, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/searchtemplates
+      def templates(query, workspace_id:, next_page: nil)
+        json = get(
+          "/api/public/v1/search/#{workspace_id}/templates",
+          { next: next_page, q: query }
+        )
+
+        templates = json['value'].map do |hit|
+          Mural::SearchTemplateResult.decode(hit)
+        end
+
+        [templates, json['next']]
+      end
+    end
+  end
+end

data/lib/mural/client/templates.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Templates
+      extend Forwardable
+
+      def_delegators :@client, :get, :post, :delete
+
+      def initialize(client)
+        @client = client
+      end
+
+      # https://developers.mural.co/public/reference/getdefaulttemplates
+      def default_templates(next_page: nil)
+        json = get('/api/public/v1/templates', { next: next_page })
+
+        templates = json['value'].map { |tpl| Mural::Template.decode(tpl) }
+
+        [templates, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/createcustomtemplate
+      def create_custom(title:, mural_id:, description: nil)
+        json = post(
+          '/api/public/v1/templates',
+          { title: title, muralId: mural_id, description: description }
+        )
+
+        Mural::Template.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/deletetemplatebyid
+      def destroy(template_id)
+        delete("/api/public/v1/templates/#{template_id}")
+      end
+
+      # https://developers.mural.co/public/reference/createmuralfromtemplate
+      def create_mural(template_id, title:, room_id:, folder_id: nil)
+        json = post(
+          "/api/public/v1/templates/#{template_id}/murals",
+          { title: title, roomId: room_id, folderId: folder_id }
+        )
+
+        Mural::MuralBoard.decode(json['value'])
+      end
+
+      # https://developers.mural.co/public/reference/gettemplatesbyworkspace
+      def for_workspace(workspace_id, next_page: nil, without_default: true)
+        json = get(
+          "/api/public/v1/workspaces/#{workspace_id}/templates",
+          { next: next_page, withoutDefault: without_default }
+        )
+
+        templates = json['value'].map { |tpl| Mural::Template.decode(tpl) }
+
+        [templates, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/getrecenttemplates
+      def recent_for_workspace(
+        workspace_id,
+        next_page: nil,
+        without_default: true
+      )
+        json = get(
+          "/api/public/v1/workspaces/#{workspace_id}/templates/recent",
+          { next: next_page, withoutDefault: without_default }
+        )
+
+        templates = json['value'].map { |tpl| Mural::Template.decode(tpl) }
+
+        [templates, json['next']]
+      end
+    end
+  end
+end

data/lib/mural/client/users/mural_users.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Users
+      module MuralUsers
+        # https://developers.mural.co/public/reference/getmuralusers
+        def mural_users(mural_id, next_page: nil)
+          json = get(
+            "/api/public/v1/murals/#{mural_id}/users",
+            { next: next_page }
+          )
+
+          users = json['value'].map do |json_user|
+            ::Mural::MuralUser.decode(json_user)
+          end
+
+          [users, json['next']]
+        end
+
+        # https://developers.mural.co/public/reference/updatemuralmemberpermissions
+        def update_mural_user_permissions(
+          mural_id,
+          user_id,
+          owner: nil,
+          facilitator: nil
+        )
+          patch(
+            "/api/public/v1/murals/#{mural_id}/users/#{user_id}/permissions",
+            { owner: owner, facilitator: facilitator }
+          )
+        end
+
+        # https://developers.mural.co/public/reference/inviteuserstomural
+        def invite_mural_users(
+          mural_id,
+          message: nil,
+          invitations: [],
+          send_email: false
+        )
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/users/invite",
+            {
+              message: message,
+              invitations: invitations.map(&:encode),
+              sendEmail: send_email
+            }
+          )
+
+          json['value'].map { |result| ::Mural::MuralInvitation.decode(result) }
+        end
+
+        # https://developers.mural.co/public/reference/removemuralusers
+        def remove_mural_users(mural_id, emails: [])
+          json = post(
+            "/api/public/v1/murals/#{mural_id}/users/remove",
+            { emails: emails }
+          )
+
+          json['value'].map do |removed_user|
+            Mural::RemovedMuralUser.decode(removed_user)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mural/client/users/room_users.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Users
+      module RoomUsers
+        # https://developers.mural.co/public/reference/getroommembers
+        def room_users(room_id, next_page: nil)
+          json = get(
+            "/api/public/v1/rooms/#{room_id}/users",
+            { next: next_page }
+          )
+
+          users = json['value'].map do |json_user|
+            ::Mural::RoomUser.decode(json_user)
+          end
+
+          [users, json['next']]
+        end
+
+        # https://developers.mural.co/public/reference/updateroommemberpermissions
+        def update_room_user_permissions(room_id, room_users: [])
+          patch(
+            "/api/public/v1/rooms/#{room_id}/users/permissions",
+            { members: room_users.map(&:encode) }
+          )
+        end
+
+        # https://developers.mural.co/public/reference/inviteuserstoroom
+        def invite_room_users(
+          room_id,
+          message: nil,
+          room_invitations: [],
+          send_email: false
+        )
+          json = post(
+            "/api/public/v1/rooms/#{room_id}/users/invite",
+            {
+              message: message,
+              invitations: room_invitations.map(&:encode),
+              sendEmail: send_email
+            }
+          )
+
+          json['value'].map { |result| Mural::RoomInvitation.decode(result) }
+        end
+      end
+
+      # https://developers.mural.co/public/reference/removeroomusers
+      def remove_room_users(room_id, emails: [])
+        json = post(
+          "/api/public/v1/rooms/#{room_id}/users/remove",
+          { emails: emails }
+        )
+
+        json['value'].map do |removed_user|
+          Mural::RemovedRoomUser.decode(removed_user)
+        end
+      end
+    end
+  end
+end

data/lib/mural/client/users.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Users
+      extend Forwardable
+
+      include Users::MuralUsers
+      include Users::RoomUsers
+
+      def_delegators :@client, :get, :post, :patch
+
+      def initialize(client)
+        @client = client
+      end
+
+      # https://developers.mural.co/public/reference/getcurrentmember
+      def current_user
+        json = get('/api/public/v1/users/me')['value']
+
+        ::Mural::CurrentUser.decode(json)
+      end
+
+      # https://developers.mural.co/public/reference/inviteuserstoworkspace
+      def invite_workspace_users(workspace_id, message: nil, emails: [])
+        json = post(
+          "/api/public/v1/workspaces/#{workspace_id}/users/invite",
+          {
+            message: message,
+            invitations: emails.map { |email| { email: email } }
+          }
+        )
+
+        json['value'].map { |inv| Mural::WorkspaceInvitation.decode(inv) }
+      end
+    end
+  end
+end

data/lib/mural/client/workspaces.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    class Workspaces
+      extend Forwardable
+
+      def_delegators :@client, :get, :post, :patch
+
+      def initialize(client)
+        @client = client
+      end
+
+      # https://developers.mural.co/public/reference/getworkspaces
+      def list(next_page: nil)
+        json = get('/api/public/v1/workspaces', { next: next_page })
+
+        workspaces = json['value'].map do |json_wp|
+          ::Mural::Workspace.decode(json_wp)
+        end
+
+        [workspaces, json['next']]
+      end
+
+      # https://developers.mural.co/public/reference/getworkspace
+      def retrieve(workspace_id)
+        json = get("/api/public/v1/workspaces/#{workspace_id}")
+
+        ::Mural::Workspace.decode(json['value'])
+      end
+    end
+  end
+end

data/lib/mural/client.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Mural
+  class Client
+    include ::Mural::Client::Authentication
+
+    ENV_VARS = {
+      host: 'MURAL_HOST',
+      client_id: 'MURAL_CLIENT_ID',
+      client_secret: 'MURAL_CLIENT_SECRET',
+      redirect_uri: 'MURAL_REDIRECT_URI',
+      scope: 'MURAL_SCOPE',
+      access_token: 'MURAL_ACCESS_TOKEN',
+      refresh_token: 'MURAL_REFRESH_TOKEN'
+    }.freeze
+
+    def self.from_env
+      new.tap do |client|
+        ENV_VARS.each do |attr, env_var|
+          value = ENV.fetch(env_var, nil)
+
+          client.public_send(:"#{attr}=", value) unless value.nil?
+        end
+      end
+    end
+
+    ENV_VARS.each_key do |attr|
+      attr_accessor(attr)
+    end
+
+    attr_reader :mural_content, :murals, :rooms, :search, :templates, :users,
+                :workspaces
+
+    def initialize
+      @host = 'app.mural.co'
+
+      @mural_content = Mural::Client::MuralContent.new(self)
+      @murals = Mural::Client::Murals.new(self)
+      @rooms = Mural::Client::Rooms.new(self)
+      @search = Mural::Client::Search.new(self)
+      @templates = Mural::Client::Templates.new(self)
+      @users = Mural::Client::Users.new(self)
+      @workspaces = Mural::Client::Workspaces.new(self)
+    end
+
+    def get(path, query = {})
+      uri = URI::HTTPS.build(
+        host: host,
+        path: path,
+        query: URI.encode_www_form(query.compact)
+      )
+
+      req = Net::HTTP::Get.new uri
+      # retryable_request(req)
+      retryable_request(req)
+    end
+
+    def post(path, body = {})
+      uri = URI::HTTPS.build(host: host, path: path)
+      req = Net::HTTP::Post.new(uri)
+      req['Content-Type'] = 'application/json'
+      req.body = body.compact.to_json
+
+      retryable_request(req)
+    end
+
+    def patch(path, body = {})
+      uri = URI::HTTPS.build(host: host, path: path)
+      req = Net::HTTP::Patch.new(uri)
+      req['Content-Type'] = 'application/json'
+      req.body = body.compact.to_json
+
+      retryable_request(req)
+    end
+
+    def delete(path)
+      uri = URI::HTTPS.build(host: host, path: path)
+      req = Net::HTTP::Delete.new(uri)
+
+      retryable_request(req)
+    end
+
+    private
+
+    def retryable_request(request)
+      res = authorized_request(request)
+      return if res.is_a?(Net::HTTPNoContent)
+
+      data = JSON.parse(res.body)
+      raise to_error(data) unless res.is_a?(Net::HTTPOK) ||
+                                  res.is_a?(Net::HTTPCreated)
+
+      data
+    rescue StandardError => e
+      raise unless e.respond_to?(:code) && e.code == 'TOKEN_EXPIRED'
+
+      refresh
+      retry
+    end
+
+    def authorized_request(request)
+      Net::HTTP.start(
+        request.uri.host,
+        request.uri.port,
+        use_ssl: request.uri.scheme == 'https'
+      ) do |http|
+        request['Authorization'] = "Bearer #{access_token}"
+        http.request request
+      end
+    end
+
+    def to_error(data)
+      message = data.fetch('message', 'unknown error')
+      code = data.fetch('code', 'unknown code')
+
+      Mural::Error.new(message, code: code, details: data['details'])
+    end
+  end
+end

data/lib/mural/codec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mural
+  # Utility module to convert from lowerCamelCase JSON to Ruby classes with
+  # proper accessors (using snake_case) and vice versa when building a payload
+  # to Mural.
+  module Codec
+    def encode
+      {}.tap do |json|
+        self.class.attrs.each do |attr, remote_attr|
+          value = public_send(attr)
+
+          json[remote_attr] = value unless value.nil?
+        end
+      end
+    end
+
+    module ClassMethods
+      def attrs
+        @attrs ||= {}
+      end
+
+      def define_attributes(values)
+        @attrs = values.freeze
+
+        attrs.each_key { |attr| attr_accessor(attr) }
+      end
+
+      def decode(json)
+        return if json.nil?
+
+        new.tap do |instance|
+          attrs.each do |attr, remote_attr|
+            instance.public_send(:"#{attr}=", json[remote_attr])
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/mural/create_mural_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mural
+  class CreateMuralParams
+    include Mural::Codec
+
+    define_attributes(
+      title: 'title',
+      room_id: 'roomId', # required
+      # 👇 Rejected by the API (invalid "backgroundColor" property was sent)
+      # background_color: 'backgroundColor',
+      folder_id: 'folderId',
+      height: 'height',
+      infinite: 'infinite',
+      width: 'width',
+      visitors_settings: 'visitorsSettings',
+      timer_sound_theme: 'timerSoundTheme',
+      visitor_avatar_theme: 'visitorAvatarTheme'
+    )
+
+    def encode
+      super.tap do |json|
+        json['visitorsSettings'] = json['visitorsSettings']&.encode
+      end
+    end
+
+    class VisitorsSettings
+      include Mural::Codec
+
+      define_attributes(expires_on: 'expiresOn')
+    end
+  end
+end

data/lib/mural/create_room_params.rb

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

data/lib/mural/create_sticky_note_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mural
+  class CreateStickyNoteParams
+    include Mural::Codec
+
+    define_attributes(
+      **Mural::Widget::StickyNote.attrs.reject do |attr|
+        %i[
+          content_edited_by
+          content_edited_on
+          created_by
+          created_on
+          hide_editor
+          hide_owner
+          id
+          invisible
+          locked
+          locked_by_facilitator
+          min_lines
+          type
+          updated_by
+          updated_on
+        ].include?(attr)
+      end
+    )
+
+    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