happyfunjuice 0.0.1.beta.1

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Happyfunjuice'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/happyfunjuice/happyfunjuice_controller.rb

@@ -0,0 +1,51 @@
+class Happyfunjuice::HappyfunjuiceController < ApplicationController
+  
+  before_filter :verify_key
+
+  def activities
+
+    begin
+      activity = params[:activity]
+
+      render :json=> {
+        activities: Happyfunjuice.activities(
+          page: params[:page],
+          per_page: params[:per_page],
+          type: params[:activity],
+          include_metadata: false
+        )
+      }.merge({:status=>'200'})
+
+    rescue StandardError => e
+      render :json=>{:status=>'500', :error=>e.message}
+    end
+
+  end
+
+  def metadata
+
+    begin
+      render :json => {
+        activities: Happyfunjuice.activities(
+          query_activities: false,
+          type: params[:activity]
+        )
+      }.merge({:status=>'200'})
+
+    rescue StandardError => e
+      render :json=>{:status=>'500', :error=>e.message}
+    end
+
+  end
+
+
+  private
+    
+    def verify_key
+      unless (Happyfunjuice.api_key == params[:api_key] )
+        render :json=>{:status=>'403', :error=>'Access Denied'}
+        return
+      end
+    end
+  
+end

data/app/controllers/newsletter_signups_controller.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+class NewsletterSignupsController < ApplicationController
+
+  layout 'landing_page'
+
+  def new
+    @newsletter_signup = NewsletterSignup.new
+    @newsletter_signup.attributes = session.delete(:newsletter_signup_params)
+  end
+
+  def create
+    @newsletter_signup = NewsletterSignup.new(params[:newsletter_signup])
+
+    if @newsletter_signup.save
+      redirect_to root_path, :flash=>{:notice=>'Thank you!'}
+    else
+      session[:newsletter_signup_params] = params[:newsletter_signup]
+      redirect_to root_path, :flash=>{:error=>@newsletter_signup.errors.full_messages}
+    end
+  end
+
+end

data/lib/generators/happyfunjuice/install_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/base'
+
+module Happyfunjuice
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Installs Happyfunjuice"
+
+      class_option :api_key, :type => :string, :required=>true, :desc=>'HappyFunJuice API key'
+
+      class << self
+
+        def source_root
+          @_source_root ||= File.expand_path("../templates", __FILE__)
+        end
+
+      end
+
+      def create_config
+        @api_key = options[:api_key]
+        template 'config/initializers/happyfunjuice.rb.erb', 'config/initializers/happyfunjuice.rb'
+      end
+
+      def insert_routes
+
+        # Indentation is a little finicky here:
+        inject_into_file 'config/routes.rb', <<-END, :after=>'::Application.routes.draw do'
+
+
+  happyfunjuice do
+    activities
+    # landing_page
+  end
+        END
+        
+      end
+
+      # def create_migrations
+      #   Dir["#{self.class.source_root}/migrations/*.rb"].sort.each do |filepath|
+      #     name = File.basename(filepath)
+      #     migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+      #     sleep 1
+      #   end
+      # end
+
+    end
+  end
+end

data/lib/generators/happyfunjuice/js_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/base'
+
+module Happyfunjuice
+  module Generators
+    class JsGenerator < Rails::Generators::Base
+      desc "Installs javascript for client-side instrumentation."
+
+      class << self
+
+        def source_root
+          @_source_root ||= File.expand_path("../templates", __FILE__)
+        end
+
+      end
+
+      def install_js
+        copy_file 'app/assets/javascripts/happyfunjuice.js'
+      end
+
+    end
+  end
+end

data/lib/generators/happyfunjuice/landing_page_generator.rb

