harleytt-gvoice-ruby 0.3.3

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.log
+gvoice-ruby-config.yml
+*.gem
+.rvmrc

data/Gemfile

@@ -0,0 +1,19 @@
+# A sample Gemfile
+source "http://rubygems.org"
+#
+gem 'curb'
+gem 'nokogiri'
+gem 'json'
+
+# Make sure the correct version of xmpp4r-simple is loaded when
+# require is called in bin/gv-notifier
+if RUBY_VERSION < '1.9'
+  gem 'xmpp4r-simple', "= 0.8.8"
+else
+  gem 'scashin133-xmpp4r-simple', '= 0.8.9'
+end
+
+group :test do
+  gem 'shoulda'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    curb (0.7.8)
+    json (1.4.6)
+    mocha (0.9.8)
+      rake
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    scashin133-xmpp4r-simple (0.8.9)
+      xmpp4r (>= 0.3.2)
+    shoulda (2.11.3)
+    xmpp4r (0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  curb
+  json
+  mocha
+  nokogiri
+  scashin133-xmpp4r-simple (= 0.8.9)
+  shoulda

data/README.rdoc

@@ -0,0 +1,90 @@
+= gvoice-ruby
+
+== Introduction
+
+gvoice-ruby is a library for interacting with Google's Voice service (previously GrandCentral) using ruby.  As Google does not yet publish an official API for Google Voice gvoice-ruby uses the ruby libcurl library (Curb) to interact with the web service itself by using the HTTP verbs POST and GET to send and retrieve information to the Google Voice service.
+
+gvoice-ruby is currently a very preliminary project with limited functionality basically confined to returning arrays of voicemail or sms objects and sending sms messages, or connecting calls.  It cannot cancel calls already in progress.  It currently works under ruby 1.8.7-p302 and 1.9.2-p0 on my computer running Mac OS X 10.6 (Snow Leopard).  It is not guaranteed to work anywhere else and has very few tests.
+
+However, you should be able to run bundle install after running git clone as outlined below and it should function.
+
+== Prerequisites
+
+1.) Ruby 1.8.7 or 1.9.2
+
+2.) Bundler 1.0 (gem install bundler)
+
+== Installing
+
+Install the gem:
+
+	$ gem install gvoice-ruby
+
+or
+
+Clone the git repository:
+
+	$ git clone git://github.com/kgautreaux/gvoice-ruby.git
+
+then:
+
+	$ cd gvoice-ruby
+
+and:
+
+	$ bundle install
+
+This should install all the required gems provided you have the right permissions.  
+
+To run the test suite:
+
+	$ bundle exec rake
+
+== Examples
+
+Please see the bin/ directory for examples of using the library to accomplish some tasks.  You must run bundle exec 'command' in order for the program to work, i.e.
+
+	$ cd gvoice-ruby
+	$ bundle exec bin/gv-notifier
+
+== Known Issues
+
+1.) You have to run 'bundle exec bin/"command"' and it must be run in the context of the gvoice-ruby directory.
+
+2.) It does some wicked monkeypatching to run on both 1.9.2 and 1.8.7 mostly due to the new Date class in Ruby 1.9.2.
+
+3.) It is technically a library but it doesn't document any sort of API thus far.
+
+== BUGS
+
+1.) It has few tests.
+
+2.) If the Google Voice service changes in any way it will break.
+
+3.) If the libraries used change it will break.
+
+4.) It is somewhat tightly coupled to the private post and fetch_page methods (sms and voicemail arrays depend upon these methods).
+
+5.) It is not RESTful in any way.
+
+6.) It cannot yet cancel calls very well, but it can initiate them.
+
+7.) It is my first attempt at writing a library and is not idiomatic ruby.
+
+8.) It requires rubygems but doesn't set RUBYOPT environment variable.
+
+9.) It requires the file compatibility.rb which monkeypatches the Array and Symbol classes on Ruby < 1.9 to enable sorting.
+
+10.) You cannot change any of the Google Voice settings using this library.
+
+11.) The library loads a specific YAML file that must be in place for anything to work as the script has no logical defaults.
+
+12.) Minimal to no error handling present.  Fail silent...Fail deep.
+
+13.) The library doesn't post the id of sms messages it sends so they don't get associated with any conversation in Google Voice.
+
+14.) On Ruby 1.9 and above the library monkeypatches it's own call method to reformat dates.
+
+== Thanks
+
+Thanks to Chad Smith for posting the URL for accessing the Google Voice service as listed on http://posttopic.com/topic/google-voice-add-on-development#post-27

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Run all tests for this project."
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.3.3

