tagcrumbs 0.3.1 → 0.3.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.2 XXX
+
+* 1 major enhancement:
+	* Support for Credentials to OAuth Proxy
+
 == 0.3.1 2009-06-14
 
 * 1 major enhancement:

data/Manifest.txt

@@ -6,6 +6,7 @@ README.rdoc
 Rakefile
 TODO.txt
 bin/tagcrumbs
+config/website.yml
 examples/address_update.rb
 examples/comment_new.rb
 examples/favorite_new.rb
@@ -22,15 +23,16 @@ examples/request_authorization.rb
 examples/settings_update.rb
 examples/subscription_new.rb
 examples/tagcrumbs_find.rb
-examples/tagcrumbs_search.rb
 examples/user.rb
 examples/user_recommendation_new.rb
+lib/console.rb
 lib/tagcrumbs.rb
 lib/tagcrumbs/builders/builder.rb
 lib/tagcrumbs/builders/json_builder.rb
 lib/tagcrumbs/builders/xml_builder.rb
 lib/tagcrumbs/cli.rb
 lib/tagcrumbs/config_store.rb
+lib/tagcrumbs/core_extensions.rb
 lib/tagcrumbs/exceptions.rb
 lib/tagcrumbs/node.rb
 lib/tagcrumbs/parsers/json_parser.rb
@@ -38,13 +40,16 @@ lib/tagcrumbs/parsers/parser.rb
 lib/tagcrumbs/parsers/xml_parser.rb
 lib/tagcrumbs/proxy.rb
 lib/tagcrumbs/requestor.rb
-lib/tagcrumbs/resources/array.rb
+lib/tagcrumbs/resources/collection.rb
+lib/tagcrumbs/resources/models/access_token.rb
 lib/tagcrumbs/resources/models/accessors.rb
 lib/tagcrumbs/resources/models/activity.rb
 lib/tagcrumbs/resources/models/address.rb
+lib/tagcrumbs/resources/models/application.rb
 lib/tagcrumbs/resources/models/city.rb
 lib/tagcrumbs/resources/models/comment.rb
 lib/tagcrumbs/resources/models/country.rb
+lib/tagcrumbs/resources/models/email_recommendation.rb
 lib/tagcrumbs/resources/models/fanship.rb
 lib/tagcrumbs/resources/models/favorite.rb
 lib/tagcrumbs/resources/models/filter.rb
@@ -54,6 +59,7 @@ lib/tagcrumbs/resources/models/geoname.rb
 lib/tagcrumbs/resources/models/link.rb
 lib/tagcrumbs/resources/models/location.rb
 lib/tagcrumbs/resources/models/model.rb
+lib/tagcrumbs/resources/models/paragraph.rb
 lib/tagcrumbs/resources/models/picture.rb
 lib/tagcrumbs/resources/models/place.rb
 lib/tagcrumbs/resources/models/placemark.rb
@@ -69,65 +75,79 @@ lib/tagcrumbs/resources/models/tagcrumb.rb
 lib/tagcrumbs/resources/models/user.rb
 lib/tagcrumbs/resources/models/user_recommendation.rb
 lib/tagcrumbs/resources/resource.rb
-lib/tagcrumbs/validations.rb
 script/console
 script/destroy
 script/generate
-spec/fixtures/activity.json
-spec/fixtures/activity.xml
-spec/fixtures/address.json
-spec/fixtures/address.xml
-spec/fixtures/city.json
-spec/fixtures/city.xml
-spec/fixtures/comment.json
-spec/fixtures/comment.xml
-spec/fixtures/country.json
-spec/fixtures/country.xml
-spec/fixtures/fanship.json
-spec/fixtures/fanship.xml
-spec/fixtures/favorite.json
-spec/fixtures/favorite.xml
-spec/fixtures/filter.json
-spec/fixtures/filter.xml
-spec/fixtures/friendship.json
-spec/fixtures/friendship.xml
-spec/fixtures/geoname.json
-spec/fixtures/geoname.xml
 spec/fixtures/json_parser.json
