invitation 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 106aa33fdda1af6e4a185946e1f1eb05c2621d90
-  data.tar.gz: 23f8f4b5ab5927052b1258ec728cdb04af2c1028
+  metadata.gz: e20a99422f6cce4d604222b2601932e9e17d22bb
+  data.tar.gz: 2023d2902bc93ce71c2c93387e9e6b786cc64a9b
 SHA512:
-  metadata.gz: 1fd3cc4ca6941ebe309af5f616338d0f966bd627a3d0c5fd0f836ef2d07308ea5e437c2b3ec5632075a56d54edb9f9f8b2cc1dd4e20a26e236265c06245b5489
-  data.tar.gz: cbb961fc6d801a5983de88b10986ca0436d4fab2a2fde6515bc8ad292d87df6ad8b6eee705f2262770c2524cb86670045b20662f9bd4cd0d368e7586c09c8a62
+  metadata.gz: 90a019005b6db16afa6a8610eff17c1009167563bea2f90745482d066a920a426ad1f7889b03d9e6000a03453195884d5a5bfed8b0d69cc2f13402b77ee5a570
+  data.tar.gz: c0ad381f8bfbf5f98738ad3037f60c5bea143c74b38eca27b8df540c5bfa46d3511dd51918f8f77cf4054963ba06fb86037600496c2259110d1b1f0c056cf015

data/Rakefile

@@ -1,6 +1,15 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc 'Run all specs in spec directory (excluding plugin specs)'
+task default: :spec

data/app/controllers/invitation/invites_controller.rb

@@ -8,48 +8,49 @@
 #
 # Common extensions include:
 # * add authorization checks: subclass and add before_actions to :new and :create.
-# * override after_invite_existing_user or after_invite_new_user.
+# * override after_invite_existing_user or after_invite_new_user
 #
 class Invitation::InvitesController < ApplicationController
-
   def new
     @invite = InviteForm.new(invite_params)
     render template: 'invites/new'
   end
 
-  # invite: { invitable_id, invitable_type, email or emails:[] }
+  # Create one or more Invite instances.
+  #   invite: { invitable_id, invitable_type, email or emails:[] }
+  #
   def create
     failures = []
     invites = InviteForm.new(invite_params).build_invites(current_user)
     ActiveRecord::Base.transaction do
-      invites.each{ |invite| invite.save ? do_invite(invite) : failures << invite.email }
+      invites.each { |invite| invite.save ? do_invite(invite) : failures << invite.email }
     end
 
     respond_to do |format|
-      format.html {
+      format.html do
         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 {
+        redirect_to url_after_invite(invites.first) # FIXME: redirect to back
+      end
+      format.json do
         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
+          invites = params[:invite].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 }
+          render json: {
+            message: t('invitation.flash.invite_error', count: failures.count, email: failures.to_sentence),
+            status: :unprocessable_entity
+          }
         end
-      }
+      end
     end
   end
 
-
-  protected
-
+  private
 
   # A form object pretends to be 'invite', but accepts both 'email' and 'emails'.
   # It knows how to build all of the invite instances.
@@ -72,8 +73,9 @@ class Invitation::InvitesController < ApplicationController
     end
 
     def build_invites(current_user)
-      all_emails.reject{ |e| e.blank? }.collect{ |e|
-        Invite.new(invitable_id: @invitable_id, invitable_type: @invitable_type, sender_id: current_user.id, email: e) }
+      all_emails.reject(&:blank?).collect do |e|
+        Invite.new(invitable_id: @invitable_id, invitable_type: @invitable_type, sender_id: current_user.id, email: e)
+      end
     end
 
     private
@@ -83,10 +85,6 @@ class Invitation::InvitesController < ApplicationController
     end
   end
 
-
-  private
-
-
   # Override this if you want to do something more complicated for existing users.
   # For example, if you have a more complex permissions scheme than just a simple
   # has_many relationship, enable it here.
@@ -95,20 +93,17 @@ class Invitation::InvitesController < ApplicationController
     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
 