data/bin/gv-notifier

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby -W1
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+begin
+  require 'gvoice-ruby'
+  require 'xmpp4r-simple'
+rescue LoadError
+  warn "\n\nYou must run 'bundle exec #{$0}' to allow loading of correct gems!\n\n"
+  raise
+end
+
+config = GvoiceRuby::Configurator.load_config
+
+# Main
+jabber_bot = Jabber::Simple.new(config[:bot_name], config[:bot_password])
+
+voicebox = GvoiceRuby::Client.new
+
+voicebox.check
+
+voicebox.missed.each do |call|
+  if DateTime.parse(call.display_start_date_time).yday >= (Time.now.yday - 3)
+    puts "You missed a call from #{call.from} on #{call.display_start_date_time}."
+  end
+end
+  puts "\n"
+
+voicebox.received.each do |call|
+  if DateTime.parse(call.display_start_date_time).yday >= (Time.now.yday - 1)
+    puts "You received a call from #{call.from} on #{call.display_start_date_time}."
+  end
+end
+  puts "\n"
+
+voicebox.placed.each do |call|
+  if DateTime.parse(call.display_start_date_time).yday >= (Time.now.yday - 3)
+    puts "You placed a call to #{call.from} on #{call.display_start_date_time}."
+  end
+end
+  puts "\n"
+
+if voicebox.any_unread?
+  sms_messages = []
+  voicemail_messages = []
+  
+  voicebox.smss.each do |t|
+    if t.labels.include?('unread')
+      sms_messages << "#{t.from} says: '#{t.text}' at #{t.display_start_date_time}\n"
+      voicebox.mark_as_read({:id => t.id})
+      voicebox.add_note({:id => t.id, :note => "You were notified via gv-notifier at #{Time.now}."})
+      # voicebox.star({:id => t.id})
+    else
+      next
+    end
+  end
+  
+  voicebox.voicemails.each do |v|
+    if v.labels.include?('unread')
+      voicemail_messages << "Voicemail from #{v.from} at #{v.display_start_date_time}:\n#{v.transcript}\n"
+      voicebox.mark_as_read({:id => v.id})
+    else
+      next
+    end
+  end
+  
+  begin
+    [sms_messages, voicemail_messages].each do |thing|
+      thing.each { |m| jabber_bot.deliver(voicebox.user.email, m, :normal);print m }
+    end
+  rescue
+    raise
+  end
+  config[:last_message_start_time] = voicebox.all_messages.last.start_time
+else
+   print "No unread messages in your Google Voice inbox.\n"
+end
+
+GvoiceRuby::Configurator.write_config(config)

data/bin/gv-place-call

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby -W1
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+begin
+  require 'gvoice-ruby'
+rescue LoadError
+  warn "\n\nYou must run 'bundle exec #{$0}' to allow loading of correct gems!\n\n"
+  raise
+end
+
+voicebox = GvoiceRuby::Client.new
+
+# Phone types:
+# 1) Home
+# 2) Mobile
+# 3) Work
+# 7) Gizmo
+this_phone = { :outgoing_number => "3088720071", :forwarding_number => "3088721257", :phone_type => 2 }
+
+puts "Call connected!" if voicebox.call(this_phone)
+
+puts "Call cancelled!" if voicebox.cancel_call

data/bin/gv-send-sms

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -W1
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+begin
+  require 'gvoice-ruby'
+rescue LoadError
+  warn "\n\nYou must run 'bundle exec #{$0}' to allow loading of correct gems!\n\n"
+  raise
+end
+
+voicebox = GvoiceRuby::Client.new
+
+txt = {:phone_number => "3088721257", :text => "Testing sms from gvoice-ruby!" }
+
+puts "Message sent!" if voicebox.send_sms(txt)    
+                  

data/config/gvoice-ruby-config.yml.sample

