simplegeo 0.2.0 → 0.2.1

data/README.rdoc

@@ -1,16 +1,18 @@
-= sg-ruby
+= simplegeo
 
 A SimpleGeo Ruby client.
 
 For the specific documentation on APIs (and the full list of parameters) see:
 
-http://help.simplegeo.com/faqs/api-documentation/endpoints
+* http://simplegeo.com/docs/api-endpoints
+* http://simplegeo.com/docs/clients-code-libraries/ruby
+* http://simplegeo.com/docs/tutorials/ruby
 
 == Installation
 
 Open the Terminal or other UNIX shell and type:
 
-  sudo gem install sg-ruby
+  sudo gem install simplegeo
 
 == Examples
 
@@ -19,94 +21,6 @@ Start by requiring SimpleGeo and setting your authentication credentials:
   require 'simple_geo'
   SimpleGeo::Client.set_credentials('token', 'secret')
   
-=== Getting a record
-
-  record = SimpleGeo::Client.get_record('com.simplegeo.global.geonames', '5373629')
-
-=== Getting multiple records
-
-  records = SimpleGeo::Client.get_records('com.simplegeo.global.geonames', ['1234', '5678'])
-
-=== Adding a record
-
-  record = SimpleGeo::Record.new({
-    :id => '1234',
-    :created => Time.now,
-    :lat => 37.759650000000001,
-    :lon => -122.42608,
-    :layer => 'com.example.testlayer',
-    :properties => {
-      :test_property => 'foobar'
-    }
-  })
-  SimpleGeo::Client.add_record(record)
-
-=== Updating a record
-  
-  record = SimpleGeo::Client.get_record('com.example.testlayer', '1234')
-  record.lat = 40.714269
-  record.lon = -74.005973
-  SimpleGeo::Client.add_record(record)
-
-=== Adding / updating multiple records
-
-  records = [
-    SimpleGeo::Record.new({
-      :id => '1234',
-      :created => Time.now,
-      :lat => 37.759650000000001,
-      :lon => -122.42608,
-      :layer => 'com.example.testlayer',
-      :properties => {
-        :test_property => 'foobar'
-      }
-    }),
-    SimpleGeo::Record.new({
-      :id => '5678',
-      :created => Time.now,
-      :lat => 37.755470000000003,
-      :lon => -122.420646,
-      :layer => 'com.example.testlayer',
-      :properties => {
-        :mad_prop => 'baz'
-      }
-    })
-  ]
-  SimpleGeo::Client.add_records('com.example.testlayer', records)
-
-=== Deleting a record
-
-  SimpleGeo::Client.delete_record('1234')
-
-=== Getting a record's history
-
-  history = SimpleGeo::Client.get_history('com.example.testlayer', '1234')
-
-=== Getting nearby records
-
-See http://help.simplegeo.com/faqs/api-documentation/endpoints for other optional params
-
-  # by lat, lon
-  records = SimpleGeo::Client.get_nearby_records('com.example.testlayer', 
-    :lat => 37.759650000000001,
-    :lon => -122.42608)
-    
-  # by geohash
-  records = SimpleGeo::Client.get_nearby_records('com.example.testlayer', 
-    :geohash => '9q8yy1ujcsfm')
-
-=== Getting a nearby address for a lat and lon
-
-  nearby_address = SimpleGeo::Client.get_nearby_address(37.759650000000001, -122.42608)
-  
-=== Getting SpotRank density information
-
-  # by day
-  density_info = SimpleGeo::Client.get_density(37.75965, -122.42608, 'sat')
-  
-  # by hour
-  density_info = SimpleGeo::Client.get_density(37.75965, -122.42608, 'sat', '16' )
-
 === Other APIs
 
 For more examples see: spec/client_spec.rb 

data/lib/simple_geo/client.rb

@@ -110,6 +110,17 @@ module SimpleGeo
         HashUtils.recursively_symbolize_keys geojson_hash
       end
       
+      def get_context_by_address(address)
+        address = URI.escape(address, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        geojson_hash = get Endpoint.context_by_address(address)
+        HashUtils.recursively_symbolize_keys geojson_hash
+      end
+      
+      def get_context_ip(ip)
+        geojson_hash = get Endpoint.context_ip(ip)
+        HashUtils.recursively_symbolize_keys geojson_hash
+      end
+      
       # Required
       #   lat - The latitude of the point
       #   lon - The longitude of the point
@@ -129,6 +140,17 @@ module SimpleGeo
         HashUtils.recursively_symbolize_keys geojson_hash
       end
 
+      def get_places_by_address(address, options={})
+        address = URI.escape(address, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        geojson_hash = get Endpoint.places_by_address(address, options)
+        HashUtils.recursively_symbolize_keys geojson_hash
+      end
+
+      def get_places_by_ip(ip='ip', options={})
+        geojson_hash = get Endpoint.places_by_ip(ip, options)
+        HashUtils.recursively_symbolize_keys geojson_hash
+      end
+
       def get_density(lat, lon, day, hour=nil)
         geojson_hash = get Endpoint.density(lat, lon, day, hour)
         geojson_hash = HashUtils.recursively_symbolize_keys(geojson_hash)

data/lib/simple_geo/endpoint.rb

@@ -40,15 +40,48 @@ module SimpleGeo
         endpoint_url "context/#{lat},#{lon}.json", '1.0'
       end
       
+      def context_by_address(address)
+        endpoint_url "context/address.json?address=#{address}", '1.0'
+      end
+      
+      def context_ip(ip)
+        endpoint_url "context/#{ip}.json", '1.0'
+      end
+      
       def places(lat, lon, options)
         if options.empty?
           endpoint_url "places/#{lat},#{lon}.json", '1.0'
         else
-          params = ""
+          params = []
+          options.each do |k,v|
+            params << "#{k}=#{v}"
+          end
+          endpoint_url "places/#{lat},#{lon}.json?#{params.join("&")}", '1.0'
+        end
+      end
+
+      def places_by_address(address, options)
+        if options.empty?
+          endpoint_url "places/address.json?address=#{address}", '1.0'
+        else
+          params = [] 
+          params << "address=#{address}"
+          options.each do |k,v|
+            params << "#{k}=#{v}"
+          end
+          endpoint_url "places/address.json?#{params.join("&")}", '1.0'
+        end
+      end
+
+      def places_by_ip(ip, options)
+        if options.empty?
+          endpoint_url "places/#{ip}.json", '1.0'
+        else
+          params = []
           options.each do |k,v|
-            params << "#{k}=#{v}&"
+            params << "#{k}=#{v}"
           end
-          endpoint_url "places/#{lat},#{lon}.json?#{params.chop!}", '1.0'
+          endpoint_url "places/#{ip}.json?#{params.join("&")}", '1.0'
         end
       end
 

data/simplegeo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplegeo}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Ryckbost", "Andrew Mager"]
-  s.date = %q{2011-01-12}
+  s.date = %q{2011-02-09}
   s.email = %q{andrew@simplegeo.com}
   s.extra_rdoc_files = [
     "LICENSE",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplegeo
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
+  hash: 21
+  prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Brian Ryckbost
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 -08:00
+date: 2011-02-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A SimpleGeo Ruby Client