amazon-chime-sdk-rails 1.0.0

data/lib/chime_sdk/controller/meetings.rb

@@ -0,0 +1,192 @@
+module ChimeSdk
+  module Controller
+    # Meetings controller implementation by amazon-chime-sdk-rails.
+    module Meetings
+      # Controller implementation to be included in custom meetings controllers.
+      module Mixin
+        extend ActiveSupport::Concern
+
+        included do
+          include ChimeSdk::Controller::Common
+          include ActionController::MimeResponds
+          helper_method :meeting_resources_path, :meeting_resource_path, :attendee_resources_path, :attendee_resource_path, :application_attendee_name
+        end
+
+        # GET /meetings
+        # GET /meetings.json
+        # @overload index(params)
+        #   @param [Hash] params Request parameter options
+        #   @option params [String] :create_meeting (ChimeSdk.config.create_meeting_by_get_request) Whether the application creates meeting in this meetings#index action by HTTP GET request
+        def index
+          if params[:create_meeting].to_s.to_boolean(false) || ChimeSdk.config.create_meeting_by_get_request
+            create
+          else
+            list_meetings
+            respond_to do |format|
+              format.html
+              format.json { render json: { meetings: @meetings } }
+            end
+          end
+        end
+
+        # GET /meetings/:meeting_id
+        # GET /meetings/:meeting_id.json
+        # @overload show(params)
+        #   @param [Hash] params Request parameter options
+        #   @option params [String] :create_attendee_from_meeting (ChimeSdk.config.create_attendee_from_meeting) Whether the application creates attendee from meeting in meetings#show action
+        def show
+          get_meeting
+          if params[:create_attendee_from_meeting].to_s.to_boolean(false) || ChimeSdk.config.create_attendee_from_meeting
+            create_attendee_from_meeting
+          end
+          respond_to do |format|
+            format.html
+            format.json { render json: @meeting }
+          end
+        end
+
+        # POST /meetings
+        # POST /meetings.json
+        # @overload create(params)
+        #   @param [Hash] params Request parameter options
+        #   @option params [String] :create_meeting_with_attendee (ChimeSdk.config.create_meeting_with_attendee) Whether the application creates meeting with attendee in this meetings#create action
+        def create
+          if params[:create_meeting_with_attendee].to_s.to_boolean(false) || ChimeSdk.config.create_meeting_with_attendee
+            create_meeting_with_attendee
+          else
+            create_meeting
+          end
+          respond_to do |format|
+            format.html { redirect_to meeting_resource_path(meeting_id), notice: "Meeting <#{meeting_id}> was successfully created." }
+            format.json { render status: 201, json: @meeting.merge(@attendee || {}) }
+          end
+        end
+
+        # DELETE /meetings/:meeting_id
+        # DELETE /meetings/:meeting_id.json
+        def destroy
+          delete_meeting
+          respond_to do |format|
+            format.html { redirect_to meeting_resources_path, notice: "Meeting <#{meeting_id}> was successfully destroyed." }
+            format.json { head 204 }
+          end
+        end
+
+        protected
+        # Override the following functions in your controllers
+        # :nocov:
+
+        # Request parameter representing meeting id such as params[:id].
+        # Configure it depending on your application routes.
+        # @api protected
+        # @return [String, Integer] Meeting id from request parameter
+        def meeting_id_param
+          params[:id]
+        end
+
+        # Unique meeting request id to identify meeting by Amazon Chime.
+        # Configure it depending on your application resources to identify meeting.
+        # For example, set "PrivateRoom-#{@room.id}" by Room model.
+        # @api protected
+        # @return [String] Unique meeting request id to identify meeting by Amazon Chime
+        def meeting_request_id
+          "default"
+        end
+
+        # Unique attendee request id to identify attendee by Amazon Chime.
+        # Configure it depending on your application resources to identify attendee.
+        # For example, set "User-#{current_user.id}" by User model.
+        # @api protected
+        # @return [String] Unique attendee request id to identify attendee by Amazon Chime
+        def attendee_request_id
+          "default"
+        end
+
+        # Path for meetings#index action such as meetings_path.
+        # Configure it depending on your application routes.
+        # @api protected
+        # @param [Hash] params Request parameters for path method
+        # @return [String] Path for meetings#index action such as meetings_path
+        def meeting_resources_path(params = {})
+          meetings_path(params)
+        end
+
+        # Path for meetings#show action such as meeting_path(meeting_id).
+        # Configure it depending on your application routes.
+        # @api protected
+        # @param [String] meeting_id Meeting id
+        # @param [Hash] params Request parameters for path method
+        # @return [String] Path for meetings#show action such as meeting_path(meeting_id)
+        def meeting_resource_path(meeting_id, params = {})
+          meeting_path(meeting_id, params)
+        end
+
+        # Path for attendees#index action such as attendees_path(meeting_id).
+        # Configure it depending on your application routes.
+        # @api protected
+        # @param [String] meeting_id Meeting id
+        # @param [Hash] params Request parameters for path method
+        # @return [String] Path for attendees#index action such as attendees_path(meeting_id)
+        def attendee_resources_path(meeting_id, params = {})
+          attendees_path(meeting_id, params)
+        end
+
+        # Path for attendees#show action such as attendee_path(meeting_id, attendee_id).
+        # Configure it depending on your application routes.
+        # @api protected
+        # @param [String] meeting_id Meeting id
+        # @param [String] attendee_id Attendee id
+        # @param [Hash] params Request parameters for path method
+        # @return [String] Path for attendees#index action such as attendees_path(meeting_id)
+        def attendee_resource_path(meeting_id, attendee_id, params = {})
+          attendee_path(meeting_id, attendee_id, params)
+        end
+
+        # Optional meeting tags to pass to Amazon Chime.
+        # This is an optional parameter and configure it depending on your application.
+        # @api protected
+        # @return [Array<Hash>] Optional tags for meetings
+        def optional_meeting_tags
+          []
+        end
+
+        # Optional attendee tags to pass to Amazon Chime.
+        # This is an optional parameter and configure it depending on your application.
+        # @api protected
+        # @return [Array<Hash>] Optional tags for attendees
+        def optional_attendee_tags
+          []
+        end
+
+        # Appication metadata that meetings API returns as JSON response included in meeting resource.
+        # This is an optional parameter and configure it depending on your application.
+        # @api protected
+        # @param [Hash] meeting Meeting JSON object as hash
+        # @return [Hash] Appication metadata for meetings
+        def application_meeting_metadata(meeting)
+          {}
+        end
+
+        # Appication metadata that attendees API returns as JSON response included in attendee resource.
+        # This is an optional parameter and configure it depending on your application.
+        # @api protected
+        # @param [Hash] attendee Attendee JSON object as hash
+        # @return [Hash] Appication metadata for attendees
+        def application_attendee_metadata(attendee)
+          {}
+        end
+
+        # Application attendee name to resolve from attendee object in your view.
+        # This is an optional parameter and configure it depending on your application.
+        # @api protected
+        # @param [Hash] attendee Attendee JSON object as hash
+        # @return [String] Appication attendee name to resolve from attendee object in your view
+        def application_attendee_name(attendee)
+          attendee[:Attendee][:AttendeeId]
+        end
+
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/chime_sdk/meeting_coordinator.rb

