mapsqueak 0.0.1

data/bin/squeak.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+# squeak.rb - update mapsqueak.heroku.com with a lat/long and a message (a squeak)
+
+$LOAD_PATH.unshift File.dirname($PROGRAM_NAME)
+$LOAD_PATH.unshift File.dirname($PROGRAM_NAME) + "/../lib"
+
+require 'opt_simple'
+require 'mapsqueak'
+
+defaults = {
+  :host => 'http://mapsqueak.heroku.com' # http://localhost:3000
+}
+
+opts = OptSimple.new(defaults).parse_opts! do 
+  argument "--latitude", "Latitude in decimal degrees","LAT"
+  argument "--longitude", "Longitude in decimal degrees","LONG"
+  argument %w[-t --text], "Squeak text", "TEXT"
+  argument %w[-d --duration], "Duration in hours","DURATION" do | arg |
+    dur = arg.to_f
+    if dur > 0.0 and dur <= 24.0 
+      set_opt dur
+    else
+      error "Duration must be between 0 and 24 hours"
+    end
+  end
+  option "--host", "MapSqueak host","URL"
+  option %w[--access-token], "Facebook access token to post mapsqueak","TOKEN"
+  flag %w[--facebook-test-user], "Create a Facebook test user using Mapsqueak's app token"
+end
+puts opts
+
+
+# TODO: add signin capability
+# TODO: re-add the facebook functionality
+m = MapSqueakSession.new
+
+m.post_squeak({
+    :latitude => opts.latitude.dup.gsub("\\",''),
+    :longitude =>opts.longitude.dup.gsub("\\",''),
+    :text =>opts.text.dup,
+    :duration => opts.duration
+  })
+
+__END__
+
+
+puts "Auto confirming squeak ..."
+
+update = {:squeak => Hash.new}
+update[:squeak][:latitude] = initial_return_hash['squeak']['latitude']
+update[:squeak][:longitude] = initial_return_hash['squeak']['longitude']
+
+# PUT    /squeaks/:id(.:format)      {:action=>"update", :controller=>"squeaks"}
+confirmation_curl_str = "curl -v --request PUT --data #{update.to_json} #{opts.host}/squeaks/#{initial_return_hash['squeak']['id']}.json -H \"Content-Type: application/json\" 2>> ruby_err.html"
+
+puts confirmation_curl_str
+
+confirmation_return = `#{confirmation_curl_str}`
+puts "Confirmed."
+confirmation_return_hash = JSON.parse(confirmation_return)
+# Mapsqueak is all set, now update facebook if desired
+user = nil
+login_url = nil
+if opts.include?('access-token')
+  user = Koala::Facebook::API.new(opts.access_token)
+elsif(opts.include?('facebook-test-user'))
+  test_users = Koala::Facebook::TestUsers.new(:app_id => '107582139349630', :secret => "ca16bbd5834ab7d4b012ec5e84a0d003")
+  user_info = test_users.create(true, "offline_access,read_stream,manage_pages,publish_stream")
+  login_url = user_info['login_url']
+  user = Koala::Facebook::API.new(user_info['access_token'])
+end
+
+unless user.nil?
+  puts "Using the following facebook user: #{user.inspect}"
+
+  picture_url = "http://maps.googleapis.com/maps/api/staticmap?center=#{update[:latitude]},#{update[:longitude]}&zoom=13&size=200x200&maptype=roadmap&markers=color:blue%7Clabel:M%7C#{update[:latitude]},#{update[:longitude]}&sensor=true"
+ 
+  puts "Google image url: #{picture_url}"
+
+  # Use google's static map api to get an image for the squeak
+  id = user.put_wall_post("MapSqueak update at #{Time.now.strftime('')}",{:name => 'squeak name', 
+			    :link => "#{opts.host}/squeaks/#{confirmation_return_hash['squeak']['id']}",
+			    :caption => opts.text,
+			    :description => "the description of the squeak, TBD",
+			    :picture => picture_url})
+  puts "Updated facebook  with id: #{id}"
+  puts "Visit #{login_url} to see it ..." unless login_url.nil?
+end
+
+
+__END__
+
+# To update the squeak using POST params, similar to the web client
+#curl_str = "curl -v -F squeak[latitude]=#{opts.latitude} -F squeak[longitude]=#{opts.longitude} -F squeak[text]=\'#{opts.text}\' -F duration=#{opts.duration} #{opts.host}/squeaks/ 2> ruby_err.html"
+# TODO: make this work. 
+class MapSqueak
+  include HTTParty
+  format :json
+  def self.squeak(host,params)
+    post("#{host}/squeaks/",:body=>params)
+  end
+end
+$stderr.puts params.to_json
+MapSqueak.squeak(opts.host,params.to_json)

data/lib/mapsqueak.rb

