tagcrumbs 0.3.1 → 0.3.2

data/lib/tagcrumbs/cli.rb

@@ -146,7 +146,7 @@ module Tagcrumbs
         @stdout.print "Please authorize the application in your browser: #{authorize_url}.\nPress Enter after you authorized the application to continue..."
         @stdin.gets
         
-        if Tagcrumbs.exchange_request_token!        
+        if Tagcrumbs.access_token_from_request_token        
           @stdout.puts "The application is now authorized. You won't have to do this again the next time you run the application."
           @config_store.update(Tagcrumbs.options.slice(:access_token, :access_secret))
         else

data/lib/tagcrumbs/config_store.rb

@@ -1,5 +1,5 @@
 module Tagcrumbs
-  # Use the ConfigStore to save configuration options to a yaml file (tokens)
+  # Use the ConfigStore to save configuration options to a yaml file
   class ConfigStore
     attr_accessor :filename, :options
 
@@ -22,8 +22,8 @@ module Tagcrumbs
     end
     
     # Save the current options into the file in YAML format
-    def save
-      File.open(filename, 'w') { |f| f.write(YAML.dump(@options)) }
+    def save(file = filename)
+      File.open(file, 'w') { |f| f.write(YAML.dump(@options.stringify_keys)) }
       self
     end
   end

data/lib/tagcrumbs/core_extensions.rb

@@ -0,0 +1,19 @@
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # uncompress the body if compression was used
+  def plain_body
+    encoding = self['content-encoding']
+
+    case encoding
+      when 'gzip'
+        Zlib::GzipReader.new(StringIO.new(self.body)).read
+      when 'deflate'
+        Zlib::Inflate.new.inflate(self.body)
+      else
+        raise "Unknown encoding - #{encoding}" if encoding.present?
+        self.body
+    end
+  end
+end

data/lib/tagcrumbs/parsers/json_parser.rb

@@ -5,9 +5,13 @@ module Tagcrumbs
     
     def initialize(parser_or_document)
       if parser_or_document.is_a?(String)
-        tmp = JSON.parse(parser_or_document)
-        self._name = tmp.keys.first
-        self.document = tmp[self._name]
+        begin
+          tmp = JSON.parse(parser_or_document)
+          self._name = tmp.keys.first
+          self.document = tmp[self._name]
+        rescue JSON::ParserError # just a string (lowest level node in array)
+          self.document = {'$' => parser_or_document }
+        end
       elsif(parser_or_document.is_a?(Tagcrumbs::JsonParser))
         self.document = parser_or_document.document
       else

data/lib/tagcrumbs/proxy.rb

@@ -8,8 +8,9 @@ module Tagcrumbs
 
     instance_methods.each { |m| undef_method m unless m =~ /^__/ } # http://onestepback.org/index.cgi/Tech/Ruby/BlankSlate.rdoc
 
-    def initialize(object)
+    def initialize(object, parameters={})
       @object = object
+      @parameters = parameters
     end
     
     
@@ -17,11 +18,13 @@ module Tagcrumbs
     def method_missing(method_name, *args, &block)
       #puts "** Proxying #{method_name}. Loaded: #{@object.loaded?}"
       
-      if @object.loaded? || UNPROXIED_METHODS.include?(method_name) #|| !@object.respond_to?(method_name) # having this doesn't allow first etc on arrays
+      if @object.loaded? || UNPROXIED_METHODS.include?(method_name) #|| !@object.respond_to?(method_name) # having this doesn't allow first etc on collections
         @object.send(method_name, *args, &block)
+      elsif method_name == :total_entries && @object.respond_to?(method_name) && @object.total_entries.present? # let total_entries go through if present
+        @object.total_entries
       else 
         #puts "** Reloading"
-        @object.reload if @object.resource_url.present?
+        @object.reload(nil, @parameters) if @object.resource_url.present?
         @object.send(method_name, *args, &block)
       end
       

data/lib/tagcrumbs/requestor.rb

@@ -48,6 +48,17 @@ module Tagcrumbs
 	      nil
       end
   	end
