openstreetmap 0.2.1

data/spec/open_street_map/node_spec.rb

@@ -0,0 +1,87 @@
+require 'openstreetmap'
+
+describe 'OpenStreetMap::Node' do
+
+  subject do
+    OpenStreetMap::Node.new(:id         => "123",
+                            :lat        => "52.2",
+                            :lon        => "13.4",
+                            :changeset  => "12",
+                            :user       => "fred",
+                            :uid        => "123",
+                            :visible    => true,
+                            :timestamp  => "2005-07-30T14:27:12+01:00")
+  end
+
+  it { should be_valid }
+
+  it "should be invalid without lat, lon" do
+    subject.lat = nil
+    subject.lon = nil
+    subject.should_not be_valid
+  end
+
+  it "should not be valid when using to large lat value" do
+    subject.lat = 181
+    subject.should_not be_valid
+  end
+
+  it "should not be valid when using to large lat value" do
+    subject.lon = 91
+    subject.should_not be_valid
+  end
+
+  it "should have an id attribute set from attributes" do
+    subject.id.should eql(123)
+  end
+
+  it "should have an id attribute within xml representation" do
+    subject.to_xml.should match /id=\"123\"/
+  end
+
+  it "should have a lat attribute set from attributes" do
+    subject.lat.should eql(52.2)
+  end
+
+  it "should have a lat attribute within xml representation" do
+    subject.to_xml.should match /lat=\"52.2\"/
+  end
+
+  it "should have a lon attribute set from attributes" do
+    subject.lon.should eql(13.4)
+  end
+
+  it "should have a lon attribute within xml representation" do
+    subject.to_xml.should match /lon=\"13.4\"/
+  end
+
+  it "should have a user attributes set from attributes" do
+    subject.user.should eql("fred")
+  end
+
+  it "should have a user attribute within xml representation" do
+    subject.to_xml.should match /user=\"fred\"/
+  end
+
+  it "should have a changeset attributes set from attributes" do
+    subject.changeset.should eql(12)
+  end
+
+  it "should have a changeset attribute within xml representation" do
+    subject.to_xml.should match /changeset=\"12\"/
+  end
+
+  it "should have a uid attribute set from attributes" do
+    subject.uid.should eql(123)
+  end
+
+  it "should have a uid attribute within xml representation" do
+    subject.to_xml.should match /uid=\"123\"/
+  end
+
+  it "should produce xml" do
+    subject.add_tags(:wheelchair => 'yes')
+    subject.to_xml.should match /k=\"wheelchair\"/
+    subject.to_xml.should match /v=\"yes\"/
+  end
+end

data/spec/open_street_map/relation_spec.rb

@@ -0,0 +1,26 @@
+require 'openstreetmap'
+
+describe 'OpenStreetMap::Relation' do
+
+  subject do
+    OpenStreetMap::Relation.new(:id         => "123",
+                                :lat        => "52.2",
+                                :lon        => "13.4",
+                                :changeset  => "12",
+                                :user       => "fred",
+                                :uid        => "123",
+                                :visible    => true,
+                                :timestamp  => "2005-07-30T14:27:12+01:00",
+                                :member     => [
+                                  {"type"=>"relation", "ref"=>"1628007", "role"=>"outer"},
+                                  {"type"=>"way", "ref"=>"50197015", "role"=>""}
+                                ])
+  end
+
+  it { should be_valid }
+
+  it "should have members" do
+    subject.members.size.should eql 2
+  end
+
+end

data/spec/open_street_map/way_spec.rb