@@ -0,0 +1,90 @@
+require 'rails/generators/active_record'
+
+module Happyfunjuice
+  module Generators
+    class LandingPageGenerator < ActiveRecord::Generators::Base
+      desc "Generates a landing page with sendgrid or mailchimp signup"
+
+      class << self
+
+        def source_root
+          @_source_root ||= File.expand_path("../templates", __FILE__)
+        end
+
+      end
+
+      argument :mailer, :type => :string, :default => "sendgrid"
+
+
+      def activate_landing_page_route
+        uncomment_lines 'config/routes.rb', /landing_page/
+      end
+
+      def install_views
+        copy_file 'app/views/newsletter_signups/new.html.haml'
+        copy_file 'app/views/layouts/landing_page.html.haml'
+        copy_file 'app/assets/javascripts/landing_page.js'
+        copy_file 'app/assets/stylesheets/landing_page.css.scss'
+      end
+
+      def set_root_url
+        inject_into_file 'config/routes.rb', <<-END, :after=>'::Application.routes.draw do'
+  
+  
+  root :to=>'newsletter_signups#new'
+
+        END
+      end
+
+      def configure_mailer
+        inject_into_file 'config/initializers/happyfunjuice.rb', <<-END, :after=> 'Happyfunjuice.setup do |config|'
+
+
+  # Mailer type and API key for newsletter signup:
+  config.mailer = '#{mailer}'
+  config.mailer_api_user = #{mailer_username}
+  config.mailer_api_key = #{mailer_password}
+  config.newsletter_list = 'newsletters'
+
+        END
+
+      end
+
+
+      def create_database_model
+        copy_file 'app/models/newsletter_signup.rb'
+        migration_template "#{self.class.source_root}/../migrations/create_newsletter_signups.rb", "db/migrate/#{File.basename('create_newsletter_signups.rb')}"
+      end
+     
+      #def create_migrations
+        #Dir["#{self.class.source_root}/../migrations/*.rb"].sort.each do |filepath|
+          #name = File.basename(filepath)
+          #migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+          #sleep 1
+        #end
+      #end
+
+
+      protected
+
+        def mailer_username
+          case mailer
+            when 'sendgrid'
+              "ENV['SENDGRID_USERNAME']"
+            when 'mailchimp'
+              'MAILCHIMP API USERNAME'
+          end
+        end
+
+        def mailer_password
+          case mailer
+            when 'sendgrid'
+              "ENV['SENDGRID_PASSWORD']"
+            when 'mailchimp'
+              'MAILCHIMP API KEY'
+          end
+        end
+
+    end
+  end
+end

data/lib/generators/happyfunjuice/migrations/create_newsletter_signups.rb

@@ -0,0 +1,10 @@
+class CreateNewsletterSignups < ActiveRecord::Migration
+  def change
+    create_table :newsletter_signups do |t|
+      t.string :name
+      t.string :email
+      #t.string :company
+      t.timestamps
+    end
+  end
+end

data/lib/generators/happyfunjuice/templates/app/assets/javascripts/happyfunjuice.js

@@ -0,0 +1,33 @@
+// I don't know... maybe a jquery plugin for something?
+
+;(function ( $, window, undefined ) {
+
+    var pluginName = 'happyfunjuice',
+            document = window.document,
+            defaults = {
+                propertyName: "value"
+            };
+
+    function Plugin( element, options ) {
+        this.element = element;
+
+        this.options = $.extend( {}, defaults, options) ;
+
+        this._defaults = defaults;
+        this._name = pluginName;
+
+        this.init();
+    }
+
+    Plugin.prototype.init = function () {
+    };
+
+    $.fn[pluginName] = function ( options ) {
+        return this.each(function () {
+            if (!$.data(this, pluginName)) {
+                $.data(this, pluginName, new Plugin( this, options ));
+            }
+        });
+    }
+
+}(jQuery, window));

data/lib/generators/happyfunjuice/templates/app/models/newsletter_signup.rb

@@ -0,0 +1,71 @@
+class NewsletterSignup < ActiveRecord::Base
+
+  attr_accessible :name
+  validates_presence_of :name
+
+  attr_accessible :email
+  validates_presence_of :email
+  validates_format_of :email, :with=>/@/
+  validates_uniqueness_of :email
+
+  #attr_accessible :company
+  #validates_presence_of :company
+  
+
+  after_create :submit_to_mailer!
+  
+
+  def submit_to_mailer!
+    submit_email_address( self.name, self.email )
+  end
+
+
+  def submit_email_address(name, email)
+    begin
+      uri = URI(newsletter_signup_endpoint)
+      data = newsletter_signup_params(name,email)
+      res = Net::HTTP.post_form( uri, data )
+      logger.info "Successful newsletter signup: #{res}"
+    rescue StandardError => e
+      logger.info "Newsletter error: #{e.message}"
+    end
+  end
+
+
+  def newsletter_signup_endpoint
+    case Happyfunjuice.mailer
+
+      when 'sendgrid'
+        'http://sendgrid.com/api/newsletter/lists/email/add.json'
+
+      when 'mailchimp'
+        provider =~ /-([\w]+)$/
+        region = $1
+        "http://#{region}.api.mailchimp.com/1.3/?method=listSubscribe"
+    end
+  end
+
+
+  def newsletter_signup_params(name,email)
+    case Happyfunjuice.mailer
+      
+      when 'sendgrid'
+        {
+          api_user: Happyfunjuice.mailer_api_user,
+          api_key: Happyfunjuice.mailer_api_key,
+          list: Happyfunjuice.newsletter_list,
+          data: {name: name, email: email}
+        }
+
+      when 'mailchimp'
+        {
+          apikey: Happyfunjuice.mailer_api_key,
+          id: Happyfunjuice.newsletter_list,
+          email_address: email
+        }
+
+    end
+  end
+
+
+end

data/lib/generators/happyfunjuice/templates/app/views/layouts/landing_page.html.haml

@@ -0,0 +1,19 @@
+!!!
+%html
+  %head
+    %title Landing Page
+    %meta{name: "viewport", content: "width=device-width, initial-scale=1.0"}
+    = stylesheet_link_tag    "landing_page", :media => "all"
+    = javascript_include_tag "landing_page"
+    = csrf_meta_tags
+  %body
+
+    - unless flash[:notice].blank?
+      .flash.notice= flash[:notice]
+
+    - unless flash[:error].blank?
+      %ul.flash.error
+        - flash[:error].each do |e|
+          %li= e
+
+    = yield

data/lib/generators/happyfunjuice/templates/app/views/newsletter_signups/new.html.haml

@@ -0,0 +1,13 @@
+= form_for @newsletter_signup do |f|
+  .form-group
+    = f.label :name
+    = f.text_field :name
+  .form-group
+    = f.label :email
+    = f.text_field :email
+  -#.form-group
+    = f.label :company
+    = f.text_field :company
+  .form-group
+    = f.submit
+

data/lib/generators/happyfunjuice/templates/config/initializers/happyfunjuice.rb.erb

@@ -0,0 +1,32 @@
+Happyfunjuice.setup do |config|
+
+  # Insert the API key from the HappyFunJuice settings page here:
+  config.api_key = "<%=@api_key%>"
+
+  # Sample usage:
+  #
+  # config.activity :new_user, User do |u|
+  #   { id: u.id, email: u.email, name: u.name, created_at: u.created_at }
+  # end
+  # 
+  # config.activity :all_postcards, PostCard do |p|
+  #   { id: p.id, user_id: p.user_id, url: p.main_url }
+  # end
+  # 
+  # config.activity :pending_postcard, PostCard.pending do |p|
+  #   { id: p.id, user_id: p.user_id, url: p.main_url }
+  # end
+  # 
+  # config.activity :printing_postcard, PostCard.printing do |p|
+  #   { id: p.id, user_id: p.user_id, url: p.main_url }
+  # end
+  # 
+  # config.activity :shipped_postcard, PostCard.shipped do |p|
+  #   { id: p.id, user_id: p.user_id, url: p.main_url }
+  # end
+  # 
+  # config.activity :transaction, Transaction do |t|
+  #   { id: t.id, user_id: t.user_id, amount: t.amount }
+  # end
+  
+end

data/lib/happyfunjuice/activity.rb

