inviter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 245696d791f13ecdd7c706f6f89ff0dbefd403b2
+  data.tar.gz: 5b502006187c8a0f98204161037bd012258d7f54
+SHA512:
+  metadata.gz: ffe0b5f629b966fc7d1d69a2c8d909715695d4338c0355553ddcb9b33757e47b35cd294e8fac87b576522ed754aba6675011ecbe6b546f9eec69e547411310b2
+  data.tar.gz: a9f98ca39050895d3467c79e703367e70862760f24b99d62b7d43c4f09318daf58b08929d7cdc43ad57d1584d8705ac4b81464352232a9f46b22db4bf6362df3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Manuel Morales
+
+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,180 @@
+# Inviter
+Take control of your rails app's invitation system using a set of model unique callbacks.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inviter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install inviter
+```
+
+Run the Installer:
+```bash
+rails g inviter:initializer install
+```
+
+Run new migrations:
+```bash
+rails db:migrate
+```
+
+## Usage
+include the Inviterable module into your application controller
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include Inviterable
+```
+this gives you access to three 'acts_as' methods you can use to set up your invitation relations.
+* acts_as_inviter
+* acts_as_invitee
+* acts_as_invited_to
+
+place the acts_as_inviter method at the top of any model with the ability to send invitations
+```ruby
+class User < ApplicationRecord
+  acts_as_inviter
+```
+like wise place the acts_as_invitee method wthin any model that can recieive invites. A model will frequently contain both 
+acts_as_inviter and acts_as_invitee.
+```ruby
+class User < ApplicationRecord
+  acts_as_inviter
+  acts_as_invitee
+```
+all invitee models have access to **.invitations**  which returns an active record collection of all 
+their invitee associated **Invitations**.
+```ruby
+invitee = User.first
+invitee.invitations == Invitations.where(invitee: invitee)
+```
+Inviter models can also view there invitations using **.sent_invitations**
+```ruby
+inviter = User.first
+inviter.sent_invitations == Invitations.where(inviter: inviter)
+```
+
+An inviter can use the **.send_invitation** method to create an invitation. The method takes a 
+an invitee resource and invited_to model as arguments.
+```ruby
+inviter = User.first
+invitee = User.second
+invited_to = Party.first
+inviter.send_invitation(invitee, invited_to)
+```
+place the acts_as_invited_to method in any model meant to show relation between an inviter and an invitee
+```ruby
+class Party < ApplicationRecord
+  acts_as_invited_to
+```
+ Like an invitee, the invited_to model can access its associated invitations using **.invitations**
+ ```ruby
+ invited_to = Party.first
+ invited_to.invitations == Invitations.where(invited_to: invited_to)
+ ```
+ ## The Invitation Model
+The invitation model gives you options to manipulate created invitations.
+ 
+ ```ruby
+ accepted? # Returns true if accepted_at IS NOT NIL
+ declined? # Returns true if declined_at IS NOT NIL
+ accepted_or_declined? #Returns true if the invitation has been accepted or declined 
+ accept #Accepts an invitation not already accepted or declined
+ decline #Declines an invitation not already accepted or declined
+ reset #Sets the declined_at and accepted_at timestamps to nil
+ ```
+ 
+ ## Callbacks
+ When an valid action is done on an invitation, all invitee, inviter, and invited_to models are sent an associated _callback method for response.
+ The valid actions are create, accept, declined and reset.
+ To view the method name that each action will create use the 
+ **Inviter::InvitationCallbacks** module.
+ The Inviter::InvitationCallbacks module contains a callback generator for each available valid action.
+  ```ruby
+  Inviter::InvitationCallbacks.invitation_created_callback
+  Inviter::InvitationCallbacks.invitation_accepted_callback
+  Inviter::InvitationCallbacks.invitation_declined_callback
+  Inviter::InvitationCallbacks.invitation_reset_callback
+  ```
+These methods take an inviter, invitee, and invited_to instance class as arguments and return a method name string.
+For example:
+```ruby
+args = [User.first, User.second, Party.first]
+Inviter::InvitationCallbacks.invitation_created_callback(*args) 
+    #=> 'user_invited_user_to_party'
+Inviter::InvitationCallbacks.invitation_accepted_callback(*args)
+    #=> 'user_accepted_invite_from_user_to_party'
+Inviter::InvitationCallbacks.invitation_declined_callback(*args) 
+    #=> 'user_declined_invite_from_user_to_party'
+Inviter::InvitationCallbacks.invitation_reset_callback
+    #=> 'user_reset_invite_from_user_to_party
+```
+
+# Example Models
+
+```ruby
+class Party < ApplicationRecord
+  acts_as_invited_to
+
+  has_many :user_parties
+  has_many :users, through: :user_parties
+end
+```
+
+```ruby
+class UserParty < ApplicationRecord
+  belongs_to :user
+  belongs_to :party
+end
+```
+```ruby
+class User < ApplicationRecord
+  acts_as_inviter
+  acts_as_invitee
+
+  has_many :user_parties
+  has_many :parties, through: :user_parties
+
+  private
+
+  class << self
+    def user_invited_user_to_party(invitation)
+      # Do Something when user invites user to party
+      UserMailer.invitatation_sent_email
+    end
+
+    def user_accepted_invite_from_user_to_party(invitation)
+      # Add user to party users collection
+      invitation.invited_to.users << invitation.invitee
+    end
+
+    def user_declined_invite_from_user_to_party(invitation)
+      # Do Something when user declined invite from user to party
+      UserMailer.invitation_declined_email
+    end
+
+    def user_reset_invite_from_user_to_party(invitation)
+      # Do Something when user resets invite from user to party
+      UserMailer.invitation_reset_email
+    end
+  end
+end
+```
+
+These same methods would also be executed on the Party Model if they existed.
+Each callback method also brings its associated invitation through the invitations variable.
+
+## Contributing
+TBA
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Inviter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/app/models/concerns/inviterable.rb

