beta_invite 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cbbd6e8201b97124364c75da584ae86e53ae17d
-  data.tar.gz: 39d22b03419a455938fd7d90c0a8ba6b7c1d9070
+  metadata.gz: 38c94035d41e4bc8e96514edf8a0f3b336647cde
+  data.tar.gz: 495a73b6976bd45153f3efd2c105cd6185d089a2
 SHA512:
-  metadata.gz: 6278215e4a20fb331619c0db2fd7965176711062bcc6adcfb958a009e615b394af4d93953945be37a2b78ffb55afadeff2cbb507b39513ada3ca972ae54d8ffe
-  data.tar.gz: eef72e83afb9b97f1e4de7b26f97d2c38b0dcc04368450e423cea1ed345b616bfd620216ae324eff8d631f719b0a45fe5a30b78f8090f5e40e97f826770ab813
+  metadata.gz: deca01f33c4a4840c801206d1ec6007a9c8de4325b5b570bb08098aa1b57e18db79fc95f36ecbc85f1211efed44e004cdf6f665cf88a562c6b73597d6c390cd3
+  data.tar.gz: b1392ebe030a4e4726c3b04dc12411a1898cfbdde6705567f18a24385e0211ec4e509f54ca148bdaf0bd1768a61a74ed2931c7320ab9c61d97be19d4b87e7db0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2013 Kaushik Thirthappa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,9 +2,27 @@
 
 A simple gem to help you build your __beta_invite__ page up and running in no time
 
