rubypulse 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-10-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/rubypulse.rb
+lib/rubypulse/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_rubypulse.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on rubypulse, see http://rubypulse.rubyforge.org

data/README.rdoc

@@ -0,0 +1,48 @@
+= rubypulse
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'rubypulse/version'
+
+AUTHOR = 'Phil Kates'  # can also be an array of Authors
+EMAIL = "hawk684@gmail.com"
+DESCRIPTION = "Provides Ruby methods to access the VoicePulse Connect API"
+GEM_NAME = 'rubypulse' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubypulse' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "philk"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Rubypulse::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'rubypulse documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/rubypulse.rb

@@ -0,0 +1,194 @@
+=begin rdoc
+  A Ruby interface to VoicePulse's SOAP interface.
+=end
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'soap/wsdlDriver'
+  
+class VoicePulse
+
+  # When you create a VoicePulseApi.new class it creates a SOAP::WSDLDriverFactory class called @driver.  It also creates a variable @apikey to store the ApiKey from VoicePulse.
+  #
+  # Example:
+  #    obj = VoicePulseApi.new
+  def initialize()
+    wsdl = 'http://connect.voicepulse.com/secure/services/Api0605.asmx?WSDL'
+    @driver = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
+    @apikey = API_KEY
+  end
+
+  # Requires a single hash in the format:
+  #    (:ApiKey => String, :StartYear => Integer, :StartMonth => Integer, :StartDay => Integer, :EndYear => Integer, :EndMonth => Integer, :EndDay => Integer, :Filename => String)
+  #
+  # Example:
+  #    datehash = {:ApiKey => @apikey, :StartYear => 2007, :StartMonth => 03, :StartDay => 01, :EndYear => 2007, :EndMonth => 04, :EndDay => 02, :Filename => "vpreport"}
+  #    obj.generateReport(datehash) => "vpreport.zip"
+  # Returns the name of the Filename created (will always be a .zip file because of the way VoicePulse processes the report).
+  def generateReport(dates)
+    result = @driver.GenerateReport(dates)
+    if result.generateReport.errorCode == "0" then
+      output = result.generateReport.filename
+    else
+      output = "Error Generating Report: #{result.generateReportResult.errorMessage}"
+    end
+    return output
+  end
+
+  # Requires a filename as a String (the one returned from generateReport).  Returns a https URL to download the file from.
+  def getReport(filename)
+    result = @driver.GetGeneratedReports(:ApiKey => @apikey)
+    if result.getGeneratedReportsResult.errorCode == "0" then
+      response = result.getGeneratedReportsResult.items.apiResponseItem
+      @reportlist = Hash.new
+      response.each do |res|
+        @reportlist.update(res.filename => res.fullPath)
+      end
+      output = @reportlist[filename]
+    else
+      output = result.getGeneratedReportsResult.errorMessage
+    end
+    return output
+  end
+
+  # Gets the current balance of the account and returns it as a String
+  def getBalance
+    result = @driver.GetBalance(:ApiKey => @apikey)
+    if result.getBalanceResult.errorCode == "0" then
+      output = result.getBalanceResult.balance
+    else
+      output = result.getBalanceResult.errorMessage
+    end
+    return output
+  end
+
+  # Requires a phone number with no formatting as a String and returns a String for the rate per-minute.
+  def getRate(phonenumber)
+    result = @driver.GetFlexRate(:ApiKey => @apikey, :PhoneNumber => phonenumber)
+    if result.getFlexRateResult.errorCode == "0" then
+      output = result.getFlexRateResult.flexRate
+    else
+      output = "Error Getting FlexRate: #{result.getFlexRateResult.errorMessage}"
+    end
+    return output
+  end
+
+  # TODO: Need to test this when account balance gets low
+  # Requires a CCV Code (3 digit number from back of Credit Card) and an amount as Strings. Returns success or failure message.
+  def refill(ccvcode, amount)
+    result = @driver.RefillNow(:ApiKey => @apikey, :CreditCardCode => ccvcode, :Amount => amount)
+    return result.refillNowResult.refillNow
+  end
+
+  # TODO: activatePhoneNumbers = {:ApiKey => @apikey, :PhoneNumbers => Array, :AccountNumber1 => String, :AccountNumber2 => String}
+  def activatePhoneNumbers
+
+  end
+
+  # TODO: deactivatePhoneNumbers = {:ApiKey => @apikey, :PhoneNumbers => Array, :AccountNumber1 => String, :AccountNumber2 => String}
+  def deactivatePhoneNumbers
+
+  end
+
+  # TODO: getActivePhoneNumbers = {:ApiKey => @apikey} THE API FOR THIS IS CURRENTLY BROKEN
+  # def getActivePhoneNumbers
+  #   result = @driver.GetActivePhoneNumbers(:ApiKey => @apikey)
+  #   if result.getActivePhoneNumbersResult.errorCode == "0" then
+  #     output = result.getActivePhoneNumbersResult.phoneNumber
+  #   else
+  #     output = result.getActivePhoneNumbersResult.errorMessage
+  #   end
+  #   return output
+  # end
+
+  # Requires input of state as a string (two digit code).  Returns list of available area codes.
+  def getAvailablePhoneNumberAreaCodes(state)
+    result = @driver.GetAvailablePhoneNumberAreaCodes(:ApiKey => @apikey, :State => state)
+    if result.getAvailablePhoneNumberAreaCodesResult.errorCode == "0" then
+      response = result.getAvailablePhoneNumberAreaCodesResult.items.apiResponseItem
+      @arealist = Array.new
+      response.each do |res|
+        @arealist += res.areaCode.to_a
+      end
+      output = @arealist
+    else
+      output = result.getAvailablePhoneNumberAreaCodesResult.errorMessage
+    end
+    return output
+  end
+
+  # Requires two strings for input ('state', 'areacode') and returns a hash of {'rate center' => 'city'}
+  def getAvailablePhoneNumberRateCenters(state, areacode)
+    result = @driver.GetAvailablePhoneNumberRateCenters(:ApiKey => @apikey, :State => state, :AreaCode => areacode)
+    if result.getAvailablePhoneNumberRateCentersResult.errorCode == "0" then
+      response = result.getAvailablePhoneNumberRateCentersResult.items.apiResponseItem
+      @reportlist = Hash.new
+      response.each do |res|
+        @reportlist.update(res.rateCenter => res.city)
+      end
+      output = @reportlist
+    else
+      output = result.getAvailablePhoneNumberRateCentersResult.errorMessage
+    end
+    return output
+  end
+
+  # TODO: getAvailablePhoneNumberStates = {:ApiKey => @apikey}
+  # Accepts no input and returns an array of available states (two digit codes)
+  def getAvailablePhoneNumberStates
+    result = @driver.GetAvailablePhoneNumberStates(:ApiKey => @apikey)
+    if result.getAvailablePhoneNumberStatesResult.errorCode == "0" then
+      response = result.getAvailablePhoneNumberStatesResult.items.apiResponseItem
+      @statelist = Array.new
+      response.each do |res|
+        @statelist += res.state.to_a
+      end
+      output = @statelist
+    else
+      output = result.getAvailablePhoneNumberStatesResult.errorMessage
+    end
+    return output
+  end
+
+  # TODO: getAvailablePhoneNumbers = {:ApiKey => @apikey, :State => String, :AreaCode => String, :RateCenter => String}
+  # Requires inputs of state, areacode, and ratecenter as strings.  Returns and array of available phone numbers.
+  def getAvailablePhoneNumbers(state, areacode, ratecenter)
+    result = @driver.GetAvailablePhoneNumbers(:ApiKey => @apikey, :State => state, :AreaCode => areacode, :RateCenter => ratecenter)
+    if result.getAvailablePhoneNumbersResult.errorCode == "0" then
+      response = result.getAvailablePhoneNumbersResult.items.apiResponseItem
+      @numberlist = Array.new
+      response.each do |res|
+        @numberlist += res.phoneNumber.to_a
+      end
+      output = @numberlist
+    else
+      output = result.getAvailablePhoneNumbersResult.errorMessage
+    end
+    return output
+  end
+
+  # TODO: getCredentials = {:ApiKey => @apikey}
+  # Accepts no inputs and returns an array of [login, password] for use in your sip.conf or iax2.conf
+  def getCredentials
+    result = @driver.GetCredentials(:ApiKey => @apikey)
+    if result.getCredentialsResult.errorCode == "0" then
+      output = [result.getCredentialsResult.items.apiResponseItem.login, result.getCredentialsResult.items.apiResponseItem.password]
+    else
+      output = "Error Getting FlexRate: #{result.getUserResult.errorMessage}"
+    end
+    return output
+  end
+
+  # Accepts no input and returns and array of [username, email]
+  def getUser
+    result = @driver.GetUser(:ApiKey => @apikey)
+    if result.getUserResult.errorCode == "0" then
+      output = [result.getUserResult.items.apiResponseItem.username, result.getUserResult.items.apiResponseItem.email]
+    else
+      output = "Error Getting FlexRate: #{result.getUserResult.errorMessage}"
+    end
+    return output
+  end
+
+end

data/lib/rubypulse/version.rb

@@ -0,0 +1,10 @@
+module Rubypulse
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+    self
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rubypulse.rb'}"
+puts "Loading rubypulse gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'rubypulse' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubypulse'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Rubypulse::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.configure.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)