@@ -0,0 +1,184 @@
+module ChimeSdk
+  # Meeting coordinator as a wrapper module of AWS SDK for Ruby, which simulates AWS SDK for JavaScript.
+  # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html Aws::Chime::Client of AWS SDK for Ruby
+  # @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Chime.html AWS.Chime of AWS SDK for JavaScript
+  module MeetingCoordinator
+    require 'aws-sdk-chime'
+
+    # Return initialized Aws::Chime::Client.
+    # You must use "us-east-1" as the region for Chime API and set the endpoint.
+    # @return [Aws::Chime::Client] Initialized Aws::Chime::Client instance
+    # @see https://aws.github.io/amazon-chime-sdk-js/modules/gettingstarted.html
+    def self.client
+      @@client ||= Aws::Chime::Client.new(region: 'us-east-1')
+    end
+
+    # Reset client with initialized Aws::Chime::Client instance.
+    # @param [Aws::Chime::Client] client Initialized Aws::Chime::Client instance
+    # @return [Aws::Chime::Client] Initialized Aws::Chime::Client instance
+    def self.reset_client(client)
+      @@client = client
+    end
+
+    # Wrapper of Aws::Chime::Client#list_meetings method.
+    # This function also provides prefix match filter of external_meeting_id.
+    # This method filters the result with ChimeSdk.config.prefix to return only meetings in your application.
+    # @param [Integer] max_results (ChimeSdk.config.max_meeting_results) The maximum number of results to return in a single call
+    # @param [String] prefix_filter (nil) Additional string for prefix match filter of external_meeting_id
+    # @return [Array<Hash>] Array of filtered meeting JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#list_meetings-instance_method Aws::Chime::Client#list_meetings of AWS SDK for Ruby
+    def self.list_meetings(
+      max_results: ChimeSdk.config.max_meeting_results,
+      prefix_filter: nil
+    )
+      resp = client.list_meetings({
+        max_results: max_results
+      })
+      meetings = resp.meetings
+      meetings = meetings.select { |meeting| meeting.external_meeting_id.start_with?(ChimeSdk.config.prefix + prefix_filter) } if prefix_filter
+      meetings.map { |meeting| meeting_as_json(meeting) }
+    end
+
+    # Wrapper of Aws::Chime::Client#create_meeting method.
+    # This method uses 'ChimeSdk.config.prefix + meeting_request_id' for client_request_token and external_meeting_id.
+    # @param [required, String] meeting_request_id The unique identifier for the client request. Use a different token for different meetings.
+    # @param [String] meeting_host_id (nil) Reserved
+    # @param [String] media_region (ChimeSdk.config.media_region) The Region in which to create the meeting
+    # @param [Array<Aws::Chime::Types::Tag>] tags (nil) The tag key-value pairs
+    # @param [Aws::Chime::Types::MeetingNotificationConfiguration] notifications_configuration (nil) The configuration for resource targets to receive notifications when meeting and attendee events occur
+    # @return [Hash] Created meeting JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#create_meeting-instance_method Aws::Chime::Client#create_meeting of AWS SDK for Ruby
+    def self.create_meeting(meeting_request_id,
+      meeting_host_id: nil,
+      media_region: ChimeSdk.config.media_region,
+      tags: [],
+      notifications_configuration: {}
+    )
+      resp = client.create_meeting({
+        client_request_token: ChimeSdk.config.prefix + meeting_request_id,
+        external_meeting_id: ChimeSdk.config.prefix + meeting_request_id,
+        meeting_host_id: meeting_host_id,
+        media_region: media_region,
+        tags: tags,
+        notifications_configuration: notifications_configuration
+      })
+      meeting_as_json(resp.meeting)
+    end
+
+    # Wrapper of Aws::Chime::Client#get_meeting method.
+    # @param [required, String] meeting_id The Amazon Chime SDK meeting ID
+    # @return [Hash] Meeting JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#get_meeting-instance_method Aws::Chime::Client#get_meeting of AWS SDK for Ruby
+    def self.get_meeting(meeting_id)
+      resp = client.get_meeting({
+        meeting_id: meeting_id
+      })
+      meeting_as_json(resp.meeting)
+    end
+
+    # Wrapper of Aws::Chime::Client#delete_meeting method.
+    # @param [required, String] meeting_id The Amazon Chime SDK meeting ID
+    # @return [void]
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#delete_meeting-instance_method Aws::Chime::Client#delete_meeting of AWS SDK for Ruby
+    def self.delete_meeting(meeting_id)
+      client.delete_meeting({
+        meeting_id: meeting_id
+      })
+    end
+
+    # Wrapper of Aws::Chime::Client#list_attendees method.
+    # @param [required, String] meeting_id The Amazon Chime SDK meeting ID
+    # @param [Integer] max_results (ChimeSdk.config.max_attendee_results) The maximum number of results to return in a single call
+    # @return [Array<Hash>] Array of attendee JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#list_attendees-instance_method Aws::Chime::Client#list_attendees of AWS SDK for Ruby
+    def self.list_attendees(meeting_id,
+      max_results: ChimeSdk.config.max_attendee_results
+    )
+      resp = client.list_attendees({
+        meeting_id: meeting_id,
+        max_results: max_results
+      })
+      resp.attendees.map { |attendee| attendee_as_json(attendee) }
+    end
+
+    # Wrapper of Aws::Chime::Client#create_attendee method.
+    # This method uses 'ChimeSdk.config.prefix + attendee_request_id' for external_user_id.
+    # @param [required, String] meeting_id The Amazon Chime SDK meeting ID
+    # @param [required, String] attendee_request_id Part of the Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
+    # @return [Hash] Created attendee JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#create_attendee-instance_method Aws::Chime::Client#create_attendee of AWS SDK for Ruby
+    def self.create_attendee(meeting_id, attendee_request_id, tags: [])
+      resp = client.create_attendee({
+        meeting_id: meeting_id,
+        external_user_id: ChimeSdk.config.prefix + attendee_request_id,
+        tags: tags
+      })
+      attendee_as_json(resp.attendee)
+    end
+
+    # Wrapper of Aws::Chime::Client#get_attendee method.
+    # @param [required, String] meeting_id The Amazon Chime SDK meeting ID
+    # @param [required, String] attendee_id The Amazon Chime SDK attendee ID
+    # @return [Hash] Attendee JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#get_attendee-instance_method Aws::Chime::Client#get_attendee of AWS SDK for Ruby
+    def self.get_attendee(meeting_id, attendee_id)
+      resp = client.get_attendee({
+        meeting_id: meeting_id,
+        attendee_id: attendee_id
+      })
+      attendee_as_json(resp.attendee)
+    end
+
+    # Wrapper of Aws::Chime::Client#delete_attendee method.
+    # @param [required, String] attendee_id The Amazon Chime SDK attendee ID
+    # @return [void]
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#delete_attendee-instance_method Aws::Chime::Client#delete_attendee of AWS SDK for Ruby
+    def self.delete_attendee(meeting_id, attendee_id)
+      client.delete_attendee({
+        meeting_id: meeting_id,
+        attendee_id: attendee_id
+      })
+    end
+    
+    # Build meeting JSON object as hash from Aws::Chime::Types::Meeting object
+    # @param [required, Aws::Chime::Types::Meeting] meeting Meeting response as Aws::Chime::Types::Meeting object
+    # @return [Hash] Meeting JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#get_meeting-instance_method Aws::Chime::Client#get_meeting of AWS SDK for Ruby
+    # @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Chime.html#getMeeting-property AWS.Chime#getMeeting of AWS SDK for JavaScript
+    def self.meeting_as_json(meeting)
+      return {} unless meeting.is_a?(Aws::Chime::Types::Meeting)
+      {
+        "Meeting": {
+          "MeetingId": meeting.meeting_id,
+          "ExternalMeetingId": meeting.external_meeting_id,
+          "MediaPlacement": {
+            "AudioHostUrl": meeting.media_placement.audio_host_url,
+            "AudioFallbackUrl": meeting.media_placement.audio_fallback_url,
+            "ScreenDataUrl": meeting.media_placement.screen_data_url,
+            "ScreenSharingUrl": meeting.media_placement.screen_sharing_url,
+            "ScreenViewingUrl": meeting.media_placement.screen_viewing_url,
+            "SignalingUrl": meeting.media_placement.signaling_url,
+            "TurnControlUrl": meeting.media_placement.turn_control_url
+          },
+          "MediaRegion": meeting.media_region
+        }
+      }
+    end
+
+    # Build attendee JSON object as hash from Aws::Chime::Types::Attendee object
+    # @param [required, Aws::Chime::Types::Attendee] attendee Attendee response as Aws::Chime::Types::Attendee object
+    # @return [Hash] Attendee JSON object as hash
+    # @see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Chime/Client.html#get_attendee-instance_method Aws::Chime::Client#get_attendee of AWS SDK for Ruby
+    # @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Chime.html#getAttendee-property AWS.Chime#getAttendee of AWS SDK for JavaScript
+    def self.attendee_as_json(attendee)
+      return {} unless attendee.is_a?(Aws::Chime::Types::Attendee)
+      {
+        "Attendee": {
+          "ExternalUserId": attendee.external_user_id,
+          "AttendeeId": attendee.attendee_id,
+          "JoinToken": attendee.join_token
+        }
+      }
+    end
+  end
+end

