invitation 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9328677bd2e812aa2989652555faf6c7c4387b4c010c3de3b0c23f2ef6a0a820
-  data.tar.gz: 65172c70d01f9b7ccce2f282c4353490780f01b420f7a3cbf79242582dd0fdbb
+  metadata.gz: 7004e218adeff494276542ea6f2ba7827274af8668808d8621a239230e865527
+  data.tar.gz: d8f6097e1d66783c5c45cee8bf1df512fe323e4ccdcd72596f87253ff6f1af49
 SHA512:
-  metadata.gz: 43ce4389d83c9a23363c7e1853be9785ff9ac752aae44415e1593a08fdf2691f55a930b4af8712fb51630d2b463a9d21b79597b39c84c0a7e81514de86d41614
-  data.tar.gz: '08a3670c9ee7c5fca90c98a6e48991c1ef6188a1615054b7f6bc513e8ea6086b7d4f69be346a6165e09c6f71dc5fd55bc3061a677fafc0eadfacb55fdd30e7be'
+  metadata.gz: 9b38a8db6689536d0021cc41c712e0d0b5b468b30f9c8d49089fd8af3a75a6d5783b0fd7a9279cb2c277ea3d243ccf56ec60911d38ab1ee1806b7ebcda0de37d
+  data.tar.gz: 592918a6380483e92ed9a9119d03585d249bb2975168d8506b52b95cef3bb14b8933f67e21489211d6c344fd47da22f345c3085d7bae0348485b292909232778

data/CHANGELOG.md

@@ -0,0 +1,144 @@
+# Invitation Changelog
+
+
+## [0.6.1] - October 1, 2019
+
+### Fix: generator support for rails 6.0
+- fixed migration_version in generators to support rails 5 and above
+- Appraisal entry and gemfile for Rails 6.0.0
+- bumped gemspec to include rails 6.0.0
+- switched from factory_girl to factory_bot
+
+[0.6.0]: https://github.com/tomichj/invitation/compare/0.6.0...0.6.1
+
+
+## [0.6.0] - May 1, 2019
+
+### Feature: support for rails 6.0
+- added Appraisal entry and gemfile for 6.0.0rc1
+- bumped gemspec to include rails 6.0.0rc1
+- bumped version
+
+[0.6.0]: https://github.com/tomichj/invitation/compare/0.5.1...0.6.0
+
+
+## [0.5.1] - June 7, 2018
+
+### Feature: support for rails 5.2
+- added Appraisal entry and gemfile for 5.2
+- added rakefile tasks for build and release
+- bumped gemspec to include rails 5.2
+- bumped version
+- added sqlite3.represent_boolean_as_integer = true to dummy app for specs
+- specs now test for http status 201 instead of :success and :created,
+  :success was deprecated, switched to 201 for brevity and longevity of test
+
+[0.5.1]: https://github.com/tomichj/invitation/compare/0.5.0...0.5.1
+
+
+## [0.5.0] - March 12, 2018
+
+### API change
+- `InviteForm` extracted from invites_controller.rb, added at `app/forms/invitation/invite_form.rb`
+- `controllers_generator.rb` now has three targets: `create_controllers`, `create_mailers`, and `create_forms`
+- deleted empty `lib/tasks/invitation_tasks.rake`
+
+[0.5.0]: https://github.com/tomichj/invitation/compare/0.4.5...0.5.0
+
+
+## [0.4.5] - March 9, 2018
+
+### Bugfix:
+- migration versioned for Rails >= 5
+
+[0.4.5]: https://github.com/tomichj/invitation/compare/0.4.4...0.4.5
+
+
+## [0.4.4] - September 30, 2017
+- recipient association optional for Rails >= 5
+
+[0.4.4]: https://github.com/tomichj/invitation/compare/0.4.3...0.4.4
+
+
+## [0.4.3] - July 1, 2017
+
+### API change
+- configuration.user_model now accepts the user class (with a warning), or the user class name (a String)
+ 
+[0.4.3]: https://github.com/tomichj/invitation/compare/0.4.2...0.4.3
+
+
+## [0.4.2] - July 1, 2017
+
+### API change
+- accept a string for configuration.user_model and constantize it
+ 
+[0.4.2]: https://github.com/tomichj/invitation/compare/0.4.1...0.4.2
+
+
+## [0.4.1] - April 26, 2017
+
+### Bugfix:
+- added case_insensitive_email to template used by install generator
+ 
+[0.4.1]: https://github.com/tomichj/invitation/compare/0.4...0.4.1
+
+
+## [0.4] - April 26, 2017
+
+### Feature:
+- added case_sensitive_email configuration option.
+
+[0.4]: https://github.com/tomichj/invitation/compare/0.3...0.4
+
+
+## [0.3] - March 26, 2017
+
+### Feature:
+- Added support for Rails 5.1
+
+[0.3]: https://github.com/tomichj/invitation/compare/0.2...0.3
+
+
+## [0.2] - October 17, 2016
+
+### Feature:
+- adding pt-BR locale file and fixing an init bug.
+
+[0.2]: https://github.com/tomichj/invitation/compare/0.1.1...0.2
+
+
+## [0.1.1] - April 21, 2016
+
+### Internal changes:
+- invites controller now users a Form object, form accepts :email or :emails, builds one invite per email address.
+
+[0.1.1]: https://github.com/tomichj/invitation/compare/0.1.0...0.1.1
+
+
+## [0.1.0] - April 18, 2016
+
+* `invites#create` supports :email or emails:[] in request, via html or json.
+* `invites#create` error message reports emails it failed to invite
+* `invites#create` invite_issued or invite_error messages now 'count' sensitive, e.g. "Invitation issued" vs "Invitations issued"
+* removed after_invite_url from config, after invite user is redirected to invitable's show action
+* added config.routes, set to true by default.
+* fixed invitation view generator packaging
+* significantly more tests
+
+[0.1.0]: https://github.com/tomichj/invitation/compare/0.0.2...0.1.0
+
+
+## [0.0.2] - April 11, 2016
+
+* invites#create supports html or json. Redirects to invitable with html, returns invite (minus token) as json.
+* gemspec dependencies cleaned up
+* documentation updated
+
+[0.0.2]: https://github.com/tomichj/invitation/compare/0.0.1...0.0.2
+
+
+## 0.0.1 - April 9, 2016
+
+Initial release.
+

