textr 0.0.8

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test.db

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in textr.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,44 @@
+# textr
+## Install
+### RubyGems.org
+	coming soon
+
+### from source
+	$ git clone http://github.com/forrestgrant/textr
+	$ cd textr
+	$ rake build
+	$ rake install
+
+## Usage
+
+You can use textr with an ActiveRecord model, standalone, or on any object.
+
+### ActiveRecord
+
+Just add `extends_textr` to your model.
+
+    class User < ActiveRecord::Base
+        extends_textr
+    end
+
+You can then send an SMS like this
+
+    User.first.send_notification :carrier => 'att', :body => 'Hello World!'
+
+Your model must have a `phone` attribute. If you wish to change this to something else (like `number` for example), simply pass it like this `extends_textr :number`
+    
+		class User < ActiveRecord::Base
+			extends_textr :number
+		end
+
+Or you can override the `phone` attribute
+
+		User.first.send_notification :number => '098-765-4321', :carrier => 'att', :body => 'Hello World!'
+
+### Standalone
+
+Simply call `Textr.send_sms` and pass the number with the hash.
+
+    $ rails c
+    >> Textr.send_sms :number => '123-456-7890', :body => 'Hello World!', :carrier => 'att'
+    => #<Mail::Message:12345>

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/textr.rb

@@ -0,0 +1,78 @@
+require "textr/version"
+require "textr/rake/tasks"
+require 'pony'
+require 'rails'
+
+module Textr
+  
+  @@config = File.exists?('config/textr_smtp.yml') ? YAML.load(ERB.new(File.read(('config/textr_smtp.yml'))).result)[Rails.env].symbolize_keys : false
+  
+  def smtp_options
+    @@config ? { :from => @@config[:from],
+                 :via => @@config[:protocol].to_sym,
+                 :via_options => {
+                   :address              => @@config[:address],
+                   :port                 => @@config[:port],
+                   :enable_starttls_auto => @@config[:ssl],
+                   :user_name            => @@config[:username],
+                   :password             => @@config[:password],
+                   :authentication       => @@config[:authentication],
+                   :domain               => @@config[:domain]
+                 }
+                } : { }
+  end
+    		
+	@@carriers = {
+    :att => 'txt.att.net',
+    :boost => 'myboostmobile.com',
+    :tmobile => 'tmomail.net',
+    :sprint => 'messaging.sprintpcs.com',
+    :verizon => 'vtext.com',
+    :virgin => 'vmobl.com'
+  }
+	
+  def self.extended(base)
+    unless base.respond_to?(:textr_options)
+      base.class_eval do
+        attr_accessor :phone
+      end
+    end
+  end
+    
+  def txtable_address( options={} )
+    "#{options[:number].gsub(/\D/, "")[-10..-1]}@#{@@carriers[options[:carrier].to_sym]}"
+  end
+  
+  def txtable_address( options={} )
+    "#{options[:number].gsub(/\D/, "")[-10..-1]}@#{@@carriers[options[:carrier].to_sym]}"
+  end
+  
+  def send_sms( options={} )
+    number = options[:number] || self.number_from_options
+    raise "#{self.class.to_s}" if number.blank?
+    raise ':carrier required' if options[:carrier].nil?
+    raise ':body required' if options[:body].nil?
+    
+    Pony.mail({
+      :to => txtable_address({:carrier => options[:carrier], :number => number}),
+      :subject => options[:subject],
+      :body => options[:body]
+    }.merge(smtp_options))
+  end
+  
+  def self.send_sms( options={} )
+    sms = Object.new
+    sms.extend Textr
+    sms.send_sms(options)
+  end
+  
+  def number_from_options
+    if respond_to?(:textr_options)
+      phone = textr_options[:phone_field]
+    end
+    send(phone)
+  end
+	
+end
+
+require File.dirname(__FILE__) + "/textr/extends_textr"

data/lib/textr/extends_textr.rb

@@ -0,0 +1,14 @@
+module Textr
+  module ExtendsTextr
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  def self.extends_textr(phone_field = :phone)
+    class_inheritable_reader :textr_options
+    write_inheritable_attribute :textr_options, {
+      :phone_field => phone_field
+    }
+    include Textr
+  end
+end

data/lib/textr/rake/tasks.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rake/tasklib'
+
+module Textr
+  module Rake
+    
+    class TextrTask < ::Rake::TaskLib
+            
+      namespace :textr do
+        desc "Generate a textr_smtp.yml file in `config` for use with smtp mail servers"
+        task "config:smtp" do
+          require "ftools"
+          if File.exists? "#{Rails.root.to_s}/config/textr_smtp.yml"
+            puts "\033[31m" + "#{Rails.root.to_s}/config/textr_smtp.yml exists... aborting." + "\033[0m"
+          else
+            status = File.copy(File.dirname(__FILE__) + "/../../../textr_smtp.yml.tpl", "#{Rails.root.to_s}/config/textr_smtp.yml") ? "\033[32m#{'[OK]'}\033[0m" : "\033[31m#{'[FAILED]'}\033[0m"
+            puts "\033[32m" + "Creating `config/textr_smtp.yml`: " + "\033[0m" + status
+          end
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/textr/version.rb

