tagcrumbs-tagcrumbs 0.3.1

data/examples/picture_update.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+pic = Tagcrumbs.current_user.picture
+
+pic.get_file(ENV['HOME'] + '/Pictures/ich/ich.jpg')
+
+if pic.save
+  puts "Uploaded a new Picture!"
+else
+  puts "There were errors when saving the Picture:"
+  puts pic.errors.full_messages.join("\n")
+end
+
+# pic.destroy

data/examples/placemark_new_simple.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+
+# Just create a Placemark without any suggestions
+placemark = Tagcrumbs::Placemark.new(:name => "Tagcrumbs Gem Test", :notes => "My Notes", :tag_list => 'tag1, tag2',
+                          :private => true, :latitude => 49.12, :longitude => 9.01, :guess_city => true,
+                          :address_attributes => {
+                            :street_address => 'Street Name',
+                            :postal_code => '1234',
+                            :city => 'City Name',
+                            :state => 'State Name',
+                            :country => 'Country Name'
+                          })
+                          
+if placemark.save
+  puts "Saved Placemark successfully at #{placemark.created_at}. URL: #{placemark.resource_url}"
+else
+  puts "There were errors when saving the Placemark:"
+  puts placemark.errors.full_messages.join("\n")
+end
+
+# placemark.destroy # would destroy the placemark

data/examples/placemark_new_suggestions.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+# Create a Placemark with Suggestions
+placemark = Tagcrumbs::Placemark.new
+
+# Latitude and Longitude must be set first to get suggestions
+placemark.latitude = 49
+placemark.longitude = 9
+
+suggestions = placemark.suggestions # load suggestions from the webservice
+
+# Of course you would let the user pick from the suggestions
+placemark.name = suggestions.names.first || 'no suggestions found'
+placemark.city = suggestions.cities.first
+placemark.tag_list = suggestions.popular_tags.first.name                          
+                          
+if placemark.save
+  puts "Saved Placemark successfully at #{placemark.created_at}. URL: #{placemark.resource_url}"
+else
+  puts "There were errors when saving the Placemark:"
+  puts placemark.errors.full_messages.join("\n")
+end

data/examples/profile_link_new.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+profile_link = Tagcrumbs::ProfileLink.new(:url => 'http://www.tagcrumbs.com', :link_type => 'Homepage')
+
+if profile_link.save
+  puts "Saved profile link. URL: #{profile_link.resource_url}"
+else
+  puts "Could not save profile link."
+  puts profile_link.errors.full_messages.join("\n")
+end
+
+# profile_link.destroy

data/examples/profile_update.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+Tagcrumbs.current_user.profile.fullname = 'Testing Webservice'
+Tagcrumbs.current_user.profile.city = Tagcrumbs::City.search('stuttgart').first
+
+if Tagcrumbs.current_user.profile.save
+  puts "Updated Fullname"
+else
+  puts "Could not update Fullname."
+end

data/examples/request_authorization.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/../lib/tagcrumbs'
+
+config_store = Tagcrumbs::ConfigStore.load(ENV['HOME'] + '/.tagcrumbs')
+Tagcrumbs.configure(config_store.options) # you can also set up your own consumer credentials at this point
+
+unless Tagcrumbs.valid_credentials?
+  puts "Please authorize the Gem to have access to your Tagcrumbs account on: #{Tagcrumbs.authorize_url}"
+  
+  %x(open #{Tagcrumbs.authorize_url}) # open browser
+  
+  print "Press Enter to continue..."
+  gets
+  
+  if Tagcrumbs.exchange_request_token!
+    puts "Authorization succeeded."
+    
+    config_store.update(Tagcrumbs.options.slice(:access_token, :access_secret))
+    
+  else
+    puts "Authorization failed."
+  end
+  
+end

data/examples/settings_update.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+Tagcrumbs.current_user.settings.locale = 'en-US'
+
+if Tagcrumbs.current_user.settings.save
+  puts "Updated settings successfully"
+else
+  puts "Could not update settings"
+  puts Tagcrumbs.current_user.settings.errors.full_messages.join("\n")
+end

data/examples/subscription_new.rb

@@ -0,0 +1,15 @@
+#!/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
+subscription = Tagcrumbs::Subscription.new(:placemark => placemark)
+
+if subscription.save
+  puts "Saved subscription. URL: #{subscription.resource_url}"
+else
+  puts "Could not save subscription."
+  puts subscription.errors.full_messages.join("\n")
+end
+
+# profile_link.destroy

data/examples/tagcrumbs_find.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/../lib/tagcrumbs' # 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
+in_stuttgart = Tagcrumbs::Tagcrumb.find(:from => :everybody, :city => stuttgart)
+
+puts "Total Tagcrumbs in Stuttgart: #{in_stuttgart.total_entries}"
+
+# Find Favorites of one user in the last two weeks
+from_cornelius = Tagcrumbs::Tagcrumb.find(:username => 'cornelius', :from => :user, :since => 2.weeks.ago)
+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)
+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)
+puts "A total of #{nearby_other.total_entries} Tagcrumbs nearby (49, 9)"
+
+# Find Placemarks with certain tags
+tagged = Tagcrumbs::Tagcrumb.find(:from => :friends, :tags => 'bar, beer')
+puts "Your friends have #{tagged.total_entries} Tagcrumbs tagged bar and beer."

