amazon-chime-sdk-rails 1.0.0

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require File.expand_path('../spec/rails_app/config/application', __FILE__)
+Rails.application.load_tasks
+
+require 'yard'
+desc 'Generate documentation for amazon-chime-sdk-rails plugin.'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+end
+
+# Define dummy module for Rake tasks
+require 'devise_token_auth'
+unless defined?(DeviseTokenAuth::Concerns::User)
+  module DeviseTokenAuth::Concerns
+    module User
+    end
+  end
+end

data/amazon-chime-sdk-rails.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "chime_sdk/version"
+
+Gem::Specification.new do |s|
+  s.name          = "amazon-chime-sdk-rails"
+  s.version       = ChimeSdk::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Shota Yamazaki"]
+  s.email         = ["shota.yamazaki.8@gmail.com"]
+  s.homepage      = "https://github.com/simukappu/amazon-chime-sdk-rails"
+  s.summary       = "Server-side implementation of Amazon Chime SDK for Ruby on Rails application"
+  s.description   = "amazon-chime-sdk-rails provides server-side API implementation for Amazon Chime SDK as wrapper functions of AWS SDK for Ruby, and basic controller implementation for Ruby on Rails application."
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_dependency 'railties', '>= 5.0.0'
+  s.add_dependency 'aws-sdk-chime', '>= 1.0.0'
+
+  s.add_development_dependency 'rspec-rails', '>= 4.0.1'
+  s.add_development_dependency 'factory_bot_rails', '>= 6.1.0'
+  s.add_development_dependency 'ammeter', '>= 1.1.4'
+  s.add_development_dependency 'yard', '>= 0.9.25'
+  s.add_development_dependency 'devise_token_auth', '>= 1.1.4'
+end

data/gemfiles/Gemfile.rails-5.0

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+# Bundle Rails
+gem 'rails', '~> 5.0.0'
+
+gem 'sqlite3', '~> 1.3.0'
+gem 'puma'
+gem 'sass-rails'
+gem 'webpacker'
+gem 'turbolinks'
+gem 'jbuilder'
+
+group :development do
+  gem 'web-console'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :test do
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
+end

data/gemfiles/Gemfile.rails-5.1

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+# Bundle Rails
+gem 'rails', '~> 5.1.0'
+
+gem 'sqlite3'
+gem 'puma'
+gem 'sass-rails'
+gem 'webpacker'
+gem 'turbolinks'
+gem 'jbuilder'
+
+group :development do
+  gem 'web-console'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :test do
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
+end

data/gemfiles/Gemfile.rails-5.2

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+# Bundle Rails
+gem 'rails', '~> 5.2.0'
+
+gem 'sqlite3'
+gem 'puma'
+gem 'sass-rails'
+gem 'webpacker'
+gem 'turbolinks'
+gem 'jbuilder'
+
+group :development do
+  gem 'web-console'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :test do
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
+end

data/gemfiles/Gemfile.rails-6.0

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+# Bundle Rails
+gem 'rails', '~> 6.0.0'
+
+gem 'sqlite3'
+gem 'puma'
+gem 'sass-rails'
+gem 'webpacker'
+gem 'turbolinks'
+gem 'jbuilder'
+
+group :development do
+  gem 'web-console'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :test do
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
+end

data/lib/amazon-chime-sdk-rails.rb

@@ -0,0 +1,37 @@
+# Top level namespace of amazon-chime-sdk-rails, server-side implementation of Amazon Chime SDK for Ruby on Rails application.
+module ChimeSdk
+  extend ActiveSupport::Autoload
+
+  autoload :Config            , 'chime_sdk/config'
+  autoload :MeetingCoordinator, 'chime_sdk/meeting_coordinator'
+
+  # Returns configuration object of ChimeSdk.
+  def self.config
+    @config ||= ChimeSdk::Config.new
+  end
+
+  # Sets global configuration options for ChimeSdk.
+  # Available options and their defaults are in the example below:
+  # @example Initializer for Rails
+  #   ChimeSdk.configure do |config|
+  #     config.appication_name               = 'chime-sdk-rails'
+  #     config.media_region                  = 'us-east-1'
+  #     config.prefix                        = "#{config.application_name}-#{Rails.env}-"
+  #     config.max_meeting_results           = 10
+  #     config.max_attendee_results          = 10
+  #     config.create_meeting_with_attendee  = true
+  #     config.create_attendee_from_meeting  = true
+  #     config.create_meeting_by_get_request = false
+  #   end
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  # Load AWS SDK for Amazon Chime
+  require 'aws-sdk-chime'
+
+  # Load ChimeSdk helpers
+  require 'chime_sdk/controller/common'
+  require 'chime_sdk/controller/meetings'
+  require 'chime_sdk/controller/attendees'
+end

