nominatim 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v0.0.3
+
+* Added Polygon class.
+
+* Fixed few typos.
+
+* Added documentation to Place class.
+
+* Added Point class.
+
+* Returning ids as integers instead of strings.
+
 ## v0.0.1
 
 * Initial release.

data/lib/nominatim/place.rb

@@ -7,29 +7,47 @@ module Nominatim
       @attrs = attrs
     end
 
+    # Return display name
+    #
+    # @return [String]
     def display_name
       @display_name ||= @attrs[:display_name]
     end
 
+    # Return a class
+    #
+    # @return [String]
     def class
       @class ||= @attrs[:class]
     end
 
+    # Return a type
+    #
+    # @return [String]
     def type
       @type ||= @attrs[:type]
     end
 
+    # Return an address
+    #
+    # @return [Nominatim::Address]
     def address
-      @address ||= Nominatim::Address.new(@attrs[:address]) unless @attrs[:address].nil?
+      @address ||= Nominatim::Address.new(@attrs[:address]) if @attrs[:address]
     end
 
+    # Return a latitude
+    #
+    # @return [Float]
     def lat
-      @lat ||= @attrs[:lat] || @attrs[:latitude]
+      point.lat
     end
     alias latitude lat
 
+    # Return a longitude
+    #
+    # @return [Float]
     def lon
-      @lon ||= @attrs[:lon] || @attrs[:longitude]
+      point.lon
     end
     alias longitude lon
 
@@ -38,20 +56,38 @@ module Nominatim
     end
     alias bounding_box boundingbox
 
+    # Return a polygon
+    #
+    # @return [Nominatim::Polygon]
     def polygonpoints
-      @polygonpoints ||= @attrs[:polygonpoints]
+      @polygonpoints ||= Nominatim::Polygon.new(@attrs[:polygonpoints]) if @attrs[:polygonpoints]
     end
 
+    # Return a place id
+    #
+    # @return [Integer]
     def place_id
-      @place_id ||= @attrs[:place_id]
+      @place_id ||= @attrs[:place_id].to_i if @attrs[:place_id]
     end
 
+    # Return an OSM id
+    #
+    # @return [Integer]
     def osm_id
-      @osm_id ||= @attrs[:osm_id]
+      @osm_id ||= @attrs[:osm_id].to_i if @attrs[:osm_id]
     end
 
+    # Return an OSM type
+    #
+    # @return [String]
     def osm_type
       @osm_type ||= @attrs[:osm_type]
     end
+
+    private
+
+    def point
+      @point ||= Nominatim::Point.new(@attrs[:lat], @attrs[:lon])
+    end
   end
 end

data/lib/nominatim/point.rb

@@ -0,0 +1,30 @@
+module Nominatim
+  class Point
+    attr_reader :lat, :lon
+    alias latitude lat
+    alias longitude lon
+
+    # @param lat [Float]
+    # @param lon [Float]
+    def initialize(lat, lon)
+      @lat, @lon = lat.to_f, lon.to_f if lat && lon
+    end
+
+    # @return [Array]
+    def to_a
+      [lat, lon]
+    end
+
+    # Return a string representation of the point
+    #
+    # @return [String]
+    def to_s
+      to_a.to_s
+    end
+
+    # @return [true, false]
+    def ==(other)
+      self.to_a == other.to_a
+    end
+  end
+end

data/lib/nominatim/polygon.rb

@@ -0,0 +1,13 @@
+module Nominatim
+  class Polygon
+    attr_reader :coordinates
+
+    # @param coordinates [Array<Array<Float, String>>]
+    def initialize(coordinates)
+      @coordinates = []
+      coordinates.each do |c|
+        @coordinates.push(Nominatim::Point.new(c[0], c[1]))
+      end
+    end
+  end
+end

data/lib/nominatim/search.rb

@@ -12,7 +12,7 @@ module Nominatim
       get('/search', @criteria).body.map! { |attrs| Nominatim::Place.new(attrs) }.each(&block)
     end
 
-    # Query string to search from.
+    # Query string to search for.
     #
     # @param q [String] Query string
     # @return [Nominatim::Search]

data/lib/nominatim/version.rb

@@ -1,3 +1,3 @@
 module Nominatim
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/nominatim.rb

@@ -1,5 +1,7 @@
 require "nominatim/version"
 require "nominatim/configuration"
+require "nominatim/point"
+require "nominatim/polygon"
 require "nominatim/address"
 require "nominatim/place"
 require "nominatim/response/parse_json"