-
   # 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 invite_params
     params[:invite] ? params.require(:invite).permit(:invitable_id, :invitable_type, :email, emails: []) : {}
   end
@@ -127,7 +122,6 @@ class Invitation::InvitesController < ApplicationController
     end
   end
 
-
   # Use deliver_later from rails 4.2+ if available.
   def deliver_email(mail)
     if mail.respond_to?(:deliver_later)
@@ -136,5 +130,4 @@ class Invitation::InvitesController < ApplicationController
       mail.deliver
     end
   end
-
 end

data/app/mailers/invite_mailer.rb

@@ -1,3 +1,4 @@
+# Send invitations to new and existing users.
 class InviteMailer < ActionMailer::Base
   def existing_user(invite)
     @invite = invite
@@ -10,7 +11,7 @@ class InviteMailer < ActionMailer::Base
 
   def new_user(invite)
     @invite = invite
-    @user_registration_url = Invitation.configuration.user_registration_url.call(:invite_token => @invite.token)
+    @user_registration_url = Invitation.configuration.user_registration_url.call(invite_token: @invite.token)
     mail(
       from: Invitation.configuration.mailer_sender,
       to: @invite.email,

data/app/models/invite.rb

@@ -24,8 +24,6 @@ class Invite < ActiveRecord::Base
 
   def check_recipient_existence
     recipient = Invitation.configuration.user_model.find_by_email(email)
-    if recipient
-      self.recipient_id = recipient.id
-    end
+    self.recipient_id = recipient.id if recipient
   end
 end

data/config/locales/invitation.pt-BR.yml

@@ -0,0 +1,25 @@
+pt-BR:
+  activerecord:
+    attributes:
+      invite:
+        email: "Email"
+  invitation:
+    flash:
+      invite_issued:
+        one: "Problema no convite"
+        other: "Problemas nos convites"
+      invite_error:
+        one: "Não foi possível enviar um convite para %{email}"
+        other: "Não foi possível enviar convites para %{email}"
+    invite_mailer:
+      existing_user:
+        subject: "Instruções do convite"
+        hello: "Olá %{email}"
+        someone_invited_you: "%{sender} convidou você para %{invitable} em %{url}. Agora você tem permissões para acessar com a url a seguir."
+        ignore: "Se as suas permissões não foram adicionadas ou se você sentir que este é um erro, por favor, entre em contato com %{sender}."
+      new_user:
+        subject: "Instruções do convite"
+        hello: "Olá %{email}"
+        someone_invited_you: "%{sender} convidou você para %{invitable} em %{url}. Agora você tem permissões para acessar com a url a seguir."
+        accept: "Aceitar o convite"
+        ignore: "Se você não deseja aceitar este convite, por favor, ignore este email. Sua conta não será criada até você acessar o link a seguir e criar a sua conta."

data/lib/generators/invitation/controllers/controllers_generator.rb

@@ -6,7 +6,7 @@ require 'rails/generators/base'
 module Invitation
   module Generators
     class ControllersGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../..", __FILE__)
+      source_root File.expand_path('../../../../..', __FILE__)
 
       def create_controllers
         directory 'app/controllers'
@@ -15,7 +15,6 @@ module Invitation
       def create_mailers
         directory 'app/mailers'
       end
-
     end
   end
 end

data/lib/generators/invitation/helpers.rb

@@ -21,7 +21,7 @@ module Invitation
       end
 
       def namespaced?
-        !!namespace
+        !namespace.nil?
       end
 
       def model_name
@@ -57,22 +57,17 @@ module Invitation
         @file_name = @class_path.pop
       end
 
-
-
-
-
-      def invitable_file_path invitable_class_name
+      def invitable_file_path(invitable_class_name)
         File.join('app', 'models', "#{invitable_model_name(invitable_class_name).underscore}.rb")
       end
 
-      def invitable_model_name invitable_class_name
+      def invitable_model_name(invitable_class_name)
         if namespaced?
           [namespace.to_s] + [invitable_class_name.classify]
         else
           [invitable_class_name.classify]
         end.join('::')
       end
-
     end
   end
-end
+end

data/lib/generators/invitation/install/install_generator.rb

@@ -10,7 +10,10 @@ module Invitation
 
       source_root File.expand_path('../templates', __FILE__)
 
-      class_option :model, optional: true, type: :string, banner: 'model',
+      class_option :model,
+                   optional: true,
+                   type: :string,
+                   banner: 'model',
                    desc: "Specify the model class name if you will use anything other than 'User'"
 
       # class_option :invitable, optional: true, type: :array, banner: 'invitable',
@@ -54,16 +57,16 @@ module Invitation
         copy_file 'invitation.rb', 'config/initializers/invitation.rb'
         if options[:model]
           inject_into_file(
-              'config/initializers/invitation.rb',
-              "  config.user_model = '#{options[:model]}' \n",
-              after: "Invitation.configure do |config|\n",
+            'config/initializers/invitation.rb',
+            "  config.user_model = '#{options[:model]}' \n",
+            after: "Invitation.configure do |config|\n"
           )
         end
       end
 
-      private
+      protected
 
-      def copy_migration migration_name
+      def copy_migration(migration_name)
         migration_template "db/migrate/#{migration_name}", "db/migrate/#{migration_name}"
       end
 
@@ -71,7 +74,6 @@ module Invitation
       def self.next_migration_number(dir)
         ActiveRecord::Generators::Base.next_migration_number(dir)
       end
-
     end
   end
 end

data/lib/generators/invitation/routes/routes_generator.rb

@@ -3,7 +3,6 @@ require 'rails/generators/base'
 module Invitation
   module Generators
     class RoutesGenerator < Rails::Generators::Base
-
       source_root File.expand_path('../templates', __FILE__)
 
       def add_invitation_routes
@@ -14,14 +13,12 @@ module Invitation
         inject_into_file(
           'config/initializers/invitation.rb',
           "  config.routes = false \n",
-          after: "Invitation.configure do |config|\n",
+          after: "Invitation.configure do |config|\n"
         )
       end
 
-
       private
 
-
       def invitation_routes
         File.read(routes_file_path)
       end
@@ -29,7 +26,6 @@ module Invitation
       def routes_file_path
         File.expand_path(find_in_source_paths('routes.rb'))
       end
-
     end
   end
 end

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

@@ -6,7 +6,7 @@ require 'rails/generators/base'
 module Invitation
   module Generators
     class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../..", __FILE__)
+      source_root File.expand_path('../../../../..', __FILE__)
 
       def create_views
         directory 'app/views'
@@ -15,7 +15,6 @@ module Invitation
       def create_locales
         directory 'config/locales'
       end
-
     end
   end
 end

data/lib/invitation/configuration.rb

@@ -1,13 +1,19 @@
+# Invitation requires configuration.#
 module Invitation
+  # Configure the invitation module. Invoke from a rails initializer.
+  #
+  # Example:
+  #   Invitation.configure do |config|
+  #     config.user_registration_path = ->(params) { new_profile_path(param) }
+  #   end
+  #
   class Configuration
-
     # ActiveRecord model class name that represents your user.
     #
     # Defaults to '::User'.
     # @return [ActiveRecord::Base]
     attr_accessor :user_model
 
-
     # Url for new users to register for your application. New users are invited to
     # sign up at this url via email. The url should be expressed as a lambda that
     # accepts one argument, a params hash. This hash will contain the invitation token.
@@ -19,7 +25,6 @@ module Invitation
     # @return [Lambda]
     attr_accessor :user_registration_url
 
-
     # Controls the 'from' address for Invitation emails.
     # Set this to a value appropriate to your application.
     #
@@ -28,7 +33,6 @@ module Invitation
     # @return [String]
     attr_accessor :mailer_sender
 
-
     # Enable or disable Invitation's built-in routes.
     #
     # Defaults to 'true'.
@@ -41,9 +45,8 @@ module Invitation
     # @return [Boolean]
     attr_accessor :routes
 
-
     def initialize
-      @user_model = ::User
+      @user_model = ::User if defined?(::User)
       @user_registration_url = ->(params) { Rails.application.routes.url_helpers.sign_up_url(params) }
       @mailer_sender = 'reply@example.com'
       @routes = true
@@ -61,10 +64,8 @@ module Invitation
     def routes_enabled?
       @routes
     end
-
   end
 
-
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -76,5 +77,4 @@ module Invitation
   def self.configure
     yield configuration
   end
-
 end

data/lib/invitation/engine.rb

@@ -1,10 +1,20 @@
 module Invitation
+  # Make invitation available to Rails apps on initialization.
+  #
+  # Requiring `invitation` (likely by having it in your `Gemfile`) will
+  # automatically require the engine.
+  #
+  # Invitation provides:
+  # * routes
+  # * controllers
+  # * views
+  #
+  # You can opt-out of Invitation's internal routes by using {Configuration#routes=}. You can
+  # subclass controllers, and override the Invitation views by running `rails generate invitation:views`.
   class Engine < ::Rails::Engine
-
     config.generators do |g|
       g.test_framework :rspec
       g.fixture_replacement :factory_girl, dir: 'spec/factories'
     end
-
   end
 end

data/lib/invitation/invitable.rb

@@ -1,64 +1,60 @@
-#
-# Any model you wish to invite users to join should extend this concern. This is typically an
-# organization or resource with limited membership like an "account" or "project".
-#
-# Your code is responsible for managing associations between your Invitable and your user model.
-#
-# For example, to make the model class Account an organization that can receive an invitation
-#
-#     class Account < ActiveRecord::Base
-#       invitable named_by: :name
-#
-#       has_many :account_memberships
-#       has_many :users, through: :account_memberships
-#     end
-#
-#
 module Invitation
+  #
+  # Any model you wish to invite users to join should extend this concern. This is typically an
+  # organization or resource with limited membership like an "account" or "project".
+  #
+  # Your code is responsible for managing associations between your Invitable and your user model.
+  #
+  # For example, to make the model class Account an organization that can receive an invitation
+  #
+  #     class Account < ActiveRecord::Base
+  #       invitable named_by: :name
+  #
+  #       has_many :account_memberships
+  #       has_many :users, through: :account_memberships
+  #     end
+  #
+  #
   module Invitable
-
+    # All resources or organizations should be invitable.
+    #
+    # @param [Hash] options - either named_by: <method name> or named: <String>
     def invitable(options = {})
       has_many :invites, as: :invitable
       class_attribute :invitable_options
-
-      self.invitable_options = options.dup # named_by: :name, named: 'Gug'
-      self.invitable_options[:named_by] = options[:named_by] if options[:named_by]
-      self.invitable_options[:named] = options[:named] if options[:named]
-
-      unless self.invitable_options[:named] || self.invitable_options[:named_by]
-        raise <<-eos
-invitable requires options be set, either :name or :named_by.
-  invitable named: "string"
-or
-  invitable named_by: :method_name
-eos
+      self.invitable_options = {}
+      case
+      when options[:named_by] then invitable_options[:named_by] = options[:named_by]
+      when options[:named] then invitable_options[:named] = options[:named]
+      else raise 'invitable requires options be set, either :name or :named_by. \
+                 e.g.: `invitable named: "string"` or `invitable named_by: :method_name`'
       end
-
       include Invitation::Invitable::InstanceMethods
     end
 
-
+    # Instance methods for invitables.
     module InstanceMethods
-
+      #
       # Add the invited user to the organization. Called by InvitesController.
+      #
       def add_invited_user(user)
         method = Invitation.configuration.user_model.name.underscore.pluralize
-        self.send(method).push(user)
+        send(method).push(user)
       end
 
+      #
       # Get the name of the organization for use in invitations.
+      #
       def invitable_name
         if invitable_options[:named_by]
-          self.send(invitable_options[:named_by])
+          send(invitable_options[:named_by])
         elsif invitable_options[:named]
           invitable_options[:named]
         else
           raise 'Invitation runtime error: invitable does not have name: or named_by: set, should not be possible! ' +
-              self.inspect
+                inspect
         end
       end
     end
-
   end
 end
-

data/lib/invitation/user.rb

@@ -1,21 +1,20 @@
-#
-# Your user model must include this concern to send and receive invitations. Your user class must also be
-# specified in the invitation configuration `Invitation.configure.user_model`.
-#
-# Your user model code is responsible for managing associations to any organizations you wish
-# to issue invitations to. Your user model will probably also include an authentication model.
-#
-# For example, to make your user class `User` able to issue invitations to model `Account`:
-#
-#     class User < ActiveRecord::Base
-#       include Invitation::User
-#       include Authenticate::User
-#
-#       has_many :account_memberships
-#       has_many :accounts, through: :account_memberships
-#     end
-#
 module Invitation
+  # Your user model must include this concern to send and receive invitations. Your user class must also be
+  # specified in the invitation configuration `Invitation.configure.user_model`.
+  #
+  # Your user model code is responsible for managing associations to any organizations you wish
+  # to issue invitations to. Your user model will probably also include an authentication model.
+  #
+  # For example, to make your user class `User` able to issue invitations to model `Account`:
+  #
+  #     class User < ActiveRecord::Base
+  #       include Invitation::User
+  #       include Authenticate::User
+  #
+  #       has_many :account_memberships
+  #       has_many :accounts, through: :account_memberships
+  #     end
+  #
   module User
     extend ActiveSupport::Concern
 
@@ -32,7 +31,5 @@ module Invitation
       invite.recipient = self
       invite.save
     end
-
   end
 end
-

data/lib/invitation/user_registration.rb

@@ -1,10 +1,10 @@
-# Your user registration controller should include this concern.
-#
 module Invitation
+  #
+  # UserRegistration should be included by your user registration controller.
+  #
   module UserRegistration
     extend ActiveSupport::Concern
 
-
     # Copy params[:invite_token] to @invite_token. Your user registration form needs
     # to include :invite_token, this method is the controller half of the glue.
     #
@@ -16,7 +16,6 @@ module Invitation
       @invite_token = params[:invite_token]
     end
 
-
     # Check for an invitation token and process the invite. If an invitation is found, the
     # user claims the invite.
     #
@@ -28,25 +27,16 @@ module Invitation
     # For example, if your user model is UserProfile, this method will check for @user_profile.
     #
     def process_invite_token(new_user = nil)
-      if new_user.nil?
-        new_user = user_instance_variable
-      end
-
+      new_user = user_instance_variable if new_user.nil?
       token = params[:invite_token]
-      if token != nil && new_user != nil
-        new_user.claim_invite token
-      end
+      new_user.claim_invite token if !token.nil? && !new_user.nil?
     end
 
-
     private
 
-
     def user_instance_variable
       name = Invitation.configuration.user_model_instance_var
-      self.instance_variable_get(name)
+      instance_variable_get(name)
     end
-
   end
 end
-

data/lib/invitation/version.rb

@@ -1,3 +1,3 @@
 module Invitation
-  VERSION = '0.1.1'
+  VERSION = '0.2'.freeze
 end

data/lib/invitation.rb

@@ -4,6 +4,7 @@ require 'invitation/user'
 require 'invitation/invitable'
 require 'invitation/user_registration'
 
+# Top level module of invitation gem.
 module Invitation
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invitation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Justin Tomich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -173,6 +173,7 @@ files:
 - app/views/invite_mailer/new_user.text.erb
 - app/views/invites/new.html.erb
 - config/locales/invitation.en.yml
+- config/locales/invitation.pt-BR.yml
 - config/routes.rb
 - lib/generators/invitation/controllers/USAGE
 - lib/generators/invitation/controllers/controllers_generator.rb