-spec/fixtures/link.json
-spec/fixtures/link.xml
-spec/fixtures/location.json
-spec/fixtures/location.xml
-spec/fixtures/picture.json
 spec/fixtures/picture.png
-spec/fixtures/picture.xml
-spec/fixtures/placemark.json
-spec/fixtures/placemark.xml
-spec/fixtures/placemarks.json
-spec/fixtures/placemarks.xml
-spec/fixtures/profile.json
-spec/fixtures/profile.xml
-spec/fixtures/profile_link.json
-spec/fixtures/profile_link.xml
-spec/fixtures/root.json
-spec/fixtures/root.xml
-spec/fixtures/settings.json
-spec/fixtures/settings.xml
-spec/fixtures/state.json
-spec/fixtures/state.xml
-spec/fixtures/subscription.json
-spec/fixtures/subscription.xml
-spec/fixtures/suggestions.json
-spec/fixtures/suggestions.xml
-spec/fixtures/tag.json
-spec/fixtures/tag.xml
-spec/fixtures/user.json
-spec/fixtures/user.xml
-spec/fixtures/user_recommendation.json
-spec/fixtures/user_recommendation.xml
-spec/fixtures/validation_errors.json
-spec/fixtures/validation_errors.xml
 spec/fixtures/xml_parser.xml
+spec/fixtures_external/README.rdoc
+spec/fixtures_external/json/access_token.json
+spec/fixtures_external/json/activity.json
+spec/fixtures_external/json/address.json
+spec/fixtures_external/json/application.json
+spec/fixtures_external/json/city.json
+spec/fixtures_external/json/comment.json
+spec/fixtures_external/json/country.json
+spec/fixtures_external/json/email_recommendation.json
+spec/fixtures_external/json/fanship.json
+spec/fixtures_external/json/favorite.json
+spec/fixtures_external/json/filter.json
+spec/fixtures_external/json/friendship.json
+spec/fixtures_external/json/geoname.json
+spec/fixtures_external/json/link.json
+spec/fixtures_external/json/location.json
+spec/fixtures_external/json/paragraph.json
+spec/fixtures_external/json/picture.json
+spec/fixtures_external/json/picture_upload.json
+spec/fixtures_external/json/placemark.json
+spec/fixtures_external/json/placemarks.json
+spec/fixtures_external/json/profile.json
+spec/fixtures_external/json/profile_link.json
+spec/fixtures_external/json/root.json
+spec/fixtures_external/json/settings.json
+spec/fixtures_external/json/state.json
+spec/fixtures_external/json/subscription.json
+spec/fixtures_external/json/suggestions.json
+spec/fixtures_external/json/tag.json
+spec/fixtures_external/json/user.json
+spec/fixtures_external/json/user_recommendation.json
+spec/fixtures_external/json/validation_errors.json
+spec/fixtures_external/kml/network_link.kml
+spec/fixtures_external/kml/tagcrumbs.kml
+spec/fixtures_external/rdf/placemark.rdf
+spec/fixtures_external/rss/tagcrumbs.rss
+spec/fixtures_external/xml/access_token.xml
+spec/fixtures_external/xml/activity.xml
+spec/fixtures_external/xml/address.xml
+spec/fixtures_external/xml/application.xml
+spec/fixtures_external/xml/city.xml
+spec/fixtures_external/xml/comment.xml
+spec/fixtures_external/xml/country.xml
+spec/fixtures_external/xml/email_recommendation.xml
+spec/fixtures_external/xml/fanship.xml
+spec/fixtures_external/xml/favorite.xml
+spec/fixtures_external/xml/filter.xml
+spec/fixtures_external/xml/friendship.xml
+spec/fixtures_external/xml/geoname.xml
+spec/fixtures_external/xml/link.xml
+spec/fixtures_external/xml/location.xml
+spec/fixtures_external/xml/paragraph.xml
+spec/fixtures_external/xml/picture.xml
+spec/fixtures_external/xml/picture_upload.xml
+spec/fixtures_external/xml/placemark.xml
+spec/fixtures_external/xml/placemarks.xml
+spec/fixtures_external/xml/profile.xml
+spec/fixtures_external/xml/profile_link.xml
+spec/fixtures_external/xml/root.xml
+spec/fixtures_external/xml/settings.xml
+spec/fixtures_external/xml/state.xml
+spec/fixtures_external/xml/subscription.xml
+spec/fixtures_external/xml/suggestions.xml
+spec/fixtures_external/xml/tag.xml
+spec/fixtures_external/xml/user.xml
+spec/fixtures_external/xml/user_recommendation.xml
+spec/fixtures_external/xml/validation_errors.xml
 spec/spec.opts
 spec/spec_helper.rb
 spec/tagcrumbs/builders/builder_spec.rb
@@ -141,12 +161,15 @@ spec/tagcrumbs/parsers/xml_parser_spec.rb
 spec/tagcrumbs/proxy_spec.rb
 spec/tagcrumbs/requestor_spec.rb
 spec/tagcrumbs/resources/array_spec.rb
+spec/tagcrumbs/resources/models/access_token_spec.rb
 spec/tagcrumbs/resources/models/accessors_spec.rb
 spec/tagcrumbs/resources/models/activity_spec.rb
 spec/tagcrumbs/resources/models/address_spec.rb
+spec/tagcrumbs/resources/models/application_spec.rb
 spec/tagcrumbs/resources/models/city_spec.rb
 spec/tagcrumbs/resources/models/comment_spec.rb
 spec/tagcrumbs/resources/models/country_spec.rb
+spec/tagcrumbs/resources/models/email_recommendation_spec.rb
 spec/tagcrumbs/resources/models/fanship_spec.rb
 spec/tagcrumbs/resources/models/favorite_spec.rb
 spec/tagcrumbs/resources/models/filter_spec.rb
@@ -156,6 +179,7 @@ spec/tagcrumbs/resources/models/geoname_spec.rb
 spec/tagcrumbs/resources/models/link_spec.rb
 spec/tagcrumbs/resources/models/location_spec.rb
 spec/tagcrumbs/resources/models/model_spec.rb
+spec/tagcrumbs/resources/models/paragraph_spec.rb
 spec/tagcrumbs/resources/models/picture_spec.rb
 spec/tagcrumbs/resources/models/place_spec.rb
 spec/tagcrumbs/resources/models/placemark_spec.rb
@@ -171,7 +195,6 @@ spec/tagcrumbs/resources/models/tagcrumb_spec.rb
 spec/tagcrumbs/resources/models/user_recommendation_spec.rb
 spec/tagcrumbs/resources/models/user_spec.rb
 spec/tagcrumbs/resources/resource_spec.rb
-spec/tagcrumbs/validations_spec.rb
 spec/tagcrumbs_spec.rb
 tagcrumbs.gemspec
 tasks/rspec.rake

data/README.rdoc

@@ -7,7 +7,7 @@ This is a RubyGem that provides an ActiveRecord-like interface to the www.tagcru
 == WEBSITES:
 
 * http://www.tagcrumbs.com/
-* http://developers.tagcrumbs.com/
+* http://wiki.tagcrumbs.com/developers
 * http://github.com/tagcrumbs/tagcrumbs_gem
 * http://tagcrumbs.rubyforge.org/
 
@@ -22,6 +22,7 @@ This is a RubyGem that provides an ActiveRecord-like interface to the www.tagcru
 * Validation error messages are read from the server and loaded into the objects
 * Find Tagcrumbs by many filter criteria
 * Load name, tag and city suggestions to help a user create a new placemark
+* Create new User Accounts on tagcrumbs.com
 
 == SYNOPSIS:
 
@@ -41,5 +42,12 @@ This is a RubyGem that provides an ActiveRecord-like interface to the www.tagcru
 
 * sudo gem install tagcrumbs
 
+== SPECS:
+
+Some fixtures are in a git submodule, this makes them reusable for different libraries. If you want to run the tests execute the following first:
+
+git submodule init
+git submodule update
+
 == LICENSE:
 * see License.txt for more information

data/Rakefile

@@ -24,7 +24,8 @@ $hoe = Hoe.new('tagcrumbs', Tagcrumbs::VERSION) do |p|
   
   p.clean_globs |= %w[**/.DS_Store tmp *.log]
   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  # p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+#  p.remote_rdoc_dir = ''
   p.rsync_args = '-av --delete --ignore-errors'
 end
 

data/TODO.txt

@@ -1,17 +1,10 @@
-- push to rubyforge
-
-- have more examples in rdoc
 - test on windows
 - filter activities by location
-- direct access to total_entries in proxy if present in document
 
 == next steps
-- implement http-basic to oauth proxy
 - migrate to ruby 1.9
 
 == future version
 - add distances with georuby?	
-- email recommendations?
-- client_application?
 
 

data/config/website.yml

@@ -0,0 +1,2 @@
+host: sashthebash@rubyforge.org
+remote_dir: /var/www/gforge-projects/tagcrumbs

data/examples/filter_new.rb

@@ -2,8 +2,8 @@
 
 require File.dirname(__FILE__) + '/request_authorization'
 
-filter = Tagcrumbs::Filter.new(:name => 'Friends Favs in Germany', :from => 'friends', :tagcrumb_type => 'Favorite',
-                               :country => Tagcrumbs::Country.search('germany').first)
+filter = Tagcrumbs::Filter.new(:name => 'Friends Favs in Stuttgart', :from => 'friends', :tagcrumb_type => 'Favorite',
+                               :city => Tagcrumbs::City.search('stuttgart').first)
 
 if filter.save
   puts "Saved Filter successfully at #{filter.created_at}. URL: #{filter.resource_url}"
@@ -12,4 +12,8 @@ else
   puts filter.errors.full_messages.join("\n")
 end
 
-puts "First Favorite: #{filter.tagcrumbs.first.name}"
+if filter.tagcrumbs.present?
+  puts "First Favorite: #{filter.tagcrumbs.first.placemark.name}"
+end
+
+filter.destroy

data/examples/placemark_new_suggestions.rb

@@ -10,11 +10,13 @@ placemark.latitude = 49
 placemark.longitude = 9
 
 suggestions = placemark.suggestions # load suggestions from the webservice
-
+#require 'ruby-debug'
+#debugger
 # Of course you would let the user pick from the suggestions
 placemark.name = suggestions.names.first || 'no suggestions found'
+placemark.private = false
 placemark.city = suggestions.cities.first
-placemark.tag_list = suggestions.popular_tags.first.name                          
+placemark.tag_list = suggestions.popular_tags.first && suggestions.popular_tags.first.name 
                           
 if placemark.save
   puts "Saved Placemark successfully at #{placemark.created_at}. URL: #{placemark.resource_url}"

data/examples/request_authorization.rb

@@ -13,7 +13,7 @@ unless Tagcrumbs.valid_credentials?
   print "Press Enter to continue..."
   gets
   
-  if Tagcrumbs.exchange_request_token!
+  if Tagcrumbs.access_token_from_request_token
     puts "Authorization succeeded."
     
     config_store.update(Tagcrumbs.options.slice(:access_token, :access_secret))

data/examples/tagcrumbs_find.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -rubygems
 
-require File.dirname(__FILE__) + '/../lib/tagcrumbs' # this would not be needed if we only search for public Tagcrumbs
+require File.dirname(__FILE__) + '/request_authorization' # this would not be needed if we only search for public Tagcrumbs
 
 # Find the latest Tagcrumbs in Stuttgart, Germany
 stuttgart = Tagcrumbs::City.search('stuttgart').first
@@ -13,11 +13,11 @@ from_cornelius = Tagcrumbs::Tagcrumb.find(:username => 'cornelius', :from => :us
 puts "Total Favorites of Cornelius in the last two weeks: #{from_cornelius.total_entries}"
 
 # Find all Placemarks near the current location
-nearby = Tagcrumbs::Tagcrumb.find(:from => :everybody, :within => 0.55)
+nearby = Tagcrumbs::Tagcrumb.find(:from => :everybody, :range => :medium)
 puts "A total of #{nearby.total_entries} Tagcrumbs near your current location"
 
 # Find all Placemarks near any other location
-nearby_other = Tagcrumbs::Tagcrumb.find(:from => :everybody, :within => 0.55, :latitude => 49, :longitude => 9, :sort => :distance, :order => :asc, :per_page => 50)
+nearby_other = Tagcrumbs::Tagcrumb.find(:from => :everybody, :range => :long, :latitude => 49, :longitude => 9, :sort => :distance, :order => :asc, :per_page => 50)
 puts "A total of #{nearby_other.total_entries} Tagcrumbs nearby (49, 9)"
 
 # Find Placemarks with certain tags

data/examples/user.rb

@@ -16,7 +16,7 @@ end
 
 puts "== Your last comments:"
 
-user.comments.each do |comment|
+user.comments(:per_page => 10).each do |comment|
   puts comment.text
 end
 

data/lib/console.rb

@@ -0,0 +1,14 @@
+# Custom initializer script so that different Tagcrumbs configurations can easily be loaded when using script/console
+require 'ruby-debug'
+
+config_file = ENV['HOME'] + '/.tagcrumbs'
+
+# optionally load another config file
+if ENV['TC_ENV']
+  config_file += '_' + ENV['TC_ENV']
+end
+
+puts "* Loading Tagcrumbs configuration from #{config_file} and merging with defaults"
+@config = Tagcrumbs::ConfigStore.load(config_file)
+
+Tagcrumbs.configure(@config.options)

data/lib/tagcrumbs.rb

@@ -2,7 +2,6 @@ $:.unshift(File.dirname(__FILE__)) unless
 	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'rubygems'
-#require 'ruby-debug'
 
 gem 'activesupport', '2.3.2'
 require 'active_support' 
@@ -25,6 +24,9 @@ require 'mime/types'
 gem 'builder', '2.1.2'
 require 'builder'
 
+require 'zlib' 
+
+
 # Inflections must be available before classes are loaded, needed to automatically find the correct classes
 ActiveSupport::Inflector.inflections do |inflect|
  inflect.irregular 'address', 'address'
@@ -32,7 +34,7 @@ ActiveSupport::Inflector.inflections do |inflect|
  inflect.uncountable "suggestions"
 end
 
-require 'tagcrumbs/validations'
+require 'tagcrumbs/core_extensions'
 require 'tagcrumbs/config_store'
 require 'tagcrumbs/exceptions'
 
@@ -53,7 +55,7 @@ require 'tagcrumbs/proxy'
 
 # resources
 require 'tagcrumbs/resources/resource'
-require 'tagcrumbs/resources/array'
+require 'tagcrumbs/resources/collection'
 
 # models
 require 'tagcrumbs/resources/models/accessors'
@@ -61,11 +63,14 @@ require 'tagcrumbs/resources/models/model'
 require 'tagcrumbs/resources/models/tagcrumb'
 require 'tagcrumbs/resources/models/place'
 
+require 'tagcrumbs/resources/models/access_token'
 require 'tagcrumbs/resources/models/address'
 require 'tagcrumbs/resources/models/activity'
+require 'tagcrumbs/resources/models/application'
 require 'tagcrumbs/resources/models/city'
 require 'tagcrumbs/resources/models/comment'
 require 'tagcrumbs/resources/models/country'
+require 'tagcrumbs/resources/models/email_recommendation'
 require 'tagcrumbs/resources/models/fanship'
 require 'tagcrumbs/resources/models/favorite'
 require 'tagcrumbs/resources/models/filter'
@@ -74,6 +79,7 @@ require 'tagcrumbs/resources/models/friendship'
 require 'tagcrumbs/resources/models/geoname'
 require 'tagcrumbs/resources/models/link'
 require 'tagcrumbs/resources/models/location'
+require 'tagcrumbs/resources/models/paragraph'
 require 'tagcrumbs/resources/models/picture'
 require 'tagcrumbs/resources/models/placemark'
 require 'tagcrumbs/resources/models/profile'
@@ -89,7 +95,7 @@ require 'tagcrumbs/resources/models/user_recommendation'
 
 
 module Tagcrumbs  
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
   
   class << self
     # Returns the default configuration options of the gem. You can overwrite the options with configure
@@ -98,10 +104,13 @@ module Tagcrumbs
   			:consumer_token => 'ZQAR3nW5D3S5JgU8EAKEfA',
   			:consumer_secret => 'vMc7NA77eraJc9TwyImshEEMVgrEy4C8YURVlwoyrHE',
   			:format => :xml,
+  			:compression => true,
   			:consumer_options => 
   			  {
-            :site => 'http://www.tagcrumbs.com'
-            #:site => 'http://localhost:2999'
+            :site => 'http://www.tagcrumbs.com',
+            :request_token_path => 'https://www.tagcrumbs.com/oauth/request_token',
+            :access_token_path => 'https://www.tagcrumbs.com/oauth/access_token',
+            :access_token_from_credentials_path => 'https://www.tagcrumbs.com/oauth/access_token_from_credentials'
   			  }
   		}
   	end
