rosemary 0.3.4 → 0.3.5

data/README.md

@@ -41,26 +41,37 @@ OK, gimme some code:
     node = api.find_node(123)
      => #<Rosemary::Node:0x1019268d0 @changeset=7836598, @timestamp=Mon Apr 11 19:40:43 UTC 2011, @user="Turleder'n", @tags={}, @uid=289426, @version=4, @lat=59.9502252, @id=123, @lon=10.7899133>
 
+## Testing your code
+
+You should try your code on the OSM testing server first! You can change the url like this:
+
+    require 'rosemary'
+    Rosemary::Api.base_uri 'http://api06.dev.openstreetmap.org/'
+    api = Rosemary::Api.new
+    api.find_node(123)
+
 Modification of data is supported too. According to the OSM license every modification to the data has to be done by a registered OSM user account. The user can be authenticated with username and password. But see yourself:
 
     client = Rosemary::BasicAuthClient.new('osm_user_name', 'password')
+
     api = Rosemary::Api.new(client)
+    changeset = api.create_changeset("Some meaningful comment")
     node = Rosemary::Node.new(:lat => 52.0, :lon => 13.4)
-    api.save(node)
+    api.save(node, changeset)
+    api.close_changeset(changeset)
 
-Yeah, i can hear you sayin: 'Seriously, do i have to provide username and password? Is that secure?' Providing username and password is prone to some security issues, especially because the OSM API does not provide an SSL service. But wait, there is some more in store for you: [OAuth](http://oauth.net/) It's much more secure for the user and your OSM app. But it comes with a price: You have to register an application on http://www.openstreetmap.org. After you have your app registered you get an app key and secret. Keep it in a save place.
+Yeah, i can hear you sayin: 'Seriously, do i have to provide username and password? Is that secure?' Providing username and password is prone to some security issues, especially because the OSM API does not provide an SSL service. But wait, there is some more in store for you: [OAuth](http://oauth.net/) It's much more secure for the user and your OSM app. But it comes with a price: You have to register an application on http://www.openstreetmap.org. After you have your app registered you get an app key and secret. Keep it in a safe place.
 
     consumer = OAuth::Consumer.new( 'osm_app_key', 'osm_app_secret',
-                                    { :site => 'http://www.openstreetmap.org',
-                                      :request_token_path => '/oauth/request_token',
-                                      :access_token_path => '/oauth/access_token',
-                                      :authorize_path => '/oauth/authorize'
-                                    })
+                                    :site => 'http://www.openstreetmap.org')
     access_token = OAuth::AccessToken.new(consumer, 'osm_user_token', 'osm_user_key')
     client = Rosemary::OauthClient.new(access_token)
+
     api = Rosemary::Api.new(client)
+    changeset = api.create_changeset("Some meaningful comment")
     node = Rosemary::Node.new(:lat => 52.0, :lon => 13.4)
-    api.save(node)
+    api.save(node, changeset)
+    api.close_changeset(changeset)
 
 Every request to the API is now handled by the OauthClient.
 

data/Rakefile

@@ -19,5 +19,11 @@ task :c => :console
 
 task :default => :spec
 
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb'] # optional
+  # t.options = ['--any', '--extra', '--opts'] # optional
+end
+
 require "bundler/gem_tasks"
 

data/lib/hash.rb

@@ -1,5 +1,7 @@
+# Standard ruby hash class extended with some additional behaviour.
 class Hash
 
+  # symbolize_keys
   define_method(:symbolize_keys!) do
     self.each do |k,v|
       self[k.to_sym] = v
@@ -7,6 +9,7 @@ class Hash
     end
   end unless method_defined? :symbolize_keys!
 
+  # stringify_keys
   define_method(:stringify_keys!) do
     temp_hash = {}
     self.each do |k,v|

data/lib/rosemary.rb

@@ -10,7 +10,9 @@ require 'rosemary/changeset'
 require 'rosemary/relation'
 require 'rosemary/member'
 require 'rosemary/user'
+require 'rosemary/permissions'
 require 'rosemary/errors'
+require 'rosemary/client'
 require 'rosemary/basic_auth_client'
 require 'rosemary/oauth_client'
 require 'rosemary/parser'

data/lib/rosemary/api.rb

@@ -9,38 +9,51 @@ module Rosemary
   #   api = Rosemary::Api.new(auth_client)
   #   @node = api.find_node(1234)
   #   @node.tags << {:wheelchair => 'no'}
-  #   api.save(@node)
+  #   @changeset = api.create_changeset('Set the wheelchair tag')
+  #   api.save(@node, @changeset)
   class Api
+    # Provide basic HTTP client behaviour.
     include HTTParty
+
+    # The OSM API version supported by this gem.
     API_VERSION = "0.6".freeze
 
     # the default base URI for the API
     base_uri "http://www.openstreetmap.org"
     #base_uri "http://api06.dev.openstreetmap.org/api/#{API_VERSION}"
 
+    # Make sure the request don't run forever
     default_timeout 5
 
+    # Use a custom parser to handle the OSM XML format.
     parser Parser
 
+
+    # @return [Rosemary::Client] the client to be used to authenticate the user towards the OSM API.
     attr_accessor :client
 
+    # @return [Rosemary::Changeset] the current changeset to be used for all writing acces.
     attr_accessor :changeset
 
+    # Creates an Rosemary::Api object with an optional client
+    # @param [Rosemary::Client] client the client to authenticate the user for write access.
     def initialize(client=nil)
       @client = client
     end
 
     # Get a Node with specified ID from API.
     #
-    # call-seq: find_node(id) -> Rosemary::Node
-    #
+    # @param [Fixnum] id the id of the node to find.
+    # @return [Rosemary::Node] the node with the given id.
+    # @raise [Rosemary::Gone] in case the node has been deleted.
     def find_node(id)
       find_element('node', id)
     end
 
     # Get a Way with specified ID from API.
     #
-    # call-seq: find_way(id) -> Rosemary::Way
+    # @param [Fixnum] id the id of the node to find.
+    # @return [Rosemary::Way] the way with the given id.
     #
     def find_way(id)
       find_element('way', id)
@@ -54,14 +67,6 @@ module Rosemary
       find_element('relation', id)
     end
 
-    # Get a Changeset with specified ID from API.
-    #
-    # call-seq: find_changeset(id) -> Rosemary::Changeset
-    #
-    def find_changeset(id)
-      find_element('changeset', id)
-    end
-
     # Get a Changeset with specified ID from API
     # if that changeset is missing, id is nil, or the changeset is closed
     # create a new one
@@ -79,7 +84,7 @@ module Rosemary
 
     # Get the user which represented by the Rosemary::Client
     #
-    # call-seq: find_user -> Rosemary::User
+    # @return: [Rosemary::User] user the user authenticated using the current client
     #
     def find_user
       raise CredentialsMissing if client.nil?
@@ -88,15 +93,29 @@ module Rosemary
       resp
     end
 
-    # Delete an element
+    def permissions
+      if client.nil?
+        get("/permissions")
+      else
+        do_authenticated_request(:get, "/permissions")
+      end
+    end
+
+    # Deletes the given element using API write access.
+    #
+    # @param [Rosemary::Element] element the element to be created
+    # @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.
+    # @return [Fixnum] the new version of the deleted element.
     def destroy(element, changeset)
       element.changeset = changeset.id
       response = delete("/#{element.type.downcase}/#{element.id}", :body => element.to_xml) unless element.id.nil?
       response.to_i # New version number
     end
 
-    # Saves an element to the API.
-    # If it has no id yet, the element will be created, otherwise updated.
+    # Creates or updates an element depending on the current state of persistance.
+    #
+    # @param [Rosemary::Element] element the element to be created
+    # @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.
     def save(element, changeset)
       response = if element.id.nil?
         create(element, changeset)
@@ -105,23 +124,49 @@ module Rosemary
       end
     end
 
+    # Create a new element using API write access.
+    #
+    # @param [Rosemary::Element] element the element to be created
+    # @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.
+    # @return [Fixnum] the id of the newly created element.
     def create(element, changeset)
       element.changeset = changeset.id
       put("/#{element.type.downcase}/create", :body => element.to_xml)
     end
 
+    # Update an existing element using API write access.
+    #
+    # @param [Rosemary::Element] element the element to be created
+    # @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.
+    # @return [Fixnum] the versiom of the updated element.
     def update(element, changeset)
       element.changeset = changeset.id
       response = put("/#{element.type.downcase}/#{element.id}", :body => element.to_xml)
       response.to_i # New Version number
     end
 
+    # Create a new changeset with an optional comment
+    #
+    # @param [String] comment a meaningful comment for this changeset
+    # @return [Rosemary::Changeset] the changeset which was newly created
+    # @raise [Rosemary::NotFound] in case the changeset could not be found
     def create_changeset(comment = nil)
       changeset = Changeset.new(:tags => { :comment => comment })
       changeset_id = put("/changeset/create", :body => changeset.to_xml).to_i
       find_changeset(changeset_id) unless changeset_id == 0
     end
 
+    # Get a Changeset with specified ID from API.
+    #
+    # @param [Integer] id the ID for the changeset you look for
+    # @return [Rosemary::Changeset] the changeset which was found with the id
+    def find_changeset(id)
+      find_element('changeset', id)
+    end
+
+    # Closes the given changeset.
+    #
+    # @param [Rosemary::Changeset] changeset the changeset to be closed
     def close_changeset(changeset)
       put("/changeset/#{changeset.id}/close")
     end

data/lib/rosemary/basic_auth_client.rb

@@ -1,15 +1,24 @@
-class Rosemary::BasicAuthClient
-  attr_reader :username, :password
+class Rosemary::BasicAuthClient < Rosemary::Client
+
+  # The username to be used to authenticate the user against the OMS API
+  attr_reader :username
+
+  # The password to be used to authenticate the user against the OMS API
+  attr_reader :password
 
   def initialize(username, password)
     @username = username
     @password = password
   end
 
+  # The username and password credentials as a Hash
+  # @return [Hash] the credential hash.
   def credentials
     {:username => username, :password => password}
   end
 
+  # Override inspect message to keep the password from showing up
+  # in any logfile.
   def inspect
     "#<#{self.class.name}:#{self.object_id} @username='#{username}'>"
   end

data/lib/rosemary/changeset.rb

@@ -3,30 +3,33 @@ module Rosemary
   # Changeset is used in OpenStreetMap to bundle several changes into a kind of "commit"
   class Changeset
     # Unique ID
+    # @return [Fixnum]
     attr_reader :id
 
-    # The user who last edited this object (as read from file, it
-    # is not updated by operations to this object)
+    # The user who last edited this object (as read from file, it is not updated by operations to this object)
+    # @return [Rosemary::User] the user who last edited this object
     attr_accessor :user
 
-    # The user id of the user who last edited this object (as read from file, it
-    # is not updated by operations to this object)
-    # API 0.6 and above only
+    # The user id of the user who last edited this object(as read from file, it
+    # is not updated by operations to this object) API 0.6 and above only
+    # @return [Fixnum] the user id of the user who last edited this object
     attr_accessor :uid
 
-    # True if this changeset is still open.
+    # @return [Boolean] is this changeset is still open.
     attr_accessor :open
 
-    # Creation date of this changeset
+    # @return [Date] creation date of this changeset
     attr_accessor :created_at
 
-    # When the changeset was closed
+    # @return [Date] when the changeset was closed
     attr_accessor :closed_at
 
     # Bounding box surrounding all changes made in this changeset
+    # @return [Float]
     attr_accessor :min_lat, :min_lon, :max_lat, :max_lon
 
     # Tags for this object
+    # @return [Hash]
     attr_reader :tags
 
     def initialize(attrs = {}) #:nodoc:
@@ -39,7 +42,7 @@ module Rosemary
       @open               = attrs['open']
       tags = attrs['tags'] || {}
       @tags               = Tags.new.merge(tags.dup.stringify_keys!)
-      @tags['created_by'] = 'osm for ruby'
+      @tags['created_by'] = "rosemary v#{Rosemary::VERSION}"
       @min_lat            = attrs['min_lat'].to_f
       @min_lon            = attrs['min_lon'].to_f
       @max_lat            = attrs['max_lat'].to_f
@@ -58,17 +61,17 @@ module Rosemary
     end
 
     # List of attributes for a Changeset
+    # @return [Array]
     def attribute_list
       [:id, :user, :uid, :open, :created_at, :closed_at, :min_lat, :max_lat, :min_lon, :max_lon]
     end
 
-    # Returns a hash of all non-nil attributes of this object.
-    #
+    # A hash of all non-nil attributes of this object.
     # Keys of this hash are <tt>:id</tt>, <tt>:user</tt>,
     # and <tt>:timestamp</tt>. For a Node also <tt>:lon</tt>
     # and <tt>:lat</tt>.
     #
-    # call-seq: attributes -> Hash
+    # @return [Hash] a hash of all non-nil attributes of this object.
     #
     def attributes
       attrs = Hash.new
@@ -79,6 +82,8 @@ module Rosemary
       attrs
     end
 
+    # Renders the object as an xml representation compatible to the OSM API
+    # @return [String] XML
     def to_xml(options = {})
       xml = options[:builder] ||= Builder::XmlMarkup.new
       xml.instruct! unless options[:skip_instruct]

data/lib/rosemary/client.rb

@@ -0,0 +1,3 @@
+# Superclass for all clients used to authenticate the user toward the OSM API.
+class Rosemary::Client
+end

data/lib/rosemary/element.rb

@@ -4,15 +4,18 @@ module Rosemary
     include ActiveModel::Validations
 
     # Unique ID
+    # @return [Fixnum] id of this element
     attr_reader :id
 
     # The version of this object (as read from file, it
     # is not updated by operations to this object)
     # API 0.6 and above only
+    # @return [Fixnum] the current version
     attr_accessor :version
 
-    # The user who last edited this object (as read from file, it
+    # The user who last edited this element (as read from file, it
     # is not updated by operations to this object)
+    # @return [Rosemary::User] the user who last edititd this element
     attr_accessor :user
 
     # The user id of the user who last edited this object (as read from file, it
@@ -22,6 +25,7 @@ module Rosemary
 
     # Last change of this object (as read from file, it is not
     # updated by operations to this object)
+    # @return [Time] last change of this object.
     attr_reader :timestamp
 
     # The changeset the last change of this object was made with.
@@ -31,6 +35,8 @@ module Rosemary
     attr_reader :tags
 
     # Get Rosemary::Element from API
+    # @param [Fixnum] id the id of the element to load from the API
+
     def self.from_api(id, api=Rosemary::API.new) #:nodoc:
         raise NotImplementedError.new('Element is a virtual base class for the Node, Way, and Relation classes') if self.class == Rosemary::Element
         api.get_object(type, id)
@@ -56,6 +62,7 @@ module Rosemary
     end
 
     # Set timestamp for this object.
+    # @param [Time] timestamp the time this object was created
     def timestamp=(timestamp)
       @timestamp = _check_timestamp(timestamp)
     end
@@ -132,7 +139,7 @@ module Rosemary
 
     # Has this object any tags?
     #
-    # call-seq: is_tagged?
+    # @return [Boolean] has any tags?
     #
     def is_tagged?
       ! @tags.empty?
@@ -228,6 +235,10 @@ module Rosemary
       @tags = from.tags.dup
     end
 
+    def self.from_xml(xml)
+      Parser.call(xml, :xml)
+    end
+
     private
 
     # Return next free ID

data/lib/rosemary/errors.rb

@@ -9,6 +9,9 @@ module Rosemary
     end
   end
 
+  # This error occurs when the request send to the server could not be parsed.
+  class ParseError < StandardError; end
+
   # This error occurs when Rosemary is instantiated without a client
   class CredentialsMissing < StandardError; end
 
@@ -22,6 +25,7 @@ module Rosemary
   # password for a write operation.
   class Unauthorized < Error; end # 401
 
+  # You don't have sufficient permissions to make that request.
   class Forbidden < Error; end # 403
 
   # The object was not found (HTTP 404). Generally means that the object doesn't exist
@@ -47,8 +51,10 @@ module Rosemary
   # Unspecified API server error.
   class ServerError < Error; end # 500
 
+  # When the API service times out or returns an HTTP 503 status.
   class Unavailable < Error; end # 503
 
-  class NotImplemented < Error; end # This method is not implemented yet.
+  # This method is not implemented yet.
+  class NotImplemented < Error; end
 
 end

data/lib/rosemary/node.rb

@@ -28,6 +28,7 @@ module Rosemary
       super(attrs)
     end
 
+
     def type
       'Node'
     end

data/lib/rosemary/oauth_client.rb

@@ -1,31 +1,50 @@
-module Rosemary
-  class OauthClient
+class Rosemary::OauthClient < Rosemary::Client
 
-    attr_reader :access_token
+  # The access token to be used for all write access
+  # @return [OAuth::AccessToken]
+  attr_reader :access_token
 
-    def initialize(access_token)
-      @access_token = access_token
-    end
-
-    def get(url, header={})
-      access_token.get(url, {'Content-Type' => 'application/xml' })
-    end
+  # @param [OAuth::AccessToken] access_token the access token to be used for write access.
+  def initialize(access_token)
+    @access_token = access_token
+  end
 
-    def put(url, options={}, header={})
-      body = options[:body]
-      access_token.put(url, body, {'Content-Type' => 'application/xml' })
-    end
+  # Execute a signed OAuth GET request.
+  # @param [String] url the url to be requested
+  # @param [Hash] header optional header attributes
+  def get(url, header={})
+    access_token.get(url, {'Content-Type' => 'application/xml' })
+  end
 
-    def delete(url, options={}, header={})
-      raise NotImplemented.new("Delete with Oauth and OSM is not supported")
-      # body = options[:body]
-      # access_token.delete(url, {'Content-Type' => 'application/xml' })
-    end
+  # Execute a signed OAuth PUT request.
+  # @param [String] url the url to be requested
+  # @param [Hash] options optional option attributes
+  # @param [Hash] header optional header attributes
+  def put(url, options={}, header={})
+    body = options[:body]
+    access_token.put(url, body, {'Content-Type' => 'application/xml' })
+  end
 
-    def post(url, options={}, header={})
-      body = options[:body]
-      access_token.post(url, body, {'Content-Type' => 'application/xml' })
-    end
+  # Execute a signed OAuth DELETE request.
+  #
+  # Unfortunately the OSM API requires to send an XML
+  # representation of the Element to be delete in the body
+  # of the request. The OAuth library does not support sending
+  # any information in the request body.
+  # If you know a workaround please fork and improve.
+  def delete(url, options={}, header={})
+    raise NotImplemented.new("Delete with Oauth and OSM is not supported")
+    # body = options[:body]
+    # access_token.delete(url, {'Content-Type' => 'application/xml' })
+  end
 
+  # Execute a signed OAuth POST request.
+  # @param [String] url the url to be requested
+  # @param [Hash] options optional option attributes
+  # @param [Hash] header optional header attributes
+  def post(url, options={}, header={})
+    body = options[:body]
+    access_token.post(url, body, {'Content-Type' => 'application/xml' })
   end
+
 end

data/lib/rosemary/parser.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 require 'xml/libxml'
 
+# The XML parser capable of understanding the custom OSM XML format.
 class Rosemary::Parser < HTTParty::Parser
   include LibXML::XML::SaxParser::Callbacks
 
@@ -53,6 +54,8 @@ class Rosemary::Parser < HTTParty::Parser
     when 'member'       then _member(attr_hash)
     when 'home'         then _home(attr_hash)
     when 'description'  then @description = true
+    when 'permissions'   then _start_permissions(attr_hash)
+    when 'permission'   then _start_permission(attr_hash)
     when 'lang'         then @lang        = true
     end
   end
@@ -77,7 +80,6 @@ class Rosemary::Parser < HTTParty::Parser
   end
 
   private
-
   def _start_node(attr_hash)
     @context = Rosemary::Node.new(attr_hash)
   end
@@ -94,6 +96,16 @@ class Rosemary::Parser < HTTParty::Parser
     @context = Rosemary::Changeset.new(attr_hash)
   end
 
+  def _start_permissions(_)
+    # just a few sanity checks: we can only parse permissions as a top level elem
+    raise ParseError, "Unexpected <permissions> element" unless @context.nil?
+    @context = Rosemary::Permissions.new
+  end
+
+  def _start_permission(attr_hash)
+    @context << attr_hash['name']
+  end
+
   def _end_changeset
     @collection << @context
   end

data/lib/rosemary/permissions.rb

@@ -0,0 +1,19 @@
+# The permissions granted to the API user.
+class Rosemary::Permissions
+  include Enumerable
+
+  attr_reader :raw
+
+  def initialize
+    @raw = []
+  end
+
+  # make sure we can add permissions and are "Enumerable" via delegation to the permissions array
+  delegate :<<, :each, :to => :raw
+
+  # some convenience helpers for permissions we already know:
+  %w(allow_read_prefs allow_write_prefs allow_write_diary
+     allow_write_api allow_read_gpx allow_write_gpx).each do |name|
+    define_method("#{name}?") { raw.include?(name) }
+  end
+end

data/lib/rosemary/tags.rb

@@ -16,7 +16,7 @@ module Rosemary
 
     # Return string with comma separated key=value pairs.
     #
-    # call-seq: to_s -> String
+    # @return [String] string representation
     #
     def to_s
       sort.collect{ |k, v| "#{k}=#{v}" }.join(', ')

data/lib/rosemary/user.rb

@@ -1,5 +1,6 @@
 require 'builder'
 module Rosemary
+  # The user object representing a registered OSM user.
   class User
     # Unique ID
     attr_reader :id

data/lib/rosemary/version.rb

@@ -1,3 +1,4 @@
 module Rosemary
-  VERSION = "0.3.4"
+  # The current version of this gem.
+  VERSION = "0.3.5"
 end

data/lib/rosemary/way.rb

@@ -9,6 +9,7 @@ module Rosemary
   #
   class Way < Element
     # Array of node IDs in this way.
+    # @return [Array]
     attr_reader :nodes
 
     # Create new Way object.
@@ -38,7 +39,7 @@ module Rosemary
     #
     # Returns the way to allow chaining.
     #
-    # call-seq: way << something -> Way
+    # @return [Rosemary::Way] the way itself
     #
     def <<(stuff)
       case stuff
@@ -64,6 +65,9 @@ module Rosemary
       [:id, :version, :uid, :user, :timestamp, :changeset]
     end
 
+    # Instantiate a way from an XML representation.
+    # @param [String] xml_string the xml representing a way.
+    # @return [Rosemary::Way] the way represented by the given XML string.
     def self.from_xml(xml_string)
       Parser.call(xml_string, :xml)
     end

data/rosemary.gemspec

@@ -37,6 +37,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<libxml-ruby>, [">= 0"])
@@ -45,6 +47,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activemodel>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
@@ -54,5 +58,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activemodel>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
   end
 end

