picturepath 0.5.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.0.1 2007-06-20
+
+* 1 major enhancement:
+  * Initial release
+  * Support version 5 of PicturePath AUI
+  * Support minimal set of Request fields. Enough to submit a tour link to Realtor.com

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Esomnie, LLC
+
+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/Manifest.txt

@@ -0,0 +1,34 @@
+History.txt
+lib/picturepath
+lib/picturepath/account.rb
+lib/picturepath/client.rb
+lib/picturepath/request.rb
+lib/picturepath/response.rb
+lib/picturepath/version.rb
+lib/picturepath.rb
+License.txt
+Manifest.txt
+Rakefile
+README.txt
+scripts/txt2html
+setup.rb
+spec/account_spec.rb
+spec/expected_responses
+spec/expected_responses/check_failed.xml
+spec/expected_responses/check_success.xml
+spec/expected_responses/check_success_partial.xml
+spec/expected_responses/failed.xml
+spec/expected_responses/success.xml
+spec/expected_responses/success_partial.xml
+spec/picturepath_spec.rb
+spec/request_spec.rb
+spec/response_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+website/index.html
+website/index.txt
+website/javascripts
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,3 @@
+README for picturepath
+======================
+

data/Rakefile

@@ -0,0 +1,139 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'picturepath', 'version')
+
+AUTHOR = 'Dean Mao, Ben Curren'  # can also be an array of Authors
+EMAIL = "dean@esomnie.com, ben@esomnie.com"
+DESCRIPTION = "Ruby wrapper for submitting virtual tours to Realtor.com using the PicturePath AUI."
+GEM_NAME = 'picturepath' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+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 ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'picturepath' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "picturepath"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = PicturePath::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'picturepath documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  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.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #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 = ["builder", ">=2.1.0"]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #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')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.libs.push "lib" 
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Default task is to run specs"
+task :default => :spec
+

data/lib/picturepath.rb

@@ -0,0 +1,8 @@
+module PicturePath #:nodoc
+end
+
+require 'picturepath/client'
+require 'picturepath/request'
+require 'picturepath/response'
+require 'picturepath/account'
+require 'picturepath/version'

data/lib/picturepath/account.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'cgi'
+
+module PicturePath #:nodoc
+  # PicturePath account information
+  class Account
+    @@ESCAPE = "escape_"
+    attr_accessor :username, :password, :action_url
+    
+    # Escape properties starting with escape_ using CGI.escape
+    def method_missing(method_id, *arguments) 
+      method_name = method_id.to_s
+      if method_name[0..@@ESCAPE.length-1] == @@ESCAPE
+        method = method_name[@@ESCAPE.length..method_name.length].to_sym
+        return CGI.escape(send(method))
+      end
+    end
+  end
+end

data/lib/picturepath/client.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'cgi'
+require 'open-uri'
+
+module PicturePath #:nodoc
+  # The client that submits a request and returns a response.
+  class Client
+    
+    # Submit a request to the provided account. Use :check as the action to simulate a request and response
+    # and use :submit to actually submit the request.
+    def self.submit(request, account, action)
+      if action == :submit
+        action = "Submit"
+      elsif action == :check
+        action = "Check"
+      else
+        raise "Action can only be :submit or :check"
+      end
+      xml = CGI.escape(request.to_xml)
+      postUrl = "username=#{account.escape_username}&password=#{account.escape_password}&client=AUI&version=5.0&action=#{action}&xml=#{xml}"
+      url = "#{account.action_url}?#{postUrl}"
+
+      output = open(url).read
+
+      return Response.new(output)
+    end
+  end
+end

data/lib/picturepath/request.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'builder'
+
+module PicturePath #:nodoc
+  class Request
+    VERSION = 5.0
+    COUNTRY_US = "US"
+    
+    attr_accessor :customer_number, :order_number, :product_line, :street1, :street2, 
+        :city, :state, :zip_code, :country, :mls_id, :tour_url, :site_realtor
+
+    # Create a valide XML request from the properties set on the request.
+    # Note: the PicturePath AUI requires capitalized tags
+    def to_xml
+      output = ""
+      x = Builder::XmlMarkup.new(:target => output, :indent => 1)
+      x.instruct!
+      x.AUI_SUBMISSION(:VERSION => VERSION) {
+        x.TOUR {
+          x.CUSTREFNUM customer_number
+          (order_number != nil) && (x.ORDERNUM order_number)
+          x.PRODUCT_LINE product_line
+          x.ADDRESS {
+            x.STREET1 street1
+            x.STREET2 street2
+            x.CITY city
+            x.STATE state
+            x.COUNTRY(:CODE => (country || COUNTRY_US))
+            x.ZIP zip_code
+          }
+          x.IDENTIFIERS {
+            x.ID1(:VALUE => mls_id, :TYPE => "MLSID")
+          }
+          x.DISTRIBUTION {
+            if site_realtor.class == Array
+              site_realtor.each do |site|
+                x.SITE site
+              end
+            else
+              x.SITE site_realtor
+            end
+          }
+          x.TOUR_URL tour_url
+        }
+      }
+      return output
+    end
+  end
+end

data/lib/picturepath/response.rb

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rexml/document'
+
+module PicturePath #:nodoc
+  # The PicturePath response returned from the client
+  class Response
+    include REXML
+    attr_accessor :status_code, :order_number, :messages, :price
+  
+    # Create a response by parsing an xml response string.
+    def initialize(xml)
+      @messages = []
+      parse_xml(xml)
+    end
+  
+    def success?
+      return status_code >= 0 && status_code <= 3 
+    end
+  
+    def warning?
+      return status_code >= 100 && status_code <= 200
+    end
+  
+    def error?
+      return !success? && !warning?
+    end
+  
+    def system_unavailable?
+      return status_code == 1000
+    end
+  
+    # Return true if the submition charged the account money for the post.
+    def charge_applies?
+      return price != null && price > 0
+    end
+  
+    # Parse the response xml to a Response object
+    def parse_xml(xml) 
+      doc = Document.new(xml)
+      order_number_node = XPath.first(doc, '//ORDER_NUMBER')
+      @order_number = (order_number_node && order_number_node[0])
+    
+      # which message do we use for the status_code??
+      XPath.each(doc, '//MESSAGE') do |message|
+        code = message.attributes['CODE'].to_i
+        description = message.attributes['DESCRIPTION']
+        text = message.text
+        @messages.push :code => code, :description => description, :text => text
+        if code >= 4000 && @order_number == nil && text =~ /Please use edit \(order number \w+\)/
+          @order_number = /order number (\w+)/.match(text.to_s)[1]
+        end
+      end
+      if @messages.size > 0
+        @status_code = @messages[0][:code]
+      end
+    
+      @price = 0
+      XPath.each(doc, '//PRODUCT') do |message|
+        @price += message.attributes['PRICE'].to_f
+      end
+    end
+  end
+end

data/lib/picturepath/version.rb

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

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/picturepath/version.rb'
+
+version  = PicturePath::VERSION::STRING
+download = 'http://rubyforge.org/projects/picturepath'
+
+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.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > 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 = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</
>!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)