@@ -0,0 +1,19 @@
+module Inviterable
+  extend ActiveSupport::Concern
+
+  private
+
+  module ClassMethods
+    def acts_as_inviter
+      self.include(Inviter::ActsAsInviter)
+    end
+
+    def acts_as_invitee
+      self.include(Inviter::ActsAsInvitee)
+    end
+
+    def acts_as_invited_to
+      self.include(Inviter::ActsAsInvitedTo)
+    end
+  end
+end

data/lib/app/models/invitation.rb

@@ -0,0 +1,67 @@
+class Invitation < ActiveRecord::Base
+  belongs_to :inviter, polymorphic: true
+  belongs_to :invitee, polymorphic: true
+  belongs_to :invited_to, polymorphic: true
+
+  alias_attribute :accepted?, :accepted_at?
+  alias_attribute :declined?, :declined_at?
+
+  after_save :trigger_callbacks, if: :valid_callback?
+
+  def accepted_or_declined?
+    accepted? || declined?
+  end
+
+  def accept
+    update!(accepted_at: Time.current) unless accepted_or_declined?
+  end
+
+  def decline
+    update!(declined_at: Time.current) unless accepted_or_declined?
+  end
+
+  def reset
+    update!(accepted_at: nil, declined_at: nil)
+  end
+
+  private
+
+  [:accepted, :declined, :created].each do |action|
+    define_method("invitation_#{action}?") { eval("saved_change_to_#{action}_at?") }
+  end
+
+  def valid_callback?
+    invitation_created? || invitation_accepted? || invitation_declined?
+  end
+
+  def invitation_reset?
+    return true unless declined? || accepted?
+    false
+  end
+
+  def callback_type
+    return 'created' if invitation_created?
+    return 'reset' if invitation_reset?
+    return 'declined' if invitation_declined?
+    'accepted'
+  end
+
+  def call_back_method
+    callback_args = [inviter, invitee, invited_to]
+    current_callback = "invitation_#{callback_type}_callback"
+    Inviter::InvitationCallbacks.send(current_callback, *callback_args)
+  end
+
+  def trigger_callbacks
+    inviters = Inviter::ActsAsInviter.inviters
+    invitees = Inviter::ActsAsInvitee.invitees
+    invited_tos = Inviter::ActsAsInvitedTo.invited_tos
+    listeners = inviters | invitees | invited_tos
+
+    return unless listeners
+    listeners.each do |klass|
+      _call_back_method = call_back_method
+      klass.send(_call_back_method, self) if klass.respond_to?(_call_back_method)
+    end
+  end
+end

data/lib/generators/inviter/initializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create migration for invitations table
+
+Example:
+    rails generate initializer install
+
+    This will create:
+        db/migrate/#{time_stamp}_inviter_create_invitations.rb

data/lib/generators/inviter/initializer/initializer_generator.rb

@@ -0,0 +1,24 @@
+module Inviter
+  class InitializerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def install
+      template 'inviations_migration.rb',
+               "db/migrate/#{time_stamp}_inviter_create_invitations.rb",
+               time_stamp: time_stamp,
+               migration_version: migration_version
+    end
+
+    private
+
+    def time_stamp
+      Time.current.strftime('%Y%m%d%H%M%S')
+    end
+
+    def migration_version
+      if Rails::VERSION::MAJOR == 5
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/inviter/initializer/templates/inviations_migration.rb

