michaeldwan-urban-mapping-api 0.9.2 → 0.9.3

data/README.rdoc

@@ -25,13 +25,31 @@ Before you do anything, create an instance of UrbanMapping::Interface
   
 For premium API access, include the premium API key
 
-  interface = UrbanMapping::Interface.new('my-api-key', 'my-shared-secred')
+  interface = UrbanMapping::Interface.new('my-api-key', :shared_secret => 'my-shared-secred')
   interface.premium_api? 
   # => true
+  
+The default return value of all methods is an OpenStruct or array of OpenStructs.
+
+  interface = UrbanMapping::Interface.new('my-api-key')
+  hood = interface.get_neighborhood_detail(3094847)
+  hood
+  # => #<OpenStruct city="Chicago", name="The Loop", state="IL", ...>
+  hood.city
+  # => "Chicago"
+
+If you want the raw hash output, pass :raw => true to the constructor
+
+  interface = UrbanMapping::Interface.new('my-api-key', :shared_secret => 'my-shared-secred', :raw => true)
+  hood = interface.get_neighborhood_detail(3094847)
+  hood
+  # => {"wkt_centroid"=>"POINT(-87.6260772332496 41.8782770670931)", "name"=>"The Loop", "city"=>"Chicago"...
+  hood.city
+  # => "Chicago"
 
 (If you don't have an api key, go get one at http://developer.urbanmapping.com/accounts/register/)
 
-Now that you have an instance of the interface, you can make calls to the service
+Now that you have an instance of the interface, you can make calls to the service. (The below examples are using raw output.)
 
   interface.get_neighborhoods_by_postal_code('60654')
   # => [{"name"=>"River North", "city"=>"Chicago", "country"=>"USA", "id"=>3320072, "state"=>"IL"}, ...]

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/lib/core_ext.rb

@@ -0,0 +1,19 @@
+class Object
+  def to_openstruct
+    self
+  end
+end
+
+class Array
+  def to_openstruct
+    map{ |el| el.to_openstruct }
+  end
+end
+
+class Hash
+  def to_openstruct
+    mapped = {}
+    each{ |key,value| mapped[key] = value.to_openstruct }
+    OpenStruct.new(mapped)
+  end
+end

data/lib/urban-mapping-api.rb

@@ -1,6 +1,9 @@
 require 'curl'
 require 'json'
 require 'digest'
+require 'ostruct'
+require 'uri'
+require "#{File.dirname(__FILE__)}/core_ext"
 
 module UrbanMapping
   class RequestError < StandardError
@@ -15,14 +18,18 @@ module UrbanMapping
   class Interface
     ENDPOINT = 'http://api1.urbanmapping.com/neighborhoods/rest'
 
-    attr_reader :api_key, :shared_secret
+    attr_reader :api_key, :shared_secret, :options
     
     # Create a new instance.
     # Requeres an api_key. A shared key needs to be provided for 
     # access to premium API methods.
-    def initialize(api_key, shared_secret = nil)
+    def initialize(api_key, options = {})
+      options = {
+        :raw => false
+      }.merge(options)
       @api_key = api_key
-      @shared_secret = shared_secret
+      @shared_secret = options.delete(:shared_secret)
+      @options = options
     end
     
     # Returns true if a shard_secret was provided to the constructor.
@@ -56,7 +63,7 @@ module UrbanMapping
     # and lists neighborhoods containing the point in a single response. 
     # This is technically executed in a single request, but for the purposes 
     # of account administration a single invocation is counted as two calls.
-    def get_neighborhoods_by_address(street, city, state, country = nil)
+    def get_neighborhoods_by_address(street, city, state, country = 'USA')
       perform('getNeighborhoodsByAddress', :street => street,
                                            :city => city,
                                            :state => state,
@@ -64,7 +71,7 @@ module UrbanMapping
     end
     
     # Returns a list of neighborhood for the requested city.
-    def get_neighborhoods_by_city_state_country(city, state, country = nil)
+    def get_neighborhoods_by_city_state_country(city, state, country = 'USA')
       perform('getNeighborhoodsByCityStateCountry', :city => city,
                                                     :state => state,
                                                     :country => country)
@@ -98,11 +105,11 @@ module UrbanMapping
       def perform(method, parameters)
         parameters.merge!({
           :format => 'json',
-          :apikey => api_key,
+          :apikey => api_key
         })
         parameters.merge!(:sig => generate_signature) if premium_api?
-
-        query_string = parameters.to_a.map{|x| x.join('=')}.join('&')
+        
+        query_string = parameters.to_a.map{ |x| x.map{|val| URI.encode(val.to_s)}.join('=') }.join('&')
 
         url = "#{ENDPOINT}/#{method}?#{query_string}"
         response = Curl::Easy.perform(url)
@@ -110,8 +117,12 @@ module UrbanMapping
         if response.response_code != 200
           raise RequestError.new(response.response_code, url, response.body_str)
         end
+        
+        output = JSON.parse(response.body_str)
+        
+        return output if options[:raw]
 
-        JSON.parse(response.body_str)
+        output.to_openstruct
       rescue StandardError => ex
         raise "An error occured while calling #{url}: #{ex.message}\n#{ex.backtrace}"
       end

data/urban-mapping-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{urban-mapping-api}
-  s.version = "0.9.2"
+  s.version = "0.9.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Dwan"]
-  s.date = %q{2009-09-02}
+  s.date = %q{2009-09-03}
   s.description = %q{A simple ruby interface to Urban Mapping's free and premium neighborhood lookup API}
   s.email = %q{mpdwan@gmail.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "lib/core_ext.rb",
      "lib/urban-mapping-api.rb",
      "test/test_helper.rb",
      "test/urban-mapping-api_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: michaeldwan-urban-mapping-api
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Michael Dwan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-02 00:00:00 -07:00
+date: 2009-09-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,12 +38,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/core_ext.rb
 - lib/urban-mapping-api.rb
 - test/test_helper.rb
 - test/urban-mapping-api_test.rb
 - urban-mapping-api.gemspec
 has_rdoc: false
 homepage: http://github.com/michaeldwan/urban-mapping-api
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A simple ruby interface to Urban Mapping's free and premium neighborhood lookup API