@@ -124,12 +133,13 @@ module Tagcrumbs
     # request_token:: The OAuth request token that you received that you can exchange against an access token
     # request_secret:: The OAuth request secret that you received that you can exchange against an access token
     # format:: The Tagcrumbs webservice supports XML and JSON. You can specify the format of your requests here
+    # compression:: Use gzip compression to save bandwidth
   	def configure(new_options={})
   	  new_options.symbolize_keys!
   		new_options.assert_valid_keys(:consumer_secret, :consumer_token, :consumer_options, 
   		                          :access_token, :access_secret, 
   		                          :request_token, :request_secret,
-  		                          :format)
+  		                          :format, :compression)
   		                          
   		self.options.merge!(new_options)
   	end
@@ -155,18 +165,35 @@ module Tagcrumbs
   	# After you redirected the user to the authorize_url and after the user authorized your application you can exchange 
   	# the request_token against an access_token that you can use to make all further signed requests.
   	# You should use configure to pass in your access_token and access_secret for all further web service calls.
-  	def exchange_request_token!
-  	  return @@access_token if defined?(@@access_token)
-  	  @@access_token = request_token.get_access_token
+  	def access_token_from_request_token
+  	  return @@access_token_from_request_token if defined?(@@access_token_from_request_token)
+  	  @@access_token_from_request_token = request_token.get_access_token
   	  
-  	  options[:access_token]  = @@access_token.token
-  	  options[:access_secret] = @@access_token.secret
+  	  options[:access_token]  = @@access_token_from_request_token.token
+  	  options[:access_secret] = @@access_token_from_request_token.secret
   	  
-  	  @@access_token
+  	  @@access_token_from_request_token
 	  rescue OAuth::Unauthorized
 	    nil
   	end
   	
+  	# Get an access token for all further requests by authenticating with the user's username and password.
+  	# Access to this must be requested from Tagcrumbs. It makes dealing with certain types of applications easier (mobile).
+  	# You should not ask for access_tokens all the time but keep the access token that you received around and not store the username and password
+  	# of the user.
+    def access_token_from_credentials(username, password)
+      return @@access_token_from_credentials if defined?(@@access_token_from_credentials)
+            
+      @@access_token_from_credentials = Requestor.new.access_token_from_credentials(username, password)
+      
+      options[:access_token]  = @@access_token_from_credentials.token
+  	  options[:access_secret] = @@access_token_from_credentials.secret
+
+  	  @@access_token_from_credentials
+	  rescue OAuth::Unauthorized
+	    nil
+    end
+  	
   	# Returns the current user that approved the application and owns the current access_token
   	# This is also used internally to automatically request all the URLs to POST new resources to.
   	def current_user
@@ -184,7 +211,7 @@ module Tagcrumbs
   	    :per_page => [1, 5, 7, 10, 25, 50, 100],
   	    :from => [:you, :friends, :fans, :recommendations, :everybody, :user],
   	    :tagcrumb_type => ['Placemark', 'Favorite'],
-  	    :within => [0.015, 0.15, 0.55],
+  	    :range => [:short, :medium, :long],
   	    :sort => [:date, :distance, :name, :favorites, :comments],
   	    :order => [:asc, :desc],
   	    :w => [:unknown, :country, :state, :city, :zip, :street, :intersection, :address, :premise, :nearby, :everywhere]