invitation 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d20b7998d1b4e813f82b634d8ed324f3b3c4a250
-  data.tar.gz: 5e983a833985e6f7713a5ab2e51f901e768ae304
+  metadata.gz: 354b452dc2fffa362fb324bd5f8ffce81aaed53f
+  data.tar.gz: fe0c07886e04e48e3911e4e9be9eb0c3d361cda5
 SHA512:
-  metadata.gz: 8675a33a4639c43d14beaa2e50caf1113b032bea2b38b66e5fc7375dc9631fbd8c70762ca8bcf4017836ac565e3aa7b53b90b0ff3f48cccf9077efc1e81d26ad
-  data.tar.gz: 971bfcc4ac6f9d6cccd8544879513c93ae887c5a9a68f2180433ae53fd10001b6227f94acc0dbf588706cadbfe0bc5a4c88555725c2805948a03b6e91772ae67
+  metadata.gz: 69b001bd110f2ffd4b081d35def31a39a02adb452a96d3f3cae97660470ef4d6c9da5ecd80ec5168595d7c85e2308531c9d578158f0f3927392419eef7bcd7e0
+  data.tar.gz: 3720cf91a52ec9ca0b7a9cb331d8590b3294336ab4bfeb0dd43f6ab2be50058b2461f6bdc0701c4007ca399f2d9ad3da608b24ae48c5318588e43e0443543230

data/app/controllers/invitation/invites_controller.rb

@@ -1,61 +1,103 @@
 class Invitation::InvitesController < ApplicationController
   def new
-    @invite = invite_from_params
+    attrs = params[:invite] ? params.require(:invite).permit(:invitable_id, :invitable_type, :email, emails: []) : {}
+    @invite = Invite.new(attrs)
     render template: 'invites/new'
   end
 
+  # invite: { invitable_id, invitable_type, email or emails:[] }
   def create
-    @invite = invite_from_params
-    @invite.sender_id = current_user.id
-    logger.debug '@invite: ' + @invite.inspect
-    if @invite.save
-      #if the user already exists
-      if @invite.recipient != nil
-        deliver_email(InviteMailer.existing_user(@invite))
-        after_invite_existing_user
-      else
-        deliver_email(InviteMailer.new_user(@invite))
-        after_invite_new_user
-      end
-      flash[:notice] = t('invitation.flash.invite_issued', email: @invite.email)
-    else
-      flash[:error] = t('invitation.flash.invite_error')
+    failures = []
+    invites = build_invites
+    ActiveRecord::Base.transaction do
+      invites.each{ |invite| invite.save ? do_invite(invite) : failures << invite.email }
     end
+
     respond_to do |format|
-      format.html { redirect_to url_after_invite }
-      format.json { render json: @invite.as_json(except: :token) }
+      format.html {
+        if failures.empty?
+          flash[:notice] = t('invitation.flash.invite_issued', count: invites.count)
+        else
+          flash[:error] = t('invitation.flash.invite_error', count: failures.count, email: failures.to_sentence)
+        end
+        redirect_to url_after_invite(invites.first) # FIXME - redirect to back
+      }
+      format.json {
+        if failures.empty?
+          # If we received a single email, json response should be a scalar, not an array.
+          invites = params[:invite].has_key?('email') ? invites.first : invites
+          render json: invites.as_json(except: [:token, :created_at, :updated_at]), status: 201
+        else
+          render json:{ message: t('invitation.flash.invite_error', count: failures.count, email: failures.to_sentence),
+                        status: :unprocessable_entity }
+        end
+      }
     end
   end
 
 
-  private
+  protected
 
 
   # Override this if you want to do something more complicated for existing users.
-  def after_invite_existing_user
-    # Add the user to the organization
-    @invite.invitable.add_invited_user(@invite.recipient)
+  # For example, if you have a more complex permissions scheme than just a simple
+  # has_many relationship, enable it here.
+  def after_invite_existing_user(invite)
+    # Add the user to the invitable resource/organization
+    invite.invitable.add_invited_user(invite.recipient)
+  end
+
+
+  # Override if you want to do something more complicated for new users.
+  # By default we don't do anything extra.
+  def after_invite_new_user(invite)
   end
 
-  # Override if you want to do something more complicated for new users. By default we do nothing.
-  def after_invite_new_user
+
+  # After an invite is created, redirect the user here.
+  # Default implementation doesn't return a url, just the invitable.
+  def url_after_invite(invite)
+    invite.invitable
   end
 
-  #
-  def url_after_invite
-    @invite.invitable
+
+  private
+
+  def build_invites
+    attributes = invite_params_for_create
+    attributes[:emails].collect{ |e| Invite.new(invitable_id: attributes[:invitable_id],
+                                                invitable_type: attributes[:invitable_type],
+                                                sender_id: current_user.id,
+                                                email: e) }
   end
 