+  	
+  	# Don't do a token dance, use the Credentials to OAuth Proxy
+  	# Only works after requesting permission from Tagcrumbs
+  	# This makes developing clients for mobile devices etc. easier
+  	def access_token_from_credentials(username, password)
+  	  url = path_with_query_string(options[:consumer_options][:access_token_from_credentials_path], :username => username, :password => password)
+  	  
+  	  response = consumer.token_request(:post, url, nil, {}, '', {}) # send a regular post request, no json or xml, makes it easier to parse
+  	  OAuth::AccessToken.from_hash(consumer, response)
+  	end
+
     
     # ========
     # = HTTP =
@@ -62,8 +73,8 @@ module Tagcrumbs
   	  
   	  if access_token # 3-legged request with access token
   	    response = self.access_token.request(http_method, url, *arguments)
-      elsif http_method == :get && consumer # 2-legged consumer only request
-        response = self.consumer.request(:get, url, nil, {}, *arguments)        
+      elsif consumer # 2-legged consumer only request
+        response = self.consumer.request(http_method, url, nil, {}, *arguments)        
       else
         raise InvalidRequest.new("Setup the Access Token first or only make get requests with a valid consumer.")
       end
@@ -102,6 +113,7 @@ module Tagcrumbs
       
       :xml 
     end
+    
   	
   	private
   	  # Build a URL from a path and a hash of query string parameters
@@ -124,17 +136,22 @@ module Tagcrumbs
   	    end
     	end
   	  
-  	  # Set the Content-Type and Accept HTTP Headers to the correct values depending on format
+  	  # Set the Content-Type and Accept HTTP Headers to the correct values depending on format.
+  	  # Add Accept-Encoding if compression is enabled.
     	def default_headers(format = nil)
     	  format ||= self.options[:format]
         
         raise UnsupportedFormat unless Tagcrumbs.supported_formats[format]
       	  