@@ -0,0 +1,77 @@
+require 'openstreetmap'
+
+describe 'OpenStreetMap::Way' do
+
+  def valid_fake_way
+    way=<<-EOF
+    <osm>
+     <way id="1234" version="142" changeset="12" user="fred" uid="123" visible="true" timestamp="2005-07-30T14:27:12+01:00">
+       <tag k="note" v="Just a way"/>
+       <nd ref="15735248"/>
+       <nd ref="169269997"/>
+       <nd ref="169270001"/>
+       <nd ref="15735251"/>
+       <nd ref="15735252"/>
+       <nd ref="15735253"/>
+       <nd ref="15735250"/>
+       <nd ref="15735247"/>
+       <nd ref="15735246"/>
+       <nd ref="15735249"/>
+       <nd ref="15735248"/>
+     </way>
+    </osm>
+    EOF
+  end
+
+  subject do
+    @way ||= OpenStreetMap::Way.from_xml(valid_fake_way)
+  end
+
+  it "should have 4 nodes" do
+    subject.nodes.size.should eql 11
+    subject.nodes.first.should eql 15735248
+  end
+
+  it "should have node referenzes in xml representation" do
+    subject.to_xml.should match /ref=\"15735248\"/
+  end
+
+
+  it "should have an id attribute set from attributes" do
+    subject.id.should eql(1234)
+  end
+
+  it "should have an id attribute within xml representation" do
+    subject.to_xml.should match /id=\"1234\"/
+  end
+
+  it "should have a user attributes set from attributes" do
+    subject.user.should eql("fred")
+  end
+
+  it "should have a user attribute within xml representation" do
+    subject.to_xml.should match /user=\"fred\"/
+  end
+
+  it "should have a changeset attributes set from attributes" do
+    subject.changeset.should eql(12)
+  end
+
+  it "should have a changeset attribute within xml representation" do
+    subject.to_xml.should match /changeset=\"12\"/
+  end
+
+  it "should have a uid attribute set from attributes" do
+    subject.uid.should eql(123)
+  end
+
+  it "should have a uid attribute within xml representation" do
+    subject.to_xml.should match /uid=\"123\"/
+  end
+
+  it "should produce xml" do
+    subject.add_tags(:wheelchair => 'yes')
+    subject.to_xml.should match /k=\"wheelchair\"/
+    subject.to_xml.should match /v=\"yes\"/
+  end
+end

data/spec/open_street_map_changeset_spec.rb

@@ -0,0 +1,136 @@
+require 'webmock/rspec'
+require 'openstreetmap'
+
+describe 'OpenStreetMap' do
+
+  before do
+    WebMock.disable_net_connect!
+  end
+
+  let :osm do
+    OpenStreetMap::Api.new
+  end
+
+  describe '::Changeset' do
+
+    def valid_fake_user
+      user=<<-EOF
+      <osm version="0.6" generator="OpenStreetMap server">
+       <user display_name="Max Muster" account_created="2006-07-21T19:28:26Z" id="1234">
+         <home lat="49.4733718952806" lon="8.89285988577866" zoom="3"/>
+         <description>The description of your profile</description>
+         <languages>
+           <lang>de-DE</lang>
+           <lang>de</lang>
+           <lang>en-US</lang>
+           <lang>en</lang>
+         </languages>
+       </user>
+      </osm>
+      EOF
+    end
+
+    def missing_changeset
+      changeset=<<-EOF
+      <osm version="0.6" generator="OpenStreetMap server"/>
+      EOF
+    end
+
+    def single_changeset
+      changeset=<<-EOF
+      <osm version="0.6" generator="OpenStreetMap server">
+        <changeset id="10" user="fred" uid="123" created_at="2008-11-08T19:07:39+01:00" open="true" min_lon="7.0191821" min_lat="49.2785426" max_lon="7.0197485" max_lat="49.2793101">
+          <tag k="created_by" v="JOSM 1.61"/>
+          <tag k="comment" v="Just adding some streetnames"/>
+       </changeset>
+      </osm>
+      EOF
+    end
+
+    def multiple_changeset
+      changeset=<<-EOF
+      <osm version="0.6" generator="OpenStreetMap server">
+        <changeset id="10" user="fred" uid="123" created_at="2008-11-08T19:07:39+01:00" open="true" min_lon="7.0191821" min_lat="49.2785426" max_lon="7.0197485" max_lat="49.2793101">
+          <tag k="created_by" v="JOSM 1.61"/>
+          <tag k="comment" v="Just adding some streetnames"/>
+       </changeset>
+       <changeset id="11" user="fred" uid="123" created_at="2008-11-08T19:07:39+01:00" open="true" min_lon="7.0191821" min_lat="49.2785426" max_lon="7.0197485" max_lat="49.2793101">
+         <tag k="created_by" v="JOSM 1.61"/>
+         <tag k="comment" v="Just adding some streetnames"/>
+      </changeset>
+      </osm>
+      EOF
+    end
+
+    describe '#find:' do
+
+      let :request_url do
+        "http://www.openstreetmap.org/api/0.6/changeset/10"
+      end
+
+      let :stubbed_request do
+        stub_request(:get, request_url)
+      end
+
+      it "should build a Change from API response via find_changeset_object" do
+        stubbed_request.to_return(:status => 200, :body => single_changeset, :headers => {'Content-Type' => 'application/xml'})
+        changeset = osm.find_changeset(10)
+        assert_requested :get, request_url, :times => 1
+        changeset.class.should eql OpenStreetMap::Changeset
+      end
+
+      it "should raise an NotFound error, when a changeset cannot be found" do
+        stubbed_request.to_return(:status => 404, :body => '', :headers => {'Content-Type' => 'text/plain'})
+        lambda {
+          node = osm.find_changeset(10)
+        }.should raise_error(OpenStreetMap::NotFound)
+      end
+    end
+
+    describe '#find_for_user' do
+
+      let :osm do
+        OpenStreetMap::Api.new(OpenStreetMap::BasicAuthClient.new('a_username', 'a_password'))
+      end
+
+      let :request_url do
+        "http://www.openstreetmap.org/api/0.6/changesets?user=1234"
+      end
+
+      let :stubbed_request do
+        stub_request(:get, request_url)
+      end
+
+      let! :stub_user_lookup do
+        stub_request(:get, "http://a_username:a_password@www.openstreetmap.org/api/0.6/user/details").to_return(:status => 200, :body => valid_fake_user, :headers => {'Content-Type' => 'application/xml'} )
+      end
+
+      it "should not find changeset for user if user has none" do
+        stubbed_request.to_return(:status => 200, :body => missing_changeset, :headers => {'Content-Type' => 'application/xml'})
+        changesets = osm.find_changesets_for_user
+        changesets.should be_empty
+      end
+
+      it "should find a single changeset for user" do
+        stubbed_request.to_return(:status => 200, :body => single_changeset, :headers => {'Content-Type' => 'application/xml'})
+        changesets = osm.find_changesets_for_user
+        changesets.size.should eql 1
+        changesets.first.class.should eql OpenStreetMap::Changeset
+      end
+
+      it "should find a multiple changesets for a user" do
+        stubbed_request.to_return(:status => 200, :body => multiple_changeset, :headers => {'Content-Type' => 'application/xml'})
+        changesets = osm.find_changesets_for_user
+        changesets.size.should eql 2
+        changesets.first.class.should eql OpenStreetMap::Changeset
+      end
+    end
+
+    describe '#update:' do
+    end
+
+    describe '#close' do
+    end
+  end
+end
+

