secret_santa_client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e67311c748ff4dd088b8ff7a34325568e2d95342
+  data.tar.gz: c87d4b6673889d0910abe3cf7f681518654e94c4
+SHA512:
+  metadata.gz: 336adf8659d7327c31ff58aca3d03d12ddec8d13bc0f4547be11b959974e0b87512959302b679aac5107f5bf15110a744fc16da166b94795e05f66983203c082
+  data.tar.gz: 24eb51b5ede23d8b5c50faf950872ca228ed8b0af2afb72c2b68511f7681340418bd47d697101ee8c6fffbc64492663046842da2f082119958801f7893b2eab1

data/README.md

@@ -0,0 +1,54 @@
+secret_santa
+============
+
+## About
+
+Use this to randomly generator pairing of people for Secret Santa.
+
+## Usage
+
+Uses Twilio API to send the texts. If you want to use this you will need a [Twilio](http://www.twilio.com) account.
+
+Example:
+
+```
+
+require 'mobile/secret_santa'
+
+list = {
+  "Tak"     => "+13302370308",
+  "Sarah"   => "+12079327441",
+  "Tania"   => "+11306358563",
+  "Clint"   => "+12212318187",
+  "Lydia"   => "+19439348292",
+  "Donovan" => "+16305302371"
+}
+
+logger = Logger.new("2015_secret_santa.txt")
+
+twilio_config = {
+  :account_sid => 'account-sid',
+  :auth_token => 'auth-token',
+  :host_number => 'your-twilio-host-number'
+}
+
+secret_santa = Mobile::SecretSanta.new(:list => list, :logger => logger, :twilio_config => twilio_config)
+
+secret_santa.pair_list.send
+
+```
+
+## Logging
+
+Logging is optional, but in case something goes wrong, for example someone didn't get a text, you can log the pairing. The names of the secret santa is hexdigested, in case you don't want to accidently see who everyone has.
+
+## Features
+
+1. Twilio Integration
+2. Logging
+
+## Future Features
+
+1. Resend email by phone number by looking through logs
+2. Blacklist pairs.
+3. Any other thoughts?

data/lib/mobile/secret_santa.rb

@@ -0,0 +1,70 @@
+require 'logger'
+require 'json'
+require 'digest'
+require 'twilio-ruby'
+
+module Mobile
+  class SecretSanta
+    attr_reader :names, :pairs, :logger
+
+    def initialize(options)
+      @list = options[:list]
+      @logger = options[:logger] || NoopLogger.new
+      @host_number = options[:twilio_config][:host_number]
+      @twilio_client = Twilio::REST::Client.new(options[:twilio_config][:account_sid], options[:twilio_config][:auth_token])
+    end
+
+    def pair_list
+      shuffled_names = names.shuffle
+      @pairs = shuffled_names.each.with_index.reduce([]) do |pair, (person, index)|
+        pair << {
+          :santa => {
+            :name => person, :number => @list[person]
+          },
+          :person => shuffled_names[next_person(index)]
+        }
+        pair
+      end
+    end
+
+    def send(options = {})
+      pairs = @pairs.clone
+      pairs.each { |pair| pair[:santa][:name] = Digest::SHA256.hexdigest(pair[:santa][:name]) }
+      @logger.info(pairs.to_json)
+
+      pairs.each { |pair|
+        @twilio_client
+          .account
+          .messages
+          .create(payload(pair[:santa][:number], pair[:person], options[:text_body]))
+      }
+    end
+
+    def names
+      @names ||= @list.keys
+    end
+
+    private
+
+    def payload(number, person, text_body)
+      {
+        :from => @host_number,
+        :to => number,
+        :body => text_body != nil ? text_body.call(person) : default_text_body(person)
+      }
+    end
+
+    def next_person(index)
+      (index + 1) == names.size ? 0 : index + 1
+    end
+
+    def default_text_body(person)
+      "Yo Secret Santa, give this whiny little kid #{person} a gift, because we all know #{person} was a bad person this year and will be getting coal from the real Santa. Sincerly, The Cool Tak's Secret Santa #{Time.now.year}."
+    end
+  end
+end
+
+class NoopLogger
+  def initialize; end
+  def info(body); end
+end

data/spec/mobile/secret_santa_spec.rb

@@ -0,0 +1,102 @@
+require 'mobile/secret_santa'
+
+require 'json'
+require 'logger'
+require 'digest'
+require 'twilio-ruby'
+
+describe Mobile::SecretSanta do
+  let(:list) { {"taka" => "123-123-1234", "dave" => "321-321-4321", "eric" => "098-098-0987", "joe" => "456-456-4567"} }
+  let(:logger) { TestLogger.new }
+  let(:twilio_config) { {:account_sid => 'account-sid', :auth_token => 'auth-token', :host_number => 'host-number'} }
+  let(:santa) { Mobile::SecretSanta.new(:list => list, :logger => logger, :twilio_config => twilio_config) }
+
+  describe '#pair_list' do
+    it 'pairs up people' do
+      results = santa.pair_list
+
+      expect(results.length).to eq(4)
+
+      names = ["taka", "dave", "eric", "joe"]
+      numbers = ["123-123-1234", "321-321-4321", "098-098-0987", "456-456-4567"]
+
+      results.each do |result|
+        expect(numbers).to include(result[:santa][:number])
+        expect(names).to include(result[:santa][:name])
+        expect(names).to include(result[:person])
+      end
+    end
+
+    it 'shuffles the list' do
+      expect(santa.names).to receive(:shuffle).and_return([])
+      santa.pair_list
+    end
+  end
+
+  it 'uses NoOp Logger if no logger is passed' do
+    secret_santa = Mobile::SecretSanta.new(:list => {}, :logger => nil, :twilio_config => twilio_config)
+
+    expect(secret_santa.logger.class).to be(NoopLogger)
+  end
+
+  it 'sends a text message' do
+    client = Twilio::REST::Client.new('account-sid', 'auth-token')
+    expect(Twilio::REST::Client).to receive(:new).with('account-sid', 'auth-token').and_return(client)
+
+    santa.pair_list
+
+    santa.pairs.each do |pair|
+      expect(client.account.messages).to receive(:create)
+        .with({:from => 'host-number', :to => pair[:santa][:number], :body => text_body(pair[:person])})
+    end
+
+    santa.send
+  end
+
+  it 'can have optional block sent for building dynamic text body' do
+    client = Twilio::REST::Client.new('account-sid', 'auth-token')
+    expect(Twilio::REST::Client).to receive(:new).with('account-sid', 'auth-token').and_return(client)
+
+    santa.pair_list
+
+    santa.pairs.each do |pair|
+      expect(client.account.messages).to receive(:create)
+        .with({:from => 'host-number', :to => pair[:santa][:number], :body => "yar #{pair[:person]}"})
+    end
+
+    santa.send(:text_body => Proc.new {|person| "yar #{person}"})
+  end
+
+  it 'logs the pairing with digested names' do
+    client = Twilio::REST::Client.new('account-sid', 'auth-token')
+    expect(Twilio::REST::Client).to receive(:new).with('account-sid', 'auth-token').and_return(client)
+    allow(client.account.messages).to receive(:create)
+
+    santa.pair_list
+    santa.send
+
+    digested_names = list.keys.reduce([]) do |names, name|
+      names << Digest::SHA256.hexdigest(name)
+      names
+    end
+
+    digested_names.each do |digested_name|
+      expect(logger.messages).to include(digested_name)
+    end
+  end
+end
+
+class TestLogger < Logger
+  def initialize
+    @stringIO = StringIO.new
+    super(@stringIO)
+  end
+
+  def messages
+    @stringIO.string
+  end
+end
+
+def text_body(person)
+  "Yo Secret Santa, give this whiny little kid #{person} a gift, because we all know #{person} was a bad person this year and will be getting coal from the real Santa. Sincerly, The Cool Tak's Secret Santa 2015."
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: secret_santa_client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Taka Goto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+description: Secret Santa Generator
+email: tak.yuki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mobile/secret_santa.rb
+- spec/mobile/secret_santa_spec.rb
+homepage: http://www.gototaka.com
+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.6
+signing_key: 
+specification_version: 4
+summary: Randomly pairs your list and sends out via text.
+test_files: []