-    	  {
+    	  hash = {
     	    "Content-Type" => Tagcrumbs.supported_formats[format].first,
     	    "Accept" => Tagcrumbs.supported_formats[format].join(', ')
     	  }
+    	  
+    	  hash.merge!("Accept-Encoding" => 'gzip, deflate') if options[:compression]
+    	  
+    	  hash
     	end
-    
+    	
   end
 end

data/lib/tagcrumbs/resources/{array.rb → collection.rb}

@@ -1,7 +1,7 @@
 module Tagcrumbs
   # Basically a regular Array that holds many Resources.
   # Used to get collections from the webservice.
-  class Array < Resource
+  class Collection < Resource
     ATTRIBUTES = [:total_entries, :pages, :per_page, :page, :sort, :order, :next_page, :previous_page]
     
     attr_accessor :array
@@ -32,12 +32,12 @@ module Tagcrumbs
       true
     end
     
-    # Replace the Array with the next page of elements if there is one
+    # Replace the Collection with the next page of elements if there is one
     def next_page!
       reload(next_page) if next_page.present?
     end
     
-    # Replace the Array with the privious page of elements if there is one
+    # Replace the Collection with the privious page of elements if there is one
     def previous_page!
       reload(previous_page) if previous_page.present?
     end
@@ -51,8 +51,8 @@ module Tagcrumbs
     
     # Iterate over all items with pagination
     def each_page_each_item(args={})
-      self.each_page(args) do |array|
-        array.each do |item|
+      self.each_page(args) do |collection|
+        collection.each do |item|
           yield item
         end
       end
@@ -84,15 +84,16 @@ module Tagcrumbs
     # Load data into the object from a document
     def initialize_from_document(parser, format = Tagcrumbs.options[:format])
       parser = super
-                  
+
       if self.loaded?
         nodes = parser.nodes_with_name(parser.name.singularize)
         return if nodes.blank?
         
+        
         nodes.each do |node|
           node_parser = Parser.new_for_format(node, parser.format)
           node_type = node_parser.get_attribute('type')
-          
+
           if node_type # a nested model
             @array << Tagcrumbs.class_by_type(node_type).new_from_document(node, parser.format)
           else # a nested node

data/lib/tagcrumbs/resources/models/access_token.rb

@@ -0,0 +1,8 @@
+module Tagcrumbs
+  # Access Tokens can be received when a new User is created with the web service.
+  # Special access must be granted for this from Tagcrumbs.
+  class AccessToken < Model
+    readable_attributes :token, :secret
+    
+  end
+end

data/lib/tagcrumbs/resources/models/accessors.rb

@@ -39,7 +39,7 @@ module Tagcrumbs
       @has_one_associations_updates ||= {}
     end
     
-    # has_many_associations contains Arrays of further objects
+    # has_many_associations contains Collection of further objects
     def has_many_associations
       @has_many_associations ||= {}
     end
@@ -115,6 +115,20 @@ module Tagcrumbs
       self.class.can_be_options.include?(method.to_sym)
     end    
 
+    def valid?
+      errors.empty?
+    end
+
+    # Returns the Errors object that holds all information about attribute error messages.
+    def errors
+      @errors ||= []
+    end
+    
+    def errors_from_document(body, format)
+      @errors = Tagcrumbs::Collection.new_from_document(body, format)
+    end
+    
+
     
     module ClassMethods 
       # Configure if objects of this class can be :created, :updated or :destroyed
@@ -216,11 +230,11 @@ module Tagcrumbs
 
         self.has_many_associations_options[name] = options
 
-        define_method name do # define a reader that loads the association if not done already
+        define_method name do |*parameters| # define a reader that loads the association if not done already
           if !has_many_associations.has_key?(name)
             nil
           else
-            Proxy.new(has_many_associations[name]) # use a proxy to load objects as late as possible
+            Proxy.new(has_many_associations[name], *parameters) # use a proxy to load objects as late as possible
           end
         end
         

data/lib/tagcrumbs/resources/models/activity.rb

@@ -14,6 +14,7 @@ module Tagcrumbs
     has_one :user
     has_one :subject
     has_one :secondary_subject
+    has_one :application
     
   end
 end

data/lib/tagcrumbs/resources/models/application.rb

@@ -0,0 +1,9 @@
+module Tagcrumbs
+  # An Application represents the program that was used to create something in the Tagcrumbs API.
+  # It is currently available for Comments, Placemarks, Favorites and Activities.
+  # If no Application is set the object was created on the Tagcrumbs website.
+  class Application < Model    
+    readable_attributes :name, :url
+        
+  end
+end

data/lib/tagcrumbs/resources/models/comment.rb

@@ -8,5 +8,7 @@ module Tagcrumbs
     writeable_attributes :text
     
     has_one :tagcrumb, :modifiable => true
+    has_one :application
+    
   end
 end

data/lib/tagcrumbs/resources/models/email_recommendation.rb

@@ -0,0 +1,17 @@
+module Tagcrumbs
+  # A Recommendation of a Placemark between two Users
+  class EmailRecommendation < Model
+    can_be :created, :destroyed
+    
+    readable_attributes :created_at, :updated_at
+    writeable_attributes :recipient_email, :message
+    
+    has_one :user
+    has_one :tagcrumb, :modifiable => true
+    
+    
+    def create_url
+      Tagcrumbs.current_user.recommendations_url # has to be overwritten
+    end
+  end
+end

data/lib/tagcrumbs/resources/models/favorite.rb

@@ -10,7 +10,8 @@ module Tagcrumbs
     readable_attributes   :created_at, :updated_at
     
     has_one :user
-     
+    has_one :application
+    
     has_one :tagcrumb, :modifiable => true
     
     # Find favorites and pass in additional filter options. The options are documented in Tagcrumb.

data/lib/tagcrumbs/resources/models/filter.rb

@@ -17,8 +17,8 @@ module Tagcrumbs
   class Filter < Model
     can_be :created, :updated, :destroyed
     
-    readable_attributes  :created_at, :updated_at, :permalink
-    writeable_attributes :name, :private, :tagcrumb_type, :tag_list, :middle_of_nowhere, :from, :within, :since, :until
+    readable_attributes  :created_at, :updated_at
+    writeable_attributes :name, :private, :tagcrumb_type, :tag_list, :middle_of_nowhere, :from, :range, :since, :until
     
     has_one :user
     

data/lib/tagcrumbs/resources/models/flag.rb

@@ -6,5 +6,8 @@ module Tagcrumbs
     
     writeable_attributes :reason
     
+    has_one :tagcrumb, :modifiable => true
+    has_one :user
+    
   end
 end

data/lib/tagcrumbs/resources/models/model.rb

@@ -3,7 +3,7 @@ module Tagcrumbs
   
   class Model < Resource
     include Tagcrumbs::Accessors
-    include Validations
+#    include Validations
     
     attr_accessor :new_record
     
@@ -19,7 +19,7 @@ module Tagcrumbs
       super
       self.new_record = true
       @nodes = @nodes_updates = {}
-      @errors = Errors.new(self) # reset errors from server
+      @errors = [] # reset errors from server
       restore!
       
       true
@@ -104,7 +104,7 @@ module Tagcrumbs
         
         self.class.has_one_associations_options.keys.each do |name| # load all has_one associations
           has_one_element = parser.get_node(self.class.has_one_associations_options[name][:node_name])
-
+                    
           if has_one_element
             has_one_parser = Parser.new_for_format(has_one_element, parser.format)
             
@@ -116,7 +116,7 @@ module Tagcrumbs
           has_many_element = parser.get_node(self.class.has_many_associations_options[name][:node_name])  
         
           if has_many_element
-            self.has_many_associations[name] = Tagcrumbs::Array.new_from_document(has_many_element, parser.format)
+            self.has_many_associations[name] = Tagcrumbs::Collection.new_from_document(has_many_element, parser.format)
           end
         end    
       end
@@ -135,11 +135,12 @@ module Tagcrumbs
     private
       # Handle the response after a create or update and set the errors if needed.
       def handle_save_response
-        if requestor.response.code == '422'
-          errors.from_format(requestor.response.body, requestor.response_format)
+        if requestor.response.code == '422'          
+          self.errors_from_document(requestor.response.plain_body, requestor.response_format)
+          
           false
         else
-          initialize_from_document(requestor.response.body)
+          initialize_from_document(requestor.response.plain_body)
           true
         end
       end

data/lib/tagcrumbs/resources/models/paragraph.rb

@@ -0,0 +1,8 @@
+module Tagcrumbs
+  # Used to represent the Tagcrumbs Terms and Conditions and the Privacy Policy
+  class Paragraph < Model
+    readable_attributes :heading
+    
+    has_many :subparagraphs
+  end
+end

data/lib/tagcrumbs/resources/models/picture.rb

@@ -6,17 +6,17 @@ module Tagcrumbs
   class Picture < Model
     can_be :updated, :destroyed
     
-    writeable_attributes :picture_file
-    readable_attributes :url, :small_thumbnail_url, :medium_thumbnail_url, :content_type, :created_at, :updated_at
+    writeable_attributes :file
+    readable_attributes :large_thumbnail_url, :small_thumbnail_url, :medium_thumbnail_url, :content_type, :created_at, :updated_at
     
-    has_one :profile
+    has_one :user
     
     # Load a file from the local filesystem and set the attributes.
     # Save the object to upload a new profile picture to the server.
     def get_file(filename)
       return if filename.blank?
       
-      self.picture_file = {
+      self.file = {
         :filename => File.basename(filename),
         :mime_type => MIME::Types.type_for(filename).first.content_type,
         :content => Base64.encode64(File.read(filename))

data/lib/tagcrumbs/resources/models/place.rb

@@ -1,17 +1,17 @@
 module Tagcrumbs
   # The superclass for City, State and Country
-  # All of them contain a name and a permalink.
+  # All of them have a name
   # The name is automatically translated into the locale that was set by the user 
   # in the settings.
   class Place < Model
-    readable_attributes :name, :permalink
+    readable_attributes :name
     
     has_one :geoname
     
     def self.search(q, args={})
       args.assert_valid_keys(:page, :per_page, :for)
       
-      Array.load(Tagcrumbs.root.place_search_url, args.merge(:q => q))
+      Collection.load(Tagcrumbs.root.place_search_url, args.merge(:q => q))
     end
   end
 end

data/lib/tagcrumbs/resources/models/placemark.rb

@@ -6,15 +6,16 @@ module Tagcrumbs
     
         
     writeable_attributes   :name, :notes, :private, :latitude, :longitude, :tag_list, :guess_city, :address_attributes
-    readable_attributes   :created_at, :updated_at, :short_url, :permalink, :favorites_count
+    readable_attributes   :created_at, :updated_at, :short_url, :favorites_count
     
     has_one :user
     has_one :city, :modifiable => true
     has_one :address
+    has_one :application
+    has_one :tagcrumb # only if favorite of current user
     
     has_many :links
     has_many :comments
-    has_many :recommendations
     
     # Find Placemarks by specifying find criteria.
     def self.find(args={})