RubyGems - astrochimp - Versions diffs - 0.1.0 → 0.1.2 - Mend

astrochimp 0.1.0 → 0.1.2

Files changed (71) hide show

data/app/assets/stylesheets/astrochimp/application.css CHANGED Viewed

@@ -9,7 +9,6 @@
  * compiled file, but it's generally better to create a new file per style scope.
  *
  *= require_self
- *= require astrochimp/bootstrap.min
  *= require_tree .
 */

data/app/controllers/astrochimp/signups_controller.rb CHANGED Viewed

@@ -2,6 +2,15 @@ require_dependency "astrochimp/application_controller"
 module Astrochimp
   class SignupsController < ApplicationController
+    before_filter :capture_referrer_code, only: [:index]
+    def capture_referrer_code
+      session[:referrer_id] = Signup.code_to_id(params[:referrer_code]) if params.has_key? :referrer_code
+    end
+    # User's 'astrochimp_splash' layout in THEIR app (that uses this gem)
+    layout "#{Rails.root}/app/views/layouts/#{ENV['AC_SPLASH_LAYOUT'] || 'astrochimp_splash'}"
     def index
       @signup = Signup.new
@@ -11,9 +20,13 @@ module Astrochimp
       end
     end
+    def show
+      @signup = Signup.find(params[:id])
+    end
     # POST
     def create
-      @signup = Signup.new(params[:signup])
+      @signup = Signup.new(params[:signup].merge(referrer_id: session[:referrer_id]))
       @signup.status = Signup::STATUS_NEW
       respond_to do |format|
@@ -22,7 +35,9 @@ module Astrochimp
           format.html { render action: :index }
           format.json { render json: @signup.errors, status: :unprocessable_entity }
         else
-          format.html { redirect_to root_url, notice: ENV['AC_SIGNUP_SUCCESS_NOTICE'] }
+          format.html do
+            redirect_to @signup, notice: ENV['AC_SIGNUP_SUCCESS_NOTICE']
+          end
           format.json { render json: @signup, status: :created, location: @signup }
         end
       end

data/app/models/astrochimp/signup.rb CHANGED Viewed

@@ -1,19 +1,38 @@
 module Astrochimp
   class Signup < ActiveRecord::Base
     # Attributes
-    attr_accessible :email
+    attr_accessible :email, :referrer_id
     # Constants
     STATUS_NEW = 0
     STATUS_SUBSCRIBED = 1
     STATUS_INVITED = 2
+    # Relations
+    has_many :referrals, class_name: 'Signup'
+    belongs_to :referrer, class_name: 'Signup', counter_cache: true
     # Validations
     validates :email, uniqueness: true, email: true
     # Callbacks
     before_create :add_email_to_mailchimp
+    # Include referral code functionality
+    include IdCode
+    alias :referral_code :id_code
+    # Return the referral code instead of id for urls
+    alias :to_param :referral_code
+    def self.find(id_or_code)
+      if id_or_code.is_a? Integer
+        super(id_or_code)
+      else
+        find_by_id_code(id_or_code)
+      end
+    end
     private
     def add_email_to_mailchimp
       # Handle any MailChimp errors

data/app/models/id_code.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module IdCode
+  extend ActiveSupport::Concern
+  module ClassMethods
+    # Determines spacing between consecutive referral codes
+    def factor
+      9
+    end
+    # determines minimum size of a referal code
+    def pad
+      26 ** 3 # insure at least four digits
+    end
+    # Use base 26 here to avoid numeric codes
+    # (We want codes to be clearly distinguishable from ids)
+    def id_to_code(id)
+      (id.to_i * factor + pad).to_s(26).tr('0-9a-p', 'a-z')
+    end
+    # exact inverse of id_to_code
+    def code_to_id(code)
+      (code.to_s.tr('a-z', '0-9a-p').to_i(26) - pad) / factor
+    end
+    def find_by_id_code(code)
+      find(code_to_id(code))
+    end
+  end
+  def id_code
+    self.class.id_to_code(id)
+  end
+end

data/app/views/astrochimp/signups/show.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<h2></h2>
+<p>
+  Your referral link to invite others:
+  <%= link_to referral_link_path(referrer_code: @signup.referral_code, only_path: false),
+              referral_link_path(referrer_code: @signup.referral_code) %>
+</p>
+<p>
+  Number of people you have referred:
+  <%= @signup.signups_count %>
+</p>
+<p>Your signup object:</p>
+<pre>
+  <%= @signup.inspect %>
+</pre>

data/app/views/layouts/astrochimp/application.html.erb CHANGED Viewed