@@ -0,0 +1,11 @@
+--- 
+:google_auth_url: https://www.google.com/accounts/ServiceLoginAuth
+:google_account_password: your_google_account_password
+:continue_url: https://www.google.com/voice
+:last_message_start_time: 0
+:bot_name: your_gtalk_or_jabber_bot_name
+:google_service: grandcentral
+:bot_password: your_gtalk_bot_password
+:google_voice_feed_url: https://www.google.com/voice/inbox/recent
+:google_account_email: your_google_email_address@gmail.com
+:logfile: path/to/log/file

data/gvoice-ruby.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'gvoice-ruby/version'
+
+Gem::Specification.new do |s|
+  s.name        = "harleytt-gvoice-ruby"
+  s.version     = GvoiceRuby::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Keith Gautreaux", "Roy Kolak", "Jeremy Stephens"]
+  s.email       = ["keith.gautreaux@gmail.com"]
+  s.homepage    = "http://github.com/kgautreaux/gvoice-ruby"
+  s.summary     = "gvoice-ruby is a library for interacting with Google’s Voice service (previously GrandCentral) using ruby."
+  s.description = <<-EOS
+  gvoice-ruby is currently a very preliminary project with limited functionality basically confined to returning arrays of voicemail or sms objects and sending sms messages, or connecting calls. It cannot cancel calls already in progress. It currently works under ruby 1.8.7-p302 and 1.9.2-p0 on my computer running Mac OS X 10.6 (Snow Leopard). It is not guaranteed to work anywhere else and has very few tests.
+EOS
+
+  s.required_rubygems_version = "~> 1.3.6"
+  # s.rubyforge_project         = "gvoice-ruby"
+  
+  s.add_dependency "curb", "~> 0.7.8"
+  s.add_dependency "nokogiri", "~> 1.4.3.1"
+  s.add_dependency "json", "~> 1.4.6"
+
+  s.add_development_dependency "bundler", "~> 1.0.0.rc.6"
+  s.add_development_dependency "mocha",  "~> 0.9.7"
+  s.add_development_dependency "shoulda", "~> 2.11.3"
+  s.add_development_dependency "rake", "~> 0.8.7"
+
+  s.files        = `git ls-files`.split("\n")
+  # s.executables  = ["bin/gv-notifier", "bin/gv-place-call", "bin/gv-send-sms"]#`git ls-files`.split("\n").select { |f| f =~ /^bin/ }
+  s.require_paths = ['lib']
+  
+  s.post_install_message = "\n\nPlease run 'cd gvoice-ruby;bundle install;bundle exec rake' to run the tests.\n\n"
+end

data/lib/gvoice-ruby/call.rb

@@ -0,0 +1,9 @@
+# -*- encoding: utf-8 -*-
+module GvoiceRuby
+  class Call < Struct.new(:id, :start_time, :display_number, :display_start_date_time, :display_start_time, :relative_start_time, :is_read, :starred, :labels, :from, :to)
+   #attr_accessor :id, :start_time, :display_number, :display_start_date_time, :display_start_time, :relative_start_time, :is_read, :labels, :from, :to, :text
+   #
+   #def initialize
+   #end
+  end
+end

data/lib/gvoice-ruby/client.rb