data/lib/chime_sdk/config.rb

@@ -0,0 +1,90 @@
+module ChimeSdk
+  # Class used to initialize configuration object.
+  class Config
+    # @overload application_name
+    #   Return application name for unique key and metadata of Chime SDK meetings and attendees.
+    #   @return [Boolean] application name for unique key and metadata of Chime SDK meetings and attendees
+    # @overload application_name=(value)
+    #   Set application name for unique key and metadata of Chime SDK meetings and attendees.
+    #   @param [Boolean] application_name The new application_name
+    #   @return [Boolean] application name for unique key and metadata of Chime SDK meetings and attendees
+    attr_accessor :application_name
+
+    # @overload media_region
+    #   Return media region to host Chime SDK meetings.
+    #   @return [Boolean] Media region to host Chime SDK meetings
+    # @overload media_region=(value)
+    #   Set media region to host Chime SDK meetings.
+    #   @param [Boolean] media_region The new media_region
+    #   @return [Boolean] Media region to host Chime SDK meetings
+    attr_accessor :media_region
+
+    # @overload prefix
+    #   Return prefix to make unique key of Chime SDK meetings and attendees.
+    #   @return [Boolean] Prefix to make unique key of Chime SDK meetings and attendees
+    # @overload prefix=(value)
+    #   Set prefix to make unique key of Chime SDK meetings and attendees.
+    #   @param [Boolean] prefix The new prefix
+    #   @return [Boolean] Prefix to make unique key of Chime SDK meetings and attendees
+    attr_accessor :prefix
+
+    # @overload max_meeting_results
+    #   Return default max_results value used in list_meetings API.
+    #   @return [Boolean] Default max_results value used in list_meetings API
+    # @overload max_meeting_results=(value)
+    #   Set default max_results value used in list_meetings API.
+    #   @param [Boolean] max_meeting_results The new max_meeting_results
+    #   @return [Boolean] Default max_results value used in list_meetings API
+    attr_accessor :max_meeting_results
+
+    # @overload max_attendee_results
+    #   Return default max_results value used in list_attendees API.
+    #   @return [Boolean] Default max_results value used in list_attendees API
+    # @overload max_attendee_results=(value)
+    #   Set default max_results value used in list_attendees API.
+    #   @param [Boolean] max_attendee_results The new max_attendee_results
+    #   @return [Boolean] Default max_results value used in list_attendees API
+    attr_accessor :max_attendee_results
+
+    # @overload create_meeting_with_attendee
+    #   Return whether the application creates meeting with attendee in meetings#create action.
+    #   @return [Boolean] Whether the application creates meeting with attendee in meetings#create action
+    # @overload create_meeting_with_attendee=(value)
+    #   Set whether the application creates meeting with attendee in meetings#create action.
+    #   @param [Boolean] create_meeting_with_attendee The new create_meeting_with_attendee
+    #   @return [Boolean] Whether the application creates meeting with attendee in meetings#create action
+    attr_accessor :create_meeting_with_attendee
+
+    # @overload create_attendee_from_meeting
+    #   Return whether the application creates attendee from meeting in meetings#show action.
+    #   @return [Boolean] Whether the application creates attendee from meeting in meetings#show action
+    # @overload create_attendee_from_meeting=(value)
+    #   Set whether the application creates attendee from meeting in meetings#show action.
+    #   @param [Boolean] create_attendee_from_meeting The new create_attendee_from_meeting
+    #   @return [Boolean] Whether the application creates attendee from meeting in meetings#show action
+    attr_accessor :create_attendee_from_meeting
+
+    # @overload create_meeting_by_get_request
+    #   Return whether the application creates meeting in meetings#index action by HTTP GET request.
+    #   @return [Boolean] Whether the application creates meeting in meetings#index action by HTTP GET request
+    # @overload create_meeting_by_get_request=(value)
+    #   Set whether the application creates meeting in meetings#index action by HTTP GET request.
+    #   @param [Boolean] create_meeting_by_get_request The new create_meeting_by_get_request
+    #   @return [Boolean] Whether the application creates meeting in meetings#index action by HTTP GET request
+    attr_accessor :create_meeting_by_get_request
+
+    # Initialize configuration for ChimeSdk.
+    # These configuration can be overridden in initializer.
+    # @return [Config] A new instance of Config
+    def initialize
+      @application_name              = 'chime-sdk-rails'
+      @media_region                  = 'us-east-1'
+      @prefix                        = "#{@application_name}-#{Rails.env}-"
+      @max_meeting_results           = 10
+      @max_attendee_results          = 10
+      @create_meeting_with_attendee  = true
+      @create_attendee_from_meeting  = true
+      @create_meeting_by_get_request = false
+    end
+  end
+end

