invite_only 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8e2a675b3381913c09924c4bf4a0615f9f5843f
+  data.tar.gz: e1adef2dacc69f6c4b6852b93b2f109a578a5fa8
+SHA512:
+  metadata.gz: 4a0e65ec20150146fd8177f6f77500f02e12715719d5d0c9e685d78194bb3c58deb6dbfb29a9bbe9312a292ff787d4ea79373127664badbe31e1c08aed7a8028
+  data.tar.gz: 11f1161fa342b83f40bc5c891fdd52491896a32a54cd5f60f5f7ede0cd7a34afc0f9083b2b89e7a66b675b5566ed23a3591a1a2c16f5bf94c10128059a00b5d4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in invite_only.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mez
+
+MIT License
+
+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,128 @@
+Invite Only
+==============
+
+[![Build Status](https://travis-ci.org/mez/invite_only.png?branch=master)](https://travis-ci.org/mez/invite_only)
+
+
+This gem was inspired by acts_as_tenant. I really liked the fail-safe and out-of-the-way manner of acts_as_tenant! Hence, this is a very low level abstraction layer to help deal with invites to your applications and integrates (near) seamless with Rails.
+
+In addition, acts_as_tenant:
+
+* auto validates on create for any model that you want invite only for.
+* sets up a helper method to allow you to create invite codes.
+
+Installation
+------------
+invite_only is tested for Rails 3.2 and up.
+
+To use it, add it to your Gemfile:
+  ```sh
+  gem 'invite_only'
+  ```
+
+  ```sh
+  bundle install
+  ```
+Run the generator to create the migration
+  ```sh
+  rails g inviter
+  ```
+
+Getting started
+===============
+There are three steps to get your app going with invite_only:
+
+1. enable_invite_only on your controller.
+2. call invite_only on the model you want protected.
+3. add virtual attribute :invite_code
+
+Calling enable_invite_only on your controller
+--------------------------
+
+Add the enable_invite_only to a controller to get the helper method you need to generate a code.
+```ruby
+  class ApplicationController < ActionController::Base
+    enable_invite_only
+  end
+```
+Now you will have a helper method called 'create_invite_code_for(identifier)'. The identifier is the string you use to uniquely identify the model. For example a User.email or User.username. Any string you want to id with. For example..
+
+```ruby
+  code = create_invite_code_for('foo@bar.com')
+```
+
+Calling invite_only on your model
+-------------------
+```ruby
+  class User < ActiveRecord::Base
+    invite_only(:email)
+  end
+```
+
+'invite_only(identifier=:email)' used in the model. Here identifier is the column the model uses as the identifier. invite_only defaults to :email, but in case you want to use for example :username or anything you like you can. This is used during the validation as the attribute to use for look up.
+
+Adding virtual attribute :invite_only
+-------------------
+```ruby
+  class User < ActiveRecord::Base
+    invite_only(:email)
+    attr_accessor :invite_code
+  end
+```
+
+Thats it! Now whenever you try to save an invite_only model, it will not work unless you have the correct :invite_code. How you pass the value to the model is up to you. Simply just add the text field for the code in the form_for the model you are interested in.
+
+To disable all this, simple remove the 'invite_only' call from the model.
+
+Configuration options
+---------------------
+
+You can control the different types of validation messages you can display. The attributes you have to create readers for are the following below.
+
+```ruby
+attr_writer :code_blank_message,
+            :code_invalid_message,
+            :code_identifier_invalid_message,
+            :code_already_used_message
+```
+
+
+The default validation error messages you get out of the box are.
+
+
+| attribute name                    | Default                                           |
+|-----------------------------------|---------------------------------------------------|
+| :code_blank_message               | "is missing."                                     |
+| :code_invalid_message             | "does not work with that #{identifier.to_s}."     |
+| :code_identifier_invalid_message  | "is not valid."                                   |
+| :code_already_used_message        | "has already been used."                          |
+
+An example of setting your own error message is below
+
+```ruby
+  class User < ActiveRecord::Base
+    invite_only(:email)
+
+    protected
+    def code_blank_message
+      'code is blank'
+    end
+  end
+```
+
+
+To Do
+-----
+* Add support for mongodb
+
+Bug reports & suggested improvements
+------------------------------------
+If you have found a bug or want to suggest an improvement, please use our issue tracked at:
+
+[github.com/mez/invite_only/issues](http://github.com/mez/invite_only/issues)
+
+If you want to contribute, fork the project, code your improvements and make a pull request on [Github](http://github.com/mez/invite_only/). When doing so, please don't forget to add tests. If your contribution is fixing a bug it would be perfect if you could also submit a failing test, illustrating the issue.
+
+License
+-------
+Copyright (c) 2014 Mez Gebre, released under the MIT license

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+task :test => :spec

data/invite_only.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invite_only/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invite_only"
+  spec.version       = InviteOnly::VERSION
+  spec.authors       = ["Mez Gebre"]
+  spec.email         = ["mez@jetcode.io"]
+  spec.summary       = %q{Low level invite system.}
+  spec.description   = %q{If you have a model (User, Account, etc..) and you only want invited people to be allowed creating those resource.
+                          Good example is while in beta, invite only account creation.}
+  spec.homepage      = "https://github.com/mez/invite_only"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('rspec-rails')
+  spec.add_development_dependency('database_cleaner')
+  spec.add_development_dependency('sqlite3')
+  spec.add_development_dependency('debugger')
+
+  spec.add_dependency('rails','~> 3.2')
+end

data/lib/generators/inviter/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate inviter Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/inviter/inviter_generator.rb

@@ -0,0 +1,19 @@
+class InviterGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  extend Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+  end
+
+    #need to create the Invite table. Start out only supporting activerecord
+  def setup_active_record_for_invite_only
+    template "invite.rb", "app/models/invite.rb"
+    migration_template "create_invites.rb", "db/migrate/create_invites.rb"
+    rake 'db:migrate'
+  end
+
+end

data/lib/generators/inviter/templates/create_invites.rb

@@ -0,0 +1,11 @@
+class CreateInvites < ActiveRecord::Migration
+  def change
+    create_table :invites do |t|
+      t.string :identifier
+      t.string :code
+      t.boolean :is_used, default: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/inviter/templates/invite.rb

@@ -0,0 +1,3 @@
+class Invite < ActiveRecord::Base
+
+end

data/lib/invite_only/controller_extensions.rb

@@ -0,0 +1,25 @@
+module InviteOnly
+  module ControllerExtensions
+
+    #use this method to enable invite only helper method in your controllers/views
+    def enable_invite_only
+      self.class_eval do
+        helper_method :create_invite_code_for
+
+        #use this helper to generate the code you need to hand off to the person
+        #identifier can be anything that IDs the person i.e. Email|Username etc...
+        #identifier: type=string
+        def create_invite_code_for(identifier)
+          #if email has been invited before, just update with new code.
+          invite = Invite.find_or_initialize_by identifier:identifier
+          #code is only valid for the identifier provided and can only be used once.
+          invite.is_used=false
+          invite.code=SecureRandom.urlsafe_base64
+          invite.save! #no need to validate
+          return invite.code
+        end
+      end
+    end
+
+  end
+end

data/lib/invite_only/errors.rb

@@ -0,0 +1,13 @@
+module InviteOnly
+  class Error < StandardError
+  end
+
+  module Errors
+    class NotRespondingToInviteCode < InviteOnly::Error
+    end
+
+    class NotRespondingToIdentifier < InviteOnly::Error
+    end
+
+  end
+end

data/lib/invite_only/model_extensions.rb

@@ -0,0 +1,81 @@
+module InviteOnly
+
+  module ModelExtensions
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def invite_only(identifier = :email, options={})
+
+        #on create make sure invite code is good
+        #validate :invite_code_legit?, on: :create
+
+        validate Proc.new {|m|
+          #first check we have the attributes we need
+          # You need to have an identifier default='email' and an 'invite_code' either as virtual attributes or columns
+          # in this model!
+          raise InviteOnly::Errors::NotRespondingToIdentifier unless m.respond_to? identifier.to_sym
+          raise InviteOnly::Errors::NotRespondingToInviteCode unless m.respond_to? :invite_code
+
+          #make sure it is not blank
+          if m.invite_code.blank?
+            errors.add(:invite_code, m.code_blank_message)
+            return
+          end
+
+          #make sure it is an existing code.
+          invite = Invite.find_by_code m.invite_code
+          if invite.nil?
+            errors.add(:invite_code, m.code_invalid_message)
+            return
+          end
+          #make sure it matches the identifier invite.
+          if invite.identifier != m.send(identifier.to_sym)
+            errors.add(:invite_code, m.code_identifier_invalid_message)
+            return
+          end
+
+          if invite.is_used
+            errors.add(:invite_code, m.code_already_used_message)
+            return
+          end
+        }, :on => :create
+
+        #if all checks out, be sure to invalidated code. Use Once Policy
+        after_create {
+          #look up the invite recode with the invite_code and mark it used.
+          invite = Invite.find_by_code self.invite_code
+          invite.is_used = true
+          invite.save!
+        }
+
+        private
+        #these are private scoped attributes used for the invite messages in validation
+        attr_writer :code_blank_message,
+                  :code_invalid_message,
+                  :code_identifier_invalid_message,
+                  :code_already_used_message
+
+        #set the reader for the message validations if not set
+        define_method :code_blank_message do
+          @code_blank_message ||= "is missing."
+        end
+
+        define_method :code_identifier_invalid_message do
+          @code_identifier_invalid_message ||= "does not work with that #{identifier.to_s}."
+        end
+
+        define_method :code_invalid_message do
+          @code_invalid_message ||= "is not valid."
+        end
+
+        define_method :code_already_used_message do
+          @code_already_used_message ||= "has already been used."
+        end
+
+      end
+
+    end
+  end
+end

data/lib/invite_only/version.rb

@@ -0,0 +1,3 @@
+module InviteOnly
+  VERSION = "0.0.1"
+end

data/lib/invite_only.rb

@@ -0,0 +1,23 @@
+#RAILS_3 = ::ActiveRecord::VERSION::MAJOR >= 3
+
+require "active_record"
+require "action_controller"
+require "active_model"
+
+
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "invite_only/version"
+require "invite_only/errors"
+require "invite_only/controller_extensions"
+require "invite_only/model_extensions"
+
+#$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, InviteOnly::ModelExtensions)
+  ActionController::Base.extend InviteOnly::ControllerExtensions
+end
+
+module InviteOnly
+end

data/spec/debug.log

@@ -0,0 +1,116 @@
+# Logfile created on 2014-03-03 10:28:40 -0500 by logger.rb/44203
+D, [2014-03-03T10:28:40.508658 #33360] DEBUG -- :    (0.3ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255)) 
+D, [2014-03-03T10:28:40.509273 #33360] DEBUG -- :    (0.1ms)  CREATE TABLE "accounts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "username" varchar(255)) 
+D, [2014-03-03T10:28:40.511405 #33360] DEBUG -- :    (0.1ms)  CREATE TABLE "invites" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_used" boolean DEFAULT 'f', "code" varchar(255), "identifier" varchar(255)) 
+D, [2014-03-03T10:28:40.512535 #33360] DEBUG -- :    (0.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+D, [2014-03-03T10:28:40.512870 #33360] DEBUG -- :    (0.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+D, [2014-03-03T10:28:40.513033 #33360] DEBUG -- :    (0.0ms)  SELECT version FROM "schema_migrations"
+D, [2014-03-03T10:28:40.513176 #33360] DEBUG -- :    (0.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('1')
+D, [2014-03-03T10:28:40.538433 #33360] DEBUG -- :    (0.1ms)  DELETE FROM "users";
+D, [2014-03-03T10:28:40.538633 #33360] DEBUG -- :    (0.1ms)  SELECT name FROM sqlite_master WHERE type='table' AND name='sqlite_sequence';
+D, [2014-03-03T10:28:40.538784 #33360] DEBUG -- :    (0.1ms)  DELETE FROM sqlite_sequence where name = 'users';
+D, [2014-03-03T10:28:40.538913 #33360] DEBUG -- :    (0.0ms)  DELETE FROM "accounts";
+D, [2014-03-03T10:28:40.539046 #33360] DEBUG -- :    (0.1ms)  SELECT name FROM sqlite_master WHERE type='table' AND name='sqlite_sequence';
+D, [2014-03-03T10:28:40.539193 #33360] DEBUG -- :    (0.1ms)  DELETE FROM sqlite_sequence where name = 'accounts';
+D, [2014-03-03T10:28:40.539314 #33360] DEBUG -- :    (0.0ms)  DELETE FROM "invites";
+D, [2014-03-03T10:28:40.539436 #33360] DEBUG -- :    (0.1ms)  SELECT name FROM sqlite_master WHERE type='table' AND name='sqlite_sequence';
+D, [2014-03-03T10:28:40.539596 #33360] DEBUG -- :    (0.0ms)  DELETE FROM sqlite_sequence where name = 'invites';
+D, [2014-03-03T10:28:40.542828 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.542960 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.543103 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.567289 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."identifier" = 'Doug.Butabi' LIMIT 1
+D, [2014-03-03T10:28:40.573125 #33360] DEBUG -- :   SQL (0.2ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "590aEF0I1mtYSSPR0V5iXw"], ["identifier", "Doug.Butabi"]]
+D, [2014-03-03T10:28:40.577828 #33360] DEBUG -- :    (0.1ms)  rollback transaction
+D, [2014-03-03T10:28:40.578798 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.578932 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.579060 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.579875 #33360] DEBUG -- :    (0.0ms)  rollback transaction
+D, [2014-03-03T10:28:40.580533 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.580653 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.580774 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.581460 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.581913 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.582356 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.582775 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.583214 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.586099 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.587108 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "accounts" ("username") VALUES (?)  [["username", "yeezus"]]
+D, [2014-03-03T10:28:40.587438 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.588429 #33360] DEBUG -- :   SQL (0.1ms)  UPDATE "invites" SET "is_used" = ? WHERE "invites"."id" = 5  [["is_used", true]]
+D, [2014-03-03T10:28:40.589031 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.589435 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.589697 #33360] DEBUG -- :    (0.1ms)  rollback transaction
+D, [2014-03-03T10:28:40.590241 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.590359 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.590491 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.591011 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.591418 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.591829 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.592269 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.592663 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.593173 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = '2paccode' LIMIT 1
+D, [2014-03-03T10:28:40.593565 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = '2paccode' LIMIT 1
+D, [2014-03-03T10:28:40.593829 #33360] DEBUG -- :    (0.1ms)  rollback transaction
+D, [2014-03-03T10:28:40.594398 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.594576 #33360] DEBUG -- :    (0.1ms)  commit transaction
+D, [2014-03-03T10:28:40.594789 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.595648 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.596323 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.597022 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.597682 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.598287 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.598860 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'notbangbang' LIMIT 1
+D, [2014-03-03T10:28:40.599240 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'notbangbang' LIMIT 1
+D, [2014-03-03T10:28:40.599428 #33360] DEBUG -- :    (0.0ms)  rollback transaction
+D, [2014-03-03T10:28:40.599844 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.599948 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.600064 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.600539 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.600941 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.601318 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.601753 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.602134 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.602922 #33360] DEBUG -- :    (0.0ms)  rollback transaction
+D, [2014-03-03T10:28:40.603271 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.603388 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.603505 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.603945 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.604339 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.604730 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.605116 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.605485 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.608205 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'usercode' LIMIT 1
+D, [2014-03-03T10:28:40.608549 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'usercode' LIMIT 1
+D, [2014-03-03T10:28:40.609343 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "users" ("email") VALUES (?)  [["email", "user@example.com"]]
+D, [2014-03-03T10:28:40.609663 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'usercode' LIMIT 1
+D, [2014-03-03T10:28:40.610134 #33360] DEBUG -- :   SQL (0.1ms)  UPDATE "invites" SET "is_used" = ? WHERE "invites"."id" = 1  [["is_used", true]]
+D, [2014-03-03T10:28:40.610445 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'usercode' LIMIT 1
+D, [2014-03-03T10:28:40.611155 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = '2chanzcode' LIMIT 1
+D, [2014-03-03T10:28:40.611583 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "accounts" ("username") VALUES (?)  [["username", "2chanz"]]
+D, [2014-03-03T10:28:40.611929 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = '2chanzcode' LIMIT 1
+D, [2014-03-03T10:28:40.612467 #33360] DEBUG -- :   SQL (0.1ms)  UPDATE "invites" SET "is_used" = ? WHERE "invites"."id" = 2  [["is_used", true]]
+D, [2014-03-03T10:28:40.612784 #33360] DEBUG -- :    (0.1ms)  rollback transaction
+D, [2014-03-03T10:28:40.613499 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.613634 #33360] DEBUG -- :    (0.0ms)  commit transaction
+D, [2014-03-03T10:28:40.613756 #33360] DEBUG -- :    (0.0ms)  begin transaction
+D, [2014-03-03T10:28:40.614385 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.614782 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.615178 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.615568 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.615951 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.616471 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'bar' LIMIT 1
+D, [2014-03-03T10:28:40.626366 #33360] DEBUG -- :    (0.1ms)  rollback transaction
+D, [2014-03-03T10:28:40.626936 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.627110 #33360] DEBUG -- :    (0.1ms)  commit transaction
+D, [2014-03-03T10:28:40.627333 #33360] DEBUG -- :    (0.1ms)  begin transaction
+D, [2014-03-03T10:28:40.628208 #33360] DEBUG -- :   SQL (0.1ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "usercode"], ["identifier", "user@example.com"]]
+D, [2014-03-03T10:28:40.628705 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2chanzcode"], ["identifier", "2chanz"]]
+D, [2014-03-03T10:28:40.629169 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "2paccode"], ["identifier", "2pac"]]
+D, [2014-03-03T10:28:40.629549 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "bangbang"], ["identifier", "chiefkeef"]]
+D, [2014-03-03T10:28:40.629943 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "invites" ("code", "identifier") VALUES (?, ?)  [["code", "kimk"], ["identifier", "yeezus"]]
+D, [2014-03-03T10:28:40.630736 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.631149 #33360] DEBUG -- :   SQL (0.0ms)  INSERT INTO "accounts" ("username") VALUES (?)  [["username", "yeezus"]]
+D, [2014-03-03T10:28:40.631446 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.631902 #33360] DEBUG -- :   SQL (0.0ms)  UPDATE "invites" SET "is_used" = ? WHERE "invites"."id" = 5  [["is_used", true]]
+D, [2014-03-03T10:28:40.632197 #33360] DEBUG -- :   Invite Load (0.1ms)  SELECT "invites".* FROM "invites" WHERE "invites"."code" = 'kimk' LIMIT 1
+D, [2014-03-03T10:28:40.632453 #33360] DEBUG -- :    (0.1ms)  rollback transaction

data/spec/invite_only/controller_extensions_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  invite_only(:email)
+  attr_accessor :invite_code
+end
+
+class RoxburyController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  enable_invite_only
+end
+
+describe RoxburyController, type: :controller do
+
+  context 'when call the create_invite_code_for' do
+    controller do
+      def index
+        code = create_invite_code_for "Doug.Butabi"
+        render text:'Doug Butabi is finally making it into a club.'
+      end
+    end
+
+    it 'should be available as a method' do
+      expect { get :index }.not_to raise_error
+    end
+  end
+end

data/spec/invite_only/model_extensions_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+#let's setup a test db
+ActiveRecord::Schema.define(:version => 1) do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.column :email, :string
+  end
+
+  create_table :accounts, :force => true do |t|
+    t.column :username, :string
+  end
+
+  create_table :invites, :force => true do |t|
+    t.column :is_used, :boolean, default: false
+    t.column :code, :string
+    t.column :identifier, :string
+  end
+
+end
+
+# Setup the models
+class User < ActiveRecord::Base
+  attr_accessor :invite_code
+  invite_only(:email)
+end
+
+class Account < ActiveRecord::Base
+  attr_accessor :invite_code
+  invite_only(:username)
+
+  protected
+  def code_blank_message
+    'code is blank'
+  end
+end
+
+class Invite < ActiveRecord::Base
+end
+
+#let test a few things
+describe InviteOnly do
+
+  describe 'model_extension' do
+    context 'when a new invite is created' do
+      let(:invite) { Invite.new }
+      it { expect(invite.is_used).to be false }
+    end
+
+    context 'when validating a model that used invite only' do
+      before do
+        Invite.create! code:'usercode', identifier:'user@example.com'
+        Invite.create! code:'2chanzcode', identifier:'2chanz'
+        Invite.create code:'2paccode', identifier:'2pac'
+        Invite.create code:'bangbang', identifier:'chiefkeef'
+        Invite.create code:'kimk', identifier:'yeezus'
+      end
+
+
+      it 'should use the identifier used to init invite_only' do
+        expect(User.create(email:'user@example.com', invite_code:'usercode')).to be_valid
+        expect(Account.create(username:'2chanz', invite_code:'2chanzcode')).to be_valid
+      end
+
+      it 'should not validate with correct invite_code but different identifier' do
+        #sorry 2chanz but this invite was for 2pac.
+        expect(Account.create(username:'2chanz', invite_code:'2paccode')).not_to be_valid
+      end
+
+      it 'should not validate with different invite_code but correct identifier' do
+        #sorry chiefkeef but you have wrong invite code
+        expect(Account.create(username:'chiefkeef', invite_code:'notbangbang')).not_to be_valid
+      end
+
+      it 'should only used once.' do
+        #yeezus should be good to go
+        expect(Account.create(username:'yeezus', invite_code:'kimk')).to be_valid
+         #not so fast ray j
+        expect(Account.create(username:'ray-j', invite_code:'kimk')).not_to be_valid
+      end
+
+      it 'should have errors when not valid' do
+        expect(Account.create(username:'foo', invite_code:'bar').errors.count).to eq(1)
+      end
+
+      it 'should show the correct error message on blank invite_code' do
+        #[:invite_code, ["code is blank"]] is the error message format
+        expect(Account.create(username:'chiefkeef', invite_code:'').errors.messages.first.last.first).to eq('code is blank')
+      end
+
+      it 'should set is_used to true after create' do
+        Account.create(username:'yeezus', invite_code:'kimk')
+        expect(Invite.find_by(code:'kimk').is_used).to be true
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'database_cleaner'
+require 'invite_only'
+require 'rspec/rails'
+require 'rails'
+
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3',:database => ':memory:')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.infer_base_class_for_anonymous_controllers = true
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+# Setup a test app
+module NightAtTheRoxbury
+  class Application < Rails::Application; end
+end
+
+NightAtTheRoxbury::Application.config.secret_token = "KeUXs+xVS6fmtRe4TPw8sK5IC2T3ceL9DPa7S35Jb5+YzAqWREyoUA=="
+NightAtTheRoxbury::Application.config.secret_key_base = "KeUXs+xVS6fmtRe4TPw8sK5IC2T3ceL9DPa7S35Jb5+YzAqWREyoUA=="

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: invite_only
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mez Gebre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |-
+  If you have a model (User, Account, etc..) and you only want invited people to be allowed creating those resource.
+                            Good example is while in beta, invite only account creation.
+email:
+- mez@jetcode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- invite_only.gemspec
+- lib/.DS_Store
+- lib/generators/inviter/USAGE
+- lib/generators/inviter/inviter_generator.rb
+- lib/generators/inviter/templates/create_invites.rb
+- lib/generators/inviter/templates/invite.rb
+- lib/invite_only.rb
+- lib/invite_only/controller_extensions.rb
+- lib/invite_only/errors.rb
+- lib/invite_only/model_extensions.rb
+- lib/invite_only/version.rb
+- spec/debug.log
+- spec/invite_only/controller_extensions_spec.rb
+- spec/invite_only/model_extensions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mez/invite_only
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Low level invite system.
+test_files:
+- spec/debug.log
+- spec/invite_only/controller_extensions_spec.rb
+- spec/invite_only/model_extensions_spec.rb
+- spec/spec_helper.rb