heroku-stage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83eb5ffcfa3d8b8b20e4842c0dde8959e31d9664
+  data.tar.gz: ecf4b7077f0f9d55f9ea24f5b4d52e55fbf5851e
+SHA512:
+  metadata.gz: 831bd6fe38287543da56604868ad15715dd1b332aacf111745f46a898f0ec2952f2662367718d6536728cb8284ec8ceb3a445653d5d2d977a9862a1a2c8fc091
+  data.tar.gz: 2e3e0f9036053cd08a376e1ba1443981897c77ec3f349b319a5d5502dfc14ba46f6166e84e4362bc9f04aa8500dc30de8a7a2927b3dc4b47884e4cd82fb530e0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.2.6
+- 2.3.3
+- 2.4.0-preview3
+script:
+- bundle exec rake spec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: gkWXoXo5OmksiDkLkDPBaXr2mO14N+y9OyX5YCbPtQXgj1p+jFUgtfRZifTImwtEWzUuzJJ+39k6kCrfC7tlA8WqWrggednyEAXCmG+klCiZm5wPG+23sbQzZimJGBdcy3ZBWBpLC7pgCn1y2x4SxV/FOTDDDFo1My/A/ZXpxYL1XLUtE9tqMxYRGbdmjsEKKl3I1MtjwvDPN3PDofrdYJMC1oBIAgqkyobTP+RHFK3WnRCh871DFyR5cR7j+HsJ8jZklWOuYHpYx5qWcs9g+u54TRWMNdMFArq6q6bRoPmrPpWCv2EdHg7bnntpgphmh3MfBb7ZLe6vQO6tA/qfYm6n/w5R/y8a2teXMFzTnm9UL2Nhuh8PnudKqatTtBpR2xa8OcM+iS/kqEe5z5OsUtjEDVK0HVzbOOzHB1gfo8UAOEs4uH7SAxgiFs4zuLJUt/Cles2BuWoEmAnljuIsxpfhcWlRPLsaLy2CufMuf5FhKDxcmdOIQCY0PYrcyWgBWo+HxCz00Q3xOfm6HcMIITjZR5qCbEkaZYU8AZBoCGrLhYDBS6BBBxNPklQ9usMWuhio075zt9dh8dmoLDzOk2VaGXPD/b9kVVs25DqBNejPhsQnIEJnX4D/uO3hstdnLjd3LQtWoYuPDsEIWuU0642xXG6wb23/66E5GDC0c4Y=
+  gem: heroku-stage
+  on:
+    tags: true
+    repo: platanus/heroku-stage

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 Platanus
+
+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,113 @@
+# Heroku Stage
+[![Build Status](https://travis-ci.org/platanus/heroku-stage.svg?branch=master)](https://travis-ci.org/platanus/heroku-stage)
+
+Get the current deployment stage of your rails app deployed using heroku pipelines.
+
+## Installation
+
+```bash
+gem install heroku-stage
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "heroku-stage"
+```
+
+```bash
+bundle install
+```
+
+## Why
+
+We've been following the heroku's recommendation on running just one
+environment for our apps *productions*. We've moved from having
+`staging.rb` and `production.rb` to just have the `production.rb`.
+The goal is to promote parity between the two environments. At the end,
+we have different **deployment** environments but the same rails one.
+
+This approach makes it difficult when you have to differentiate
+some actions based on your deploy environment. We cannot rely on `Rails.env`
+anymore because it will always be `production`.
+
+One example is for error monitoring. If we want to know from which
+environment the errors are, we need to provide that information somehow.
+
+The idea is to take the same syntax from `Rails.env` but with
+`Heroku.stage`
+
+This gem uses the `HEROKU_APP_NAME` environmental variable to get the
+current stage on the heroku pipeline.
+
+## The convention
+
+The application name convention is `my-app-<stage>`.
+
+You can manually add the environmental variable `HEROKU_APP_NAME` with the app name
+or you can use the [dyno metadata labs](https://devcenter.heroku.com/articles/dyno-metadata)
+from heroku which will add the variable on your next deploy.
+
+```shell
+heroku labs:enable runtime-dyno-metadata --app <your app>
+heroku labs:enable runtime-dyno-metadata --remote production
+```
+
+> *Note*: Heroku does not provide the information on what stage the app is running,
+> so this gem relies on that convention. I've contacted heroku requesting this information
+> but I haven't had any response.
+
+## Usage
+
+To get the current state
+
+```ruby
+Heroku.stage # => 'production'
+```
+
+You can ask for the production or staging stages
+
+```ruby
+Heroku.stage.production? # => true
+Heroku.stage.staging? # => false
+```
+
+### In development
+
+When using in the *development* rails environment the `Heroku.stage` will
+respond with an empty string.
+
+```ruby
+Rails.env.development? # true
+Heroku.stage # => ''
+```
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/my_gem/spec/` directory.
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/heroku-stage/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Heroku Stage is maintained by [platanus](http://platan.us).
+
+## License
+
+Heroku Stage is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heroku/stage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/heroku-stage.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "heroku/stage/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku-stage"
+  spec.version       = Heroku::Stage::VERSION
+  spec.authors       = ["Platanus", "Juan Ignacio Donoso"]
+  spec.email         = ["rubygems@platan.us", "juan.ignacio@platan.us"]
+  spec.homepage      = "https://github.com/platanus/heroku-stage"
+  spec.summary       = "Read stage name from heroku pipelines"
+  spec.description   = "Based on convention this gem will get the heroku pipeline stage from the app name"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "pry"
+end

data/lib/heroku/stage.rb

@@ -0,0 +1,37 @@
+require 'heroku/stage/version'
+require 'active_support'
+require 'rails'
+
+module Heroku
+  class << self
+    # Returns the current Heroku stage.
+    #
+    #   Heroku.stage # => "staging"
+    #   Heroku.stage.staging? # => true
+    #   Heroku.stage.production? # => false
+    def stage
+      @_stage ||= ActiveSupport::StringInquirer.new(heroku_pipeline_stage)
+    end
+
+    private
+
+    def heroku_pipeline_stage
+      Rails.env.development? ? '' : ENV.fetch('HEROKU_APP_NAME')[/staging|production/]
+    rescue KeyError
+      raise $!, enable_dyno_metadata_message($!), $!.backtrace
+    end
+
+    def enable_dyno_metadata_message(exception)
+      <<~EOS
+        #{exception.message}
+
+        Remember to enable the heroku dyno metadata to add the HEROKU_APP_NAME key to the environment.
+        To do that run the folowing command:
+
+          heroku labs:enable runtime-dyno-metadata --remote production
+
+        On the next deploy the key will be populated with the app name
+      EOS
+    end
+  end
+end

data/lib/heroku/stage/version.rb

@@ -0,0 +1,5 @@
+module Heroku
+  module Stage
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: heroku-stage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Platanus
+- Juan Ignacio Donoso
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Based on convention this gem will get the heroku pipeline stage from
+  the app name
+email:
+- rubygems@platan.us
+- juan.ignacio@platan.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heroku-stage.gemspec
+- lib/heroku/stage.rb
+- lib/heroku/stage/version.rb
+homepage: https://github.com/platanus/heroku-stage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Read stage name from heroku pipelines
+test_files: []