-  # Build new Invite from params.
-  def invite_from_params
-    Invite.new(invite_params)
+
+  # Paramsters used in #create. Allow :email or :emails in payload.
+  # Copy :email scalar to :emails array, so we only have to process :emails attribute.
+  def invite_params_for_create
+    params[:invite][:emails] ||= []
+    if params[:invite][:email]
+      params[:invite][:emails] << params[:invite][:email]
+    end
+    params.require(:invite).permit(:invitable_id, :invitable_type, emails: [])
   end
 
-  def invite_params
-    return params.require(:invite).permit(:invitable_id, :invitable_type, :email) if params[:invite]
-    Hash.new
+
+  # Invite user by sending email.
+  # Existing users are granted permissions via #after_invite_existing_user.
+  # New users are granted permissions via #after_invite_new_user, currently a null op.
+  def do_invite(invite)
+    if invite.existing_user?
+      deliver_email(InviteMailer.existing_user(invite))
+      after_invite_existing_user(invite)
+      invite.save
+    else
+      deliver_email(InviteMailer.new_user(invite))
+      after_invite_new_user(invite)
+    end
   end
 
+
   # Use deliver_later from rails 4.2+ if available.
   def deliver_email(mail)
     if mail.respond_to?(:deliver_later)

data/app/models/invite.rb

@@ -14,6 +14,9 @@ class Invite < ActiveRecord::Base
   validates :invitable, presence: true
   validates :sender, presence: true
 
+  def existing_user?
+    recipient != nil
+  end
 
   def generate_token
     self.token = SecureRandom.hex(20).encode('UTF-8')

data/app/views/invite_mailer/existing_user.text.erb

@@ -0,0 +1,7 @@
+<%= t('invitation.invite_mailer.existing_user.hello', email: @invite.email) %>
+
+<%= raw t('invitation.invite_mailer.existing_user.someone_invited_you',
+             sender: @invite.sender.email, invitable: @invite.invitable.invitable_name, url: root_url) %>
+
+<%= t('invitation.invite_mailer.existing_user.ignore', sender: @invite.sender.email) %>
+

data/app/views/invite_mailer/new_user.text.erb

@@ -0,0 +1,9 @@
+<%= t('invitation.invite_mailer.new_user.hello', email: @invite.email) %>
+
+<%= t('invitation.invite_mailer.new_user.someone_invited_you',
+      sender: @invite.sender.email, invitable: @invite.invitable.invitable_name, url: root_url) %>
+
+<%= t('invitation.invite_mailer.new_user.accept') %>:
+<%= @user_registration_url %>
+
+<%= t('invitation.invite_mailer.new_user.ignore') %>

data/config/locales/invitation.en.yml

@@ -5,17 +5,21 @@ en:
         email: "Email"
   invitation:
     flash:
-      invite_issued: "Invitation issued to %{email}"
-      invite_error: "Unable to issue invitation"
+      invite_issued:
+        one: "Invitation issued"
+        other: "Invitations issued"
+      invite_error:
+        one: "Unable to issue invitation to %{email}"
+        other: "Unable to issue invitations to %{email}"
     invite_mailer:
       existing_user:
         subject: "Invitation instructions"
         hello: "Hello %{email}"
-        someone_invited_you: "%{sender} has invited you to <b>%{invitable}</b> at %{url}. You now have permissions to access it."
+        someone_invited_you: "%{sender} has invited you to %{invitable} at %{url}. You now have permissions to access it."
         ignore: "If you don't want this permission added or feel it is in error, please contact %{sender}."
       new_user:
         subject: "Invitation instructions"
         hello: "Hello %{email}"
-        someone_invited_you: "%{sender} has invited you to <b>%{invitable}</b> at %{url}. You can accept the invitation with the url below."
+        someone_invited_you: "%{sender} has invited you to %{invitable} at %{url}. You can accept the invitation with the url below."
         accept: "Accept invitation"
-        ignore: "If you don't want to accept the invitation, please ignore this email.<br />Your account won't be created until you access the link above and set your password."
+        ignore: "If you don't want to accept the invitation, please ignore this email. Your account won't be created until you access the link above and set your password."

data/lib/generators/invitation/views/views_generator.rb

@@ -3,7 +3,7 @@ require 'rails/generators/base'
 #
 # deploy view and locale assets
 #
-module Authenticate
+module Invitation
   module Generators
     class ViewsGenerator < Rails::Generators::Base
       source_root File.expand_path("../../../../..", __FILE__)

data/lib/invitation/version.rb

@@ -1,3 +1,3 @@
 module Invitation
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invitation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Tomich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,7 +168,9 @@ files:
 - app/mailers/invite_mailer.rb
 - app/models/invite.rb
 - app/views/invite_mailer/existing_user.html.erb
+- app/views/invite_mailer/existing_user.text.erb
 - app/views/invite_mailer/new_user.html.erb
+- app/views/invite_mailer/new_user.text.erb
 - app/views/invites/new.html.erb
 - config/locales/invitation.en.yml
 - config/routes.rb