@@ -0,0 +1,102 @@
+module Happyfunjuice
+  mattr_accessor :activity_list
+  @@activity_list = {}
+
+  DEFAULT_PER_PAGE = 50
+  MAX_PER_PAGE = 1000
+
+  class << self
+    def push_activity( key, scope, opts={}, &block )
+      Happyfunjuice.activity_list[key.to_sym] = Happyfunjuice::Activity.new( key, scope, opts, &block )
+    end
+
+    # Query the list of activities. Data and metadata combined into one method since the
+    # queries are otherwise identical.
+    #
+    # Optional parameters are:
+    #
+    #   page: controls pagination with DEFAULT_PER_PAGE activities returned at a time
+    #
+    #   type: if specified, queries only this type of activity. Otherwise returns all activities.
+    #
+    #   include_metadata: true/false
+    #
+    #   query_activities: true/false
+    #
+    def activities( opts = {} )
+      # Default options
+      opts.reverse_merge!({
+        page:1,
+        per_page: DEFAULT_PER_PAGE,
+        type: nil,
+        include_metadata: true,
+        query_activities: true
+      })
+
+      # If page unspecified or invalid, return page 1
+      _per_page = [(opts[:per_page] || DEFAULT_PER_PAGE).to_i,1].max
+      _page = [opts[:page].to_i || 1,1].max
+
+      raise StandardError.new("No more than #{MAX_PER_PAGE} records may be returned in a single response.") if _per_page > MAX_PER_PAGE
+
+      ret = {}
+
+      # Choose specified activity or else all activities
+      types = [(opts[:type].to_sym rescue nil)].reject(&:nil?)
+      types = Happyfunjuice.activity_list.keys if types.empty?
+
+      # Iterate through activity types to build response
+      types.each do |k|
+      
+        # Error message returned to user if activity invalid
+        unless Happyfunjuice.activity_list.include? k
+          raise StandardError.new("No activity '#{k.to_s}' is defined")
+        end
+
+        activity = Happyfunjuice.activity_list[k]
+
+        _ret = {}
+        _ret.merge!({data:     activity.query(_page,_per_page)}) if opts[:query_activities]
+        _ret.merge!({metadata: activity.metadata    }) if opts[:include_metadata]
+
+        ret[k] = _ret
+      end
+
+      ret
+    end
+
+  end
+
+  class Activity
+    attr_accessor :key, :scope, :block
+
+    def initialize( key, scope, opts={}, &block )
+      @options = opts
+      @key = key.to_sym
+      @scope = scope
+      @block = block
+    end
+
+    # Kinda gross, but instantiate an object and yield the block on it to get the list of returned keys.
+    def fields
+      block.yield(@scope.new).keys
+    end
+
+    # Execute the query. Reorder (not order, just in case a default order is specified) by id desc
+    # and paginate.
+    def query( page=1, limit=DEFAULT_PER_PAGE )
+      scope.reorder('id desc').limit(limit).offset((page-1)*limit).collect do |activity|
+        block.yield activity
+      end
+    end
+
+    # Metadata for this activity
+    def metadata
+      {
+        key: @key,
+        name: @options[:name] || @key.to_s.humanize,
+        fields: fields
+      }
+    end
+  end
+end

data/lib/happyfunjuice/config.rb

@@ -0,0 +1,64 @@
+module Happyfunjuice
+
+  class << self
+
+    def setup( &block )
+
+      # This MUST happen after initialization otherwise configuration variables
+      # are not known to the models at the time activity reports are configured:
+      Rails.application.config.after_initialize do
+        HappyfunjuiceConfig.class_eval(&block)
+      end 
+
+    end
+
+    # An extra class so there's no ambiguity between mattr_accessors in config.rb
+    # and the methods here:
+    class HappyfunjuiceConfig
+
+      class << self
+        def api_key= key
+          Happyfunjuice.api_key = key.to_s
+        end
+
+        def notifications
+          Happyfunjuice.notifications
+        end
+
+        def environment= env
+          Happyfunjuice.environment = env.to_s
+        end
+
+        def debug_mode= bool
+          Happyfunjuice.debug_mode = !!(bool)
+        end
+
+        def activity( key, scope, opts={}, &block )
+          Happyfunjuice.push_activity( key, scope, opts, &block )
+        end
+
+        def mailer= value
+          unless %w( mailchimp sendgrid ).include? value.downcase
+            raise ArgumentError.new('Mailer host must be either sendgrid or mailchimp. Choose one and reconfigure it later if necessary.')
+          end
+          Happyfunjuice.mailer = value.downcase
+        end
+
+        def mailer_api_user= value
+          Happyfunjuice.mailer_api_user = value
+        end
+
+        def mailer_api_key= value
+          Happyfunjuice.mailer_api_key = value
+        end
+
+        def newsletter_list= value
+          Happyfunjuice.newsletter_list = value
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/happyfunjuice/engine.rb

@@ -0,0 +1,8 @@
+module Happyfunjuice
+
+  # This gives this gem controllers and whatnot. Does more than the content
+  # of this file would seem to indicate, so don't remove it.
+  class Engine < Rails::Engine
+  end
+
+end

data/lib/happyfunjuice/notifications.rb