-##Instructions
+* [Features](#features)
+* [Installation](#installation)
+* [Setup](#setup)
+	- [Initializer](#initializer)
+	- [Migrations](#migrations)
+	- [Mount](#mount)
+* [API](#where-are-the-invites-)
+* [Views](#views)
 
-###Installation
+## For version >= 1.0.0
+
+##Features
+
+* Quick and easy setup of __Beta Invite__ engine and its functionality
+* Random Token stored and generated with each invite
+* Customize and modify all the views and email templates
+* Send emails as notification when someone requests for an invite to the admins
+* Send __Thank you__ emails which can easily be customized by the developer in future.
+
+
+##Installation
 
 ```ruby
 gem install beta_invite
@@ -12,9 +30,27 @@ gem install beta_invite
 
 or with the use of __Bundler__, you can just write `beta_invite` in your `Gemfile` and run `bundle` command in your CLI.
 
-###Setup
+Installing from the source:
+
+```
+gem 'beta_invite', :github => 'git://github.com/ktkaushik/beta_invite.git'
+```
 
-####Migrations
+If you are living on the edge with `beta_invite` gem, then you should refer [this](https://github.com/ktkaushik/beta_invite/blob/master/living_on_the_edge.md)
+
+##Setup
+
+###Initializer
+
+The `beta_invite` gem has a beta_invite installer. First step to setup is to run the __install generator__ 
+
+```ruby
+rails g beta_invite:install
+```
+
+This would create an __initializer__ named `beta_invite.rb`
+
+###Migrations
 The setup is very primary as of now. Once installed, you will need to copy the migrations by running this command
 
 ```ruby
@@ -29,14 +65,25 @@ rake db:migrate
 
 The above migrations would create a `beta_invites` table in your app
 
-####Mount
+
+###Mount
 Now mount the `BetaInvite` engine by going into your `routes.rb` file and adding the below line
 
 ```ruby
 mount BetaInvite::Engine, at: '/'
 ```
 
-####Views
+##Where are the invites ?
+
+Well, you can fire up your rails console and you will see that all the tables are under `BetaInvite::BetaInvite`
+
+This should fetch you all the records
+
+```ruby
+BetaInvite::BetaInvite.all
+```
+
+##Views
 
 ___for version >= 0.1.1___
 
@@ -56,6 +103,7 @@ Obviously, you can mount it to any route.
 
 __You may wanna restart your server__
 
+###[Roadmap](https://github.com/ktkaushik/beta_invite/wiki/Roadmap)
 ###[Changelogs](https://github.com/ktkaushik/beta_invite/wiki/Changelog)
 
 ##Contributing
@@ -68,3 +116,7 @@ __You may wanna restart your server__
 ```
 
 Thank you !
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ktkaushik/beta_invite/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/app/controllers/beta_invite/beta_invites_controller.rb

@@ -7,18 +7,28 @@ module BetaInvite
       @beta_invite = BetaInvite.new
     end
 
+    # Save the email and a randomly generated token
     def create
       email = params[:beta_invite][:email]
-      beta_invite = BetaInvite.new
-      beta_invite.email = email
-      beta_invite.token = SecureRandom.hex(10) #generate a random hex token for all the users
+      beta_invite = BetaInvite.new( email: email, token: SecureRandom.hex(10) )
+
       if beta_invite.save
         flash[:success] = "#{email} has been registered for beta invite"
+
+        # send an email if configured
+        if BetaInviteSetup.send_email_to_admins
+          BetaInvite::BetaInviteNotificationMailer.notify_admins( BetaInviteSetup.from_email,  BetaInviteSetup.admin_emails, email, BetaInvite.count ).deliver
+        end
+
+        if BetaInviteSetup.send_thank_you_email
+          BetaInvite::BetaInviteNotificationMailer.thank_user( BetaInviteSetup.from_email, email ).deliver
+        end
         redirect_to beta_invites_path
       else
         flash[:alert] = beta_invite.errors.full_messages
         redirect_to new_beta_invite_path
       end
+
     end
   end
 end

data/app/mailers/beta_invite/beta_invite_notification_mailer.rb

@@ -0,0 +1,35 @@
+module BetaInvite
+
+  # The BetaInviteNotificationMailer sends notification emails to users and admins
+  # The `from` and `to` emails has to be configured in the initializer.
+  #
+  # Do not forget to enter the mail configurations in your environments file.
+  #
+  class BetaInviteNotificationMailer < ActionMailer::Base
+    
+    # send the email with adequate info
+    # TODO: Subject in locales
+    def notify_admins( from_email, to_email, beta_invite_email, count )
+
+      @email = beta_invite_email
+      @count = count
+      subject = "#{@email} has registered for your app"
+      mail(
+          to: to_email,
+          from: from_email,
+          subject: subject
+        )
+    end
+
+    # Send an email to the user as a thank you
+    # TODO: Subject in locales
+    def thank_user( from_email, to_email )
+      subject = "Thank you for requesting an invite"
+      mail(
+          to: to_email,
+          from: from_email,
+          subject: subject
+        )
+    end
+  end
+end

data/app/views/beta_invite/beta_invite_notification_mailer/notify_admins.html.erb

@@ -0,0 +1,9 @@
+Hi,
+<br/>
+<%= @email %> has registered for BetaInvite
+<br/>
+
+Total no of BetaInvites <%= @count %>
+<br/>
+
+Thanks.

data/app/views/beta_invite/beta_invite_notification_mailer/thank_user.html.erb

@@ -0,0 +1,6 @@
+Hi,
+<br/>
+Thank you registering an invite, we will get back soon.
+<br/>
+
+Thanks.

data/app/views/beta_invite/beta_invites/new.html.erb

@@ -1,4 +1,11 @@
-<h1>You are in new of beta_invites</h1>
+<% flash.each do |key, msg| %>
+  <div class="alert alert-#{name == :notice ? 'success' : 'error' }">
+    <% Array(msg).each_with_index do |message, index| %>
+      <%= content_tag :div, message %>
+    <% end %>
+  </div>
+<% end %>
+<h1>Request for a beta invite</h1>
 <%= form_for @beta_invite do |f| %>
   <%= f.label :email, 'Email'%>
   <%= f.text_field :email, placeholder: "Enter your email"  %>

data/lib/beta_invite.rb

@@ -1,4 +1,5 @@
 require "beta_invite/engine"
+require "beta_invite_setup"
 
 module BetaInvite
 end

data/lib/beta_invite/version.rb

@@ -1,3 +1,3 @@
 module BetaInvite
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/lib/beta_invite_setup.rb

@@ -0,0 +1,14 @@
+# Beta Invite setup module
+
+module BetaInviteSetup
+
+  mattr_accessor :from_email
+  mattr_accessor :admin_emails
+  mattr_accessor :send_email_to_admins
+  mattr_accessor :send_thank_you_email
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/generators/beta_invite/install_generator.rb

@@ -0,0 +1,21 @@
+#
+# TODO: add copy migration file as well. No need for developer to run another command
+#
+module BetaInvite
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a BetaInvite initializer"
+
+      def copy_initializer
+        template "beta_invite.rb", "config/initializers/beta_invite.rb"
+      end
+
+      # Display readme when the user installs the gem. inspired from Devise gem :)
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/beta_invite/templates/README

@@ -0,0 +1,18 @@
+=================================================================================
+Instructions for beta_invite gem
+
+An initializer by the name beta_invite.rb has been created in your initializer,
+wherein you will find a few options there with instructions for you to configure
+
+You can also generate views by running this comamnd:
+
+ rails g beta_invite:views
+
+Please checkout the README on the below URL for full information:
+
+https://github.com/ktkaushik/beta_invite#betainvite
+
+Thanks !
+Roadmap: https://github.com/ktkaushik/beta_invite/wiki/Roadmap
+
+=================================================================================

data/lib/generators/beta_invite/templates/beta_invite.rb

@@ -0,0 +1,22 @@
+# 
+# Setup your BetaInvite engine in easy steps using this config initializer
+# 
+
+BetaInviteSetup.setup do |config|
+  # Setting this to true would send an email to the admins saying that a
+  # particular user with a particular email address has requested for an invite
+  config.send_email_to_admins = false
+
+  # If you have set the above option as true then you should add the email addresses
+  # of the admins who should receive a notification about the user having requested
+  # for an invite in a comma separated value.
+  config.admin_emails = 'email_1@example.org, email_2@example.org'
+
+  # Configure your mail configuration in the environments file and enter the from email
+  # to send emails
+  config.from_email = 'from@email.com'
+
+  # Send thank you emails to the user who has requested for an invite
+  # False by default
+  config.send_thank_you_email = false
+end

data/lib/generators/beta_invite/views_generator.rb

@@ -1,5 +1,6 @@
 require "rails/generators"
 
+# Generate View Generator
 module BetaInvite
   module Generators
     class ViewsGenerator < Rails::Generators::Base
@@ -7,6 +8,7 @@ module BetaInvite
 
       desc "this generator would copy all the view files for beta_invite engine into your rails app"
 
+      # Generate views from the beta_invite gem
       def create_views
         copy_file 'new.html.erb', Rails.root.join('app','views','beta_invite','beta_invites','new.html.erb')
         copy_file 'index.html.erb', Rails.root.join('app','views','beta_invite','beta_invites','index.html.erb')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beta_invite
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Kaushik Thirthappa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,10 @@ files:
 - app/controllers/beta_invite/beta_invites_controller.rb
 - app/helpers/beta_invite/application_helper.rb
 - app/helpers/beta_invite/beta_invites_helper.rb
+- app/mailers/beta_invite/beta_invite_notification_mailer.rb
 - app/models/beta_invite/beta_invite.rb
+- app/views/beta_invite/beta_invite_notification_mailer/notify_admins.html.erb
+- app/views/beta_invite/beta_invite_notification_mailer/thank_user.html.erb
 - app/views/beta_invite/beta_invites/index.html.erb
 - app/views/beta_invite/beta_invites/new.html.erb
 - app/views/layouts/beta_invite/application.html.erb
@@ -48,6 +51,10 @@ files:
 - lib/beta_invite/engine.rb
 - lib/beta_invite/version.rb
 - lib/beta_invite.rb
+- lib/beta_invite_setup.rb
+- lib/generators/beta_invite/install_generator.rb
+- lib/generators/beta_invite/templates/beta_invite.rb
+- lib/generators/beta_invite/templates/README
 - lib/generators/beta_invite/views_generator.rb
 - lib/tasks/beta_invite_tasks.rake
 - MIT-LICENSE
@@ -80,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.1.6
 signing_key: 
 specification_version: 4
 summary: Setup beta invite system with ease