tincan 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2967dd0d4f1f05af20103c1c50939111c751aa90
+  data.tar.gz: 17ff307ad20ea27021eb624c5d3a9ece804e8d89
+SHA512:
+  metadata.gz: 92c22a93fc950507fa525d98b6711ae1237d558082aac60eb7e5ec1b85026d189a48bd71531a1a12045e5d3127146269d638ae54832ab1be19329fa3d9a35b54
+  data.tar.gz: c4a48557ced89f840dc503284ea6d4e20413be60b7e4040eca5aa81f9e7666a480ad1eac7d8d9c12e3225ded13d045ee434863711c393ae5cadf6cef453378ec

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+ruby '2.0.0'
+
+gemspec
+
+gem 'rake', require: false
+gem 'oj', require: false
+
+group :development do
+  gem 'shotgun', require: false
+end
+
+group :test do
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'fakeredis'
+  gem 'simplecov', require: false
+end

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec
+
+task :coverage do
+  `open coverage/index.html`
+end

data/Readme.markdown

@@ -0,0 +1,78 @@
+# Phone
+
+Phone number provider.
+
+# Configuration
+
+Tincan delegates out the sending of SMS messages. Place the following code in an initializer
+with an implementation in order to use it.
+
+```ruby
+Tincan::SMS.sender = lambda do |phone_number, body|
+  puts "SMS sent to #{phone_number} - #{body}"
+end
+```
+
+## Create
+
+First, create a phone number verification:
+
+    POST /v1/phone_numbers
+    phone_number=%2B14152751660&message_format=Click%20this%20link%3A%20https%3A//seesaw.co/a/CODE
+
+Response:
+
+``` json
+{
+  "id": "0H2r2U1W3s3I0M3K0k173j1s3y2i2r05",
+  "e164": "+14152751660",
+  "country_code": "US",
+  "local_format": "(415) 275-1660",
+  "verified_at": null
+}
+```
+
+This will send a text message with the following message:
+
+> Click this link: https://seesaw.co/a/aFdh79mD"
+
+
+## Verify
+
+A client can now make the following request:
+
+    POST /v1/phone_numbers/verify
+    code=aFdh79mD
+
+Response:
+
+``` json
+{
+  "id": "0H2r2U1W3s3I0M3K0k173j1s3y2i2r05",
+  "e164": "+14152751660",
+  "country_code": "US",
+  "local_format": "(415) 275-1660",
+  "verified_at": 1365445347
+}
+```
+
+Now `verified_at` is set and the client knows this is a valid phone number.
+
+
+## Show
+
+You can show a phone number token for a day to poll to see if it's verified. This will probably rarely be used since the request to verify it will be the only place this information is needed.
+
+    GET /v1/phone_numbers/0H2r2U1W3s3I0M3K0k173j1s3y2i2r05
+
+Response:
+
+``` json
+{
+  "id": "0H2r2U1W3s3I0M3K0k173j1s3y2i2r05",
+  "e164": "+14152751660",
+  "country_code": "US",
+  "local_format": "(415) 275-1660",
+  "verified_at": 1365445347
+}
+```

data/config.ru

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift 'lib'
+require 'tincan'
+
+run Tincan::Application

data/lib/tincan/application.rb