@@ -0,0 +1,14 @@
+module Happyfunjuice
+
+  class << self
+    def notifications
+
+      # It'd be nice to do something interesting here:
+      ActiveSupport::Notifications.subscribe do |name, start, finish, id, payload|  
+        Rails.logger.debug(["juice_notification:", name, start, finish, id, payload].join(" "))  
+      end 
+
+    end
+  end
+
+end

data/lib/happyfunjuice/routes.rb

@@ -0,0 +1,37 @@
+module ActionDispatch::Routing
+  class Mapper
+
+    # The only helper exposed to happyfunjuice
+    def happyfunjuice(options={}, &block)
+      HappyfunjuiceMapper.new(self,options,&block)
+    end
+
+
+    # Scope helper methods within HappyfunjuiceMapper to avoid name collisions
+    class HappyfunjuiceMapper
+      def initialize(mapper,options={},&block)
+        @mapper = mapper
+
+        options.reverse_merge!({})
+
+        self.instance_eval(&block)
+      end
+
+      def activities 
+        @mapper.namespace :happyfunjuice do
+          @mapper.get 'activities'   => 'happyfunjuice#activities'
+          @mapper.get 'metadata' => 'happyfunjuice#metadata'
+        end
+      end
+
+      def landing_page
+        #@mapper.namespace :happyfunjuice do
+          @mapper.resources :newsletter_signups, :only=>[:new, :create]
+        #end
+      end
+    end
+
+
+  end
+
+end

data/lib/happyfunjuice/version.rb

@@ -0,0 +1,10 @@
+module Happyfunjuice
+  VERSION = "0.0.1.beta.1"
+
+  class << self
+    def version
+      Happyfunjuice::VERSION.dup
+    end
+  end
+
+end

data/lib/happyfunjuice.rb

@@ -0,0 +1,26 @@
+require 'happyfunjuice/routes'
+require 'happyfunjuice/version'
+require 'happyfunjuice/activity'
+require 'happyfunjuice/engine'
+require 'happyfunjuice/config'
+require 'happyfunjuice/notifications'
+
+# Module-wide data
+module Happyfunjuice
+
+  # Variables for Juice
+  @@apikey = nil
+  @@debug_mode = false
+  @@environment = 'production'
+
+  # Variables for landing page:
+  @@mailer = 'sendgrid'
+  @@mailer_api_user = 'username'
+  @@mailer_api_key = 'api-key'
+  @@newsletter_list = 'newsletters'
+
+  mattr_accessor :api_key, :debug_mode
+  mattr_accessor :mailer, :mailer_api_user, :mailer_api_key, :newsletter_list
+  mattr_accessor :environment
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: happyfunjuice
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.1
+  prerelease: 6
+platform: ruby
+authors:
+- Ricky Reusser
+- Will Schenk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pull data and analytics from your app into HappyFunJuice.
+email:
+- ricky@happyfuncorp.com
+- will@happyfuncorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/happyfunjuice/happyfunjuice_controller.rb
+- app/controllers/newsletter_signups_controller.rb
+- lib/generators/happyfunjuice/install_generator.rb
+- lib/generators/happyfunjuice/js_generator.rb
+- lib/generators/happyfunjuice/landing_page_generator.rb
+- lib/generators/happyfunjuice/migrations/create_newsletter_signups.rb
+- lib/generators/happyfunjuice/templates/app/assets/javascripts/happyfunjuice.js
+- lib/generators/happyfunjuice/templates/app/assets/javascripts/landing_page.js
+- lib/generators/happyfunjuice/templates/app/assets/stylesheets/landing_page.css.scss
+- lib/generators/happyfunjuice/templates/app/models/newsletter_signup.rb
+- lib/generators/happyfunjuice/templates/app/views/layouts/landing_page.html.haml
+- lib/generators/happyfunjuice/templates/app/views/newsletter_signups/new.html.haml
+- lib/generators/happyfunjuice/templates/config/initializers/happyfunjuice.rb.erb
+- lib/happyfunjuice/activity.rb
+- lib/happyfunjuice/config.rb
+- lib/happyfunjuice/engine.rb
+- lib/happyfunjuice/notifications.rb
+- lib/happyfunjuice/routes.rb
+- lib/happyfunjuice/version.rb
+- lib/happyfunjuice.rb
+- Rakefile
+homepage: http://happyfunjuice.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Happy Fun Juice!
+test_files: []