bluebase_api 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6ddcaa4125f7f7b4ae65c32b1b4c12c243b4809
+  data.tar.gz: 238f701b724851a0af98c568cc9b046fb4e55909
+SHA512:
+  metadata.gz: 93ed4092807a3c739e96d36394bd15fc38d613db67b97b73ec71f92614cdd7ba8595b4a6a58296b3a488f379f69ea8d14ee97b6e0288deb3fe9749c123221a4f
+  data.tar.gz: 00259e82b18122fe23bd387c66183a3cea3f61556999215fea1ee5dd1d6473424d9d8c690692216dfdbbf6c8f9500554c6e264338df84c585be81b0f004310b1

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.hound.yml

@@ -0,0 +1,6 @@
+ruby:
+  enabled: true
+  config_file: ./.rubocop.yml
+
+# Show cop names by default; can commment out if needed
+ShowCopNames: true

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude: ~
+
+Metrics/LineLength:
+  Description: 'Limit lines to 110 characters.'
+  Max: 110
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+bluebase_api

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bluebase_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cal Blueprint
+
+MIT License
+
+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,85 @@
+# Bluebase
+
+The base API for Blueprint's Rails mobile applications.
+
+## Features
+
+Core gems:
+- [Thin](https://github.com/macournoyer/thin/) for the server
+- [Postgres](https://rubygems.org/gems/pg) to use postgres as the database
+- [Figaro](https://github.com/laserlemon/figaro) for environment variables
+
+Component gems:
+- [Devise](https://github.com/plataformatec/devise) for user auth
+- [Gon](https://github.com/gazay/gon) to push data to javascript
+- [Kaminari](https://github.com/amatsuda/kaminari) for pagination
+- [Recipient Interceptor](https://github.com/croaky/recipient_interceptor) to stop email sending from staging
+
+Development gems:
+- [Annotate](https://github.com/ctran/annotate_models) to annotate models
+- [FFaker](https://github.com/EmmanuelOga/ffaker) to generate random data
+- [Better Errors](https://github.com/charliesome/better_errors) + [Binding of Caller](https://github.com/banister/binding_of_caller) for useful error pages
+- [Quiet Assets](https://github.com/evrone/quiet_assets) to quiet asset rending output in the server
+- [Spring](https://github.com/rails/spring) for fast commands
+- [Rubocop](https://github.com/bbatsov/rubocop) for Rails linting
+- [I18n Tasks](https://github.com/glebm/i18n-tasks) to lint translation files
+- [Awesome Print](https://github.com/michaeldv/awesome_print) for better console object printing
+- [Guard](https://github.com/guard/guard) to run tasks on file changes
+- [Pry](https://github.com/pry/pry) and [Pry Byebug](https://github.com/deivid-rodriguez/pry-byebug) to explore objects and debug
+
+Test gems:
+- [RSpec](https://github.com/rspec/rspec-rails) for specs
+- [Capybara](https://github.com/jnicklas/capybara) for integration tests
+- [FactoryGirl](https://github.com/thoughtbot/factory_girl) for test data
+- [Shoulda Matchers](https://github.com/thoughtbot/shoulda) for common RSpec matchers
+- Launchy to use ```save_and_open_page``` in Capybara
+- [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) to clear the database for specs
+- [CodeClimate Test Reporter](https://github.com/codeclimate/ruby-test-reporter) to track test coverage
+
+Production gems/features (most of these require setup):
+- New Relic for monitoring performance
+- Rollbar for error logging
+- Rails 12Factor for Heroku
+
+Other features:
+- Staging environment config
+- Email config using SMTP
+- The ```./bin/setup``` convention for new developer setup
+- Rails' flashes set up and in application layout
+- Configuration for Rubocop/[Hound](https://houndci.com/)
+- A Guardfile set up with [Livereload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en), RSpec, and Rubocop
+- A few nice time formats set up for localization
+- ```Rack::Deflater``` to compress responses with Gzip
+- A low database connection pool limit
+- ```t()``` and ```l()``` in specs without prefixing with I18n
+- An automatically-created ```SECRET_KEY_BASE``` environment variable in all environments.
+- Config for Google Analytics
+
+## Installation
+
+Run
+
+    gem install bluebase_api
+
+Then you can run
+
+    bluebase_api app_name
+
+To create an app called ```app_name```. Optionally append ```-G repo_name``` and ```-H``` to create a Github repo and staging + production Heroku apps, respectively.
+
+## Contributing
+
+Feel free to open issues or send pull requests with improvements. Thanks in
+advance for your help!
+
+## Cal Blueprint
+![bp](http://bptech.berkeley.edu/assets/logo-full-large-d6419503b443e360bc6c404a16417583.png "BP Banner")
+**[Cal Blueprint](http://www.calblueprint.org/)** is a student-run UC Berkeley organization devoted to matching the skills of its members to our desire to see social good enacted in our community. Each semester, teams of 4-5 students work closely with a non-profit to bring technological solutions to the problems they face every day.
+
+## Credits
+Bluebase is a fork of thoughtbot's [suspenders](https://github.com/thoughtbot/suspenders)
+
+## License
+
+Bluebase is Copyright © 2014 Cal Blueprint. It is free software, and may be redistributed under the terms
+specified in the LICENSE.txt file.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Run the test suite'
+task default: :rspec

data/bin/bluebase_api

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'bluebase_api'
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Bluebase_api::AppGenerator.source_root templates_root
+Bluebase_api::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Bluebase_api::AppGenerator.start

data/bin/build

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/bluebase_api"
+version = Bluebase_api::VERSION
+%x(gem build bluebase_api.gemspec)
+%x(gem install ./bluebase_api-#{version}.gem)

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bluebase_api', 'bundler')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bluebase_api', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bluebase_api', 'rspec')

data/bluebase_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bluebase_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bluebase_api"
+  spec.version       = Bluebase_api::VERSION
+  spec.authors       = ["Sam Lau, Tricia Fu and Quinton Dang", "Cal Blueprint"]
+  spec.email         = ["team@calblueprint.org"]
+  spec.summary       = "Bluebase_api creates a Rails API app with all of our favorite defaults."
+  spec.description   = <<-HERE
+Bluebase_api is Blueprint's base Rails API app. We use it internally to get a jump start on our Rails projects.
+  HERE
+  spec.homepage      = "https://github.com/calblueprint/bluebase_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= #{Bluebase_api::RUBY_VERSION}"
+
+  spec.add_runtime_dependency "rails", Bluebase_api::RAILS_VERSION
+  spec.add_runtime_dependency "bundler", "~> 1.6"
+
+  spec.add_development_dependency "rspec", "~> 3.2", ">= 3.2.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "capybara", "~> 2.4"
+end

data/lib/bluebase_api.rb

@@ -0,0 +1,4 @@
+require_relative "bluebase_api/version"
+require_relative "bluebase_api/generators/app_generator"
+require_relative "bluebase_api/actions"
+require_relative "bluebase_api/app_builder"

data/lib/bluebase_api/actions.rb

@@ -0,0 +1,25 @@
+module Bluebase_api
+  module Actions
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+
+    def action_mailer_host(rails_env, host)
+      host_config = "config.action_mailer.default_url_options = { host: '#{host}' }"
+      configure_environment(rails_env, host_config)
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+  end
+end

data/lib/bluebase_api/app_builder.rb

@@ -0,0 +1,379 @@
+module Bluebase_api
+  class AppBuilder < Rails::AppBuilder
+    include Bluebase_api::Actions
+
+    #########################################################
+    # Root directory files
+    #########################################################
+    def readme
+      template "README.md.erb", "README.md"
+    end
+
+    def replace_gemfile
+      remove_file "Gemfile"
+      template "Gemfile.erb", "Gemfile"
+    end
+
+    def add_envrc
+      copy_file ".envrc", ".envrc"
+    end
+
+    def replace_gitignore
+      remove_file ".gitignore"
+      copy_file "bluebase_api_gitignore", ".gitignore"
+    end
+
+    def add_rubocop_and_hound_config
+      copy_file ".hound.yml", ".hound.yml"
+      copy_file ".rubocop.yml", ".rubocop.yml"
+    end
+
+    def add_rvm_config
+      create_file ".ruby-gemset",  "#{app_path}\n"
+      create_file ".ruby-version", "#{Bluebase_api::RUBY_VERSION}\n"
+    end
+
+    def add_guardfile
+      copy_file "Guardfile", "Guardfile"
+    end
+
+    def add_dot_rspec
+      copy_file ".rspec", ".rspec"
+    end
+
+    #########################################################
+    # app/ directory files
+    #########################################################
+
+    # Only front-end changes were contained here, so removed for API app.
+    def configure_api_directory
+      empty_directory "app/controllers/api"
+    end
+
+    def configure_v1_directory
+      empty_directory_with_keep_file "app/controllers/api/v1"
+    end
+
+    def add_base_controller
+      template "app/controllers/api/base_controller.rb", "app/controllers/api/base_controller.rb"
+    end
+
+    def replace_application_controller
+      file = "app/controllers/application_controller.rb"
+      remove_file file
+      template "app/controllers/bluebase_api_application_controller.rb", file
+    end
+
+    def add_serializers_directory
+      empty_directory_with_keep_file "app/serializers"
+    end
+
+    def remove_app_assets_directory
+      run "rm -rf app/assets"
+    end
+
+    def remove_app_views_directory
+      run "rm -rf app/views"
+    end
+
+    #########################################################
+    # vendor directory files
+    #########################################################
+    def remove_vendor_assets_directories
+      run "rm -rf vendor"
+      empty_directory_with_keep_file "vendor"
+    end
+    #########################################################
+    # public/ directory files
+    #########################################################
+    def remove_html_files
+      remove_file "public/404.html"
+      remove_file "public/422.html"
+      remove_file "public/500.html"
+      run "rm -rf public/favicon.ico"
+    end
+
+    #########################################################
+    # bin/ directory files
+    #########################################################
+    def add_setup_to_bin
+      copy_file "bin/setup", "bin/setup"
+      run "chmod a+x bin/setup"
+    end
+   
+    #########################################################
+    # lib/ directory files
+    #########################################################
+    def remove_lib_assets_directory
+      run "rm -rf lib/assets"
+    end
+
+    #########################################################
+    # tmp/ directory files
+    #########################################################
+    def remove_tmp_assets_directory
+      run "rm -rf tmp/cache"
+      empty_directory_with_keep_file "tmp/cache"
+    end
+    #########################################################
+    # config/ directory files
+    #########################################################
+    def configure_application_environment
+      config = <<-RUBY
+
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+
+      config = <<-RUBY
+    config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+
+    def configure_development_environment
+      replace_in_file "config/environments/development.rb",
+        "raise_delivery_errors = false", "raise_delivery_errors = true"
+      inject_into_file "config/environments/development.rb",
+        "  # Don't send emails in development\n  config.action_mailer.perform_deliveries = false",
+        after: "raise_delivery_errors = true\n"
+      raise_on_missing_translations_in "development"
+      action_mailer_host "development", "localhost:3000"
+    end
+
+    def configure_test_environment
+      raise_on_missing_translations_in "test"
+    end
+
+    def configure_production_environment
+      prepend_file "config/environments/production.rb",
+        %{require Rails.root.join("config/smtp")\n}
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+      inject_into_file "config/environments/production.rb", config,
+        after: "config.action_mailer.raise_delivery_errors = false"
+
+      config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+      RUBY
+      inject_into_file "config/environments/production.rb", config,
+        after: "config.serve_static_assets = false\n"
+
+      action_mailer_host "production", "please-change-me.com"
+    end
+
+    def add_staging_environment
+      template "config/staging.rb.erb", "config/environments/staging.rb"
+    end
+
+    def add_devise_config
+      copy_file "config/devise.rb", "config/initializers/devise.rb"
+    end
+
+    def add_figaro_config
+      copy_file "config/figaro.rb", "config/initializers/figaro.rb"
+    end
+
+    def replace_en_yml
+      file = "config/locales/en.yml"
+      remove_file file
+      template "config/en.yml.erb", file
+    end
+
+    def add_application_yml
+      template "config/application.yml.sample.erb", "config/application.yml.sample"
+
+      template "config/application.yml.sample.erb", "config/application.yml"
+      replace_in_file "config/application.yml",
+        "# Copy this file into application.yml and change env variables as necessary.",
+        "# Change env variables as necessary."
+    end
+
+    def add_database_yml
+      template "config/database.yml.sample.erb", "config/database.yml.sample"
+
+      remove_file "config/database.yml"
+      template "config/database.yml.sample.erb", "config/database.yml"
+      replace_in_file "config/database.yml",
+        "# and then copy the file into database.yml", ""
+    end
+
+    def add_i18n_tasks_yml
+      file = "config/i18n-tasks.yml"
+      copy_file file, file
+    end
+
+    def replace_secrets_yml
+      file = "config/secrets.yml"
+      remove_file file
+      copy_file "config/bluebase_api_secrets.yml", file
+    end
+
+    def add_smtp_settings
+      file = "config/smtp.rb"
+      copy_file file, file
+    end
+
+    def replace_routes_rb
+      file = "config/routes.rb"
+      remove_file file
+      template "config/bluebase_api_routes.rb", file
+    end
+
+    #########################################################
+    # spec/ directory files
+    #########################################################
+    def add_spec_dirs
+      empty_directory "spec"
+      empty_directory_with_keep_file "spec/features"
+      empty_directory_with_keep_file "spec/factories"
+    end
+
+    def configure_rspec
+      %w(spec/rails_helper.rb spec/spec_helper.rb).each do |file|
+        copy_file file, file
+      end
+    end
+
+    def configure_factorygirl
+      copy_file "spec/factory_girl.rb", "spec/support/factory_girl.rb"
+    end
+
+    def configure_actionmailer
+      copy_file "spec/action_mailer.rb", "spec/support/action_mailer.rb"
+    end
+
+    def configure_i18n
+      copy_file "spec/i18n.rb", "spec/support/i18n.rb"
+    end
+
+    def configure_database_cleaner
+      copy_file "spec/database_cleaner_and_factory_girl_lint.rb",
+        "spec/support/database_cleaner_and_factory_girl_lint.rb"
+    end
+
+    #########################################################
+    # git/heroku setup
+    #########################################################
+    def git_init
+      run 'git init'
+    end
+
+    def create_github_repo(repo_name)
+      path_addition = override_path_for_tests
+      run "#{path_addition} hub create #{repo_name}"
+    end
+
+    def create_heroku_apps
+      run_heroku "create #{heroku_app_name :production}", "production"
+      run_heroku "create #{heroku_app_name :staging}", "staging"
+      run_heroku "config:add RACK_ENV=staging RAILS_ENV=staging", "staging"
+    end
+
+    def set_heroku_remotes
+      remotes = <<-SHELL
+
+# Set up the staging and production apps.
+#{join_heroku_app :staging}
+#{join_heroku_app :production}
+      SHELL
+
+      append_file "bin/setup", remotes
+    end
+
+    def set_heroku_env_variables
+      config = <<-SHELL
+# Sets Heroku env variables
+figaro heroku:set -a #{heroku_app_name :production} -e production
+figaro heroku:set -a #{heroku_app_name :staging} -e production
+      SHELL
+      append_file "bin/setup", config
+    end
+
+    def add_heroku_addons
+      config = <<-SHELL
+
+# Heroku addons for production
+heroku addons:add mandrill --app #{heroku_app_name :production}
+heroku addons:add newrelic:stark --app #{heroku_app_name :production}
+heroku addons:add rollbar --app #{heroku_app_name :production}
+      SHELL
+      append_file "bin/setup", config
+    end
+
+    def set_memory_management_variable
+      %w(staging production).each do |environment|
+        run_heroku "config:add NEW_RELIC_AGGRESSIVE_KEEPALIVE=1", environment
+      end
+    end
+
+    #########################################################
+    # Helper methods
+    #########################################################
+    private
+
+    def raise_on_missing_translations_in(environment)
+      config = "config.action_view.raise_on_missing_translations = true"
+
+      uncomment_lines("config/environments/#{environment}.rb", config)
+    end
+
+    def run_heroku(command, environment)
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku #{command} --remote #{environment}"
+    end
+
+    def heroku_app_name(environment)
+      "#{app_name.gsub '_', '-'}-#{environment}"
+    end
+
+    def join_heroku_app(environment)
+      name = heroku_app_name environment
+      <<-SHELL
+if heroku join --app #{name} &> /dev/null; then
+  git remote add #{environment} git@heroku.com:#{name}.git || true
+  printf 'You are a collaborator on the "#{name}" Heroku app\n'
+else
+  printf 'Ask for access to the "#{name}" Heroku app\n'
+fi
+      SHELL
+    end
+
+    def generate_secret
+      SecureRandom.hex(64)
+    end
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
+    end
+  end
+end