@@ -0,0 +1,87 @@
+require 'sinatra/base'
+require 'fakie/errors'
+
+module Tincan
+  class Application < Sinatra::Base
+    # Create phone number
+    post '/' do
+      unless phone_number = params['phone_number']
+        status 400
+        return json({
+          error: 'bad_request',
+          error_description: "The `phone_number` parameter is required."
+        })
+      end
+
+      unless message_format = params['message_format']
+        status 400
+        return json({
+          error: 'bad_request',
+          error_description: "The `message_format` parameter is required."
+        })
+      end
+
+      begin
+        phone = PhoneNumber.create!(phone_number)
+      rescue Fakie::InvalidPhoneNumber
+        status 400
+        hash = {
+          error: 'invalid_phone_number',
+          error_description: 'The phone number provided was invalid.'
+        }
+        return json(hash)
+      end
+
+      SMS.send(phone, message_format)
+
+      status 201
+      json phone.as_json
+    end
+
+    # Verify phone number
+    post '/verify' do
+      unless code = params['code']
+        status 400
+        return json({
+          error: 'bad_request',
+          error_description: "The `code` parameter is required."
+        })
+      end
+
+      if phone = PhoneNumber.verify_code!(code)
+        return json(phone.as_json)
+      end
+
+      status 400
+      json({
+        error: 'invalid_code',
+        error_description: 'There were no phone numbers matching the given code.'
+      })
+    end
+
+    # Show phone number
+    get '/:id' do
+      if phone = PhoneNumber.find(params[:id])
+        return json(phone)
+      end
+
+      status 404
+      json({
+        error: 'not_found',
+        error_description: 'A phone_number was not found with this id.'
+      })
+    end
+
+  private
+
+    def json(content)
+      content_type 'application/json'
+      MultiJson.dump(content)
+    end
+
+    def params
+      return super if request.get? || !request.content_type || request.content_type.index('application/json') != 0
+      @_params ||= MultiJson.load(request.env['rack.input'].read)
+    end
+  end
+end

data/lib/tincan/phone_number.rb

@@ -0,0 +1,94 @@
+require 'multi_json'
+require 'fakie'
+
+module Tincan
+  class PhoneNumber
+    REDIS_KEY_PREFIX = 'phone-number_'
+    CODE_REDIS_KEY_PREFIX = 'phone-number-code'
+    EXPIRATION = 86400 # one day of in-cache storage
+
+    attr_reader :id, :e164, :country_code, :local_format, :verified_at
+    attr_accessor :code
+
+    class << self
+      def create!(e164)
+        # TODO: Make sure there aren't collisions
+        parsed = Fakie.parse(e164)
+        phone = new({
+          'id' => Utils.generate_code(32),
+          'e164' => parsed.e164,
+          'country_code' => parsed.region_code,
+          'local_format' => parsed.local_format
+        })
+
+        phone.save
+
+        # Store code
+        phone.code = Utils.generate_code(8)
+        key = "#{CODE_REDIS_KEY_PREFIX}#{phone.code}"
+        Tincan.redis.set(key, phone.id)
+        Tincan.redis.expire(key, EXPIRATION)
+        phone
+      end
+
+      def find(id)
+        return nil unless id
+
+        result = Tincan.redis.get("#{REDIS_KEY_PREFIX}#{id}")
+        return nil unless result
+
+        new(MultiJson.load(result))
+      end
+
+      def verify_code!(code)
+        id = Tincan.redis.get("#{CODE_REDIS_KEY_PREFIX}#{code}")
+        return nil unless phone = find(id)
+
+        phone.verify!
+        phone
+      end
+    end
+
+    def initialize(hash)
+      %w{id e164 country_code local_format}.each do |key|
+        instance_variable_set(:"@#{key}", hash[key])
+      end
+
+      @verified_at = Time.at(hash['verified_at']) if hash['verified_at']
+    end
+
+    def verified?
+      verified_at && verified_at < Time.now.utc
+    end
+
+    def verify!
+      @verified_at = Time.now.utc
+      save
+    end
+
+    def as_json
+      hash = {}
+
+      # Default attributes
+      %w{id e164 country_code local_format}.each do |key|
+        hash[key] = instance_variable_get(:"@#{key}")
+      end
+
+      # Add `verified_at` as an integer
+      hash['verified_at'] = verified_at.to_i if verified_at
+
+      # Return the hash
+      hash
+    end
+
+    def to_json
+      MultiJson.dump(as_json)
+    end
+
+    def save
+      key = "#{REDIS_KEY_PREFIX}#{id}"
+      Tincan.redis.set(key, to_json)
+      Tincan.redis.expire(key, EXPIRATION)
+    end
+  end
+end