@@ -0,0 +1,246 @@
+=begin rdoc
+
+= mapsqueak - a reference implementation for MapSqueak clients
+
+=end
+
+require 'json'
+require 'koala'
+require 'rexml/document'
+include REXML
+
+module XmlHelpers
+  def xml_element(tag,text=nil)
+    e = Element.new(tag)
+    e << Text.new(text) unless text.nil?
+    e
+  end
+end
+
+# MapSqueakSession - an class that encapsulates a session with the mapsqueak server. 
+# 
+class MapSqueakSession
+  include XmlHelpers
+  attr_accessor :host, :facebook_token
+  attr_reader :session_cookie
+
+  def initialize(host = 'http://mapsqueak.heroku.com', username=nil,password=nil)
+    @host = host
+    @cookie_file = 'anonymous@anaonymous.com.cookies'
+  end
+
+  # sign in by email/password. 
+  # note that a remember_token will be saved in a cookie file
+  def sign_in(email,password)
+    signin_xml = Document.new
+    signin_xml.add_element('session')
+    signin_xml.root << xml_element('email',email)
+    signin_xml.root << xml_element('password',password)
+    puts signin_xml.to_s
+
+    @cookie_file = "#{email}.cookies"
+
+    curl_str = "curl --data \'#{signin_xml.to_s}\' #{self.host}/sessions.xml -H \"Content-Type: application/xml\" --cookie-jar #{@cookie_file}"
+
+    result = `#{curl_str}`
+    puts result
+    doc = Document.new(result)
+    @user_id = XPath.first(doc,"hash/user-id").text
+  end
+
+  # sign the current user out.
+  # note that the cookie file will be deleted. 
+  def sign_out
+    curl_str = "curl #{self.host}/sessions --request DELETE --cookie #{@cookie_file}"
+    puts curl_str
+    `#{curl_str}`
+    File.unlink(@cookie_file)
+  end
+  
+  # post a new squeak. the squeak can either be whatever the ClientSqueak constructor accepts - 
+  # a String of json or xml, or a hash, or it can be a ClientSqueak object. Talk about flexibility!
+  # the send_format must be :xml or :json
+  def post_squeak(squeak,send_format = :xml)
+    s = nil
+    case squeak
+      when ClientSqueak
+      s = squeak
+      when Hash
+      s = ClientSqueak.new(squeak)
+    end
+    unless [:json, :xml].include?(send_format)
+      $stderr.puts "Error: send_format must be in json or xml"
+    end
+    format_str = send_format.to_s
+    data = s.send("to_#{format_str}")
+    curl_str = "curl --data \'#{data}\' #{self.host}/squeaks.#{format_str} -H \"Content-Type: application/#{format_str}\" --cookie #{@cookie_file}"
+
+    # execute the curl command
+    `#{curl_str}`
+  end
+
+  # get a list of no more than max squeaks closest to the given center_latitude/centerlongitude
+  # The format must either be :json or :xml.
+  # TODO: create a list of ClientSqueak objects, or make a get_squeak_objects function
+  def get_squeaks(center_latitude,center_longitude,max = 100,format=:json)
+    # curl "http://192.168.0.2:3000/squeaks.xml?num_squeaks=3&center_latitude=50.0&center_longitude=-1.8" 
+    unless [:json, :xml].include?(format)
+      $stderr.puts "Error: must be in json or xml"
+    end
+    
+    squeaks = `curl #{self.host}/squeaks.#{format.to_s}?num_squeaks=#{max}&center_latitude=#{center_latitude}&center_longitude=#{center_longitude}`
+
+    # TODO: parse these appropriately
+  end
+
+  # return all of my squeaks in a specified format, either :xml or :json
+  def get_my_squeaks(format=:json)
+    unless [:json, :xml].include?(format)
+      $stderr.puts "Error: must be in json or xml"
+    end
+    # TODO: add a hash based on the parameters requested and use session token
+    # T
+    `curl #{self.host}/users/#{@user_id}.#{format.to_s} --cookie #{@cookie_file}`
+  end
+end
+
+# ClientSqueak - a class that encapsulates a client side squeak
+# Note that if I am not the owner of a squeak, I will not know the user
+class ClientSqueak
+  include XmlHelpers
+  attr_accessor :latitude, :longitude, :text, :duration, :expires, :username
+
+  @@mandatory_parameters = %w[latitude longitude text duration]
+  @@min_latitude = -90.0
+  @@max_latitude = 90.0
+  @@min_longitude = -180.0
+  @@max_longitude = 180.0
+  @@min_duration = 0.0 
+  @@max_duration = 24.0
+  @@max_text_length = 140
+
+  # Initialize a new squeak which must be in an allowable format: 
+  # json - a String representation of a JSON object
+  #         e.g. {\"squeak\":{\"latitude\":\"54.1\",\"longitude\":\"-1.7\",\"duration\":\"2\",\"text\":\"Another squeak!\"}}
+  # xml - a String representation of an XML blob
+  #        e.g. <squeak><latitude>54.1</latitude><longitude>-1.7</longitude><text>Another squeak!</text><duration>2</duration></squeak>
+  # hash - a hash representation of a squeak
+  #         e.g. {:squeak => {:latitude=> 54.1, :longitude=>-1.69, :text => "Another squeak!", :duration => 2}}
+  #         OR if you are lazy (like me) you can just specify the inner hash:
+  #         e.g. {:latitude=> 54.1, :longitude=>-1.69, :text => "Another squeak!", :duration => 2}
+  def initialize(squeak)
+    @original_squeak = squeak
+    temp_hash = {:squeak => {}}
+    case squeak
+    when Hash
+      # just to be nice, we won't force the user to specify the outer wrapping
+      if squeak.has_key? 'squeak'
+	temp_hash = squeak.dup
+      else
+	temp_hash = {:squeak => squeak}
+      end
+      
+    when String 
+      begin
+	temp_hash = JSON.parse(squeak)
+      rescue Exception => e
+	begin
+	  doc = Document.new(squeak)
+	  # a nice flexible way to parse the XML. as long as the XML 
+	  # is only one level deep
+	  doc.elements.each('squeak/') do | el |
+	    el.each do |child|
+	      temp_hash[:squeak][child.name.to_sym] = child.text
+	    end
+	  end
+	rescue Exception => e2
+	  raise "Can't parse squeak text: #{squeak}"
+	end
+      end
+    end
+    
+    t = temp_hash['squeak'] || temp_hash[:squeak]
+    parms_set = []
+    t.keys.each do | k |
+      # this will set and validate the parameters
+      self.send("#{k.to_s}=",t[k])
+      parms_set << k.to_s
+    end
+
+    # but we need to make sure that all of the mandatory parameters are defined
+    unless (@@mandatory_parameters - parms_set).empty?
+      raise "Must have duration, lat and long and text"
+    end
+  end
+
+  # convert the squeak to XML format
+  # e.g. <squeak><latitude>54.1</latitude><longitude>-1.7</longitude><text>Another squeak!</text><duration>2</duration></squeak>
+  def to_xml
+    params_xml = Document.new
+    params_xml.add_element('squeak')
+    params_xml.root << xml_element('latitude',self.latitude.to_s)
+    params_xml.root << xml_element('longitude',self.longitude.to_s)
+    params_xml.root << xml_element('text',self.text)
+    params_xml.root << xml_element('duration',self.duration.to_s)
+    params_xml
+  end
+
+  # convert the squeak to JSON format
+  #  e.g. {\"squeak\":{\"latitude\":\"54.1\",\"longitude\":\"-1.7\",\"duration\":\"2\",\"text\":\"Another squeak!\"}}
+  def to_json
+    self.to_hash.to_json
+  end
+  
+  # convert the squeak to a Hash
+  def to_hash
+    {
+      :squeak=> {
+	:latitude => self.latitude.to_s,
+	:longitude => self.longitude.to_s,
+	:duration => self.duration.to_s,
+	:text => self.text
+      }
+    }
+  end
+
+  # set the latitude for the squeak
+  # must be between  @@min_latitude and @@max_latitude 
+  def latitude=(latitude)
+    lat = latitude.to_f
+    raise "Bad latitude" if lat < @@min_latitude
+    raise "Bad latitude" if lat > @@max_latitude
+    @latitude = lat
+  end
+
+  # set the longitude for the squeak
+  # must be between @@min_longitude and @@max_longitude
+  def longitude=(longitude)
+    long = longitude.to_f
+    raise "Bad longitude" if long < @@min_longitude
+    raise "Bad longitude" if long > @@max_longitude
+    @longitude = long
+  end
+
+  # set the time to live for the squeak
+  # must be between @@min_duration and @@max_duration
+  def duration=(duration)
+    dur = duration.to_f
+    raise "Bad duration" if dur < @@min_duration
+    raise "Bad duration" if dur > @@max_duration
+    @duration = dur
+  end
+
+  # set the message portion of the squeak
+  # length can't exceed @@max_text_length
+  def text=(txt)
+    raise "Bad text length" unless txt.length <= @@max_text_length
+    @text = txt.dup
+  end
+
+  # simply use to_s on the Hash representation
+  def to_s
+    self.to_hash.to_s
+  end
+
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: mapsqueak
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ethan Stryker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-03 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: "  A REST client for MapSqueak, a mobile enabled web app. \n"
+email: e.stryker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mapsqueak.rb
+- bin/squeak.rb
+has_rdoc: true
+homepage: http://mapsqueak.rubyforge.org/
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: mapsqueak
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: a REST client for MapSqueak
+test_files: []
+