yahoo-placemaker 0.0.4 → 0.0.4.1

data/README.markdown

@@ -10,6 +10,10 @@
 
     gem install yahoo-placemaker
 
+## Documentation
+
+http://rdoc.info/github/kyledecot/yahoo-placemaker/master/frames
+
 ## Usage
 
     require 'yahoo-placemaker'
@@ -17,6 +21,7 @@
     result = Yahoo::Placemaker.extract "Columbus Ohio is my hometown"
     result.document.geographic_scope.name # Columbus, OH, US
     result.document.administrative_scope.centroid.latitude # 39.962
+    result.document.references.first.text # Columbus Ohio
     
 ## Contributing
 

data/lib/yahoo-placemaker.rb

@@ -1,4 +1,3 @@
-require "yahoo-placemaker/version"
 require "yahoo-placemaker/response"
 require "yahoo-placemaker/version"
 
@@ -8,8 +7,10 @@ require "net/http"
 module Yahoo
   module Placemaker
 
-    def self.extract (text = '', options = {})
+    # Main method for interacting w/ the Yahoo! Placemaker API
 
+    def self.extract (text = '', options = {})
+      result = nil
       host = 'wherein.yahooapis.com'
 
       # These options need to be explicitly set!
@@ -20,23 +21,29 @@ module Yahoo
 
       req = ::Net::HTTP::Post.new('/v1/document')
       req.body = to_url_params(options)
-      response = ::Net::HTTP.new(host).start do |http|
-        http.request(req)
+      begin
+        response = ::Net::HTTP.new(host).start do |http|
+          http.request(req)
+        end
+        json = ::JSON.parse(response.body)
+
+        result = Yahoo::Placemaker::Response.new(json)
+      rescue Exception => e
+       # puts e
+        # Something has gone horribly wrong...
       end
-      json = ::JSON.parse(response.body)
 
-      Yahoo::Placemaker::Response.new(json)
+      result
 
     end
 
-      private
+    private
 
-      def self.to_url_params(h)
-      elements = []
-      h.keys.size.times do |i|
-      elements << "#{h.keys[i]}=#{h.values[i]}"
-      end
-      elements.join('&')
+    # Takes a hash and turns it into a query string that can be used
+    # in a URL request
+
+    def self.to_url_params(params)
+      params.collect{|key, value| "#{key}=#{value}"}.join('&')
     end
 
   end

data/lib/yahoo-placemaker/document.rb

@@ -1,14 +1,12 @@
 require 'yahoo-placemaker/geographic_scope'
 require 'yahoo-placemaker/local_scope'
 require 'yahoo-placemaker/administrative_scope'
-require 'yahoo-placemaker/reference_list'
 require 'yahoo-placemaker/reference'
 require 'yahoo-placemaker/extents'
 require 'yahoo-placemaker/place'
-require 'yahoo-placemaker/places'
 
 class Yahoo::Placemaker::Document
-  attr_accessor :administrative_scope, :geographic_scope, :local_scopes, :reference_list, :extents, :place_details, :places
+  attr_accessor :administrative_scope, :geographic_scope, :local_scopes, :references, :extents, :places
   def initialize(json)
 
     if json['administrativeScope']
@@ -23,7 +21,8 @@ class Yahoo::Placemaker::Document
       @administrative_scope = Yahoo::Placemaker::AdministrativeScope.new(json['administrativeScope'])
     end
 
-    @places = Yahoo::Placemaker::Places.new
+    @places = Array.new
+
     # if the placeDetails key exists then that means that we
     # only have one result so we'll just use it. Otherwise
     # yahoo has given us back some POORLY formatted data which
@@ -42,8 +41,8 @@ class Yahoo::Placemaker::Document
       end
     end
 
+    @local_scopes = Array.new
     if json['localScopes']
-      @local_scopes = Array.new
       if json['localScopes'].class == Array
         json['localScopes'].each do |ls|
           @local_scopes << Yahoo::Placemaker::LocalScope.new(ls['localScope'])