data/lib/tincan/sms.rb

@@ -0,0 +1,14 @@
+module Tincan
+  class SMS
+    class << self
+      attr_accessor :sender
+
+      def send(number, message)
+        raise NoSmsSenderError.new unless @sender
+        @sender.call number.e164, message.sub('CODE', number.code)
+      end
+    end
+
+    class NoSmsSenderError < ArgumentError; end
+  end
+end

data/lib/tincan/utils.rb

@@ -0,0 +1,13 @@
+require 'base62'
+
+module Tincan
+  module Utils
+    module_function
+
+    def generate_code(length = 8)
+      SecureRandom.random_bytes((length / 2.0).ceil).unpack('C*').map do |int|
+        int.base62_encode.rjust 2, '0'
+      end.join[0...length]
+    end
+  end
+end

data/lib/tincan/version.rb

@@ -0,0 +1,3 @@
+module Tincan
+  VERSION = '0.1.5'
+end

data/lib/tincan.rb

@@ -0,0 +1,54 @@
+require 'tincan/version'
+require 'tincan/utils'
+require 'tincan/phone_number'
+require 'tincan/application'
+require 'tincan/sms'
+
+require 'redis'
+require 'redis/namespace'
+
+module Tincan
+  def self.configure
+    yield self
+  end
+
+  def self.redis
+    # Set redis to nothing make the setter run and setup a default if it's nothing
+    self.redis = {} unless defined? @@redis
+
+    # Return the namespaced Redis instance
+    @@redis
+  end
+
+  def self.redis=(options = {})
+    client = nil
+    if options.is_a?(Redis)
+      client = options
+    else
+      url = options[:url] || determine_redis_provider || 'redis://localhost:6379/0'
+      driver = options[:driver] || 'ruby'
+      namespace = options[:namespace] || 'tincan'
+
+      client = Redis.connect(url: url, driver: driver)
+    end
+
+    @@redis = Redis::Namespace.new(namespace, redis: client)
+  end
+
+  def self.sms_sender
+    SMS.sender
+  end
+
+  def self.sms_sender=(sender)
+    SMS.sender = sender
+  end
+
+private
+
+  def self.determine_redis_provider
+    return ENV['REDISTOGO_URL'] if ENV['REDISTOGO_URL']
+    provider = ENV['REDIS_PROVIDER'] || 'REDIS_URL'
+    ENV[provider]
+  end
+
+end

data/spec/integration/create_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'Create integration' do
+
+  before do
+    Tincan::SMS.sender = lambda do |number, body|
+      @messages = [] unless @messages
+      @messages << {number: number, body: body}
+    end
+  end
+
+  after do
+    Tincan::SMS.sender = nil
+  end
+
+  it 'requires a phone number' do
+    post '/'
+    last_status.must_equal 400
+    last_json['error'].must_equal 'bad_request'
+  end
+
+  it 'requires a valid phone number' do
+    post '/', phone_number: '+14152751660', message_format: 'Click this: https://seesaw.co/CODE'
+    last_status.must_equal 201
+    last_json['e164'].must_equal '+14152751660'
+    last_json['local_format'].must_equal '(415) 275-1660'
+
+    # Verify the last messages are in the correct formats
+    @messages.last[:number].must_equal last_json['e164']
+    @messages.last[:body].must_match /https\:\/\/seesaw.co\/(\S+)/
+  end
+
+  it 'handles invalid phone numbers' do
+    post '/', phone_number: '+1415275166', message_format: 'Click this: https://seesaw.co/CODE'
+    last_status.must_equal 400
+    last_json['error'].must_equal 'invalid_phone_number'
+  end
+
+  it 'handles missing message formats' do
+    post '/', phone_number: '+14152751660'
+    last_status.must_equal 400
+    last_json['error'].must_equal 'bad_request'
+  end
+
+  it 'sends an SMS'
+  it 'store a redirect URI'
+end

