smesser 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JJ Buckley
+
+MIT License
+
+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,79 @@
+# SMeSser
+
+For using your provider's WebText programatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smesser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smesser
+
+## Usage
+
+Smesser is generally supposed to be used as part of a more useful application,
+for sending (free!) SMSs.
+
+It does, however, come with a little command-line application (`smesser`). Try
+`smesser -h` when it's installed.
+
+## Configuration
+
+You can program Smesser programatically, but it will also
+have a look for some configuration files, and determine the
+username/password/provider from there. These config files are loaded, in order,
+if they exist:
+
+* /etc/smesserrc
+* /usr/local/etc/smesserrc
+* ~/.smesserrc
+
+*HINT*: If you're a command-line type of person (which I presume yuo are, as
+you're reading this), then add a "contacts" hash to your configuration file.
+These can be used as aliases instead of phone number.
+
+Here's a sample configuration file, which you'd keep as ~/.smesserrc
+
+```yaml
+provider: o2.ie
+username: "0861234567" # <-- Ensure a string, or the leading 0 could vanish!
+password: secret
+contacts:
+  mom: "+3538712345678"
+  dad: "+1123456788"
+  lisa: "08517171717"
+```
+
+## Providers
+
+The core of Smesser is done by little [Mechanize][mechanize] agents, called
+Providers, that know how to log in (as you) to a specific website, fill in a
+form, and submit it.
+
+The only requirements for a Provider is that it responds to `login` and `send`.
+By subclassing Smesser::Provider, you get a couple of convenience methods to
+help you create your own.
+
+Have a look at bundled providers for info on how to write your own provider.
+
+Currently, there's
+
+* vodafone.ie
+* o2.ie
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[mechanize]: http://mechanize.rubyforge.org/

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+end
+
+task :default => :test
+

data/bin/smesser

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/smesser'))
+require 'optparse'
+
+$options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: smesser [options]"
+
+  opts.on('-c', '--config FILE', String, 'Use a specific config file') do |f|
+    if File.exists?
+      Smesser.config_files << f
+    else
+      puts "Can't open file #{f}"
+      exit 3
+    end
+  end
+
+  opts.on('-m', '--message MESSAGE', String, 'Your message. If blank, reads from STDIN.') do |m|
+    $options[:message] = m
+  end
+
+  opts.on('-P', '--provider PROVIDER', String, 'Choose a provider (list with --list)') do |p|
+    $options[:provider] = p
+  end
+
+  opts.on('-u', '--username USERNAME', String, 'Specify a username to log in with') do |u|
+    $options[:username] = u
+  end
+
+  opts.on('-p', '--password PASSWORD', String, 'Specify a password to log in with') do |p|
+    $options[:password] = p
+  end
+
+  opts.on('-L', '--list', 'Show all known providers, and exit') do
+    Smesser.print_providers
+    exit
+  end
+
+  opts.on('-v', '--verbose', 'Be more verbose') do
+    Smesser.log.level = Logger::INFO
+  end
+
+  opts.on('-d', '--debug', 'Debug the application') do
+    Smesser.log.level = Logger::DEBUG
+  end
+
+  opts.on('-n', '--dry-run', "Don't actually send the message") do
+    Smesser.configuration[:dryrun] = true
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts.to_s
+    exit
+  end
+end.parse!(ARGV)
+
+if ARGV.empty?
+  puts "You didn't enter any recipients!"
+  exit 1
+end
+$options[:recipients] = []
+$options[:recipients] << ARGV.shift until ARGV.empty?
+
+if $options[:message].nil?
+  print "Type your message below, and finish with ^D:\n> "
+  $options[:message] = ARGF.read.chomp
+end
+
+print "Sending... "
+result = Smesser.send_message($options)
+
+puts "#{result[:remaining]} remaining" if result[:remaining]
+puts result[:message] if result[:message]
+puts result[:status]
+exit -1 unless result[:status] == "OK"

data/lib/smesser/provider.rb

@@ -0,0 +1,81 @@
+require 'mechanize'
+require 'smesser'
+
+module Smesser
+  class Provider
+    class << self
+      attr_accessor :description
+    end
+
+    attr_accessor :username, :password
+
+    def self.paths
+      @paths ||= [File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'providers'))]
+    end
+
+    def self.load_all
+      Smesser.log.debug("Loading all provider files in #{paths.inspect}")
+      paths.each do |path|
+        Dir["#{path}/*.rb"].each do |f|
+          require f
+        end
+      end
+    end
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def get(address)
+      log.debug("Getting #{address}")
+      agent.get(address) unless agent.page and agent.page.uri == URI.parse(address)
+      log.debug("Got #{address} (#{page.code})")
+      page.code
+    end
+
+    def post_form(spec, &block)
+      spec = { :name => spec } if spec.is_a? String
+      log.debug("Looking for form with #{spec.inspect}")
+      form = page.form_with(spec)
+      raise "Form not found: #{spec.inspect} on #{page.uri} (forms: #{page.forms.map(&:name).inspect})" unless form
+      yield form
+      log.debug("Submitting form: #{form.action} #{form.request_data}")
+      form.submit
+      log.debug("Submitted #{form.action} (#{page.code})")
+      page.code
+    end
+
+    def click(spec)
+      spec = { :text => spec } if spec.is_a? String
+      log.debug("Looking for a form with #{spec.inspect}")
+      link = page.link_with(spec)
+      raise "Link not found: #{spec.inspect} on #{page.uri} (links: #{page.links.map(&:text).inspect})" unless link
+      log.debug("Clicking link #{link.text} => #{link.href}")
+      link.click
+      log.debug("Clicked link #{link.href} (#{page.code})")
+      page.code
+    end
+
+    def login
+      raise "You need to override #{this}#login"
+    end
+
+    def send(message, *recipients)
+      raise "You need to override #{this}#send"
+    end
+
+    def agent
+      @agent ||= Mechanize.new
+    end
+
+    def page
+      agent.page
+    end
+
+    def log
+      Smesser.log
+    end
+
+  end
+end

data/lib/smesser/version.rb

@@ -0,0 +1,3 @@
+module Smesser
+  VERSION = "0.0.1"
+end

data/lib/smesser.rb

@@ -0,0 +1,116 @@
+require 'yaml'
+require 'ostruct'
+require 'logger'
+require "smesser/version"
+
+module Smesser
+  autoload :Provider, 'smesser/provider'
+
+  def self.config_files
+    @configfiles ||= [
+      "/etc/smesserrc",
+      "/usr/local/etc/smesserrc",
+      "~/.smesserrc"
+    ]
+  end
+
+  # The easiest way to send an SMS.
+  #
+  # Accepts the following options:
+  #
+  # provider::    The name of the provider to use (see `providers`)
+  # username::    The username to log in with
+  # password::    The password to log in with
+  # message::     The message
+  # recipients::  An array of recipients. If Smesser has `contacts` configured,
+  #               then you can use aliases here.
+  # retry::       The number of times to attempt sending. Default is 1.
+  #
+  # If any are missing, Smesser's configuration will be checked for a suitable
+  # value.
+  #
+  # Returns a hash, with (at least)
+  #
+  # status::    'OK' if all went well, 'Failed' otherwise
+  #
+  # ...and any additional provider specific return values. A common one might be
+  # `:remaining`, to indicate the number of free SMSs left with the provider.
+  def self.send_message(options = {})
+    options.dup.each { |k, v| options[k.to_sym] = options.delete(k) if k.is_a?(String) }
+
+    args = configuration.merge(options)
+    log.debug("Sending message: args = #{args.inspect}")
+
+    provider = providers[args[:provider]].new(args[:username], args[:password])
+    log.debug("Provider: #{provider.inspect}")
+
+    recipients = lookup_contacts(args[:recipients])
+    log.debug("Recipients: #{recipients.inspect}")
+
+    unless provider.logged_in?
+      log.debug("Logging in... (#{args[:username]})")
+      provider.login unless args[:dryrun]
+    end
+
+    log.info("Message: #{args[:message].inspect}")
+
+    result = {}
+
+    if args[:dryrun] or provider.send(args[:message], *recipients)
+      log.info "Message sent."
+      result[:code] = "OK"
+      result[:remaining] = provider.remaining if provider.respond_to?(:remaining)
+    elsif args[:retry] and args[:retry] > 0
+      log.info "Failed, trying again... (#{args[:retry]})"
+      args[:retry] -= 1
+      return send_message(args)
+    else
+      log.info "Failed!"
+      result[:code] = "Failed"
+    end
+
+    result
+  end
+
+  def self.log
+    return @log if @log
+    @log = Logger.new(STDOUT)
+    @log.level = Logger::WARN
+    @log
+  end
+
+  def self.configuration
+    @configuration ||= load_config!
+  end
+
+  def self.providers
+    Provider.load_all
+    @providers ||= {}
+  end
+
+  def self.load_config!
+    config = {}
+    config_files.each do |f|
+      if File.exists?(path = File.expand_path(f))
+        config.merge!(YAML.load(File.read(path)))
+      end
+    end
+    config.dup.each { |k, v| config[k.to_sym] = v if k.is_a?(String) }
+    config
+  end
+
+  def self.lookup_contacts(recipients)
+    contacts = configuration[:contacts]
+    return recipients unless contacts
+    recipients.map do |r|
+      log.debug "#{r} => #{contacts[r]}" if contacts[r]
+      contacts[r] || r
+    end
+  end
+
+  def self.print_providers(io = STDOUT)
+    providers.each do |k, v|
+      io.puts "#{k}: #{v.description || 'No description'}"
+    end
+  end
+end

data/providers/o2_ie.rb

