amazon-chime-sdk-rails 1.0.0

data/lib/generators/chime_sdk/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/base'
+
+module ChimeSdk
+  # Generators implementation by amazon-chime-sdk-rails.
+  module Generators #:nodoc:
+    # Install generator to copy initializer to rails application.
+    # @example Run install generator
+    #   rails generate chime_sdk:install
+    class InstallGenerator < Rails::Generators::Base
+      desc <<-DESC.strip_heredoc
+        Create chime_sdk initializer in your application.
+
+        Example:
+
+          rails generate chime_sdk:insall
+
+      DESC
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      # Copies initializer file in application directory
+      def copy_initializer
+        template "chime_sdk.rb", "config/initializers/chime_sdk.rb"
+      end
+    end
+  end
+end

data/lib/generators/chime_sdk/js_generator.rb

@@ -0,0 +1,67 @@
+require 'rails/generators/base'
+
+module ChimeSdk
+  module Generators
+    # Amazon Chime SDK single .js file generator.
+    # Bundle Amazon Chime SDK into single amazon-chime-sdk.min.js file and copy it to app/assets/javascripts directory.
+    # @example Run Amazon Chime SDK single .js file generator
+    #   rails generate chime_sdk:js
+    # @see https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/singlejs
+    class JsGenerator < Rails::Generators::Base
+      desc <<-DESC.strip_heredoc
+        Bundle Amazon Chime SDK into single amazon-chime-sdk.min.js file and copy it to app/assets/javascripts directory.
+
+        Example:
+
+          rails generate chime_sdk:js
+
+        This generator requires npm installation.
+
+      DESC
+
+      source_root File.expand_path('./')
+
+      # Build amazon-chime-sdk.min.js and copy it to app/assets/javascripts directory
+      def build_and_copy_chime_sdk_js
+        # :nocov:
+        begin
+          node_version = Gem::Version.new(`node -v`.delete("v"))
+          puts "Found Node v#{node_version}"
+          if node_version < Gem::Version.new("10")
+            puts "Amazon Chime SDK single .js file generator requires Node 10+. Update Node before running."
+            return
+          end
+        rescue StandardError => e
+          puts "Amazon Chime SDK single .js file generator requires Node. Install Node before running."
+          return
+        end
+        begin
+          npm_version = Gem::Version.new(`npm -v`)
+          puts "Found npm v#{npm_version}"
+          if npm_version < Gem::Version.new("6.11")
+            puts "Amazon Chime SDK single .js file generator requires npm 6.11+. Update npm before running."
+            return
+          end
+        rescue StandardError => e
+          puts "Amazon Chime SDK single .js file generator requires npm. Install npm before running."
+          return
+        end
+        # :nocov:
+
+        `mkdir -p tmp`
+        puts "Cloning into 'amazon-chime-sdk-js' git repository in tmp directory ..."
+        `cd tmp; git clone https://github.com/aws/amazon-chime-sdk-js.git > /dev/null 2>&1`
+        puts "Running 'npm install @rollup/plugin-commonjs' in the repository ..."
+        `cd tmp/amazon-chime-sdk-js/demos/singlejs; npm install @rollup/plugin-commonjs > /dev/null 2>&1`
+        puts "Running 'npm run bundle' in the repository ..."
+        `cd tmp/amazon-chime-sdk-js/demos/singlejs; npm run bundle > /dev/null 2>&1`
+        puts "Built Amazon Chime SDK as amazon-chime-sdk.min.js"
+        copy_file "tmp/amazon-chime-sdk-js/demos/singlejs/build/amazon-chime-sdk.min.js", "app/assets/javascripts/amazon-chime-sdk.min.js"
+        copy_file "tmp/amazon-chime-sdk-js/demos/singlejs/build/amazon-chime-sdk.min.js.map", "app/assets/javascripts/amazon-chime-sdk.min.js.map"
+        `rm -rf tmp/amazon-chime-sdk-js`
+        puts "Cleaned up the repository in tmp directory"
+        puts "Completed"
+      end
+    end
+  end
+end

data/lib/generators/chime_sdk/views_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators/base'
+
+module ChimeSdk
+  module Generators
+    # View generator to copy customizable meetings view files from templates.
+    # @example Run view generator as default name
+    #   rails generate chime_sdk:views
+    # @example Run view generator as room prefix
+    #   rails generate chime_sdk:views rooms
+    class ViewsGenerator < Rails::Generators::Base
+      desc <<-DESC.strip_heredoc
+        Create meetings views for Amazon Chime SDK in your app/views folder.
+
+        Example:
+
+          rails generate chime_sdk:views
+
+        Views files will be generated in app/views/meetings directory.
+        You can also specify prefix of views name like this:
+
+          rails generate chime_sdk:views room
+
+        Then, views files will be generated in app/views/room_meetings directory.
+      DESC
+
+      # Views to be generated
+      VIEWS = [:meetings].freeze
+
+      source_root File.expand_path("../../templates/views", __FILE__)
+      argument :prefix, required: false,
+        desc: "Prefix of view directory name, e.g. room"
+
+      # Generate view files in application directory
+      def generate_views
+        target_views = VIEWS
+        file_prefix = prefix.blank? ? '' : prefix.singularize.underscore + '_'
+        target_views.each do |name|
+          directory name, "app/views/#{file_prefix}#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/chime_sdk.rb