data/examples/tagcrumbs_search.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/../lib/tagcrumbs' # this would not be needed if we only search for public Tagcrumbs
+
+# This is doing a fulltext search, searching name, tags, description, etc.
+restaurants = Tagcrumbs::Tagcrumb.search(:q => 'restaurant', :l => 'berlin', :w => 'city')
+puts "#{restaurants.total_entries} Placemarks that contain the word 'restaurant' in Berlin."

data/examples/user.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+user = Tagcrumbs.current_user
+
+puts "== Current active user: #{user}, Fullname: #{user.profile.fullname}"
+
+puts "== You have #{user.tagcrumbs.total_entries} Tagcrumbs."
+
+puts "== Your friends:"
+
+user.friends.each do |friend|
+  puts friend.username
+end
+
+puts "== Your last comments:"
+
+user.comments.each do |comment|
+  puts comment.text
+end
+
+puts "== Your last activities:"
+
+user.activities.each do |activity|
+  puts "Type: #{activity.event_type}, Subject: #{activity.subject.resource_url} Secondary Subject: #{activity.secondary_subject ? activity.secondary_subject.resource_url : 'none'}"
+end
+

data/examples/user_recommendation_new.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/request_authorization'
+
+placemark = Tagcrumbs.current_user.placemarks.first
+friend = Tagcrumbs.current_user.friends.first
+
+recommendation = Tagcrumbs::UserRecommendation.new(:placemark => placemark, :recommended_user => friend, :message => 'very interesting place, check it out!')
+
+if recommendation.save
+  puts "You sent a recommendation to #{friend}!"
+else
+  puts "Could not sent a recommendation to #{friend}!"
+  puts recommendation.errors.full_messages.join("\n")
+end

data/lib/tagcrumbs.rb

