https://github.com/bearandgiraffe/bg-common
A ruby library of common behaviors
https://github.com/bearandgiraffe/bg-common
ruby ruby-gem ruby-on-rails
Last synced: about 2 months ago
JSON representation
A ruby library of common behaviors
- Host: GitHub
- URL: https://github.com/bearandgiraffe/bg-common
- Owner: bearandgiraffe
- License: gpl-3.0
- Created: 2017-07-31T17:15:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-15T02:37:23.000Z (over 7 years ago)
- Last Synced: 2026-03-25T03:33:14.348Z (3 months ago)
- Topics: ruby, ruby-gem, ruby-on-rails
- Language: Ruby
- Size: 36.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BG::Common
A Ruby library of common behaviors, especially for Ruby on Rails applications.
# Table of Contents
- Installation
- Usage
- I. Basic Auth
- Development
- Contributing
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'bg-common'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install bg-common
## Usage
### I. Basic Auth
To hide an app from bots and people who are trying to troll us, we want to hide the app behind a "firewall". Typically we want to do that for staging or any other environment that is not public.
The best way to do that is to put the app behind Basic Auth.
To enable Basic Auth, add the following as an ENV variable:
```
BASIC_AUTH_ENABLED=true
BASIC_AUTH_USERNAME=user
BASIC_AUTH_PASSWORD=password
```
make sure to change `user` and `password` to something a bit more secure!
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bearandgiraffe/bg-common. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.