tagcrumbs-tagcrumbs 0.3.1

data/History.txt

@@ -0,0 +1,9 @@
+== 0.3.1 2009-06-14
+
+* 1 major enhancement:
+  * Improved documentation
+
+== 0.3.0 2009-06-13
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Tagcrumbs
+
+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,177 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+TODO.txt
+bin/tagcrumbs
+examples/address_update.rb
+examples/comment_new.rb
+examples/favorite_new.rb
+examples/filter_new.rb
+examples/friendship_create.rb
+examples/link_new.rb
+examples/location_update.rb
+examples/picture_update.rb
+examples/placemark_new_simple.rb
+examples/placemark_new_suggestions.rb
+examples/profile_link_new.rb
+examples/profile_update.rb
+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/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/exceptions.rb
+lib/tagcrumbs/node.rb
+lib/tagcrumbs/parsers/json_parser.rb
+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/models/accessors.rb
+lib/tagcrumbs/resources/models/activity.rb
+lib/tagcrumbs/resources/models/address.rb
+lib/tagcrumbs/resources/models/city.rb
+lib/tagcrumbs/resources/models/comment.rb
+lib/tagcrumbs/resources/models/country.rb
+lib/tagcrumbs/resources/models/fanship.rb
+lib/tagcrumbs/resources/models/favorite.rb
+lib/tagcrumbs/resources/models/filter.rb
+lib/tagcrumbs/resources/models/flag.rb
+lib/tagcrumbs/resources/models/friendship.rb
+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/picture.rb
+lib/tagcrumbs/resources/models/place.rb
+lib/tagcrumbs/resources/models/placemark.rb
+lib/tagcrumbs/resources/models/profile.rb
+lib/tagcrumbs/resources/models/profile_link.rb
+lib/tagcrumbs/resources/models/root.rb
+lib/tagcrumbs/resources/models/settings.rb
+lib/tagcrumbs/resources/models/state.rb
+lib/tagcrumbs/resources/models/subscription.rb
+lib/tagcrumbs/resources/models/suggestions.rb
+lib/tagcrumbs/resources/models/tag.rb
+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/spec.opts
+spec/spec_helper.rb
+spec/tagcrumbs/builders/builder_spec.rb
+spec/tagcrumbs/builders/json_builder_spec.rb
+spec/tagcrumbs/builders/xml_builder_spec.rb
+spec/tagcrumbs/exceptions_spec.rb
+spec/tagcrumbs/node_spec.rb
+spec/tagcrumbs/parsers/json_parser_spec.rb
+spec/tagcrumbs/parsers/parser_spec.rb
+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/accessors_spec.rb
+spec/tagcrumbs/resources/models/activity_spec.rb
+spec/tagcrumbs/resources/models/address_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/fanship_spec.rb
+spec/tagcrumbs/resources/models/favorite_spec.rb
+spec/tagcrumbs/resources/models/filter_spec.rb
+spec/tagcrumbs/resources/models/flag_spec.rb
+spec/tagcrumbs/resources/models/friendship_spec.rb
+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/picture_spec.rb
+spec/tagcrumbs/resources/models/place_spec.rb
+spec/tagcrumbs/resources/models/placemark_spec.rb
+spec/tagcrumbs/resources/models/profile_link_spec.rb
+spec/tagcrumbs/resources/models/profile_spec.rb
+spec/tagcrumbs/resources/models/root_spec.rb
+spec/tagcrumbs/resources/models/settings_spec.rb
+spec/tagcrumbs/resources/models/state_spec.rb
+spec/tagcrumbs/resources/models/subscription_spec.rb
+spec/tagcrumbs/resources/models/suggestions_spec.rb
+spec/tagcrumbs/resources/models/tag_spec.rb
+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/PostInstall.txt

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

data/README.rdoc

@@ -0,0 +1,45 @@
+= Tagcrumbs Gem
+
+== DESCRIPTION:
+
+This is a RubyGem that provides an ActiveRecord-like interface to the www.tagcrumbs.com web service.
+
+== WEBSITES:
+
+* http://www.tagcrumbs.com/
+* http://developers.tagcrumbs.com/
+* http://github.com/tagcrumbs/tagcrumbs_gem
+* http://tagcrumbs.rubyforge.org/
+
+== FEATURES:
+
+* ActiveRecord and ActiveResource-like interface
+* Support for OAuth authorization (3-legged and 2-legged)
+* Automatic loading of associated Models when they are accessed (just like ActiveRecord associations)
+* JSON and XML support
+* URLs are loaded from the web service and are not build manually to automatically adapt to smaller changes
+* A console program to interactively create new Placemarks or to create a Placemark by passing command line arguments (scripting support)
+* 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
+
+== SYNOPSIS:
+
+* see the examples directory for some usage examples
+
+== REQUIREMENTS:
+
+* activesupport
+* hpricot
+* htmlentities
+* json
+* oauth
+* mime-types
+* builder
+
+== INSTALL:
+
+* sudo gem install tagcrumbs
+
+== LICENSE:
+* see License.txt for more information

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/tagcrumbs'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('tagcrumbs', Tagcrumbs::VERSION) do |p|
+  p.developer('Sascha Konietzke', 'sascha@tagcrumbs.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['activesupport','= 2.3.2'],
+    ['hpricot', '= 0.8.1'],
+    ['htmlentities', '= 4.0.0'],
+    ['json', '= 1.1.6'],
+    ['oauth', '= 0.3.4'],
+    ['mime-types', '= 1.16'],
+    ['builder', '= 2.1.2']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  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.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:spec]

data/TODO.txt

@@ -0,0 +1,17 @@
+- 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/bin/tagcrumbs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/../lib/tagcrumbs/cli'
+
+Tagcrumbs::CLI.execute(STDOUT, STDIN, STDERR, ARGV)

data/examples/address_update.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+
+placemark = Tagcrumbs.current_user.placemarks.first # get your last placemark
+
+placemark.address.street_address += '- modified by webservice'
+                          
+if placemark.address.save
+  puts "Updated the address of #{placemark.name}"
+else
+  puts "Could not update the address of #{placemark.name}"
+end
+

data/examples/comment_new.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+# Find a Placemark to put the comment first
+placemark = Tagcrumbs.current_user.placemarks.first 
+raise "You don't have any Placemarks" unless placemark # of course you can also add comments to other user's placemarks, but we don't want to spam them here
+
+comment = Tagcrumbs::Comment.new(:text => 'My comment text', :placemark => placemark)
+
+                          
+if comment.save
+  puts "Saved Comment successfully at #{comment.created_at}. URL: #{comment.resource_url}"
+else
+  puts "There were errors when saving the Comment:"
+  puts comment.errors.full_messages.join("\n")
+end
+
+# comment.destroy # would destroy the comment

data/examples/favorite_new.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+
+placemark = Tagcrumbs::Placemark.find(:from => :friends, :per_page => 1).first # get the last placemark of your friends
+
+favorite = Tagcrumbs::Favorite.new(:tag_list => 'tag1, tag2', :private => false, :subscribe => false, :placemark => placemark)
+                          
+if favorite.save
+  puts "Saved Favorite successfully at #{favorite.created_at}. URL: #{favorite.resource_url}"
+else
+  puts "There were errors when saving the Favorite:"
+  puts favorite.errors.full_messages.join("\n")
+end
+
+# favorite.destroy # would destroy the favorite

data/examples/filter_new.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby -rubygems
+
+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)
+
+if filter.save
+  puts "Saved Filter successfully at #{filter.created_at}. URL: #{filter.resource_url}"
+else
+  puts "There were errors when saving the Filter:"
+  puts filter.errors.full_messages.join("\n")
+end
+
+puts "First Favorite: #{filter.tagcrumbs.first.name}"

data/examples/friendship_create.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+sascha = Tagcrumbs::User.find_by_username 'sascha'
+
+if Tagcrumbs.current_user.friend_with?(sascha)
+  puts "You are already a friend with sascha"
+  Tagcrumbs.current_user.friendship_with(sascha).destroy
+else
+  puts "Making you a friend of sascha..."
+  friendship = Tagcrumbs::Friendship.new(:friend => sascha)
+  
+  if friendship.save
+    puts "You are now friend with sascha"
+  else
+    puts "Could not become friend of sascha"
+  end  
+end

data/examples/link_new.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+placemark = Tagcrumbs.current_user.placemarks.first
+
+link = Tagcrumbs::Link.new(:url => 'http://www.tagcrumbs.com', :placemark => placemark)
+                          
+if link.save
+  puts "Saved Link successfully at #{link.created_at}. URL: #{link.resource_url}"
+else
+  puts "There were errors when saving the Link:"
+  puts link.errors.full_messages.join("\n")
+end
+
+# link.destroy # would destroy the link

data/examples/location_update.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+
+location = Tagcrumbs.current_user.location
+puts "Your are currently at #{location.latitude}, #{location.longitude}."
+
+location.latitude = 0.0
+location.longitude = 0.0
+
+if location.save
+  puts "Updated your current location"
+else
+  puts "Could not update your current location."
+end