@@ -57,14 +56,16 @@ class Yahoo::Placemaker::Document
       @extents = Yahoo::Placemaker::Extents.new(json['extents'])
     end
 
-    @reference_list = Yahoo::Placemaker::ReferenceList.new
+    # referenceList -> references
+
+    @references = Array.new
     if json['referenceList']
       if json['referenceList'].class == Array
         json['referenceList'].each do |reference|
-          @reference_list << Yahoo::Placemaker::Reference.new(reference)
+          @references << Yahoo::Placemaker::Reference.new(reference)
         end
       else
-        @reference_list << Yahoo::Placemaker::Reference.new(json['referenceList'])
+        @references << Yahoo::Placemaker::Reference.new(json['referenceList']['reference'])
       end
     end
 

data/lib/yahoo-placemaker/geographic_scope.rb

@@ -1,11 +1,4 @@
 require 'yahoo-placemaker/scope'
-require 'yahoo-placemaker/centroid'
 
 class Yahoo::Placemaker::GeographicScope < Yahoo::Placemaker::Scope
-  def initialize (json)
-    @woe_id = json['woeId']
-    @type = json['type']
-    @name = json['name']
-    @centroid = Yahoo::Placemaker::Centroid.new(json['centroid'])
-  end
 end

data/lib/yahoo-placemaker/local_scope.rb

@@ -1,6 +1,5 @@
 require 'yahoo-placemaker/scope'
 require 'yahoo-placemaker/ancestor'
-require 'yahoo-placemaker/centroid'
 
 class Yahoo::Placemaker::LocalScope < Yahoo::Placemaker::Scope
 
@@ -8,7 +7,7 @@ class Yahoo::Placemaker::LocalScope < Yahoo::Placemaker::Scope
 
   def initialize (json)
     super(json)
-    @centroid = Yahoo::Placemaker::Centroid.new json['centroid']
+    @centroid = Yahoo::Placemaker::LatLng.new json['centroid']
     @south_west = Yahoo::Placemaker::LatLng.new json['southWest']
     @north_east = Yahoo::Placemaker::LatLng.new json['northEast']
     @ancestors = Array.new
@@ -16,8 +15,10 @@ class Yahoo::Placemaker::LocalScope < Yahoo::Placemaker::Scope
       json['ancestors'].each do |ancestor|
         @ancestors << Yahoo::Placemaker::Ancestor.new(ancestor['ancestor'])
       end
-    else
+    elsif json['ancestors'].class == Hash
         @ancestors << Yahoo::Placemaker::Ancestor.new(json['ancestors']['ancestor'])
+    else
+      # no ancestors...country?
     end
   end
 end

data/lib/yahoo-placemaker/place.rb

@@ -1,4 +1,4 @@
-require 'yahoo-placemaker/centroid'
+require 'yahoo-placemaker/lat_lng'
 
 class Yahoo::Placemaker::Place
 
@@ -8,7 +8,7 @@ class Yahoo::Placemaker::Place
   def initialize(json)
 
     @place_id = json['placeId']
-    @centroid = Yahoo::Placemaker::Centroid.new json['place']['centroid']
+    @centroid = Yahoo::Placemaker::LatLng.new json['place']['centroid']
     @type = json['place']['type']
     @woe_id = json['place']['woeId']
     @name = json['place']['name']

data/lib/yahoo-placemaker/reference.rb

@@ -3,8 +3,8 @@ class Yahoo::Placemaker::Reference
 
   def initialize(json)
     @woe_ids = json['woeIds']
-    @end = json['end']
-    @start = json['start']
+    @end = json['end'].to_i
+    @start = json['start'].to_i
     @place_reference_id = json['placeReferenceId']
     @place_ids = json['placeIds']
     @text = json['text']

data/lib/yahoo-placemaker/scope.rb

@@ -1,10 +1,10 @@
-require 'yahoo-placemaker/centroid'
+require 'yahoo-placemaker/lat_lng'
 
 class Yahoo::Placemaker::Scope
   attr_accessor :woe_id, :type, :name, :centroid
 
   def initialize(json)