data/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+I love pull requests. I'm trying to keep it as easy as possible to contribute changes. There
+are just a couple of guidelines to follow to help me stay on top of things.
+
+
+## Let's talk
+
+Whether you're fixing a bug or adding a feature, feel free to talk to me first on 
+[twitter](https://twitter.com/JustinTomich). We can make sure the change isn't already
+underway somewhere else.
+
+
+## Getting started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Open a [New Issue](https://github.com/tomichj/invitation/issues) on github for your change, 
+assuming one does not already exist. If one already exists, join the conversation.
+* Fork the repository on GitHub.
+
+## Setup
+
+Clone the repo:
+
+`git clone https://github.com/<your-username>/invitation`
+
+CD into your clone and run bundler install:
+
+`cd invitation && bundle install`
+
+Make sure the tests pass:
+ 
+`rake`
+
+Make your change. Add tests for your change. Make sure the tests pass:
+
+`rake`
+
+I use `rubocop` to maintain ruby coding style. Install and run it like so:
+
+```sh
+gem install rubocop
+rubocop
+```
+
+Once you resolve any issues rubocop finds, you're ready to go. Push your fork and 
+[submit a pull request](https://github.com/tomichj/invitation/compare/).
+
+The ball is now in my court. I'll try to comment on your pull request within a couple of business days 
+(hopefully the same day).
+  
+Things you can do to increase the speed of acceptance:
+ 
+* talk to me ahead of time
+* write tests
+* follow the [ruby style guide](https://github.com/bbatsov/ruby-style-guide)
+* write a good [commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+ 
+Thanks very much!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Justin Tomich
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,378 @@
+# Invitation
+
+A Rails gem to issue scoped invitations.
+
+Please see the [CHANGELOG] for information on the latest changes.
+
+Please use [GitHub Issues] to report bugs. You can contact me directly on twitter at
+[@JustinTomich](https://twitter.com/justintomich).
+
+[![Gem Version](https://badge.fury.io/rb/invitation.svg)](https://badge.fury.io/rb/invitation) ![Build status](https://travis-ci.org/tomichj/invitation.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/invitation/badges/gpa.svg)
+
+
+## Overview
+
+Allow users to invite others to join an organization or resource. Plenty of gems can issue a 'system-wide' invitation,
+but few offer 'scoped' invitations, giving an invited user access to a particular invitable organization or resource.
+
+Invitations are issued via email. You can invite users new to join the system while giving them permissions to
+a resource, or invite existing users by giving them access to a new resource.
+
+* a user can invite someone to join an invitable by providing an email address to invite
+* if the user already exists, that user is granted access to the invitable, and a notification email is sent
+* if the user does not exist, sends an email with a link to sign up. When the new user signs up,
+they are added to the invitable resource/organization.
+* the invite grants the invited user access to ONLY the invitable organization they were invited to.
+
+
+## Prerequisites
+
+* An authentication system with a User model and current_user helper, e.g. https://github.com/tomichj/authenticate
+* Your user model must include an :email attribute.
+* Additional model classes that are resources or organizations you wish to invite users to join, usually with a
+many-to-many relationship to your user model.
+* You probably also want an authorization system to restrict who can issue invitations to particular resources
+
+A example user-to-organization system you might be familiar with: Basecamp's concepts of accounts and 
+projects (invitables) and users.
+
+
+## Install
+
+To get started, add Invitation to your `Gemfile` and run `bundle install` to install it:
+
+```ruby
+gem 'invitation'
+```
+
+Then run the invitation install generator:
+
+```sh
+rails generate invitation:install
+```
+
+If your user model is not User, you can optionally specify one: `rails generate invitation:install --model Profile`. 
+
+The install generator does the following:
+
+* Add an initializer at `config/initializers/invitation.rb`, see [Configure](#configure) below.
+* Insert `include Invitation::User` into your `User` model.
+* Create a migration for the Invite class.
+
+
+Then run the migration that Invitation just generated.
+
+```sh
+rake db:migrate
+```
+
+
+## Configure
+
+Override any of these defaults in your application `config/initializers/invitation.rb`.
+
+```ruby
+Invitation.configure do |config|
+  config.user_model = '::User'
+  config.user_registration_url = ->(params) { Rails.application.routes.url_helpers.sign_up_url(params) } 
+  config.mailer_sender = 'reply@example.com'
+  config.routes = true
+  config.case_sensitive_email = true
+end
+```
+
+Configuration parameters are described in detail here: [configuration]
+
+
+### Invitable
+
+You'll need to configure one or more model classes as `invitables`. Invitables are resources or organizations that
+can be joined with an invite.
+
+An `invitable` must have some sort of name for Invitation to use in views and mailers.  An invitable needs to 
+call a class method, `invitable`, with one of the following options:
+* `named: "String"`
+* `named_by: :some_method_name`.
+
+Example: a Company model that users can be invited to join. The companies are identified in invitation emails by
+their `name` attribute:
+
+```ruby
+class Company < ActiveRecord::Base
+  invitable named_by: :name
+end
+```
+
+
+### User Registration Controller
+
+Your user registration controller must `include Invitation::UserRegistration`. You'll want to invoke `set_invite_token`
+before you execute your `new` action, and `process_invite_token` after your `create` action.
+
+If you're using [Authenticate](https://github.com/tomichj/authenticate), for example:
+```ruby
+class UsersController < Authenticate::UsersController
+  include Invitation::UserRegistration
+  before_action :set_invite_token, only: [:new]
+  after_action :process_invite_token, only: [:create]
+end
+``` 
+To pass the invite token on signup, add `invite_token` as a hidden field in your signup form.
+
+## Usage
+
+Invitation adds routes to create invitations (GET new_invite and POST invites). Once you've configured
+Invitation and set up an invitable, add a link to new_invite, specifying the the invitable id and type in the link:
+
+```erb
+  <%= link_to 'invite a friend', 
+              new_invite_path(invite: { invitable_id: account.id, invitable_type: 'Account' } ) %>
+```
+
+Invitation includes a simple `invitations#new` view which accepts an email address for a user to invite. 
+
+When the form is submitted, [invites#create](app/controllers/invitation/invites_controller.rb) will create
+an [invite](app/models/invite.rb) to track the invitation. An email is then sent:
+
+* a new user is emailed a link to your user registration page as set in [configuration], with a secure
+invitation link that will be used to 'claim' the invitation when the new user registers 
+
+* an existing user is emailed a notification to tell them that they've been added to the resource
+
+
+### JSON Invitation
+
+You can send a JSON request to [invites#create](app/controllers/invitation/invites_controller.rb).
+
+* request:
+```javascript
+invite:
+{
+    "email": String,
+    "invitable_id": Number,
+    "invitable_type": String
+}
+```
+
+or, with an array of multiple `emails`:
+
+```javascript
+invite:
+{
+    "emails": [String],
+    "invitable_id": Number,
+    "invitable_type": String
+}
+```
+
+* response:
+```javascript
+{
+    "id": Number, 
+    "email": String, 
+    "sender_id": Number, 
+    "recipient_id": Number (optional), 
+    "invitable_id": Number, 
+    "invitable_type": String, 
+}
+```
+
+or, with multiple emails requested, an array of responses:
+
+```javascript
+[{
+    "id": Number, 
+    "email": String, 
+    "sender_id": Number, 
+    "recipient_id": Number (optional), 
+    "invitable_id": Number, 
+    "invitable_type": String, 
+},
+{
+    "id": Number, 
+    "email": String, 
+    "sender_id": Number, 
+    "recipient_id": Number (optional), 
+    "invitable_id": Number, 
+    "invitable_type": String, 
+}]
+```
+
+## Security
+
+Many systems require authorization to issue invitations to a resource. `Invitation` does not handle authorization,
+but is intended to be a simple, easily extended framework upon which you can impose any required authorization scheme.
+
+Most implementations will require extending the `InvitationsController`. [See below](#controllers) to read more
+about extending InvitationController.
+
+A common use case:
+* every invitable resource has authorization requirements exposed via a method, we'll call it `can_invite?(user)`
+* the current user must be authorized before issuing invitations
+
+To implement: extend `InvitesController` and add a before_action to authorize access to the resource or resources. A
+real implementation would probably do something more than just `raise 'unauthorized'`.
+
+```ruby
+# app/controllers/invites_controller.rb
+class InvitesController < Invitation::InvitesController
+  before_action :authorize
+
+  private
+
+  def authorize
+    invitable = load_invitable
+    invitable.can_invite?(current_user) or raise 'unauthorized'
+  end
+
+  def load_invitable
+    invite_params[:invitable_type].classify.constantize.find(invite_params[:invitable_id])
+  end
+end
+```
+
+
+## Overriding Invitation
+
+
+### Views
+
+You can quickly get started with a rails application using the built-in views. See [app/views](/app/views) for
+the default views. When you want to customize an Invitation view, create your own copy of it in your app.
+
+You can use the Invitation view generator to copy the default views and translations
+(see [translations](#translations) below) into your application:
+
+```sh
+$ rails generate invitation:views
+```
+
+
+### Routes
+
+Invitation adds routes to your application. See [config/routes.rb](/config/routes.rb) for the default routes.
+
+If you want to control and customize the routes, you can turn off the built-in routes in
+the Invitation [configuration] with `config.routes = false` and dump a copy of the default routes into your
+application for modification.
+
+To turn off Invitation's built-in routes:
+
+```ruby
+Invitation.configure do |config|
+  config.routes = false
+end
+```
+
+You can run a generator to dump a copy of the default routes into your application for modification. The generator
+will also switch off the routes by setting `config.routes = false` in your [configuration].
+
+```sh
+$ rails generate invitation:routes
+```
+
+
+### Controllers
+
+You can customize the `invites_controller.rb` and the `invites_mailer.rb`. See [app/controllers](/app/controllers)
+for the controller, and [app/mailers](/app/mailers) for the mailer.
+
+To override `invites_controller.rb`, subclass the controller and update your routes to point to your implementation.
+
+* subclass the controller:
+
+```ruby
+# app/controllers/invites_controller.rb
+class InvitesController < Invitation::InvitesController
+  # render invite screen
+  def new
+    # ...
+  end
+  ...
+end
+```
+
+* update your routes to use your new controller. 
+
+Start by dumping a copy of Invitation's routes to your `config/routes.rb`:
+
+```sh
+$ rails generate invitation:routes 
+```
+
+Now update `config/routes.rb`, changing the controller entry so it now points to your `invites` controller instead
+of `invitation/invites`:
+
+```ruby
+resources :invites, controller: 'invites', only: [:new, :create]
+```
+
+You can also use the Invitation controller generator to copy the default controller and mailer into 
+your application if you would prefer to more heavily modify the controller.
+
+```sh
+$ rails generate invitation:controllers
+```
+
+
+### Layout
+
+Invitation uses your application's default layout. If you would like to change the layout Invitation uses when
+rendering views, you can either deploy copies of the controllers and customize them, or you can specify
+the layout in an initializer. This should be done in a to_prepare callback in `config/application.rb`
+because it's executed once in production and before each request in development.
+                              
+You can specify the layout per-controller:
+
+```ruby
+config.to_prepare do
+  Invitation::InvitesController.layout 'my_invites_layout'
+end
+```
+
+
+### Translations
+
+All flash messages and email subject lines are stored in [i18n translations](http://guides.rubyonrails.org/i18n.html).
+Override them like any other i18n translation.
+
+See [config/locales/invitation.en.yml](/config/locales/invitation.en.yml) for the default messages.
+
+
+## Thanks
+
+This gem was inspired by and draws heavily from:
+* https://gist.github.com/jlegosama/9026919
+
+With additional inspiration from:
+* https://github.com/scambra/devise_invitable
+
+## Contributors
+
+Many thanks to:
+
+* [augustocbx](https://github.com/augustocbx) added pt-BR locale file and fixed an init bug
+* [vincentwoo](https://github.com/vincentwoo/) raising the security bar, & bumping Invitation to rails 5.1
+* [conarro](https://github.com/conarro) added case_sensitive_email configuration option
+* [itkin](https://github.com/itkin) bugfix, stringified configuration.user_model 
+* [thesubr00t](https://github.com/thesubr00t) made recipient association optional for rails 5+
+
+## Future changes
+
+Possible future changes, some of which may be breaking:
+
+* accepted flag, so we can scope invites by accepted vs not yet accepted
+* expiration date - invites expire, scope expired by not expired
+* move all view text to locale
+* issue many invitations at once?
+* dynamic user name lookup? requires JS, CSS
+* add JS support to invites#create
+
+## License
+
+This project rocks and uses MIT-LICENSE.
+
+
+[configuration]: lib/invitation/configuration.rb
+[CHANGELOG]: CHANGELOG.md
+[GitHub Issues]: https://github.com/tomichj/invitation/issues

data/lib/generators/invitation/helpers.rb

@@ -69,9 +69,13 @@ module Invitation
         end.join('::')
       end
 
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+
       def migration_version
-        if Rails.version.start_with? '5'
-          "[#{ActiveRecord::Migration.current_version}]"
+        if rails5_and_up?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
         end
       end
     end

data/lib/invitation/engine.rb

@@ -14,7 +14,7 @@ module Invitation
   class Engine < ::Rails::Engine
     config.generators do |g|
       g.test_framework :rspec
-      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.fixture_replacement :factory_bot, dir: 'spec/factories'
     end
   end
 end

data/lib/invitation/version.rb

@@ -1,3 +1,3 @@
 module Invitation
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invitation
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Justin Tomich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,23 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: 4.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: 4.11.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +199,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
 - Rakefile
 - app/controllers/invitation/invites_controller.rb
 - app/forms/invitation/invite_form.rb