@@ -0,0 +1,50 @@
+require 'smesser/provider'
+
+class O2Ie < Smesser::Provider
+  @@start_url = "http://www.o2online.ie/o2/"
+  @@send_action = "http://messaging.o2online.ie/smscenter_send.osp"
+  @@send_delay = 2
+
+  self.description = "www.o2.ie (400 free texts per month)"
+
+  def logged_in?
+    get @@start_url
+    !!page.link_with(:text => 'Logout of o2.ie')
+  end
+
+  def login
+    get(@@start_url)
+    click('Login to o2.ie')
+    post_form('o2login_form') do |form|
+      form["IDToken1"] = @username
+      form["IDToken2"] = @password
+    end
+  end
+
+  def send(message, *recipients)
+    get_webtext_page
+    post_form('form_WebtextSend') do |form|
+      form["SMSTo"] = recipients.join(", ")
+      form["SMSText"] = message
+      form.action = @@send_action
+      sleep(@@send_delay)
+    end
+  end
+
+  def remaining
+    get_webtext_page
+    if span = page.at("#spn_WebtextFree")
+      span.inner_text
+    else
+      nil
+    end
+  end
+
+  def get_webtext_page
+    login unless logged_in?
+    get(@@start_url)
+    click('Send a webtext')
+    get(page.frames.first.href)
+  end
+end
+Smesser.providers['o2.ie'] = O2Ie

data/providers/vodafone_ie.rb

@@ -0,0 +1,65 @@
+require 'smesser/provider'
+
+class VodafoneIe < Smesser::Provider
+  @@start_url = "https://www.vodafone.ie/myv/index.jsp"
+  @@login_url = "https://www.vodafone.ie/myv/services/login/login.jsp"
+  @@webtext_url = "https://www.vodafone.ie/myv/messaging/webtext/index.jsp"
+  @@send_delay = 3 # Vodafone's servers don't like instantaneousness.
+
+  self.description = "www.vodafone.ie"
+
+  def logged_in?
+    log.debug("Checking if logged in")
+    get(@@start_url)
+    if page.uri == URI.parse(@@start_url)
+      log.debug("Logged in")
+      true
+    else
+      log.debug("Not logged in")
+      false
+    end
+  end
+
+  def login
+    get(@@login_url)
+    post_form('Login') do |form|
+      form.username = @username
+      form.password = @password
+    end
+  end
+
+  def send(message, *recipients)
+    get(@@webtext_url)
+
+    post_form('WebText') do |form|
+      form.message = message
+      recipients.each_with_index do |recipient, index|
+        form["recipients[#{index}]"] = recipient
+      end
+      sleep(@@send_delay)
+    end
+
+    log.debug("Looking for div#webtext-thankyou")
+    if !!page.at('div#webtext-thankyou')
+      log.debug("Found!")
+      true
+    else
+      log.warn("No matching element found!")
+      false
+    end
+  end
+
+  def remaining
+    log.debug("Checking remaining texts...")
+    login unless logged_in?
+    get @@webtext_url unless page.uri == URI::parse(@@webtext_url)
+    if div = page.at("div.info-row.text-remaining strong")
+      log.debug("Found element")
+      div.inner_text
+    else
+      log.warn("No matching element found!")
+      nil
+    end
+  end
+end
+Smesser.providers['vodafone.ie'] = VodafoneIe

data/smesser.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/smesser/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JJ Buckley"]
+  gem.email         = ["jj@bjjb.org"]
+  gem.description   = %q{Send free text messages!}
+  gem.summary       = %q{SMeSser helps you send SMSs using various mobile provider's websites. The gem comes with a binary, which helps you set up the details for your own provider, and with a library which you can integrate into nicer front-ends.}
+  gem.homepage      = "http://jjbuckley.github.com/smesser"
+
+  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.name          = "smesser"
+  gem.require_paths = ["lib"]
+  gem.version       = Smesser::VERSION
+  gem.add_development_dependency 'rake'
+  gem.add_dependency 'mechanize', '~> 2.3'
+end

data/test/test_smesser.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require 'smesser'
+
+class TestSmesser < Test::Unit::TestCase
+  def test_provider_paths
+    assert Smesser::Provider.paths.include?(File.expand_path(File.join(File.dirname(__FILE__), '..', 'providers')))
+  end
+
+  def test_config_files
+    assert Smesser.config_files.include?("/usr/local/etc/smesserrc")
+    assert Smesser.config_files.include?("/etc/smesserrc")
+    assert Smesser.config_files.include?("~/.smesserrc")
+  end
+
+  # TODO - loads more tests!
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: smesser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &76809390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76809390
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: &76788750 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76788750
+description: Send free text messages!
+email:
+- jj@bjjb.org
+executables:
+- smesser
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/smesser
+- lib/smesser.rb
+- lib/smesser/provider.rb
+- lib/smesser/version.rb
+- providers/o2_ie.rb
+- providers/vodafone_ie.rb
+- smesser.gemspec
+- test/test_smesser.rb
+homepage: http://jjbuckley.github.com/smesser
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 251797839
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 251797839
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: SMeSser helps you send SMSs using various mobile provider's websites. The
+  gem comes with a binary, which helps you set up the details for your own provider,
+  and with a library which you can integrate into nicer front-ends.
+test_files:
+- test/test_smesser.rb