@@ -0,0 +1,28 @@
+ChimeSdk.configure do |config|
+  # Configure application name for unique key and metadata of Chime SDK meetings and attendees.
+  # Do not use '-' in this application name since it is a delimiter.
+  config.application_name = 'ChimeSdkRailsApp'
+
+  # Configure media region to host Chime SDK meetings.
+  # Default value is 'us-east-1'.
+  config.media_region = 'us-east-1'
+
+  # Configure prefix to make unique key of Chime SDK meetings and attendees.
+  # Default value is "#{config.application_name}-#{Rails.env}-".
+  config.prefix = "#{config.application_name}-#{Rails.env}-"
+
+  # Configure default max_results value used in list_meetings API.
+  config.max_meeting_results = 10
+
+  # Configure default max_results value used in list_attendees API.
+  config.max_attendee_results = 10
+
+  # Configure whether the application creates meeting with attendee in meetings#create action.
+  config.create_meeting_with_attendee = true
+
+  # Configure whether the application creates attendee from meeting in meetings#show action.
+  config.create_attendee_from_meeting = true
+
+  # Configure whether the application creates meeting in meetings#index action by HTTP GET request.
+  config.create_meeting_by_get_request = false
+end

data/lib/generators/templates/controllers/README

@@ -0,0 +1,35 @@
+===============================================================================
+
+Routing setup you must do manually if you haven't yet:
+
+  Rails.application.routes.draw do
+    resources :meetings, only: [:index, :show, :create, :destroy] do
+      resources :meeting_attendees, as: :attendees, path: :attendees, only: [:index, :show]
+    end
+  end
+
+Examples:
+
+If you generated controllers with room as parent resource by --parent option, setup routes like this:
+
+  Rails.application.routes.draw do
+    resources :rooms do
+      resources :meetings, only: [:index, :show, :create, :destroy] do
+        resources :meeting_attendees, as: :attendees, path: :attendees, only: [:index, :show]
+      end
+    end
+  end
+
+If you generated controllers for Rails API with api as namespace by --namespace option, setup routes like this:
+
+  Rails.application.routes.draw do
+    namespace :api do
+      scope :"v1" do
+        resources :meetings, defaults: { format: :json }, only: [:index, :show, :create, :destroy] do
+          resources :meeting_attendees, as: :attendees, path: :attendees, only: [:index, :show, :create, :destroy]
+        end
+      end
+    end
+  end
+
+===============================================================================

data/lib/generators/templates/controllers/meeting_attendees_controller.rb

@@ -0,0 +1,106 @@
+# Generated by amazon-chime-sdk-rails
+
+class <%= @namespace %><%= @class_name_prefix %>MeetingAttendeesController < ApplicationController
+
+  include ChimeSdk::Controller::Attendees::Mixin
+
+  private
+  # Override the following functions in your controllers.
+
+  # Request parameter representing meeting id such as params[:meeting_id].
+  # Configure it depending on your application routes.
+  # @api protected
+  # @return [String, Integer] Meeting id from request parameter
+  def meeting_id_param
+    params[:<%= @param_name_prefix %>meeting_id]
+  end
+
+  # Request parameter representing attendee id such as params[:id].
+  # Configure it depending on your application routes.
+  # @api protected
+  # @return [String] Unique meeting request id to identify meeting by Amazon Chime
+  # def attendee_id_param
+  #   params[:id]
+  # 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
+    # "User-#{current_user.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 = {})
+    <%= @path_name_prefix %>meetings_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_attendees_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_attendee_path(<%= @path_args_prefix %>meeting_id, attendee_id, params)
+  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] meeting Attendee JSON object as hash
+  # @return [Array<Hash>] Appication metadata for attendees
+  # def optional_attendee_tags
+  #   [
+  #     {
+  #       key: "AttendeeType",
+  #       value: "User"
+  #     },
+  #     {
+  #       key: "UserId",
+  #       value: current_user.id.to_s
+  #     }
+  #   ]
+  # 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] meeting Attendee JSON object as hash
+  # @return [Hash] Appication metadata for attendees
+  # def application_attendee_metadata(attendee)
+  #   user_id = attendee[:Attendee][:ExternalUserId].split('-')[3]
+  #   {
+  #     "AttendeeType": "User",
+  #     "User": User.find_by_id(user_id)
+  #   }
+  # end
+end

data/lib/generators/templates/controllers/meetings_controller.rb

@@ -0,0 +1,146 @@
+# Generated by amazon-chime-sdk-rails
+
+class <%= @namespace %><%= @class_name_prefix %>MeetingsController < ApplicationController
+
+  include ChimeSdk::Controller::Meetings::Mixin
+
+  private
+  # Override the following functions in your controllers.
+
+  # 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
+    # "PrivateRoom-#{@room.id}"
+    "<%= @default_meeting_request_id %>"
+  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
+    # "User-#{current_user.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 = {})
+    <%= @path_name_prefix %>meetings_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_attendees_path(<%= @path_args_prefix %>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 = {})
+    <%= @path_name_prefix %>meeting_attendee_path(<%= @path_args_prefix %>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
+  #   [
+  #     {
+  #       key: "MeetingType",
+  #       value: "PrivateRoom"
+  #     },
+  #     {
+  #       key: "RoomId",
+  #       value: @room.id.to_s
+  #     }
+  #   ]
+  # 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
+  #   [
+  #     {
+  #       key: "AttendeeType",
+  #       value: "User"
+  #     },
+  #     {
+  #       key: "UserId",
+  #       value: current_user.id.to_s
+  #     }
+  #   ]
+  # 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)
+  #   {
+  #     "MeetingType": "PrivateRoom",
+  #     "Room": @room
+  #   }
+  # 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] meeting Attendee JSON object as hash
+  # @return [Hash] Appication metadata for attendees
+  # def application_attendee_metadata(attendee)
+  #   user_id = attendee[:Attendee][:ExternalUserId].split('-')[3]
+  #   {
+  #     "AttendeeType": "User",
+  #     "User": User.find_by_id(user_id)
+  #   }
+  # 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] meeting 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][:ApplicationMetadata][:User][:name]
+    attendee[:Attendee][:AttendeeId]
+  end
+end