secretsanta 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbcf51da2f07ca310dfd840ad9f2a3e74d3e78a42fee8a8f9f9b08f9c2cd6820
+  data.tar.gz: a83d8971943f61a728ae651ca6b079420be9efd6eb8ec871652b281da69683ae
+SHA512:
+  metadata.gz: 672007cf00c50a4133d71a58e6bf50735112f44df171888957bb67002ca545365bd6d2e920f0ba9f6bf13e3914fd81768aae1a7099fb992860bef08371f498b5
+  data.tar.gz: b1726b59b5c68b058296887a3e852403f8c4db194546a4b24a9b15a6b3ceef5893185f2101ce6295447e9022e29dc602a20c739c058ad34c9c244951ef5522a7

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Layout/IndentationWidth:
+  Width: 2
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    secretsanta (1.0.0)
+      dotenv
+      twilio-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    dotenv (2.5.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    jaro_winkler (1.5.1)
+    jwt (2.1.0)
+    method_source (0.9.2)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multipart-post (2.0.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    twilio-ruby (5.17.0)
+      faraday (~> 0.9)
+      jwt (>= 1.5, <= 2.5)
+      nokogiri (>= 1.6, < 2.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  pry
+  rake (~> 10.0)
+  rubocop
+  secretsanta!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ty-Lucas Kelley <tylucaskelley@gmail.com> (https://tylucaskelley.com)
+
+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,53 @@
+# SecretSanta
+
+> Send a text message to let everyone know their Secret Santa recipient!
+
+---
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'secretsanta'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secretsanta
+
+## Usage
+
+First, head on over to [Twilio](https://www.twilio.com/console) 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`
+
+## 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](https://github.com/tylucaskelley/secret-santa).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pry'
+
+require 'secretsanta'
+
+Pry.start

data/bin/secretsanta

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'dotenv'
+require 'optparse'
+require 'ostruct'
+
+require_relative '../lib/secretsanta'
+
+Dotenv.load
+
+begin
+  options = OpenStruct.new
+
+  options.twilio_account_sid = ENV['TWILIO_ACCOUNT_SID']
+  options.twilio_auth_token = ENV['TWILIO_AUTH_TOKEN']
+  options.from_number = ENV['TWILIO_PHONE_NUMBER']
+  options.dry_run = ENV['ENVIRONMENT'] == 'TEST'
+  options.participants = nil
+
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = SecretSanta.help_text
+
+    opts.on '-h', '--help', 'Show this help message' do
+      puts opts
+      exit
+    end
+
+    opts.on '-a', '--twilio-account-sid=SID', 'Twilio AccountSID' do |sid|
+      options.twilio_account_sid = sid
+    end
+
+    opts.on '-t', '--twilio-auth-token=TOKEN', 'Twilio authentication token' do |token|
+      options.twilio_auth_token = token
+    end
+
+    opts.on '-f', '--from_number=NUM', 'Twilio phone number' do |num|
+      options.from_number = num
+    end
+
+    opts.on '-p', '--participants=JSON_FILE', 'JSON file with participants' do |participants_file|
+      options.participants = JSON.parse(File.read(participants_file), symbolize_names: true)[:participants]
+    rescue StandardError => e
+      puts e
+      exit 1
+    end
+  end
+
+  opt_parser.parse!(ARGV)
+
+  raise OptionParser::MissingArgument if options.to_h.values.any?(&:nil?)
+
+  begin
+    puts SecretSanta.notify_participants!(options)
+  rescue SecretSanta::Error => e
+    puts e
+    exit 1
+  end
+rescue OptionParser::MissingArgument
+  puts "All options are required, see help below:\n\n"
+  puts opt_parser.help
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install

data/lib/secretsanta.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'twilio-ruby'
+
+require_relative 'secretsanta/version'
+
+module SecretSanta
+  class Error < StandardError; end
+
+  module_function
+
+  def notify_participants!(options)
+    client = Twilio::REST::Client.new(options.twilio_account_sid, options.twilio_auth_token)
+    pairs = generate_pairs(options.participants)
+
+    return pairs if options.dry_run
+
+    pairs.each do |pair|
+      client.messages.create(
+        body: "Happy holidays! You have been assigned to give a gift to #{pair.recipient_name} this year.",
+        from: options.from_number,
+        to: pair.sender_number
+      )
+    rescue Twilio::Rest::TwilioError => e
+      puts e.message
+    end
+
+    "\nAll participants have been notified - happy holidays! 🎅 🎄 🎁\n\n"
+  end
+
+  def generate_pairs(participants)
+    [].tap do |list|
+      loop do
+        participants.each do |participant|
+          index = rand 0..participants.length - 1
+          recipient = participants[index]
+
+          next if try_again?(participant, recipient)
+
+          list << { sender_number: participant[:number], recipient_name: recipient[:name] }
+
+          participant[:has_assignment] = true
+          participants[index][:is_assigned] = true
+        end
+
+        break if done?(participants)
+      end
+    end
+  end
+
+  def try_again?(sender, recipient)
+    disallowed = !sender[:disallow].nil? && sender[:disallow].include?(recipient[:name])
+
+    return true if disallowed || sender[:has_assignment] || recipient[:is_assigned]
+  end
+
+  def done?(participants)
+    participants.all? { |p| p[:has_assignment] && p[:is_assigned] }
+  end
+
+  def help_text
+    <<~HEREDOC
+      SecretSanta, version #{VERSION}
+
+      To run, provide command-line arguments or set corresponding environment variables:
+
+      - TWILIO_ACCOUNT_SID
+      - TWILIO_AUTH_TOKEN
+      - TWILIO_PHONE_NUMBER
+
+      Command-line arguments:
+
+    HEREDOC
+  end
+end

data/lib/secretsanta/version.rb

@@ -0,0 +1,3 @@
+module SecretSanta
+  VERSION = '1.0.0'
+end

data/secretsanta.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'secretsanta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'secretsanta'
+  spec.version       = SecretSanta::VERSION
+  spec.authors       = ['Ty-Lucas Kelley']
+  spec.email         = ['tylucaskelley@gmail.com']
+
+  spec.summary       = 'Start a gift exchange from the command line'
+  spec.homepage      = 'https://github.com/tylucaskelley/secret-santa'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ['secretsanta']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'twilio-ruby'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: secretsanta
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ty-Lucas Kelley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: twilio-ruby
+  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: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !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: rubocop
+  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: 
+email:
+- tylucaskelley@gmail.com
+executables:
+- secretsanta
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/secretsanta
+- bin/setup
+- lib/secretsanta.rb
+- lib/secretsanta/version.rb
+- secretsanta.gemspec
+homepage: https://github.com/tylucaskelley/secret-santa
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Start a gift exchange from the command line
+test_files: []