data/spec/integration/verify_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Verify integration' do
+  it 'should require a code' do
+    post '/verify'
+    last_status.must_equal 400
+    last_json['error'].must_equal 'bad_request'
+  end
+
+  it 'should require a valid code' do
+    post '/verify', code: 'asdf'
+    last_status.must_equal 400
+    last_json['error'].must_equal 'invalid_code'
+
+    phone = Tincan::PhoneNumber.create!('+14152751660')
+    post '/verify', code: phone.code
+    last_status.must_equal 200
+
+    get "/#{phone.id}"
+    last_json['verified_at'].wont_be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require :test
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'minitest/autorun'
+require 'tincan'
+
+# Support files
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].each do |file|
+  require file
+end
+
+class IntegrationTest < MiniTest::Spec
+  include Rack::Test::Methods
+  include RequestMacros
+
+  def app
+    Tincan::Application
+  end
+
+  def teardown
+    super
+    Tincan.redis.flushdb
+  end
+
+  register_spec_type(/integration$/, self)
+end

data/spec/support/request_macros.rb

@@ -0,0 +1,13 @@
+module RequestMacros
+  def last_json
+    return @_last_json if @_last_json_id == last_response.object_id
+    @_last_json_id = last_response.object_id
+    @_last_json = last_response.body.length > 0 ? MultiJson.load(last_response.body) : nil
+  rescue MultiJson::LoadError
+    raise "Failed to parse JSON:\n\n#{last_response.body}"
+  end
+
+  def last_status
+    last_response.status
+  end
+end

data/spec/unit/sms_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Tincan::SMS do
+
+  it 'should explode if you try to send without a sender' do
+    p = proc { Tincan::SMS.send(Tincan::PhoneNumber.create!('+17174683737'), 'body') }
+    p.must_raise Tincan::SMS::NoSmsSenderError
+  end
+
+end

data/spec/unit/utils_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Tincan::Utils do
+  describe 'generate_code' do
+    subject do
+      Tincan::Utils.generate_code
+    end
+
+    it 'returns a string' do
+      subject.must_be_kind_of String
+    end
+
+    it 'defaults to 8 characters' do
+      subject.length.must_equal 8
+    end
+
+    it 'supports odd numbers of characters' do
+      Tincan::Utils.generate_code(7).length.must_equal 7
+    end
+  end
+end

data/tincan.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tincan/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'tincan'
+  gem.version       = Tincan::VERSION
+  gem.authors       = ['Sam Soffes']
+  gem.email         = ['sam@soff.es']
+  gem.description   = 'Phone number provider.'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/seesawco/tincan'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'fakie'
+  gem.add_dependency 'redis'
+  gem.add_dependency 'redis-namespace'
+  gem.add_dependency 'base62'
+  gem.add_dependency 'multi_json'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: tincan
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Sam Soffes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: fakie
+  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: redis
+  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: redis-namespace
+  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: base62
+  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: multi_json
+  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'
+description: Phone number provider.
+email:
+- sam@soff.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.markdown
+- config.ru
+- lib/tincan.rb
+- lib/tincan/application.rb
+- lib/tincan/phone_number.rb
+- lib/tincan/sms.rb
+- lib/tincan/utils.rb
+- lib/tincan/version.rb
+- spec/integration/create_spec.rb
+- spec/integration/verify_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_macros.rb
+- spec/unit/sms_spec.rb
+- spec/unit/utils_spec.rb
+- tincan.gemspec
+homepage: https://github.com/seesawco/tincan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Phone number provider.
+test_files:
+- spec/integration/create_spec.rb
+- spec/integration/verify_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_macros.rb
+- spec/unit/sms_spec.rb
+- spec/unit/utils_spec.rb