data/lib/chime_sdk/version.rb

@@ -0,0 +1,4 @@
+module ChimeSdk
+  # Gem version of amazon-chime-sdk-rails
+  VERSION = "1.0.0"
+end

data/lib/generators/chime_sdk/controllers_generator.rb

@@ -0,0 +1,104 @@
+require 'rails/generators/base'
+
+module ChimeSdk
+  module Generators
+    # Controller generator to copy customizable meetings and attendees controller files from templates.
+    # @example Run controller generator as default name
+    #   rails generate chime_sdk:controllers
+    # @example Run controller generator with prefix as 'room'
+    #   rails generate chime_sdk:controllers room
+    # @example Run controller generator with parent option as 'room'
+    #   rails generate chime_sdk:controllers -r room
+    # @example Run controller generator with namespace option as 'api'
+    #   rails generate chime_sdk:controllers -n api
+    class ControllersGenerator < Rails::Generators::Base
+      desc <<-DESC.strip_heredoc
+        Create meetings and attendees controllers for Amazon Chime SDK in your app/controllers folder.
+
+        Example:
+
+          rails generate chime_sdk:controllers
+
+        You can specify prefix of controllers name like this:
+
+          rails generate chime_sdk:controllers room
+
+        Then, meeting controller class will be generated as app/controllers/room_meetings_controller.rb like this:
+
+          class RoomMeetingsController < ApplicationController
+            include ChimeSdk::Controller::Meetings::Mixin
+            def meeting_resources_path(params = {})
+              room_meetings_path(@room, params)
+            end
+            ...
+          end
+
+        Use --parent option to specify parent resource of meetings. If you specify prefix of controllers name, parent option will be ignored.
+
+          rails generate chime_sdk:controllers --parent room
+
+        Then, meeting controller class will be generated as app/controllers/meetings_controller.rb like this:
+
+          class MeetingsController < ApplicationController
+            include ChimeSdk::Controller::Meetings::Mixin
+            def meeting_resources_path(params = {})
+              room_meetings_path(@room, params)
+            end
+            ...
+          end
+
+        Use --namespace option to specify namespace of generated controllers.
+
+          rails generate chime_sdk:controllers --namespace api
+  
+        Then, meeting controller class will be generated as app/controllers/api/meetings_controller.rb like this:
+
+          class Api::MeetingsController < ApplicationController
+            include ChimeSdk::Controller::Meetings::Mixin
+            def meeting_resources_path(params = {})
+              api_meetings_path(params)
+            end
+            ...
+          end
+
+        Use --controllers option to specify which controller you want to generate. If you do no specify a controller, all controllers will be created.
+
+          rails generate chime_sdk:controllers --controllers meetings
+      DESC
+
+      # Controllers to be generated
+      CONTROLLERS = ['meetings', 'meeting_attendees'].freeze
+
+      source_root File.expand_path("../../templates/controllers", __FILE__)
+      argument :prefix, required: false,
+        desc: "Prefix of controllers name, e.g. room"
+      class_option :parent, aliases: "-r", type: :string,
+        desc: "Parent resource of generated controllers, e.g. room"
+      class_option :namespace, aliases: "-n", type: :string,
+        desc: "Namespace of generated controllers, e.g. api"
+      class_option :controllers, aliases: "-c", type: :array,
+        desc: "Select specific controllers to generate (#{CONTROLLERS.join(', ')})"
+
+      # Generate controller files in application directory
+      def generate_controllers
+        @namespace = options[:namespace].blank? ? '' : "#{options[:namespace].camelize}::"
+        @class_name_prefix = prefix.blank? ? '' : prefix.singularize.camelize
+        @param_name_prefix = prefix.blank? ? '' : "#{prefix.singularize.underscore}_"
+        parent_resource = prefix.present? ? prefix.singularize.underscore : (options[:parent].blank? ? '' : options[:parent].singularize.underscore)
+        @path_name_prefix = (options[:namespace].blank? ? '' : "#{options[:namespace].singularize.underscore}_") + (parent_resource.blank? ? '' : "#{parent_resource}_")
+        @path_args_prefix = parent_resource.blank? ? '' : "@#{parent_resource}, "
+        @default_meeting_request_id = parent_resource.blank? ? 'default' : "#{parent_resource.camelize}-#{'#'}{@#{parent_resource}.id}"
+        file_name_prefix = (options[:namespace].blank? ? '' : "#{options[:namespace].underscore}/") + @param_name_prefix
+        controllers = options[:controllers] || CONTROLLERS
+        controllers.each do |name|
+          template "#{name}_controller.rb", "app/controllers/#{file_name_prefix}#{name}_controller.rb"
+        end
+      end
+
+      # Show readme after generated controllers
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end