0.0
No commit activity in last 3 years
No release in over 3 years
Start a gift exchange from the command line
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.17
~> 5.0
>= 0
~> 10.0

Runtime

~> 2.5
 Project Readme

secret-santa

Send a text message to let everyone know their Secret Santa recipient!

Gem Build Status


Installation

Add this line to your application's Gemfile:

gem 'secretsanta'

And then execute:

$ bundle

Or install it yourself as:

$ gem install secretsanta

Usage

First, head on over to Twilio and get a phone number with texting capabilities. You can then run secretsanta from the command line (see below).

Example:

$ secretsanta -a ACCOUNT_SID -t AUTH_TOKEN -f FROM_NUMBER -p PARTICIPANTS_FILE

Alternatively, set the following environment variables:

  • TWILIO_ACCOUNT_SID
  • TWILIO_AUTH_TOKEN
  • TWILIO_PHONE_NUMBER

The participants file is a JSON file, containing an array of people going to your event. It needs to be formatted as follows:

{
  "participants": [
    {
      "name": "John Doe",
      "number": "+1 (123) 456-7890",
      "disallow": [
        "Jane Doe"
      ]
    }
  ]
}

The disallow array is optional, and contains an array of people the participant is not allowed to be paired with.

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.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

The gem is available as open source under the terms of the MIT License.