@@ -0,0 +1,18 @@
+class InviterCreateInvitations < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :invitations do |t|
+      t.references :inviter, polymorphic: true, index: true, null: false
+      t.references :invitee, polymorphic: true, index: true, null: false
+      t.references :invited_to, polymorphic: true, index: true, null: false
+      t.timestamp :accepted_at
+      t.timestamp :declined_at
+      t.timestamps
+    end
+
+    add_index(:invitations, :accepted_at)
+    add_index(:invitations, :declined_at)
+    add_index(:invitations, [:accepted_at, :declined_at])
+    add_index(:invitations, [:inviter_id, :inviter_type, :invitee_type, :invitee_id, :invited_to_id,
+                             :invited_to_type], unique: true, name: :unique_invitation_index)
+  end
+end

data/lib/inviter.rb

@@ -0,0 +1,8 @@
+module Inviter
+  require 'inviter/invitation_callbacks'
+  require 'inviter/acts_as_invited_to'
+  require 'inviter/acts_as_invitee'
+  require 'inviter/acts_as_inviter'
+  require 'app/models/concerns/inviterable'
+  require 'app/models/invitation'
+end

data/lib/inviter/acts_as_invited_to.rb

@@ -0,0 +1,19 @@
+module Inviter
+  module ActsAsInvitedTo
+    extend ActiveSupport::Concern
+    class << self
+      attr_reader :invited_tos
+    end
+
+    included do
+      has_many :invitations, as: :invited_to
+    end
+
+    private
+
+    def self.included(base)
+      @invited_tos ||= []
+      @invited_tos << base
+    end
+  end
+end

data/lib/inviter/acts_as_invitee.rb

@@ -0,0 +1,19 @@
+module Inviter
+  module ActsAsInvitee
+    extend ActiveSupport::Concern
+    class << self
+      attr_reader :invitees
+    end
+
+    included do
+      has_many :invitations, as: :invitee
+    end
+
+    private
+
+    def self.included(base)
+      @invitees ||= []
+      @invitees << base
+    end
+  end
+end

data/lib/inviter/acts_as_inviter.rb

@@ -0,0 +1,23 @@
+module Inviter
+  module ActsAsInviter
+    extend ActiveSupport::Concern
+    class << self
+      attr_reader :inviters
+    end
+
+    included do
+      has_many :sent_invitations, as: :inviter, class_name: Invitation
+    end
+
+    def send_invitation(invitee, invited_to)
+      Invitation.create!(inviter: self, invitee: invitee, invited_to: invited_to)
+    end
+
+    private
+
+    def self.included(base)
+      @inviters ||= []
+      @inviters << base
+    end
+  end
+end

data/lib/inviter/invitation_callbacks.rb

@@ -0,0 +1,15 @@
+module Inviter
+  module InvitationCallbacks
+    class << self
+      def invitation_created_callback(inviter, invitee, invited_to)
+        "#{inviter.class.name}_invited_#{invitee.class.name}_to_#{invited_to.class.name}".downcase
+      end
+
+      ['accepted', 'declined', 'reset'].each do |action|
+        define_method("invitation_#{action}_callback") do |inviter, invitee, invited_to|
+          "#{invitee.class.name}_#{action}_invite_from_#{inviter.class.name}_to_#{invited_to.class.name}".downcase
+        end
+      end
+    end
+  end
+end

data/lib/inviter/version.rb

@@ -0,0 +1,3 @@
+module Inviter
+  VERSION = '0.1.0'
+end

data/lib/tasks/inviter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :inviter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: inviter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manuel Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !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'
+description: ''
+email:
+- morales.jmanuel16@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/app/models/concerns/inviterable.rb
+- lib/app/models/invitation.rb
+- lib/generators/inviter/initializer/USAGE
+- lib/generators/inviter/initializer/initializer_generator.rb
+- lib/generators/inviter/initializer/templates/inviations_migration.rb
+- lib/inviter.rb
+- lib/inviter/acts_as_invited_to.rb
+- lib/inviter/acts_as_invitee.rb
+- lib/inviter/acts_as_inviter.rb
+- lib/inviter/invitation_callbacks.rb
+- lib/inviter/version.rb
+- lib/tasks/inviter_tasks.rake
+homepage: https://github.com/mjmorales/inviter
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A Light weight invitation system for Ruby on Rails.
+test_files: []