@@ -0,0 +1,232 @@
+$:.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' 
+
+gem 'hpricot', '0.8.1'
+require 'hpricot'
+
+gem 'htmlentities', '4.0.0'
+require 'htmlentities'
+
+gem 'json', '1.1.6'
+require 'JSON'
+
+gem 'oauth', '0.3.4'
+require 'oauth'
+
+gem 'mime-types', '1.16'
+require 'mime/types'
+
+gem 'builder', '2.1.2'
+require 'builder'
+
+# Inflections must be available before classes are loaded, needed to automatically find the correct classes
+ActiveSupport::Inflector.inflections do |inflect|
+ inflect.irregular 'address', 'address'
+ inflect.uncountable "settings"
+ inflect.uncountable "suggestions"
+end
+
+require 'tagcrumbs/validations'
+require 'tagcrumbs/config_store'
+require 'tagcrumbs/exceptions'
+
+# parsers
+require 'tagcrumbs/parsers/parser'
+require 'tagcrumbs/parsers/json_parser'
+require 'tagcrumbs/parsers/xml_parser'
+
+# builders
+require 'tagcrumbs/builders/builder'
+require 'tagcrumbs/builders/json_builder'
+require 'tagcrumbs/builders/xml_builder'
+
+# general
+require 'tagcrumbs/node'
+require 'tagcrumbs/requestor'
+require 'tagcrumbs/proxy'
+
+# resources
+require 'tagcrumbs/resources/resource'
+require 'tagcrumbs/resources/array'
+
+# models
+require 'tagcrumbs/resources/models/accessors'
+require 'tagcrumbs/resources/models/model'
+require 'tagcrumbs/resources/models/tagcrumb'
+require 'tagcrumbs/resources/models/place'
+
+require 'tagcrumbs/resources/models/address'
+require 'tagcrumbs/resources/models/activity'
+require 'tagcrumbs/resources/models/city'
+require 'tagcrumbs/resources/models/comment'
+require 'tagcrumbs/resources/models/country'
+require 'tagcrumbs/resources/models/fanship'
+require 'tagcrumbs/resources/models/favorite'
+require 'tagcrumbs/resources/models/filter'
+require 'tagcrumbs/resources/models/flag'
+require 'tagcrumbs/resources/models/friendship'
+require 'tagcrumbs/resources/models/geoname'
+require 'tagcrumbs/resources/models/link'
+require 'tagcrumbs/resources/models/location'
+require 'tagcrumbs/resources/models/picture'
+require 'tagcrumbs/resources/models/placemark'
+require 'tagcrumbs/resources/models/profile'
+require 'tagcrumbs/resources/models/profile_link'
+require 'tagcrumbs/resources/models/root'
+require 'tagcrumbs/resources/models/settings'
+require 'tagcrumbs/resources/models/state'
+require 'tagcrumbs/resources/models/subscription'
+require 'tagcrumbs/resources/models/suggestions'
+require 'tagcrumbs/resources/models/tag'
+require 'tagcrumbs/resources/models/user'
+require 'tagcrumbs/resources/models/user_recommendation'
+
+
+module Tagcrumbs  
+  VERSION = '0.3.1'
+  
+  class << self
+    # Returns the default configuration options of the gem. You can overwrite the options with configure
+    def default_options
+  		{
+  			:consumer_token => 'ZQAR3nW5D3S5JgU8EAKEfA',
+  			:consumer_secret => 'vMc7NA77eraJc9TwyImshEEMVgrEy4C8YURVlwoyrHE',
+  			:format => :xml,
+  			:consumer_options => 
+  			  {
+            :site => 'http://www.tagcrumbs.com'
+            #:site => 'http://localhost:2999'
+  			  }
+  		}
+  	end
+  	
+  	# Returns the current configuration options
+  	def options
+  		@@options ||= default_options.with_indifferent_access
+  	end
+  	
+  	# Resets the configuration options to the default_options
+  	def reset_options!
+  	  @@options = default_options.with_indifferent_access
+  	end
+
+    # Overwrite the default_options with your own options. You can specify:
+    # 
+    # consumer_secret:: The OAuth consumer secret of your client that you registered on www.tagcrumbs.com
+    # consumer_token:: The OAuth consumer token of your client that you registered on www.tagcrumbs.com
+    # consumer_options:: Further Options that will be passed to the OAuth Gem
+    # 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
+  	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)
+  		                          
+  		self.options.merge!(new_options)
+  	end
+  	
+
+  	# A request_token that you can let the user authorize, alternatively you can directly use the authorize_url
+  	def request_token
+  	  return @@request_token if defined?(@@request_token)
+  	  @@request_token = Requestor.new.request_token
+  	  
+  	  options[:request_token]  = @@request_token.token
+  	  options[:request_secret] = @@request_token.secret
+  	  
+  	  @@request_token
+  	end
+  	
+  	# An URL that you should redirect the user to or that you should open in a browser on which the user has to approve access
+  	# for your application
+  	def authorize_url
+  	  request_token.authorize_url  	  
+  	end
+  	
+  	# 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
+  	  
+  	  options[:access_token]  = @@access_token.token
+  	  options[:access_secret] = @@access_token.secret
+  	  
+  	  @@access_token
+	  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
+  	  @@current_user ||= User.load('/you')
+    end
+    
+    # Reads the index.(xml|json) file and automatically useses the URLs for further other queries
+    def root
+      @@root ||= Root.load('/index')
+    end
+  	
+  	# Constants that are used to validate query parameters in find and search queries
+  	def constants
+  	  @@constants ||= {
+  	    :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],
+  	    :sort => [:date, :distance, :name, :favorites, :comments],
+  	    :order => [:asc, :desc],
+  	    :w => [:unknown, :country, :state, :city, :zip, :street, :intersection, :address, :premise, :nearby, :everywhere]        
+  	  }.with_indifferent_access
+	  end
+	  
+	  # Validate that key has a valid value. Returns an error if it does not. The constants method returns the valid values.
+	  def validate(key, value)
+      if constants[key]
+        raise ArgumentError.new("#{key} must be one of the following: #{constants[key].join(', ')}") unless constants[key].include?(value)
+        true
+      end
+    end
+	  
+	  # Returns a Tagcrumbs Class by name
+  	def class_by_type(class_name)  	  
+  		"Tagcrumbs::#{class_name.classify}".constantize
+  	end
+  	
+  	# The supported formats of the Gem and their MIME types
+  	def supported_formats
+  	  {
+        :xml =>   ['application/xml',  'text/xml'],
+        :json =>  ['application/json', 'text/json']
+      }
+  	end
+    
+    # Checks whether there is a valid access_token and access_secret that can be used to make all further calls to the webservice.
+    def valid_credentials?
+      if options[:access_token] && options[:access_secret]
+        requestor = Requestor.new
+        requestor.get('/you')
+              
+        true
+      else
+        false
+      end
+    rescue Net::HTTPServerException => error      
+      requestor.response.code == '401' ? false : (raise error) # unauthorized
+    end
+  end
+  
+end
+
+