data/spec/nominatim/place_spec.rb

@@ -51,13 +51,8 @@ describe Nominatim::Place do
 
   describe '#lat' do
     it 'returns a latitude when set with lat' do
-      place = Nominatim::Place.new(lat: '52.5487969264788')
-      place.lat.should eq '52.5487969264788'
-    end
-
-    it 'returns a latitude when set with latitude' do
-      place = Nominatim::Place.new(latitude: '52.5487969264788')
-      place.lat.should eq '52.5487969264788'
+      place = Nominatim::Place.new(lat: '52.5487969264788', lon: '-1.81642935385411')
+      place.lat.should eq 52.5487969264788
     end
 
     it 'returns nil when not set' do
@@ -68,13 +63,8 @@ describe Nominatim::Place do
 
   describe '#latitude' do
     it 'returns a latitude when set with lat' do
-      place = Nominatim::Place.new(lat: '52.5487969264788')
-      place.latitude.should eq '52.5487969264788'
-    end
-
-    it 'returns a latitude when set with latitude' do
-      place = Nominatim::Place.new(latitude: '52.5487969264788')
-      place.latitude.should eq '52.5487969264788'
+      place = Nominatim::Place.new(lat: '52.5487969264788', lon: '-1.81642935385411')
+      place.latitude.should eq 52.5487969264788
     end
 
     it 'returns nil when not set' do
@@ -85,13 +75,8 @@ describe Nominatim::Place do
 
   describe '#lon' do
     it 'returns a longitude when set with lon' do
-      place = Nominatim::Place.new(lon: '-1.81642935385411')
-      place.lon.should eq '-1.81642935385411'
-    end
-
-    it 'returns a longitude when set with longitude' do
-      place = Nominatim::Place.new(longitude: '-1.81642935385411')
-      place.lon.should eq '-1.81642935385411'
+      place = Nominatim::Place.new(lat: '52.5487969264788', lon: '-1.81642935385411')
+      place.lon.should eq -1.81642935385411
     end
 
     it 'returns nil when not set' do
@@ -102,13 +87,8 @@ describe Nominatim::Place do
 
   describe '#longitude' do
     it 'returns a longitude when set with lon' do
-      place = Nominatim::Place.new(lon: '-1.81642935385411')
-      place.longitude.should eq '-1.81642935385411'
-    end
-
-    it 'returns a longitude when set with longitude' do
-      place = Nominatim::Place.new(longitude: '-1.81642935385411')
-      place.longitude.should eq '-1.81642935385411'
+      place = Nominatim::Place.new(lat: '52.5487969264788', lon: '-1.81642935385411')
+      place.longitude.should eq -1.81642935385411
     end
 
     it 'returns nil when not set' do
@@ -117,13 +97,6 @@ describe Nominatim::Place do
     end
   end
 
-  # describe '#coordinates' do
-  #   it 'returns coordinates when set with lat and lon' do
-  #     place = Nominatim::Place.new(lat: '52.5487969264788', lon: '-1.81642935385411')
-  #     place.coordinates.should eq ['52.5487969264788', '-1.81642935385411']
-  #   end
-  # end
-
   describe '#boundingbox' do
     it 'returns a boundingbox when set with boundingbox' do
       place = Nominatim::Place.new(boundingbox: ["52.5487442016602", "52.5488510131836", "-1.81651306152344", "-1.81634628772736"])
@@ -151,7 +124,7 @@ describe Nominatim::Place do
   describe '#polygonpoints' do
     it 'returns polygon points when set with polygonpoints' do
       place = Nominatim::Place.new(polygonpoints: [["-1.816513", "52.5487566"], ["-1.8164913", "52.548824"], ["-1.8164685", "52.5488213"]])
-      place.polygonpoints.should eq [["-1.816513", "52.5487566"], ["-1.8164913", "52.548824"], ["-1.8164685", "52.5488213"]]
+      place.polygonpoints.should be_a Nominatim::Polygon
     end
 
     it 'returns nil when not set' do
@@ -163,7 +136,7 @@ describe Nominatim::Place do
   describe '#place_id' do
     it 'returns a place id when set with place_id' do
       place = Nominatim::Place.new(place_id: '84327444')
-      place.place_id.should eq '84327444'
+      place.place_id.should eq 84327444
     end
 
     it 'returns nil when not set' do