-    @centroid = Yahoo::Placemaker::Centroid.new json['centroid']
+    @centroid = Yahoo::Placemaker::LatLng.new(json['centroid'])
     @woe_id = json['woeId']
     @type = json['type']
     @name = json['name']

data/lib/yahoo-placemaker/version.rb

@@ -1,5 +1,5 @@
 module Yahoo
   module Placemaker
-    VERSION = "0.0.4"
+    VERSION = "0.0.4.1"
   end
 end

data/spec/yahoo_placemaker_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Yahoo::Placemaker do
 
   it "determines we're talking about Columbus, Ohio" do
-  VCR.use_cassette('columbus ohio') do
+    VCR.use_cassette('columbus ohio') do
       response = Yahoo::Placemaker.extract "columbus ohio"
       response.document.administrative_scope.name.should == "Columbus, OH, US"
     end
@@ -19,7 +19,14 @@ describe Yahoo::Placemaker do
   it "contains only one item in reference_list when given 'Atlanta Georgia'" do
     VCR.use_cassette('atlanta_georgia') do
         response = Yahoo::Placemaker.extract "Atlanta Georgia"
-        response.document.reference_list.size.should == 1
+        response.document.references.size.should == 1
+    end
+  end
+
+  it "doesn't return any ancestors for 'France'" do
+    VCR.use_cassette('france') do
+      response = Yahoo::Placemaker.extract "France"
+      response.document.local_scopes.first.ancestors.should == Array.new
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo-placemaker
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000Z
+date: 2012-02-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70185541547500 !ruby/object:Gem::Requirement
+  requirement: &70231339663460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70185541547500
+  version_requirements: *70231339663460
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70185541545820 !ruby/object:Gem::Requirement
+  requirement: &70231339662920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70185541545820
+  version_requirements: *70231339662920
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70185541543640 !ruby/object:Gem::Requirement
+  requirement: &70231339662340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70185541543640
+  version_requirements: *70231339662340
 description: Easily interact w/ the Yahoo Placemaker API
 email:
 - kyle.decot@me.com
@@ -60,18 +60,14 @@ files:
 - lib/yahoo-placemaker.rb
 - lib/yahoo-placemaker/administrative_scope.rb
 - lib/yahoo-placemaker/ancestor.rb
-- lib/yahoo-placemaker/centroid.rb
 - lib/yahoo-placemaker/config.rb
 - lib/yahoo-placemaker/document.rb
 - lib/yahoo-placemaker/extents.rb
 - lib/yahoo-placemaker/geographic_scope.rb
 - lib/yahoo-placemaker/lat_lng.rb
 - lib/yahoo-placemaker/local_scope.rb
-- lib/yahoo-placemaker/local_scopes.rb
 - lib/yahoo-placemaker/place.rb
-- lib/yahoo-placemaker/places.rb
 - lib/yahoo-placemaker/reference.rb
-- lib/yahoo-placemaker/reference_list.rb
 - lib/yahoo-placemaker/response.rb
 - lib/yahoo-placemaker/scope.rb
 - lib/yahoo-placemaker/version.rb

data/lib/yahoo-placemaker/centroid.rb

@@ -1,4 +0,0 @@
-require 'yahoo-placemaker/lat_lng'
-
-class Yahoo::Placemaker::Centroid < Yahoo::Placemaker::LatLng
-end

data/lib/yahoo-placemaker/local_scopes.rb

@@ -1,2 +0,0 @@
-class Yahoo::Placemaker::LocalScopes < Array
-end

data/lib/yahoo-placemaker/places.rb

@@ -1,2 +0,0 @@
-class Yahoo::Placemaker::Places < Array
-end

data/lib/yahoo-placemaker/reference_list.rb

@@ -1,3 +0,0 @@
-require 'yahoo-placemaker/reference'
-class Yahoo::Placemaker::ReferenceList < Array
-end