@@ -0,0 +1,3 @@
+module Textr
+  VERSION = "0.0.8"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'rails/all'
+require 'sqlite3'
+gem 'activerecord', '= 3.0.7'
+
+ENV["RAILS_ENV"] ||= 'test'
+Rails.env = 'test'
+
+require 'textr'
+
+MY_DB_NAME = "test.db"
+MY_DB = SQLite3::Database.new(MY_DB_NAME)
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => MY_DB_NAME)
+
+class User < ActiveRecord::Base
+  extends_textr
+end
+
+class Company < ActiveRecord::Base
+  extends_textr
+end
+
+class Person < ActiveRecord::Base
+  extends_textr :number
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  unless User.table_exists? 
+    create_table :users do |t|
+      t.string :name
+      t.string :phone
+    end
+    
+    User.create({:name => 'foo', :phone => '123-456-7890'})
+  end
+  
+  unless Company.table_exists? 
+    create_table :companies do |t|
+      t.string :name
+    end
+    
+    Company.create({:name => 'bar'})
+  end
+  
+  unless Person.table_exists? 
+    create_table :people do |t|
+      t.string :name
+      t.string :number
+    end
+    
+    Person.create({:name => 'foo', :number => '184-617-3344'})
+  end
+end
+
+RSpec.configure do |config|
+  
+end

data/spec/textr/textr_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Textr do
+  
+  it "should load textr" do
+    Textr.should_not be_nil
+  end
+  
+  it "should fail without carrier" do
+		lambda {
+		  User.first.send_sms
+		}.should raise_error RuntimeError
+  end
+  
+  it "should fail without body" do
+    lambda {
+      User.first.send_sms({:carrier => 'att'})
+    }.should raise_error RuntimeError
+  end
+  
+  it "should succeed with all requirements" do
+    user = User.first
+    user.phone.should == '123-456-7890'
+    message = user.send_sms({:carrier => 'att', :body => 'Hello World!'})
+    message.from.should == ['pony@unknown']
+    message.to.should == ['1234567890@txt.att.net']
+  end
+  
+  it "should allow sending without phone column" do
+    company = Company.first
+    company.name.should == 'bar'
+    message = company.send_sms({:carrier => 'att', :body => 'Hello World!', :number => '098-765-4321'})
+    message.to.should == ['0987654321@txt.att.net']
+  end
+  
+  it "should create proper sms addresses" do
+    [
+      ['att', 'txt.att.net'], 
+      ['boost', 'myboostmobile.com'], 
+      ['tmobile', 'tmomail.net'], 
+      ['sprint', 'messaging.sprintpcs.com'], 
+      ['verizon', 'vtext.com'], 
+      ['virgin', 'vmobl.com']
+    ].each do |carrier|
+      message = User.first.send_sms({:carrier => carrier[0], :body => 'Hello World!'})
+      message.to.should == ["1234567890@#{carrier[1]}"]
+    end
+  end
+  
+  it "should use number from person table" do
+    person = Person.first
+    person.name.should == 'foo'
+    person.number.should == '184-617-3344'
+    message = person.send_sms({:carrier => 'att', :body => 'Hello Bruins!'})
+    message.to.should == ["1846173344@txt.att.net"]
+  end
+  
+  it "should work without model" do
+    lambda {
+      message = Textr.send_sms({:carrier => 'att', :body => 'Hello World!', :number => '098-765-4321'})
+      message.to.should == ['0987654321@txt.att.net'] 
+    }.should_not raise_error
+  end
+  
+end

data/textr.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "textr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "textr"
+  s.version     = Textr::VERSION
+  s.authors     = ["Forrest Grant"]
+  s.email       = ["forrest@forrestgrant.com"]
+  s.homepage    = "https://github.com/forrestgrant/textr"
+  s.summary     = %q{Simple gem for sending SMS}
+  s.description = %q{Send SMS either via `phone` column in class, or by calling Textr directly}
+
+  s.rubyforge_project = "textr"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'pony'
+  s.add_dependency 'rake', '0.8.7'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'activerecord', '3.0.7'
+end

data/textr_smtp.yml.tpl

@@ -0,0 +1,32 @@
+development:
+  protocol: smtp
+  from: email@example.com
+  address: smtp.yourserver.com
+  port: 25
+  ssl: true
+  username: user
+  password: password
+  authentication: plain
+  domain: localhost.localdomain
+
+test:
+  protocol: smtp
+  from: email@example.com
+  address: smtp.yourserver.com
+  port: 25
+  ssl: true
+  username: user
+  password: password
+  authentication: plain
+  domain: localhost.localdomain
+
+production:
+  protocol: smtp
+  from: email@example.com
+  address: smtp.yourserver.com
+  port: 25
+  ssl: true
+  username: user
+  password: password
+  authentication: plain
+  domain: localhost.localdomain

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: textr
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
+platform: ruby
+authors: 
+- Forrest Grant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  type: :development
+  version_requirements: *id005
+description: Send SMS either via `phone` column in class, or by calling Textr directly
+email: 
+- forrest@forrestgrant.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .DS_Store
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/textr.rb
+- lib/textr/extends_textr.rb
+- lib/textr/rake/tasks.rb
+- lib/textr/version.rb
+- spec/spec_helper.rb
+- spec/textr/textr_spec.rb
+- textr.gemspec
+- textr_smtp.yml.tpl
+homepage: https://github.com/forrestgrant/textr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: textr
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Simple gem for sending SMS
+test_files: 
+- spec/spec_helper.rb
+- spec/textr/textr_spec.rb