@@ -173,9 +146,9 @@ describe Nominatim::Place do
   end
 
   describe '#osm_id' do
-    it 'returns a osm id when set with osm_id' do
+    it 'returns an osm id when set with osm_id' do
       place = Nominatim::Place.new(osm_id: '90394480')
-      place.osm_id.should eq '90394480'
+      place.osm_id.should eq 90394480
     end
 
     it 'returns nil when not set' do
@@ -185,7 +158,7 @@ describe Nominatim::Place do
   end
 
   describe '#osm_type' do
-    it 'returns a osm type when set with osm_type' do
+    it 'returns an osm type when set with osm_type' do
       place = Nominatim::Place.new(osm_type: 'way')
       place.osm_type.should eq 'way'
     end

data/spec/nominatim/point_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Nominatim::Point do
+  let(:point) { Nominatim::Point.new(52.5487969264788, -1.81642935385411) }
+
+  describe '#lat' do
+    it 'returns the latitude' do
+      point.lat.should eq 52.5487969264788
+    end
+  end
+
+  describe '#latitude' do
+    it 'returns the latitude' do
+      point.latitude.should eq 52.5487969264788
+    end
+  end
+
+  describe '#lon' do
+    it 'returns the longitude' do
+      point.lon.should eq -1.81642935385411
+    end
+  end
+
+  describe '#longitude' do
+    it 'returns the longitude' do
+      point.longitude.should eq -1.81642935385411
+    end
+  end
+
+  describe '#to_a' do
+    it 'returns an array representing the point' do
+      point.to_a.should eq [52.5487969264788, -1.81642935385411]
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns a string representing the point' do
+      point.to_s.should eq '[52.5487969264788, -1.81642935385411]'
+    end
+  end
+
+  describe '#==' do
+    it 'returns true when objects coordinates are the same' do
+      other = Nominatim::Point.new(52.5487969264788, -1.81642935385411)
+      (point == other).should be_true
+    end
+
+    it 'returns false when objects coordinates are different' do
+      other = Nominatim::Point.new(-1.81642935385411, 52.5487969264788)
+      (point == other).should be_false
+    end
+  end
+end

data/spec/nominatim/polygon_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Nominatim::Polygon do
+
+  let(:polygon) { Nominatim::Polygon.new([[-1.816513, 52.5487566], [-1.8164913, 52.548824], [-1.8164685, 52.5488213]]) }
+
+  it 'sets coordinates correctly' do
+    polygon.coordinates.first.lat.should eq -1.816513
+    polygon.coordinates.first.lon.should eq 52.5487566
+  end
+
+  describe '#coordinates' do
+    it 'retruns an array of coordinates' do
+      polygon.coordinates.each do |p|
+        p.should be_a Nominatim::Point
+      end
+    end
+  end
+end

data/spec/nominatim/search_spec.rb

@@ -36,8 +36,8 @@ describe Nominatim::Search do
 
     it 'returns correct places' do
       search.first.display_name.should eq 'Los Angeles, California, United States of America'
-      search.first.lat.should eq '34.0966764'
-      search.first.lon.should eq '-117.7196785'
+      search.first.lat.should eq 34.0966764
+      search.first.lon.should eq -117.7196785
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nominatim
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -144,6 +144,8 @@ files:
 - lib/nominatim/client.rb
 - lib/nominatim/configuration.rb
 - lib/nominatim/place.rb
+- lib/nominatim/point.rb
+- lib/nominatim/polygon.rb
 - lib/nominatim/response/parse_json.rb
 - lib/nominatim/search.rb
 - lib/nominatim/version.rb
@@ -152,6 +154,8 @@ files:
 - spec/nominatim/address_spec.rb
 - spec/nominatim/client_spec.rb
 - spec/nominatim/place_spec.rb
+- spec/nominatim/point_spec.rb
+- spec/nominatim/polygon_spec.rb
 - spec/nominatim/search_spec.rb
 - spec/nominatim_spec.rb
 - spec/spec_helper.rb
@@ -167,18 +171,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -449881262904296726
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -449881262904296726
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -190,6 +188,8 @@ test_files:
 - spec/nominatim/address_spec.rb
 - spec/nominatim/client_spec.rb
 - spec/nominatim/place_spec.rb
+- spec/nominatim/point_spec.rb
+- spec/nominatim/polygon_spec.rb
 - spec/nominatim/search_spec.rb
 - spec/nominatim_spec.rb
 - spec/spec_helper.rb