data/spec/open_street_map_node_spec.rb

@@ -0,0 +1,388 @@
+require 'webmock/rspec'
+require 'openstreetmap'
+
+describe 'OpenStreetMap' do
+
+  before do
+    WebMock.disable_net_connect!
+  end
+
+  let :osm do
+    OpenStreetMap::Api.new
+  end
+
+  let :stub_changeset_lookup do
+    stub_request(:get, "http://www.openstreetmap.org/api/0.6/changesets?open=true&user=1234").to_return(:status => 200, :body => valid_fake_changeset, :headers => {'Content-Type' => 'application/xml'} )
+  end
+
+  let :stub_node_lookup do
+    stub_request(:get, "http://www.openstreetmap.org/api/0.6/node/123").to_return(:status => 200, :body => valid_fake_node, :headers => {'Content-Type' => 'application/xml'})
+  end
+
+  describe '::Node' do
+
+    def valid_fake_node
+      node=<<-EOF
+      <osm>
+       <node id="123" lat="51.2" lon="13.4" version="42" changeset="12" user="fred" uid="123" visible="true" timestamp="2005-07-30T14:27:12+01:00">
+         <tag k="note" v="Just a node"/>
+         <tag k="amenity" v="bar" />
+         <tag k="name" v="The rose" />
+       </node>
+      </osm>
+      EOF
+    end
+
+    def valid_fake_user
+      user=<<-EOF
+      <osm version="0.6" generator="OpenStreetMap server">
+       <user display_name="Max Muster" account_created="2006-07-21T19:28:26Z" id="1234">
+         <home lat="49.4733718952806" lon="8.89285988577866" zoom="3"/>
+         <description>The description of your profile</description>
+         <languages>
+           <lang>de-DE</lang>
+           <lang>de</lang>
+           <lang>en-US</lang>
+           <lang>en</lang>
+         </languages>
+       </user>
+      </osm>
+      EOF
+    end
+
+    def valid_fake_changeset
+      changeset=<<-EOF
+      <osm>
+        <changeset id="10" user="fred" uid="123" created_at="2008-11-08T19:07:39+01:00" open="true" min_lon="7.0191821" min_lat="49.2785426" max_lon="7.0197485" max_lat="49.2793101">
+          <tag k="created_by" v="JOSM 1.61"/>
+          <tag k="comment" v="Just adding some streetnames"/>
+       </changeset>
+      </osm>
+      EOF
+    end
+
+    describe '#find:' do
+
+      let :request_url do
+        "http://www.openstreetmap.org/api/0.6/node/1234"
+      end
+
+      let :stubbed_request do
+        stub_request(:get, request_url)
+      end
+
+      it "should build a Node from API response via get_object" do
+        stubbed_request.to_return(:status => 200, :body => valid_fake_node, :headers => {'Content-Type' => 'application/xml'})
+        node = osm.find_node 1234
+        assert_requested :get, request_url, :times => 1
+        node.class.should eql OpenStreetMap::Node
+        node.tags.size.should eql 3
+        node.tags['name'].should eql 'The rose'
+        node['name'].should eql 'The rose'
+        node.add_tags('wheelchair' => 'yes')
+        node['wheelchair'].should eql 'yes'
+      end
+
+      it "should raise a Unavailable, when api times out" do
+        stubbed_request.to_timeout
+        lambda {
+          node = osm.find_node(1234)
+        }.should raise_error(OpenStreetMap::Unavailable)
+      end
+
+      it "should raise an Gone error, when a node has been deleted" do
+        stubbed_request.to_return(:status => 410, :body => '', :headers => {'Content-Type' => 'text/plain'})
+        lambda {
+          node = osm.find_node(1234)
+        }.should raise_error(OpenStreetMap::Gone)
+      end
+
+      it "should raise an NotFound error, when a node cannot be found" do
+        stubbed_request.to_return(:status => 404, :body => '', :headers => {'Content-Type' => 'text/plain'})
+        lambda {
+          node = osm.find_node(1234)
+        }.should raise_error(OpenStreetMap::NotFound)
+      end
+    end
+
+    describe 'with BasicAuthClient' do
+
+      let :osm do
+        OpenStreetMap::Api.new(OpenStreetMap::BasicAuthClient.new('a_username', 'a_password'))
+      end
+
+      let :stub_user_lookup do
+        stub_request(:get, "http://a_username:a_password@www.openstreetmap.org/api/0.6/user/details").to_return(:status => 200, :body => valid_fake_user, :headers => {'Content-Type' => 'application/xml'} )
+      end
+
+      describe '#create:' do
+
+        let :node do
+          OpenStreetMap::Node.new
+        end
+
+        let :request_url do
+          "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/create"
+        end
+
+        let :stubbed_request do
+          stub_request(:put, request_url)
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+        end
+
+        it "should create a new Node from given attributes" do
+          stubbed_request.to_return(:status => 200, :body => '123', :headers => {'Content-Type' => 'text/plain'})
+          node.id.should be_nil
+          new_id = osm.save(node)
+        end
+
+        it "should raise a Unavailable, when api times out" do
+          stubbed_request.to_timeout
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::Unavailable)
+        end
+
+        it "should not create a Node with invalid xml but raise BadRequest" do
+          stubbed_request.to_return(:status => 400, :body => 'The given node is invalid', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::BadRequest)
+        end
+
+        it "should not allow to create a node when a changeset has been closed" do
+          stubbed_request.to_return(:status => 409, :body => 'The given node is invalid', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::Conflict)
+        end
+
+        it "should not allow to create a node when no authentication client is given" do
+          osm = OpenStreetMap::Api.new
+          lambda {
+            osm.save(node)
+          }.should raise_error(OpenStreetMap::CredentialsMissing)
+        end
+
+      end
+
+      describe '#update:' do
+
+        let :node do
+          osm.find_node 123
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+          stub_node_lookup
+        end
+
+        it "should save a edited node" do
+          stub_request(:put, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 200, :body => '43', :headers => {'Content-Type' => 'text/plain'})
+          node.tags['amenity'] = 'restaurant'
+          node.tags['name'] = 'Il Tramonto'
+          node.should_receive(:changeset=)
+          new_version = osm.save(node)
+          new_version.should eql 43
+        end
+
+      end
+
+      describe '#delete:' do
+
+        let :node do
+          osm.find_node 123
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+          stub_node_lookup
+        end
+
+        it "should not delete an node with missing id" do
+          node = OpenStreetMap::Node.new
+          osm.destroy(node)
+        end
+
+        it "should delete an existing node" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 200, :body => '43', :headers => {'Content-Type' => 'text/plain'})
+          node.should_receive(:changeset=)
+          new_version = osm.destroy(node)
+          new_version.should eql 43 # new version number
+        end
+
+        it "should raise an error if node to be deleted is still part of a way" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 400, :body => 'Version does not match current database version', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            response = osm.destroy(node)
+            response.should eql "Version does not match current database version"
+          }.should raise_error OpenStreetMap::BadRequest
+        end
+
+        it "should raise an error if node cannot be found" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 404, :body => 'Node cannot be found', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            response = osm.destroy(node)
+            response.should eql "Node cannot be found"
+          }.should raise_error OpenStreetMap::NotFound
+        end
+
+        it "should raise an error if there is a conflict" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 409, :body => 'Node has been deleted in this changeset', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            response = osm.destroy(node)
+            response.should eql "Node has been deleted in this changeset"
+          }.should raise_error OpenStreetMap::Conflict
+        end
+
+        it "should raise an error if the node is already delted" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 410, :body => 'Node has been deleted', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            response = osm.destroy(node)
+            response.should eql "Node has been deleted"
+          }.should raise_error OpenStreetMap::Gone
+        end
+
+        it "should raise an error if the node is part of a way" do
+          stub_request(:delete, "http://a_username:a_password@www.openstreetmap.org/api/0.6/node/123").to_return(:status => 412, :body => 'Node 123 is still used by way 456', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            response = osm.destroy(node)
+            response.should eql "Node 123 is still used by way 456"
+          }.should raise_error OpenStreetMap::Precondition
+        end
+
+      end
+    end
+
+    describe 'with OauthClient' do
+
+      let :consumer do
+        OAuth::Consumer.new(  'a_key', 'a_secret',
+                              {
+                                :site => 'http://www.openstreetmap.org',
+                                :request_token_path => '/oauth/request_token',
+                                :access_token_path => '/oauth/access_token',
+                                :authorize_path => '/oauth/authorize'
+                              }
+                            )
+      end
+
+      let :access_token do
+        OAuth::AccessToken.new(consumer, 'a_token', 'a_secret')
+      end
+
+      let :osm do
+        OpenStreetMap::Api.new(OpenStreetMap::OauthClient.new(access_token))
+      end
+
+      let :stub_user_lookup do
+        stub_request(:get, "http://www.openstreetmap.org/api/0.6/user/details").to_return(:status => 200, :body => valid_fake_user, :headers => {'Content-Type' => 'application/xml'} )
+      end
+
+      describe '#create:' do
+        let :node do
+          OpenStreetMap::Node.new
+        end
+
+        let :request_url do
+          "http://www.openstreetmap.org/api/0.6/node/create"
+        end
+
+        let :stubbed_request do
+          stub_request(:put, request_url)
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+        end
+
+        it "should create a new Node from given attributes" do
+          stubbed_request.to_return(:status => 200, :body => '123', :headers => {'Content-Type' => 'text/plain'})
+          node.id.should be_nil
+          new_id = osm.save(node)
+        end
+
+        it "should raise a Unavailable, when api times out" do
+          stubbed_request.to_timeout
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::Unavailable)
+        end
+
+
+        it "should not create a Node with invalid xml but raise BadRequest" do
+          stubbed_request.to_return(:status => 400, :body => 'The given node is invalid', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::BadRequest)
+        end
+
+        it "should not allow to create a node when a changeset has been closed" do
+          stubbed_request.to_return(:status => 409, :body => 'The given node is invalid', :headers => {'Content-Type' => 'text/plain'})
+          lambda {
+            new_id = osm.save(node)
+          }.should raise_error(OpenStreetMap::Conflict)
+        end
+
+        it "should not allow to create a node when no authentication client is given" do
+          osm = OpenStreetMap::Api.new
+          lambda {
+            osm.save(node)
+          }.should raise_error(OpenStreetMap::CredentialsMissing)
+        end
+
+      end
+
+      describe '#update:' do
+
+        let :node do
+          osm.find_node 123
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+          stub_node_lookup
+        end
+
+        it "should save a edited node" do
+          stub_request(:put, "http://www.openstreetmap.org/api/0.6/node/123").to_return(:status => 200, :body => '43', :headers => {'Content-Type' => 'text/plain'})
+          node.tags['amenity'] = 'restaurant'
+          node.tags['name'] = 'Il Tramonto'
+          node.should_receive(:changeset=)
+          new_version = osm.save(node)
+          new_version.should eql 43
+        end
+      end
+
+      describe '#delete:' do
+
+        let :node do
+          osm.find_node 123
+        end
+
+        before do
+          stub_changeset_lookup
+          stub_user_lookup
+          stub_node_lookup
+        end
+
+        it "should delete an existing node" do
+          stub_request(:delete, "http://www.openstreetmap.org/api/0.6/node/123").to_return(:status => 200, :body => '43', :headers => {'Content-Type' => 'text/plain'})
+          node.should_receive(:changeset=)
+          lambda {
+            # Delete is not implemented using oauth
+            new_version = osm.destroy(node)
+          }.should raise_error(OpenStreetMap::NotImplemented)
+        end
+      end
+    end
+  end
+end