@@ -3,7 +3,8 @@
 <head>
   <title><%= ENV['AC_NAME'] %> Beta Signup</title>
   <%= stylesheet_link_tag "astrochimp/application" %>
-  <link href="http://fonts.googleapis.com/css?family=Oxygen" rel="stylesheet" type="text/css" />
+  <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap.min.css" rel="stylesheet">
+  <link href="//fonts.googleapis.com/css?family=Oxygen" rel="stylesheet" type="text/css" />
   <%= csrf_meta_tags %>
 </head>
 <body>
@@ -38,7 +39,6 @@
           <hr />
-          <%= render 'layouts/astrochimp/messages' %>
           <%= yield %>
         </div>

data/config/astrochimp.example.yml CHANGED Viewed

@@ -1,15 +1,16 @@
 defaults: &defaults
-  name                  : Awesome Startup
-  company               : Company, LLC
-  company_url           : http://mailchimp.com
-  twitter_user          : Brightbit
-  facebook_url          : http://www.facebook.com/brightbit
-  google_analytics_code :
-  mailchimp_list_id     :
-  mailchimp_api_key     :
-  email_format          : html
+  name                  : "Awesome Startup"
+  company               : "Company, LLC"
+  company_url           : "http://mailchimp.com"
+  twitter_user          : "Brightbit"
+  facebook_url          : "http://www.facebook.com/brightbit"
+  google_analytics_code : ""
+  mailchimp_list_id     : ""
+  mailchimp_api_key     : ""
+  email_format          : "html"
   email_double_optin    : false # true will require user to confirm their email address
-  signup_success_notice : Thanks! We'll drop you a line when we launch!
+  signup_success_notice : "Thanks! We'll drop you a line when we launch!"
+  splash_layout         : "astrochimp"
 development:
   <<: *defaults

data/config/initializers/settings.rb CHANGED Viewed

@@ -13,3 +13,13 @@ config.each do |key, value|
   ENV[key] = value.to_s if !value.kind_of?(Hash) && ENV[key].blank?
 end
+#if File.basename($0) != 'rake'
+  #unless ActiveRecord::Base.connection.table_exists?('astrochimp_signups')
+    #raise "\n\nThe Chimp wants you to run rake db:migrate\n\n"
+  #end
+  #if ENV['AC_MAILCHIMP_API_KEY'].blank? || ENV['AC_MAILCHIMP_LIST_ID'].blank?
+    #raise "\n\nThe Chimp wants you to set the ENV variables: AC_MAILCHIMP_API_KEY and AC_MAILCHIMP_LIST_ID.\n" <<
+      #"You can also set them in astrochimp.yml if you're an ape.\n\n"
+  #end
+#end

data/config/routes.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 Astrochimp::Engine.routes.draw do
   root to: "signups#index"
-  resource :signups, only: [:index, :create]
+  resources :signups, only: [:index, :create, :show]
+  get ':referrer_code' => 'signups#index', as: :referral_link
 end

data/db/migrate/20121101211218_add_referrals_to_astrochimp_signup.rb ADDED Viewed

@@ -0,0 +1,10 @@
+class AddReferralsToAstrochimpSignup < ActiveRecord::Migration
+  def change
+    add_column :astrochimp_signups, :referral_id, :integer
+    add_column :astrochimp_signups, :referral_code, :string
+    add_column :astrochimp_signups, :referral_count, :integer, default: 0
+    add_index  :astrochimp_signups, :referral_id
+    add_index  :astrochimp_signups, :referral_code
+  end
+end

data/db/migrate/20121206205605_remove_referral_code_from_astrochimp_signup.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class RemoveReferralCodeFromAstrochimpSignup < ActiveRecord::Migration
+  def change
+    remove_index  :astrochimp_signups, :referral_code
+    remove_column :astrochimp_signups, :referral_code
+  end
+end

data/db/migrate/20121207033108_rename_referrer_id_foreign_key_column.rb ADDED Viewed

@@ -0,0 +1,13 @@
+class RenameReferrerIdForeignKeyColumn < ActiveRecord::Migration
+  def up
+    remove_index  :astrochimp_signups, :referral_id
+    rename_column :astrochimp_signups, :referral_id, :referrer_id
+    add_index     :astrochimp_signups, :referrer_id
+  end
+  def down
+    remove_index  :astrochimp_signups, :referrer_id
+    rename_column :astrochimp_signups, :referrer_id, :referral_id
+    add_index     :astrochimp_signups, :referral_id
+  end
+end

data/db/migrate/20121207034527_rename_referrals_counter_cache_column.rb ADDED Viewed

@@ -0,0 +1,5 @@
+class RenameReferralsCounterCacheColumn < ActiveRecord::Migration
+  def change
+    rename_column :astrochimp_signups, :referral_count, :signups_count
+  end
+end

data/lib/astrochimp/engine.rb CHANGED Viewed

@@ -4,5 +4,12 @@ module Astrochimp
   class Engine < ::Rails::Engine
     isolate_namespace Astrochimp
+    initializer "astrochimp.load_app_instance_data" do |app|
+      app.class.configure do |config|
+        #Pull in all the migrations from Astrochimp to the application
+        config.paths['db/migrate'] += Astrochimp::Engine.paths['db/migrate'].existent
+      end
+    end
   end
 end

data/lib/astrochimp/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Astrochimp
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/generators/astrochimp/install_generator.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module Astrochimp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Move astrochimp configuration and layout in place"
+      def copy_config_yml
+        copy_file "../../../config/astrochimp.example.yml", "config/astrochimp.yml"
+      end
+      def copy_default_layout
+        copy_file "../../templates/astrochimp.html.erb", "app/views/layouts/astrochimp.html.erb"
+      end
+      def add_astrochimp_routes
+        route 'mount Astrochimp::Engine => "/"'
+      end
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README ADDED Viewed

@@ -0,0 +1,22 @@
+===============================================================================
+Your app is now Chimpified!
+1. Add the astrochimp_signups table by running:
+     rake db:migrate
+2. Set your Mailchimp API key and List ID:
+     export AC_MAILCHIMP_API_KEY=abcdefg12345
+     export AC_MAILCHIMP_LIST_ID=zyxwvut09876
+   Note: you can also set these in astrochimp.yml but ENV variables will take precedence
+3. Specify your own configurations in astrochimp.yml (optional)
+4. Give the astrochimp.html.erb layout your own style (optional)
+5. Modify your routes.rb and mount the chimp somewhere besides '/' (optional)
+===============================================================================

data/lib/templates/astrochimp.html.erb ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= ENV['AC_NAME'] %> Beta Signup</title>
+  <%= stylesheet_link_tag "astrochimp/application" %>
+  <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap.min.css" rel="stylesheet">
+  <link href="//fonts.googleapis.com/css?family=Oxygen" rel="stylesheet" type="text/css" />
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="container">
+    <!-- Header -->
+    <div class="row">
+      <div class="span7">
+        <div id="header" class="outside">
+          <h1><a href="/"><%= ENV['AC_NAME'] %></a></h1>
+        </div>
+      </div>
+      <div class="span5">
+        <div id="nav_header_user">
+        </div>
+      </div>
+    </div>
+    <!-- Content -->
+    <div class="row">
+      <div class="span4">
+        <div class="appframe iphone">
+          <%= image_tag('astrochimp/Astrochimp-phone-splash.png') %>
+        </div>
+      </div>
+      <div class="span8">
+        <div class="hero-unit">
+          <h1>Change The World in 5 Minutes.</h1>
+          <h2>Literally. The Entire World.</h2>
+          <p>Rock the world so hard it turns upside down. Like Australia.</p>
+          <hr />
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+    <div class="row">
+      <div class="span4">
+        <div class="well">
+          <h2>Feature One</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+      <div class="span4">
+        <div class="well">
+          <h2>Feature Two</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+      <div class="span4">
+        <div class="well">
+          <h2>Feature Three</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+    </div>
+    <!-- Footer -->
+    <div class="row">
+      <div class="span6 company">
+        <p><%= ENV['AC_NAME'] %> is a product of <a href="<%= ENV['AC_COMPANY_URL'] %>"><%= ENV['AC_COMPANY'] %></a></p>
+      </div>
+      <div class="span6 credits">
+        <p><a href="http://mailchimp.com">Powered by MailChimp</a></p>
+      </div>
+    </div>
+  </div>
+  <!-- JavaScripts -->
+  <% if !ENV['AC_GOOGLE_ANALYTICS_CODE'].blank? -%>
+  <script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', '<%= ENV['AC_GOOGLE_ANALYTICS_CODE'] %>']);
+    _gaq.push(['_trackPageview']);
+    (function() {
+     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+     ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+     var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+    })();
+  </script>
+  <% end %>
+  <%= javascript_include_tag "astrochimp/application" %>
+</body>
+</html>

data/test/dummy/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    astrochimp (0.0.1)
+    astrochimp (0.1.2)
       hominid (~> 3.0.5)
       jquery-rails
       rails (~> 3.2.8)

data/test/dummy/app/views/layouts/astrochimp.html.erb ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= ENV['AC_NAME'] %> Beta Signup</title>
+  <%= stylesheet_link_tag "astrochimp/application" %>
+  <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap.min.css" rel="stylesheet">
+  <link href="//fonts.googleapis.com/css?family=Oxygen" rel="stylesheet" type="text/css" />
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="container">
+    <!-- Header -->
+    <div class="row">
+      <div class="span7">
+        <div id="header" class="outside">
+          <h1><a href="/"><%= ENV['AC_NAME'] %></a></h1>
+        </div>
+      </div>
+      <div class="span5">
+        <div id="nav_header_user">
+        </div>
+      </div>
+    </div>
+    <!-- Content -->
+    <div class="row">
+      <div class="span4">
+        <div class="appframe iphone">
+          <%= image_tag('astrochimp/Astrochimp-phone-splash.png') %>
+        </div>
+      </div>
+      <div class="span8">
+        <div class="hero-unit">
+          <h1>Change The World in 5 Minutes.</h1>
+          <h2>Literally. The Entire World.</h2>
+          <p>Rock the world so hard it turns upside down. Like Australia.</p>
+          <hr />
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+    <div class="row">
+      <div class="span4">
+        <div class="well">
+          <h2>Feature One</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+      <div class="span4">
+        <div class="well">
+          <h2>Feature Two</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+      <div class="span4">
+        <div class="well">
+          <h2>Feature Three</h2>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce
+            bibendum leo sed enim mattis vitae ullamcorper felis pellentesque.
+            Sed porta eleifend diam sit amet tincidunt.
+          </p>
+        </div>
+      </div>
+    </div>
+    <!-- Footer -->
+    <div class="row">
+      <div class="span6 company">
+        <p><%= ENV['AC_NAME'] %> is a product of <a href="<%= ENV['AC_COMPANY_URL'] %>"><%= ENV['AC_COMPANY'] %></a></p>
+      </div>
+      <div class="span6 credits">
+        <p><a href="http://mailchimp.com">Powered by MailChimp</a></p>
+      </div>
+    </div>
+  </div>
+  <!-- JavaScripts -->
+  <% if !ENV['AC_GOOGLE_ANALYTICS_CODE'].blank? -%>
+  <script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', '<%= ENV['AC_GOOGLE_ANALYTICS_CODE'] %>']);
+    _gaq.push(['_trackPageview']);
+    (function() {
+     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+     ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+     var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+    })();
+  </script>
+  <% end %>
+  <%= javascript_include_tag "astrochimp/application" %>
+</body>
+</html>

data/test/dummy/config/astrochimp.yml CHANGED Viewed

@@ -1,15 +1,16 @@
 defaults: &defaults
-  name                  : Awesome Startup
-  company               : Company, LLC
-  company_url           : http://mailchimp.com
-  twitter_user          : Brightbit
-  facebook_url          : http://www.facebook.com/brightbit
-  google_analytics_code :
-  mailchimp_list_id     :
-  mailchimp_api_key     :
-  email_format          : html
+  name                  : "Awesome Startup"
+  company               : "Company, LLC"
+  company_url           : "http://mailchimp.com"
+  twitter_user          : "Brightbit"
+  facebook_url          : "http://www.facebook.com/brightbit"
+  google_analytics_code : ""
+  mailchimp_list_id     : ""
+  mailchimp_api_key     : ""
+  email_format          : "html"
   email_double_optin    : false # true will require user to confirm their email address
-  signup_success_notice : Thanks! We'll drop you a line when we launch!
+  signup_success_notice : "Thanks! We'll drop you a line when we launch!"
+  splash_layout         : "astrochimp"
 development:
   <<: *defaults

data/test/dummy/config/routes.rb CHANGED Viewed

@@ -1,4 +1,6 @@
 Rails.application.routes.draw do
   mount Astrochimp::Engine => "/"
 end

data/test/dummy/custom_plan.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'zeus/rails'
+class CustomPlan < Zeus::Rails
+  # def my_custom_command
+  #  # see https://github.com/burke/zeus/blob/master/docs/ruby/modifying.md
+  # end
+end
+Zeus.plan = CustomPlan.new

data/test/dummy/db/schema.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+ActiveRecord::Schema.define(:version => 20121207034527) do
+  create_table "astrochimp_signups", :force => true do |t|
+    t.string   "email"
+    t.integer  "status"
+    t.datetime "created_at",                   :null => false
+    t.datetime "updated_at",                   :null => false
+    t.integer  "referrer_id"
+    t.integer  "signups_count", :default => 0
+  end
+  add_index "astrochimp_signups", ["referrer_id"], :name => "index_astrochimp_signups_on_referrer_id"
+end