data/lib/chime_sdk/controller/attendees.rb

@@ -0,0 +1,128 @@
+module ChimeSdk
+  module Controller
+    # Attendees controller implementation by amazon-chime-sdk-rails.
+    module Attendees
+      # Controller implementation to be included in custom attendees controllers.
+      module Mixin
+        extend ActiveSupport::Concern
+
+        included do
+          include ChimeSdk::Controller::Common
+          include ActionController::MimeResponds
+        end
+    
+        # GET /meetings/:meeting_id/attendees
+        def index
+          list_attendees
+          render json: { attendees: @attendees }
+        end
+
+        # GET /meetings/:meeting_id/attendees/:attendee_id
+        def show
+          get_attendee
+          render json: @attendee
+        end
+
+        # POST /meetings/:meeting_id/attendees
+        def create
+          create_attendee
+          render status: 201, json: @attendee
+        end
+
+        # DELETE /meetings/:meeting_id/attendees/:attendee_id
+        def destroy
+          delete_attendee
+          head 204
+        end
+
+        protected
+        # Override the following functions in your controllers
+        # :nocov:
+
+        # 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[:meeting_id]
+        end
+
+        # Request parameter representing attendee id such as params[:id].
+        # Configure it depending on your application routes.
+        # @api protected
+        # @return [String, Integer] Attendee id from request parameter
+        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
+          "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 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 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
+
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/chime_sdk/controller/common.rb