@@ -0,0 +1,277 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.dirname(__FILE__))
+%w[curb nokogiri json sms voicemail call user logger compatibility inbox_parser open-uri errors].each { |lib| require lib }
+
+module GvoiceRuby
+  class Client
+    include Curl
+    
+    attr_accessor :unread_counts, :smss, :voicemails, :user, :all_messages, :calls
+    attr_reader :logger
+    
+    def initialize(config = GvoiceRuby::Configurator.load_config)
+      if config[:google_account_email].nil? || config[:google_account_password].nil?
+        raise ArgumentError, "Invalid Google Account username or password provided."
+      else          
+        @logger        = Logger.new(config.has_key?(:logfile) ? config[:logfile] :
+                                      File.join(File.dirname(__FILE__), '..', '..', 'log', 'gvoice-ruby.log'))
+        @user          = User.new(config[:google_account_email], config[:google_account_password])
+        @any_unread    = []
+        @unread_counts = {}
+        @all_messages  = []
+        initialize_curb
+      end
+      
+      login(config)
+      set_rnr_se_token
+    end
+    
+    def any_unread?
+      @any_unread
+    end
+    
+    def logged_in?
+      !@curb_instance.nil?
+    end
+    
+    def check(parser = GvoiceRuby::InboxParser.new)
+      inbox = parser.parse_page(fetch_page)
+      
+      get_unread_counts(inbox)
+      @smss = parser.parse_sms_messages(inbox['messages'])
+      @voicemails = parser.parse_voicemail_messages(inbox['messages'])
+      @all_messages = smss | voicemails
+      @all_messages.sort_by!(&:start_time)
+    end
+    
+    def missed(parser = GvoiceRuby::InboxParser.new)
+      inbox = parser.parse_page(fetch_page('https://www.google.com/voice/inbox/recent/missed/'))
+      parser.parse_calls(inbox['messages'])
+    end
+    
+    def received(parser = GvoiceRuby::InboxParser.new)
+      inbox = parser.parse_page(fetch_page('https://www.google.com/voice/inbox/recent/received/'))
+      parser.parse_calls(inbox['messages'])
+    end
+    
+    def placed(parser = GvoiceRuby::InboxParser.new)
+      inbox = parser.parse_page(fetch_page('https://www.google.com/voice/inbox/recent/placed/'))
+      parser.parse_calls(inbox['messages'])
+    end
+    
+    def send_sms(options, show_details = true)
+      fields = [ PostField.content('phoneNumber', options[:phone_number]),
+                 PostField.content('text', options[:text]),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+
+      options.merge!({ :post_url => "https://www.google.com/voice/sms/send" })
+
+      if show_details
+        logger.info "Sending sms..."
+        logger.info "\tTo: #{options[:phone_number]}"
+        logger.info "\tBody: #{options[:text]}"
+        logger.info "\tSent at: #{Time.now}\n"
+      end
+
+      post(options, fields)
+    end
+    
+    def call(options)
+      fields = [ PostField.content('outgoingNumber', options[:outgoing_number]),
+                 PostField.content('forwardingNumber', options[:forwarding_number]),
+                 PostField.content('phoneType', options[:phone_type] || 2),
+                 PostField.content('subscriberNumber', 'undefined'),
+                 PostField.content('remember', 0),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+      
+      options.merge!({ :post_url => "https://www.google.com/voice/call/connect" })
+                 
+      post(options, fields)
+    end
+    
+    def cancel_call(options = {})
+      fields = [ PostField.content('outgoingNumber', options[:outgoing_number] || 'undefined'),
+                 PostField.content('forwardingNumber', options[:forwarding_number] || 'undefined'),
+                 PostField.content('cancelType', 'C2C'),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => "https://www.google.com/voice/call/cancel" })
+      
+      post(options, fields)
+    end
+    
+    def archive(options)
+      fields = [ PostField.content('messages', options[:id]),
+                 PostField.content('archive', 1),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/mark'})
+                 
+      post(options, fields)
+    end
+    
+    def mark_as_read(options)
+      fields = [ PostField.content('messages', options[:id]),
+                 PostField.content('read', 1),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/mark'})
+                 
+      post(options, fields)
+    end
+    
+    def mark_as_unread(options)
+      fields = [ PostField.content('messages', options[:id]),
+                 PostField.content('read', 0),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/mark'})
+                 
+      post(options, fields)
+    end
+    
+    def star(options)
+      fields = [ PostField.content('messages', options[:id]),
+                 PostField.content('star', 1),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/star'})
+                 
+      post(options, fields)
+    end
+    
+    def unstar(options)
+      fields = [ PostField.content('messages', options[:id]),
+                 PostField.content('star', 0),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/star'})
+                 
+      post(options, fields)
+    end
+    
+    def add_note(options)
+      fields = [ PostField.content('id', options[:id]),
+                 PostField.content('note', options[:note]),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/savenote'})
+      
+      post(options, fields)
+    end
+    
+    def delete_note(options)
+      fields = [ PostField.content('id', options[:id]),
+                 PostField.content('_rnr_se', @_rnr_se) ]
+                 
+      options.merge!({ :post_url => 'https://www.google.com/voice/inbox/deletenote'})
+      
+      post(options, fields)
+    end
+    
+    def logout
+      if logged_in?
+        @curb_instance.url = "https://www.google.com/voice/account/signout"
+        @curb_instance.perform
+        logger.info "FINISHED LOGOUT #{@curb_instance.url}: HTTP #{@curb_instance.response_code}"
+        @curb_instance = nil
+      end
+      self
+    end
+    
+    private
+    def login(options = {})
+      @curb_instance.url = 'https://www.google.com/accounts/ServiceLoginAuth'
+      @curb_instance.perform
+      # If String#force_encoding doesn't exist we are on Ruby 1.8 and we shouldn't encode anything
+      @curb_instance.body_str.force_encoding("UTF-8") if @curb_instance.body_str.respond_to?(:force_encoding)
+      
+      defeat_google_xsrf(@curb_instance.body_str)
+      
+      begin
+        fields = [ PostField.content('continue', (options[:continue_url] || 'https://www.google.com/voice')),
+                   PostField.content('GALX', @galx),
+                   PostField.content('service', (options[:google_service] || 'grandcentral')),
+                   PostField.content('Email', options[:google_account_email]),
+                   PostField.content('Passwd', options[:google_account_password]) ]
+      rescue ArgumentError
+        warn "Unable to log in."
+        raise GvoiceRuby::LoginFailed
+      end
+      options.merge!({ :post_url => 'https://www.google.com/accounts/ServiceLoginAuth' })
+      
+      post(options, fields)
+    end
+    
+    def post(options, fields)
+      @curb_instance.url = options[:post_url] #"https://www.google.com/voice/call/connect || https://www.google.com/voice/sms/send"
+      @curb_instance.http_post(fields)
+      
+      logger.info "FINISHED POST TO #{options[:post_url]}: HTTP #{@curb_instance.response_code}"
+      return @curb_instance
+    end
+    
+    def fetch_page(url = 'https://www.google.com/voice/inbox/recent')
+  
+      @curb_instance.url = url #"https://www.google.com/voice/inbox/recent"
+      
+      @curb_instance.http_get
+      
+      logger.info "FINISHED FETCHING #{url}: HTTP #{@curb_instance.response_code}"
+      return @curb_instance
+    end
+    
+    def get_unread_counts(inbox)
+      @unread_counts = inbox['unreadCounts']
+      @any_unread = inbox['unreadCounts']['unread'].to_i != 0
+      logger.info "No unread messages in your Google Voice inbox." unless @any_unread
+    end
+    
+    def defeat_google_xsrf(body_string)
+      # defeat Google's XSRF protection
+      doc = Nokogiri::HTML::DocumentFragment.parse(body_string)
+      doc.css('div.loginBox table#gaia_table input').each do |input|
+        if input.to_s =~ /GALX/u
+          @galx = input.to_s.scan(/value\="(.+?)"/u).flatten!.pop
+        else
+          next
+          # raise IOError, 'Cannot fetch galx attribute from Google.'
+        end
+      end
+    end
+    
+    def set_rnr_se_token
+      if @curb_instance.response_code == 200 #&& @curb_instance.respond_to?(:perform) # Vestigial?
+        @curb_instance.url = "http://www.google.com/voice"
+        @curb_instance.perform 
+        @_rnr_se = extract_rnr_se(@curb_instance.body_str)
+      else
+        raise IOError, "Curb instance was not properly initialized."  
+      end
+    end
+    
+    def extract_rnr_se(body_string)
+      begin
+        /value="(.+)"/.match(Nokogiri::HTML::Document.parse(body_string).css('form#gc-search-form').inner_html)
+        return $1
+      rescue IOError
+        raise IOError, "Problem extracting _rnr_se code from page."
+      end
+    end
+    
+    def initialize_curb
+      @curb_instance = Easy.new do |curl|
+        # Google gets mad if you don't fake this...
+        curl.headers["User-Agent"] = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1.2) Gecko/20090729 Firefox/3.5.2"
+        # Let's see what happens under the hood
+        # curl.verbose = true
+
+        # Google will redirect us a bit
+        curl.follow_location = true
+
+        # Google will make sure we retain cookies
+        curl.enable_cookies = true
+      end
+    end
+  end
+end