yahoo-placemaker 0.0.2 → 0.0.3

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .DS_Store
 .bundle
+spec/fixtures/*
 Gemfile.lock
 pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
-
-# Specify your gem's dependencies in yahoo-placemaker.gemspec
 gemspec
+
+gem 'rake', '>= 0.8.7'
+gem 'json'

data/README.markdown

@@ -2,13 +2,22 @@
 
 `yahoo-placemaker` is a rubygem that allows for easy interaction w/ the [Yahoo Placemaker](http://developer.yahoo.com/geo/placemaker) API.
 
+## Build Status
 
-## Examples
+![Build Status](https://secure.travis-ci.org/kyledecot/yahoo-placemaker.png)
+
+## Installation
+
+    gem install yahoo-placemaker
+
+## Usage
 
     require 'yahoo-placemaker'
-    Yahoo::Placemaker.APP_ID = 'xxxx'
-    place = Yahoo::Placemaker.extact "Columbus Ohio is my hometown"
+    Yahoo::Placemaker::APP_ID = 'xxxx'
+    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
     
 ## Contributing
 
-I am by not means a Ruby guru so if you have seen something that I have done incorrectly or that could be improved please feel free to contribute some code!h
+I am by not means a Ruby guru so if you have seen something that I have done incorrectly or that could be improved please feel free to contribute some code.

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/yahoo-placemaker/administrative_scope.rb

@@ -0,0 +1,4 @@
+require 'yahoo-placemaker/scope'
+
+class Yahoo::Placemaker::AdministrativeScope < Yahoo::Placemaker::Scope
+end

data/lib/yahoo-placemaker/ancestor.rb

@@ -0,0 +1,11 @@
+class Yahoo::Placemaker::Ancestor
+
+  attr_accessor :woe_id, :type, :name
+
+  def initialize (json)
+    @woe_id = json['woeId']
+    @type = json['type']
+    @name = json['name']
+  end
+
+end

data/lib/yahoo-placemaker/centroid.rb

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

data/lib/yahoo-placemaker/document.rb

@@ -0,0 +1,67 @@
+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
+  def initialize(json)
+
+    if json['administrativeScope']
+      @administrative_scope = json['administrativeScope']
+    end
+
+    if json['geographicScope']
+      @geographic_scope = Yahoo::Placemaker::GeographicScope.new(json['geographicScope'])
+    end
+
+    if json['administrativeScope']
+      @administrative_scope = Yahoo::Placemaker::AdministrativeScope.new(json['administrativeScope'])
+    end
+
+    @places = Yahoo::Placemaker::Places.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
+    # is in numeric keys so we'll search for them and pull them out
+
+    if json.has_key? 'placeDetails'
+        @places << Yahoo::Placemaker::Place.new(json['placeDetails'])
+    else
+      (json.map{ |k,v| k =~ /^[\d]+$/ ? v : nil }).compact.each do |place|
+        @places << Yahoo::Placemaker::Place.new(place['placeDetails'])
+      end
+    end
+
+    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'])
+        end
+      else
+          @local_scopes << Yahoo::Placemaker::LocalScope.new(json['localScopes']['localScope'])
+      end
+    end
+
+    if json['extents']
+      @extents = Yahoo::Placemaker::Extents.new(json['extents'])
+    end
+
+    @reference_list = Yahoo::Placemaker::ReferenceList.new
+    if json['referenceList']
+      if json['referenceList'].class == Array
+        json['referenceList'].each do |reference|
+          @reference_list << Yahoo::Placemaker::Reference.new(reference)
+        end
+      else
+        @reference_list << Yahoo::Placemaker::Reference.new(json['referenceList'])
+      end
+    end
+
+  end
+end

data/lib/yahoo-placemaker/extents.rb

@@ -0,0 +1,13 @@
+require 'yahoo-placemaker/lat_lng'
+
+class Yahoo::Placemaker::Extents
+
+  attr_accessor :center, :south_west, :north_east
+
+  def initialize (json)
+    @center = Yahoo::Placemaker::LatLng.new(json['center'])
+    @south_west = Yahoo::Placemaker::LatLng.new(json['southWest'])
+    @north_east = Yahoo::Placemaker::LatLng.new(json['northEast'])
+  end
+
+end

data/lib/yahoo-placemaker/geographic_scope.rb

@@ -0,0 +1,11 @@
+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/lat_lng.rb

@@ -0,0 +1,7 @@
+class Yahoo::Placemaker::LatLng
+  attr_accessor :latitude, :longitude
+  def initialize(json)
+    @latitude = json['latitude'].to_f
+    @longitude = json['longitude'].to_f
+  end
+end

data/lib/yahoo-placemaker/local_scope.rb

@@ -0,0 +1,23 @@
+require 'yahoo-placemaker/scope'
+require 'yahoo-placemaker/ancestor'
+require 'yahoo-placemaker/centroid'
+
+class Yahoo::Placemaker::LocalScope < Yahoo::Placemaker::Scope
+
+  attr_accessor :ancestors, :centroid, :south_west, :north_east
+
+  def initialize (json)
+    super(json)
+    @centroid = Yahoo::Placemaker::Centroid.new json['centroid']
+    @south_west = Yahoo::Placemaker::LatLng.new json['southWest']
+    @north_east = Yahoo::Placemaker::LatLng.new json['northEast']
+    @ancestors = Array.new
+    if json['ancestors'].class == Array
+      json['ancestors'].each do |ancestor|
+        @ancestors << Yahoo::Placemaker::Ancestor.new(ancestor['ancestor'])
+      end
+    else
+        @ancestors << Yahoo::Placemaker::Ancestor.new(json['ancestors']['ancestor'])
+    end
+  end
+end

data/lib/yahoo-placemaker/local_scopes.rb

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

data/lib/yahoo-placemaker/place.rb

@@ -0,0 +1,21 @@
+require 'yahoo-placemaker/centroid'
+
+class Yahoo::Placemaker::Place
+
+  attr_accessor :place_id, :match_type, :place_reference_ids, :weight, :confidence
+  attr_accessor :centroid, :type, :woe_id, :name
+
+  def initialize(json)
+
+    @place_id = json['placeId']
+    @centroid = Yahoo::Placemaker::Centroid.new json['place']['centroid']
+    @type = json['place']['type']
+    @woe_id = json['place']['woeId']
+    @name = json['place']['name']
+
+    @match_type = json['matchType']
+    @place_reference_ids = json['placeReferenceIds']
+    @weight = json['weight'].to_i
+    @confidence = json['confidence'].to_i
+  end
+end

data/lib/yahoo-placemaker/places.rb

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

data/lib/yahoo-placemaker/reference.rb

@@ -0,0 +1,16 @@
+class Yahoo::Placemaker::Reference
+  attr_accessor :woe_ids, :end, :start, :place_reference_id, :place_ids, :text, :type, :xpath, :is_plaintext_marker
+
+  def initialize(json)
+    @woe_ids = json['woeIds']
+    @end = json['end']
+    @start = json['start']
+    @place_reference_id = json['placeReferenceId']
+    @place_ids = json['placeIds']
+    @text = json['text']
+    @type = json['type']
+    @xpath = json['xpath']
+    @is_plaintext_marker = json['isPlaintextMarker']
+  end
+
+end

data/lib/yahoo-placemaker/reference_list.rb

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

data/lib/yahoo-placemaker/response.rb

@@ -0,0 +1,10 @@
+require 'yahoo-placemaker/document'
+
+class Yahoo::Placemaker::Response
+  attr_accessor :document, :version, :processing_time
+  def initialize (json)
+    @document = Yahoo::Placemaker::Document.new(json['document'])
+    @version = json['version']
+    @processing_time = json['processingTime']
+  end
+end

data/lib/yahoo-placemaker/scope.rb

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

data/lib/yahoo-placemaker/version.rb

@@ -1,5 +1,5 @@
 module Yahoo
   module Placemaker
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/yahoo-placemaker.rb

@@ -1,6 +1,8 @@
 require "yahoo-placemaker/version"
+require "yahoo-placemaker/response"
+require "yahoo-placemaker/version"
+
 require "json"
-require "ostruct"
 require "net/http"
 
 module Yahoo
@@ -22,7 +24,9 @@ module Yahoo
         http.request(req)
       end
       json = ::JSON.parse(response.body)
-      OpenStruct.new(json)
+
+      Yahoo::Placemaker::Response.new(json)
+
     end
 
       private

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'vcr'
+require 'fakeweb'
+require 'yahoo-placemaker'
+
+Yahoo::Placemaker::APP_ID = 'xxx'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures'
+  c.stub_with :fakeweb
+end
+
+RSpec.configure do |config|
+end

data/spec/yahoo_placemaker_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Yahoo::Placemaker do
+
+  it "determines we're talking about 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
+  end
+
+  it "returns an administrative scope of 'United States' when given a string of text w/ two US locations" do
+      VCR.use_cassette('columbus ohio miami florida') do
+      response = Yahoo::Placemaker.extract "columbus ohio miami florida"
+      response.document.administrative_scope.name.should == "United States"
+    end
+  end
+
+  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
+    end
+  end
+
+end

data/yahoo-placemaker.gemspec

@@ -3,6 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 require "yahoo-placemaker/version"
 
 Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
   s.name        = "yahoo-placemaker"
   s.version     = Yahoo::Placemaker::VERSION
   s.authors     = ["Kyle Decot"]
@@ -18,7 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-end
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "vcr"
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo-placemaker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000Z
-dependencies: []
+date: 2012-02-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70211849137140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211849137140
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70211849136500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211849136500
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70211849135540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211849135540
 description: Easily interact w/ the Yahoo Placemaker API
 email:
 - kyle.decot@me.com
@@ -18,13 +51,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gemtest
 - .gitignore
+- .rspec
 - Gemfile
 - README.markdown
 - Rakefile
 - 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
+- spec/spec_helper.rb
+- spec/yahoo_placemaker_spec.rb
 - yahoo-placemaker.gemspec
 homepage: ''
 licenses: []
@@ -50,4 +102,6 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Easily interact w/ the Yahoo Placemaker API
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yahoo_placemaker_spec.rb