@@ -0,0 +1,202 @@
+module ChimeSdk
+  # Controllers implementation by amazon-chime-sdk-rails.
+  module Controller
+    # Common implementation for controllers.
+    module Common
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from Aws::Chime::Errors::ForbiddenException, with: :render_forbidden
+        rescue_from Aws::Chime::Errors::NotFoundException, with: :render_resource_not_found
+        rescue_from Aws::Chime::Errors::ValidationException, with: :render_resource_not_found
+
+        class ::String
+          # Convets to boolean.
+          # Returns true for 'true', '1', 'yes', 'on' and 't'.
+          # Returns false for 'false', '0', 'no', 'off' and 'f'.
+          # @param [Boolean] default Default value to return when the String is not interpretable
+          # @return [Boolean] Convered boolean value
+          def to_boolean(default = nil)
+            return true if ['true', '1', 'yes', 'on', 't'].include? self
+            return false if ['false', '0', 'no', 'off', 'f'].include? self
+            return default
+          end
+        end
+      end
+  
+      protected
+      # Return meeting id from @meeting object or meeting id param.
+      # @api protected
+      # @return [String] Meeting id
+      def meeting_id
+        @meeting ? @meeting[:Meeting][:MeetingId] : meeting_id_param
+      end
+
+      # Return attendee id from @attendee object or attendee id param.
+      # @api protected
+      # @return [String] Attendee id
+      def attendee_id
+        @attendee ? @attendee[:Attendee][:AttendeeId] : attendee_id_param
+      end
+
+      # List meetings by MeetingCoordinator.
+      # @api protected
+      # @return [Array<Hash>] Meeting list
+      def list_meetings
+        @meetings = ChimeSdk::MeetingCoordinator.list_meetings(prefix_filter: meeting_request_id)
+        @meetings = @meetings.map { |meeting| merge_application_meeting_metadata(meeting) }
+      end
+
+      # Create meeting by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Created meeting
+      def create_meeting
+        @meeting = ChimeSdk::MeetingCoordinator.create_meeting(meeting_request_id, tags: meeting_tags)
+        @meeting = merge_application_meeting_metadata(@meeting)
+      end
+
+      # Get meeting by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Meeting
+      def get_meeting
+        @meeting = ChimeSdk::MeetingCoordinator.get_meeting(meeting_id)
+        @meeting = merge_application_meeting_metadata(@meeting)
+      end
+
+      # Delete meeting by MeetingCoordinator.
+      # @api protected
+      # @return [void]
+      def delete_meeting
+        ChimeSdk::MeetingCoordinator.delete_meeting(meeting_id)
+      end
+
+      # List attendees by MeetingCoordinator.
+      # @api protected
+      # @return [Array<Hash>] Attendee list
+      def list_attendees
+        @attendees = ChimeSdk::MeetingCoordinator.list_attendees(meeting_id)
+        @attendees = @attendees.map { |attendee| merge_application_attendee_metadata(attendee) }
+      end
+
+      # Create attendee by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Created attendee
+      def create_attendee
+        @attendee = ChimeSdk::MeetingCoordinator.create_attendee(meeting_id, attendee_request_id, tags: attendee_tags)
+        @attendee = merge_application_attendee_metadata(@attendee)
+      end
+
+      # Get attendee by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Attendee
+      def get_attendee
+        @attendee = ChimeSdk::MeetingCoordinator.get_attendee(meeting_id, attendee_id)
+        @attendee = merge_application_attendee_metadata(@attendee)
+      end
+
+      # Delete attendee by MeetingCoordinator.
+      # @api protected
+      # @return [void]
+      def delete_attendee
+        ChimeSdk::MeetingCoordinator.delete_attendee(meeting_id, attendee_id)
+      end
+
+      # Create meeting with attendee by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Created meeting
+      def create_meeting_with_attendee
+        create_meeting
+        create_attendee_from_meeting
+        @meeting
+      end
+
+      # Create attendee from meeting by MeetingCoordinator.
+      # @api protected
+      # @return [Hash] Created attendee
+      def create_attendee_from_meeting
+        create_attendee
+        @meeting = @meeting.merge(@attendee)
+        @meeting = merge_application_attendee_metadata(@meeting)
+        @meeting = merge_application_attendee_metadata(@meeting)
+        @attendee = merge_application_attendee_metadata(@attendee)
+      end
+
+      # Return common tags for meetings and attendees.
+      # @api protected
+      # @return [Array<Hash>] Common tags
+      def tags
+        [
+          {
+            key: "Application",
+            value: ChimeSdk.config.application_name
+          },
+          {
+            key: "Environment",
+            value: Rails.env
+          }
+        ]
+      end
+
+      # Return tags for meetings from defined optional_meeting_tags.
+      # @api protected
+      # @return [Array<Hash>] Tags for meetings
+      def meeting_tags
+        tags + optional_meeting_tags
+      end
+
+      # Return tags for attendees from defined optional_attendee_tags.
+      # @api protected
+      # @return [Array<Hash>] Tags for attendees
+      def attendee_tags
+        tags + optional_attendee_tags
+      end
+
+      # Merge application metadata into meeting instance and return.
+      # @api protected
+      # @param [Hash] meeting Meeting JSON object as hash
+      # @return [Hash] Merged meeting
+      def merge_application_meeting_metadata(meeting)
+        meeting[:Meeting][:ApplicationMetadata] = application_meeting_metadata(meeting)
+        meeting
+      end
+
+      # Merge application metadata into attendee instance and return.
+      # @api protected
+      # @param [Hash] attendee Attendee JSON object as hash
+      # @return [Hash] Merged attendee
+      def merge_application_attendee_metadata(attendee)
+        attendee[:Attendee][:ApplicationMetadata] = application_attendee_metadata(attendee)
+        attendee
+      end
+
+      # Returns error response as Hash
+      # @api protected
+      # @return [Hash] Error message
+      def error_response(error_info = {})
+        { gem: "chime-sdk-rails", error: error_info }
+      end
+
+      # Render Forbidden error with 403 status
+      # @api protected
+      # @return [void]
+      def render_forbidden(error = nil)
+        message_type = error.respond_to?(:message) ? error.message : error
+        respond_to do |format|
+          format.html { redirect_to meeting_resources_path, notice: "Forbidden: #{message_type}" }
+          format.json { render status: 403, json: error_response(code: 403, message: "Forbidden", type: message_type) }
+        end
+      end
+
+      # Render Resource Not Found error with 404 status
+      # @api protected
+      # @return [void]
+      def render_resource_not_found(error = nil)
+        message_type = error.respond_to?(:message) ? error.message : error
+        respond_to do |format|
+          format.html { redirect_to meeting_resources_path, notice: "Resource not found: #{message_type}" }
+          format.json { render status: 404, json: error_response(code: 404, message: "Resource not found", type: message_type) }
+        end
+      end
+    end
+  end
+end