yahoo-placemaker 0.0.5 → 0.0.6

data/lib/yahoo-placemaker.rb

@@ -1,56 +1 @@
-require "yahoo-placemaker/response"
-require "yahoo-placemaker/exception"
-require "yahoo-placemaker/version"
-
-require "json"
-require "net/http"
-
-module Yahoo
-  module Placemaker
-
-    # Main method for interacting w/ the Yahoo! Placemaker API
-
-    def self.extract (text = '', options = {})
-
-      unless defined?(Yahoo::Placemaker::APP_ID)
-        raise Yahoo::Placemaker::Exception.new("Invalid APP_ID")
-      end
-
-      result = nil
-      host = 'wherein.yahooapis.com'
-
-      # These options need to be explicitly set!
-      options['documentContent'] = text
-      options['appid'] = Yahoo::Placemaker::APP_ID
-      options['outputType'] = 'json'
-      options['documentType'] = 'text/plain'
-
-      req = ::Net::HTTP::Post.new('/v1/document')
-      req.body = to_url_params(options)
-      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
-
-      result
-
-    end
-
-    private
-
-    # 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
-end
+require 'yahoo/placemaker'

data/lib/yahoo/placemaker.rb

@@ -0,0 +1,56 @@
+require "yahoo/placemaker/response"
+require "yahoo/placemaker/exception"
+require "yahoo/placemaker/version"
+
+require "json"
+require "net/http"
+
+module Yahoo
+  module Placemaker
+
+    # Main method for interacting w/ the Yahoo! Placemaker API
+
+    def self.extract (text = '', options = {})
+
+      unless defined?(Yahoo::Placemaker::APP_ID)
+        raise Yahoo::Placemaker::Exception.new("Invalid APP_ID")
+      end
+
+      result = nil
+      host = 'wherein.yahooapis.com'
+
+      # These options need to be explicitly set!
+      options['documentContent'] = text
+      options['appid'] = Yahoo::Placemaker::APP_ID
+      options['outputType'] = 'json'
+      options['documentType'] = 'text/plain'
+
+      req = ::Net::HTTP::Post.new('/v1/document')
+      req.body = to_url_params(options)
+      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
+
+      result
+
+    end
+
+    private
+
+    # 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
+end

data/lib/yahoo/placemaker/administrative_scope.rb

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

data/lib/yahoo/placemaker/ancestor.rb

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

data/lib/{yahoo-placemaker → yahoo/placemaker}/document.rb

@@ -1,11 +1,13 @@
-require 'yahoo-placemaker/geographic_scope'
-require 'yahoo-placemaker/local_scope'
-require 'yahoo-placemaker/administrative_scope'
-require 'yahoo-placemaker/reference'
-require 'yahoo-placemaker/extents'
-require 'yahoo-placemaker/place'
+require 'yahoo/placemaker/geographic_scope'
+require 'yahoo/placemaker/local_scope'
+require 'yahoo/placemaker/administrative_scope'
+require 'yahoo/placemaker/reference'
+require 'yahoo/placemaker/extents'
+require 'yahoo/placemaker/place'
 
-class Yahoo::Placemaker::Document
+module Yahoo
+  module Placemaker
+    class Document
   attr_accessor :administrative_scope, :geographic_scope, :local_scopes, :references, :extents, :places
   def initialize(json)
 
@@ -69,5 +71,7 @@ class Yahoo::Placemaker::Document
       end
     end
 
+  end
+    end
   end
 end

data/lib/yahoo/placemaker/exception.rb

@@ -0,0 +1,6 @@
+module Yahoo
+  module Placemaker
+    class Exception < Exception
+    end
+  end
+end

data/lib/yahoo/placemaker/extents.rb

@@ -0,0 +1,17 @@
+require 'yahoo/placemaker/lat_lng'
+
+module Yahoo
+  module Placemaker
+    class 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
+  end
+end

data/lib/yahoo/placemaker/geographic_scope.rb

@@ -0,0 +1,8 @@
+require 'yahoo/placemaker/scope'
+
+module Yahoo
+  module Placemaker
+    class GeographicScope < Yahoo::Placemaker::Scope
+    end
+  end
+end

data/lib/yahoo/placemaker/lat_lng.rb

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

data/lib/yahoo/placemaker/local_scope.rb

@@ -0,0 +1,33 @@
+require 'yahoo/placemaker/scope'
+require 'yahoo/placemaker/ancestor'
+
+module Yahoo
+  module Placemaker
+    class LocalScope < Yahoo::Placemaker::Scope
+
+      attr_accessor :ancestors, :centroid, :south_west, :north_east
+
+      def initialize (json)
+        super(json)
+        @centroid = Yahoo::Placemaker::LatLng.new json['centroid']
+        @south_west = Yahoo::Placemaker::LatLng.new json['southWest']
+        @north_east = Yahoo::Placemaker::LatLng.new json['northEast']
+
+        # Yahoo doesn't always return an array of ancestors; ancestors can
+        # be an array, a hash, or a string containing "\n"?! We need to
+        # account for this and stuff everything into @ancestors...
+
+        @ancestors = Array.new
+        if json['ancestors'].class == Array
+          json['ancestors'].each do |ancestor|
+            @ancestors << Yahoo::Placemaker::Ancestor.new(ancestor['ancestor'])
+          end
+        elsif json['ancestors'].class == Hash
+            @ancestors << Yahoo::Placemaker::Ancestor.new(json['ancestors']['ancestor'])
+        else
+          # no ancestors...country?
+        end
+      end
+    end
+  end
+end

data/lib/yahoo/placemaker/place.rb

@@ -0,0 +1,25 @@
+require 'yahoo/placemaker/lat_lng'
+
+module Yahoo
+  module Placemaker
+    class 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::LatLng.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
+  end
+end

data/lib/yahoo/placemaker/reference.rb

@@ -0,0 +1,19 @@
+module Yahoo
+  module Placemaker
+    class 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'].to_i
+        @start = json['start'].to_i
+        @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
+  end
+end

data/lib/yahoo/placemaker/response.rb

@@ -0,0 +1,14 @@
+require 'yahoo/placemaker/document'
+
+module Yahoo
+  module Placemaker
+    class 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
+  end
+end

data/lib/yahoo/placemaker/scope.rb

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

data/lib/{yahoo-placemaker → yahoo/placemaker}/version.rb

@@ -1,5 +1,5 @@
 module Yahoo
   module Placemaker
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/spec/lat_lng_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Yahoo::Placemaker::LatLng do
+
+  it "returns the latitude" do
+    stub = { :latitude => 0.0, :longitude => 0.0 }
+    ll = Yahoo::Placemaker::LatLng.new stub
+    ll.latitude.should == 0.0
+  end
+
+  it "returns the longitude" do
+    stub = { :latitude => 0.0, :longitude => 0.0 }
+    ll = Yahoo::Placemaker::LatLng.new stub
+    ll.longitude.should == 0.0
+  end
+end

data/spec/reference_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Yahoo::Placemaker::Reference do
+  it "returns text" do
+  end
+end

data/spec/yahoo_placemaker_spec.rb

@@ -43,5 +43,4 @@ describe Yahoo::Placemaker do
         response.document.geographic_scope.should == nil
     end
   end
-
 end

data/yahoo-placemaker.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "yahoo-placemaker/version"
+require "yahoo/placemaker/version"
 
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo-placemaker
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70294204088140 !ruby/object:Gem::Requirement
+  requirement: &70155972433600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70294204088140
+  version_requirements: *70155972433600
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70294204087600 !ruby/object:Gem::Requirement
+  requirement: &70155972433000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70294204087600
+  version_requirements: *70155972433000
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70294204087020 !ruby/object:Gem::Requirement
+  requirement: &70155972432000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70294204087020
+  version_requirements: *70155972432000
 description: Easily interact w/ the Yahoo Placemaker API
 email:
 - kyle.decot@me.com
@@ -58,20 +58,23 @@ files:
 - README.markdown
 - Rakefile
 - lib/yahoo-placemaker.rb
-- lib/yahoo-placemaker/administrative_scope.rb
-- lib/yahoo-placemaker/ancestor.rb
-- lib/yahoo-placemaker/config.rb
-- lib/yahoo-placemaker/document.rb
-- lib/yahoo-placemaker/exception.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/place.rb
-- lib/yahoo-placemaker/reference.rb
-- lib/yahoo-placemaker/response.rb
-- lib/yahoo-placemaker/scope.rb
-- lib/yahoo-placemaker/version.rb
+- lib/yahoo/placemaker.rb
+- lib/yahoo/placemaker/administrative_scope.rb
+- lib/yahoo/placemaker/ancestor.rb
+- lib/yahoo/placemaker/config.rb
+- lib/yahoo/placemaker/document.rb
+- lib/yahoo/placemaker/exception.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/place.rb
+- lib/yahoo/placemaker/reference.rb
+- lib/yahoo/placemaker/response.rb
+- lib/yahoo/placemaker/scope.rb
+- lib/yahoo/placemaker/version.rb
+- spec/lat_lng_spec.rb
+- spec/reference_spec.rb
 - spec/spec_helper.rb
 - spec/yahoo_placemaker_spec.rb
 - yahoo-placemaker.gemspec
@@ -100,5 +103,7 @@ signing_key:
 specification_version: 3
 summary: Easily interact w/ the Yahoo Placemaker API
 test_files:
+- spec/lat_lng_spec.rb
+- spec/reference_spec.rb
 - spec/spec_helper.rb
 - spec/yahoo_placemaker_spec.rb

data/lib/yahoo-placemaker/administrative_scope.rb

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

data/lib/yahoo-placemaker/ancestor.rb

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

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

data/lib/yahoo-placemaker/extents.rb

@@ -1,13 +0,0 @@
-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

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

data/lib/yahoo-placemaker/lat_lng.rb

@@ -1,7 +0,0 @@
-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

@@ -1,24 +0,0 @@
-require 'yahoo-placemaker/scope'
-require 'yahoo-placemaker/ancestor'
-
-class Yahoo::Placemaker::LocalScope < Yahoo::Placemaker::Scope
-
-  attr_accessor :ancestors, :centroid, :south_west, :north_east
-
-  def initialize (json)
-    super(json)
-    @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
-    if json['ancestors'].class == Array
-      json['ancestors'].each do |ancestor|
-        @ancestors << Yahoo::Placemaker::Ancestor.new(ancestor['ancestor'])
-      end
-    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,21 +0,0 @@
-require 'yahoo-placemaker/lat_lng'
-
-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::LatLng.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/reference.rb

@@ -1,16 +0,0 @@
-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'].to_i
-    @start = json['start'].to_i
-    @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/response.rb

@@ -1,10 +0,0 @@
-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

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