data/spec/models/node_spec.rb

@@ -95,4 +95,9 @@ describe Node do
     subject.add_tags(:wheelchair => '')
     subject.to_xml.should_not match /k=\"wheelchair\"/
   end
+
+  it "should properly escape ampersands" do
+    subject.name = "foo & bar"
+    subject.to_xml.should match "foo & bar"
+  end
 end

data/spec/models/parser_spec.rb

@@ -20,5 +20,36 @@ describe Parser do
 
 
     end
+
+    it "parses empty set of permissions" do
+      permissions_xml =<<-EOF
+      <osm version="0.6" generator="OpenStreetMap Server">
+        <permissions>
+        </permissions>
+      </osm>
+      EOF
+
+      permissions = Parser.call(permissions_xml, :xml)
+      permissions.raw.should be_empty
+    end
+
+    it "parses permissions" do
+      permissions_xml =<<-EOF
+      <osm version="0.6" generator="OpenStreetMap Server">
+        <permissions>
+        <permission name="allow_read_prefs" />
+        <permission name="allow_write_api" />
+        </permissions>
+      </osm>
+      EOF
+
+      permissions = Parser.call(permissions_xml, :xml)
+      permissions.raw.sort.should == %w(allow_read_prefs allow_write_api)
+
+      permissions.allow_write_api?.should be_true
+      permissions.allow_read_prefs?.should be_true
+      permissions.allow_write_prefs?.should be_false
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rosemary
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70334409635220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334409635220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &70334409634680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334409634680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70334409634120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334409634120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70334409633580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334409633580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70334409633020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334409633020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70334409632200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334409632200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70334409631420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334409631420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70334409630720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +133,44 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334409630720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: OpenStreetMap API client for ruby
 email:
 - info@christophbuente.de
@@ -125,12 +197,14 @@ files:
 - lib/rosemary/api.rb
 - lib/rosemary/basic_auth_client.rb
 - lib/rosemary/changeset.rb
+- lib/rosemary/client.rb
 - lib/rosemary/element.rb
 - lib/rosemary/errors.rb
 - lib/rosemary/member.rb
 - lib/rosemary/node.rb
 - lib/rosemary/oauth_client.rb
 - lib/rosemary/parser.rb
+- lib/rosemary/permissions.rb
 - lib/rosemary/relation.rb
 - lib/rosemary/tags.rb
 - lib/rosemary/user.rb
@@ -167,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4299720809747143469
+      hash: -896372154269482923
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.2'
 requirements: []
 rubyforge_project: rosemary
-rubygems_version: 1.8.10
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: OpenStreetMap API client for ruby
@@ -191,3 +265,4 @@ test_files:
 - spec/models/relation_spec.rb
 - spec/models/way_spec.rb
 - spec/spec_helper.rb
+has_rdoc: