mvpkit 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a78c97aaf8fc350fb702744057b73c16fafffd46
+  data.tar.gz: 58c602c862a77dcb0bc840c56c19f1a2b90d0877
+SHA512:
+  metadata.gz: 67866bb1702604125a6a6fc0c454b477a3f9bfeb0874c7547b5088d46c3e325a581eb9f945357dd4472b746d7a36dab285b22ed8c2c6eb9f50737b599d438247
+  data.tar.gz: 4efc911bb55a71d2f3e0eb0164af90cc331a1058b612da0dd634417b986a6316e3786c1156a321de9eeea32bd591351eaa12497169cec34c643e49534bc07844

data/Gemfile

@@ -0,0 +1,30 @@
+source "https://rubygems.org"
+
+gem 'carrierwave'
+gem "cloudinary"
+gem "geocoder"
+gem 'faraday'
+gem 'fog'
+gem 'fog-aws'
+gem "hashie"
+gem "rack-canonical-host"
+gem 'rack-ssl-enforcer'
+gem 'rollbar'
+gem 'sass-rails', '~> 5.0'
+gem 'sitemap_generator'
+gem 'slack-notifier'
+
+group :development do
+  gem "byebug"
+  gem "better_errors"
+  gem "binding_of_caller"
+  gem "bullet"
+  gem "semantic"
+  gem 'web-console', '~> 2.0'
+  # gem 'spring'
+  # gem "shoulda", ">= 0"
+  # gem "rdoc", "~> 3.12"
+  # gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.3.2"
+  # gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,329 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.3.5)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    aws_cf_signer (0.1.3)
+    better_errors (2.1.1)
+      coderay (>= 1.0.0)
+      erubis (>= 2.6.6)
+      rack (>= 0.9.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    bullet (5.4.0)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.10.0)
+    byebug (9.0.6)
+    carrierwave (1.0.0)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
+    cloudinary (1.5.2)
+      aws_cf_signer
+      json (~> 1.8)
+      rest-client (< 2.0)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.4)
+    debug_inspector (0.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    erubis (2.7.0)
+    excon (0.55.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    fission (0.5.0)
+      CFPropertyList (~> 2.2)
+    fog (1.38.0)
+      fog-aliyun (>= 0.1.0)
+      fog-atmos
+      fog-aws (>= 0.6.0)
+      fog-brightbox (~> 0.4)
+      fog-cloudatcost (~> 0.1.0)
+      fog-core (~> 1.32)
+      fog-dynect (~> 0.0.2)
+      fog-ecloud (~> 0.1)
+      fog-google (<= 0.1.0)
+      fog-json
+      fog-local
+      fog-openstack
+      fog-powerdns (>= 0.1.1)
+      fog-profitbricks
+      fog-rackspace
+      fog-radosgw (>= 0.0.2)
+      fog-riakcs
+      fog-sakuracloud (>= 0.0.4)
+      fog-serverlove
+      fog-softlayer
+      fog-storm_on_demand
+      fog-terremark
+      fog-vmfusion
+      fog-voxel
+      fog-vsphere (>= 0.4.0)
+      fog-xenserver
+      fog-xml (~> 0.1.1)
+      ipaddress (~> 0.5)
+    fog-aliyun (0.1.0)
+      fog-core (~> 1.27)
+      fog-json (~> 1.0)
+      ipaddress (~> 0.8)
+      xml-simple (~> 1.1)
+    fog-atmos (0.1.0)
+      fog-core
+      fog-xml
+    fog-aws (1.2.0)
+      fog-core (~> 1.38)
+      fog-json (~> 1.0)
+      fog-xml (~> 0.1)
+      ipaddress (~> 0.8)
+    fog-brightbox (0.11.0)
+      fog-core (~> 1.22)
+      fog-json
+      inflecto (~> 0.0.2)
+    fog-cloudatcost (0.1.2)
+      fog-core (~> 1.36)
+      fog-json (~> 1.0)
+      fog-xml (~> 0.1)
+      ipaddress (~> 0.8)
+    fog-core (1.43.0)
+      builder
+      excon (~> 0.49)
+      formatador (~> 0.2)
+    fog-dynect (0.0.3)
+      fog-core
+      fog-json
+      fog-xml
+    fog-ecloud (0.3.0)
+      fog-core
+      fog-xml
+    fog-google (0.1.0)
+      fog-core
+      fog-json
+      fog-xml
+    fog-json (1.0.2)
+      fog-core (~> 1.0)
+      multi_json (~> 1.10)
+    fog-local (0.3.1)
+      fog-core (~> 1.27)
+    fog-openstack (0.1.19)
+      fog-core (>= 1.40)
+      fog-json (>= 1.0)
+      ipaddress (>= 0.8)
+    fog-powerdns (0.1.1)
+      fog-core (~> 1.27)
+      fog-json (~> 1.0)
+      fog-xml (~> 0.1)
+    fog-profitbricks (3.0.0)
+      fog-core (~> 1.42)
+      fog-json (~> 1.0)
+    fog-rackspace (0.1.4)
+      fog-core (>= 1.35)
+      fog-json (>= 1.0)
+      fog-xml (>= 0.1)
+      ipaddress (>= 0.8)
+    fog-radosgw (0.0.5)
+      fog-core (>= 1.21.0)
+      fog-json
+      fog-xml (>= 0.0.1)
+    fog-riakcs (0.1.0)
+      fog-core
+      fog-json
+      fog-xml
+    fog-sakuracloud (1.7.5)
+      fog-core
+      fog-json
+    fog-serverlove (0.1.2)
+      fog-core
+      fog-json
+    fog-softlayer (1.1.4)
+      fog-core
+      fog-json
+    fog-storm_on_demand (0.1.1)
+      fog-core
+      fog-json
+    fog-terremark (0.1.0)
+      fog-core
+      fog-xml
+    fog-vmfusion (0.1.0)
+      fission
+      fog-core
+    fog-voxel (0.1.0)
+      fog-core
+      fog-xml
+    fog-vsphere (1.7.1)
+      fog-core
+      rbvmomi (~> 1.9)
+    fog-xenserver (0.2.3)
+      fog-core
+      fog-xml
+    fog-xml (0.1.2)
+      fog-core
+      nokogiri (~> 1.5, >= 1.5.11)
+    formatador (0.2.5)
+    geocoder (1.4.3)
+    git (1.3.0)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.5.5)
+    highline (1.7.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.8.1)
+    inflecto (0.0.2)
+    ipaddress (0.8.3)
+    jeweler (2.3.3)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api (~> 0.11.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych (~> 2.2)
+      rake
+      rdoc
+      semver2
+    json (1.8.6)
+    jwt (1.5.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mime-types (2.99.3)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    netrc (0.11.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.3.0)
+      faraday (>= 0.8, < 0.11)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (2.2.4)
+    public_suffix (2.0.5)
+    rack (2.0.1)
+    rack-canonical-host (0.2.2)
+      addressable (> 0, < 3)
+      rack (>= 1.0.0, < 3)
+    rack-ssl-enforcer (0.2.9)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rbvmomi (1.9.4)
+      builder (~> 3.2)
+      json (>= 1.8)
+      nokogiri (~> 1.5)
+      trollop (~> 2.1)
+    rdoc (5.1.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rollbar (2.14.0)
+      multi_json
+    sass (3.4.23)
+    sass-rails (5.0.6)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    semantic (1.6.0)
+    semver2 (3.4.2)
+    sitemap_generator (5.3.0)
+      builder (~> 3.0)
+    slack-notifier (2.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.6)
+    trollop (2.1.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    uniform_notifier (1.10.0)
+    web-console (2.3.0)
+      activemodel (>= 4.0)
+      binding_of_caller (>= 0.7.2)
+      railties (>= 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+    xml-simple (1.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  better_errors
+  binding_of_caller
+  bullet
+  byebug
+  carrierwave
+  cloudinary
+  faraday
+  fog
+  fog-aws
+  geocoder
+  hashie
+  jeweler (~> 2.3.2)
+  rack-canonical-host
+  rack-ssl-enforcer
+  rollbar
+  sass-rails (~> 5.0)
+  semantic
+  sitemap_generator
+  slack-notifier
+  web-console (~> 2.0)
+
+BUNDLED WITH
+   1.14.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Ian Hunter
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Ian Hunter
+
+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,134 @@
+# Installation
+
+Install the mvp gem:
+
+```
+gem install minimum_viable_product
+```
+
+Then setup your project:
+
+```
+mvp new PROJECT
+```
+
+# Setup
+
+## `.env`
+
+Set your `.env` file up with your own variables
+
+```
+ROLLBAR_CLIENT_ACCESS_TOKEN=
+ROLLBAR_SERVER_ACCESS_TOKEN=
+SEGMENT_WRITE_KEY=
+SLACK_WEBHOOK_URL=
+SLACK_POST_USERNAME=
+FACEBOOK_TRACKING_ID=
+AMPLITUDE_API_KEY=
+HOST_DOMAIN=localhost
+HOST_PORT=3000
+HOST_PROTOCOL=http
+GOOGLE_ANALYTICS_ID=
+HOTJAR_ID=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_S3_BUCKET=
+SPOOF_IP=true
+```
+
+## Heroku
+
+To setup deployment for heroku, first create the project:
+
+```
+heroku create PROJECT
+```
+
+You're probably going to want Database backups.  This will let you use `rake db:import`
+
+```
+heroku pg:backups capture
+```
+
+You're also going to need to setup the buildpacks
+
+```
+heroku buildpacks:set heroku/ruby
+heroku buildpacks:add --index 1 heroku/nodejs
+```
+
+Make sure to turn off npm cacheing (since we're loading MVP from a repo)
+
+```
+heroku config:set NODE_MODULES_CACHE=false
+```
+
+Add a scheduled task to update your sitemaps:
+
+```
+heroku addons:create scheduler:standard
+heroku addons:open scheduler
+```
+
+Add the following task: `rake sitemap:worker`.  Your choice on the frequency but I usually use `daily`
+
+# SEO
+
+## Meta Properties
+
+All meta fields are controlled via the `page` object.  Set attributes on this in order to get meta properties populated.  This is best done at the controller level.
+
+### Available Properties
+
+|Property|Description|Inheritance|
+|---|---|---|
+|`page.title`|   |   |
+|`page.description`|   |   |
+|`page.author`|   |   |
+|`page.og_url`|   |   |
+|`page.og_type`|   |   |
+|`page.og_title`|   |`page.title`|
+|`page.og_description`|   |`page.description`|
+|`page.og_image`|   |   |
+|`page.twitter_card`|   |   |   |
+
+## Sitemaps
+
+### Setup
+
+Edit `config/sitemap.rb` with your own custom routes.
+
+### Updating
+
+Run `sitemap:refresh` in production to update Bing/Google with changes to the sitemap.
+
+Put this in a `cron` task or in Heroku Scheduler.
+
+# Helpers
+
+## Geolocation
+
+By default, Geolocation of the session will automatically happen.
+
+You can access the session's geolocation in `request.location`.
+
+To test geolocation locally, set `SPOOF_IP=true` in your `.env`.
+
+For more info see [Geocoder](https://github.com/alexreisner/geocoder).
+
+## Bootstrap
+
+### `row_groups_of`
+
+Makes a series of row/col `div` elements based in group count.
+
+```
+<% row_groups_of(3, [1,2,3,4,5,6,7,8,9]) do |i| %>
+  <div class="panel panel-default">
+    <div class="panel-heading">
+      <h2 class="text-center"><%= i %></h2>
+    </div>
+  </div>
+<% end %>
+```

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "mvpkit"
+  gem.homepage = "http://github.com/ian/mvp"
+  gem.license = "MIT"
+  gem.summary = %Q{The start-to-finish 3 minute product platform}
+  gem.description = %Q{Built for Developers. Ideal for MVPs, product ideation and validation.}
+  gem.email = "ianhunter@gmail.com"
+  gem.authors = ["Ian Hunter"]
+  gem.executables = []
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MVP #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/app/assets/javascripts/mvp/application.js

@@ -0,0 +1 @@
+console.log("MVP Loaded")

data/app/controllers/concerns/mvp/analytics_concern.rb

@@ -0,0 +1,78 @@
+module MVP
+  module AnalyticsConcern
+    extend ActiveSupport::Concern
+
+    INVISIBLE_SESSION_COOKIE = 'invisible'
+
+    included do
+      before_action :generate_uid_if_not_set
+      helper_method :analytics_id
+      helper_method :analytics_identify_events
+      helper_method :analytics_track_events
+    end
+
+    def identify!(id, properties={})
+      return if session[INVISIBLE_SESSION_COOKIE].to_b == true
+
+      events = flash['__analytics_identify_events'] ||= []
+      events << {
+        'id': id,
+        'properties': properties
+      }
+      flash['__analytics_identify_events'] = events
+    end
+
+    def track!(event, properties={})
+      return if session[INVISIBLE_SESSION_COOKIE].to_b == true
+
+      events = flash['__analytics_track_events'] ||= []
+      events << {
+        'name': event,
+        'properties': properties.reverse_merge({
+          iteration: MVP::Iteration.version,
+          user: current_user.try(:name),
+          url: request.fullpath
+        })
+      }
+      flash['__analytics_track_events'] = events
+    end
+
+    def slack!(message, properties=nil)
+      if ENV['SLACK_WEBHOOK_URL']
+        _msg = [message]
+        _msg << properties.inspect if properties
+
+        begin
+          slack_notifier.ping _msg.join(' ')
+        rescue
+          slack_notifier.ping "Tried to use slack messaging but failure happened"
+        end
+      end
+    end
+
+    def analytics_identify_events
+      flash['__analytics_identify_events'] ||= []
+      flash['__analytics_identify_events']
+    end
+
+    def analytics_track_events
+      flash['__analytics_track_events'] ||= []
+      flash['__analytics_track_events']
+    end
+
+    private
+
+    def slack_notifier
+      Slack::Notifier.new ENV['SLACK_WEBHOOK_URL'], channel: ENV['SLACK_POST_CHANNEL'],
+                                                    username: ENV['SLACK_POST_USERNAME']
+    end
+
+    def analytics_id
+      cookies[:uid]
+    end
+
+    def generate_uid_if_not_set
+      cookies[:uid] = SecureRandom.uuid unless cookies[:uid].present?
+    end
+  end
+end

data/app/controllers/concerns/mvp/seo_concern.rb

@@ -0,0 +1,25 @@
+module MVP
+  module SEOConcern
+    extend ActiveSupport::Concern
+
+    private
+
+    included do
+      before_action :force_no_trailing_slash
+      helper_method :page
+    end
+
+    def force_no_trailing_slash
+      return if request.path == '/'
+      redirect_to request.original_url.gsub(/\/$/,'') if request.original_url.match(/\/$/)
+    end
+
+    def page
+      @page ||= begin
+        h = Hashie::Mash.new
+        h.classes = []
+        h
+      end
+    end
+  end
+end