interior 0.8.2 → 0.8.3

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+
+notifications:
+  recipients: chunt@climate.com

data/README.md

@@ -1,4 +1,4 @@
-Interior
+Interior ![Travis CI Status](https://secure.travis-ci.org/climate/interior.png)
 ========
 
 Township GeoCoder Web Service
@@ -12,19 +12,24 @@ Interior uses the GeoCommunicator GeoCoder Web Service provided by the
 
 Usage
 -----
-Given township `1N`, range `1E`, section `35`, and meridian `14` (see the US Meridian table below, this is the Gila-Salt River meridian), we can get the center point latitude and longitude in the state of Arizona with:
+Given township `1N`, range `1E`, section `35`, and meridian `14` (Gila-Salt Meridian
+in the US Meridian table), we can get the center point latitude and longitude
+in the state of Arizona with:
 
     require 'interior'
     response = Interior::Geocoder.get_lat_lon('AZ', 14, 1, 'N', 1, 'E', 35)
-    response.latitude    => 33.384549272498
-    response.longitude   => -112.228362739723
+    response.success?   => true
+    response.latitude   => 33.384549272498
+    response.longitude  => -112.228362739723
 
-Section is option. If omitted, the centerpoint latitude and longitude will be for the township and range:
+Section is option. If omitted, the centerpoint latitude and longitude will be for
+the township and range:
 
     require 'interior'
     response = Interior::Geocoder.get_lat_lon('AZ', 14, 1, 'N', 1, 'E') # No section
-    response.latitude    => 33.4211630233451
-    response.longitude   => -112.254699834217
+    response.success?   => true
+    response.latitude   => 33.4211630233451
+    response.longitude  => -112.254699834217
 
 US Meridian Map
 ---------------

data/Rakefile

@@ -1,10 +1,22 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-desc 'Default: Run all specs'
-task :default => :spec
+desc 'Default: Run specs'
+task :default => 'spec:fast'
 
 desc "Run all specs"
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = ['--color', '-d']
 end
+
+namespace :spec do
+  desc "Run enemy spec"
+  RSpec::Core::RakeTask.new(:enemy) do |t|
+    t.rspec_opts = ['--color', '-d', '--tag', 'enemy']
+  end
+
+  desc "Run all specs except enemy spec"
+  RSpec::Core::RakeTask.new(:fast) do |t|
+    t.rspec_opts = ['--color', '-d', '--tag', '~enemy']
+  end
+end

data/interior.gemspec

@@ -13,11 +13,12 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "interior"
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = `git ls-files | grep -v maps`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "ruby-debug"
 

data/lib/interior/geocoder.rb

@@ -20,7 +20,7 @@ module Interior
       trs    = build_trs_param(st, me, to, to_dir, ra, ra_dir, se)
       xml    = get_response_body(trs)
       result = parse_xml(xml)
-      result ? Interior::Response.new(result[:lat], result[:lon]) : nil
+      result ? Interior::Response.new(result[:lat], result[:lon], true) : Interior::Response.new
     end
 
     private

data/lib/interior/response.rb

@@ -2,9 +2,14 @@ module Interior
   class Response
     attr_reader :latitude, :longitude
 
-    def initialize(latitude, longitude)
+    def initialize(latitude = nil, longitude = nil, success = false)
       @latitude  = latitude
       @longitude = longitude
+      @success   = success
+    end
+
+    def success?
+      @success
     end
   end
 end

data/lib/interior/version.rb

@@ -1,3 +1,3 @@
 module Interior
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/spec/fixtures/az_invalid_section.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<TownshipGeocoderResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.esri.com/">
+  <CompletionStatus>false</CompletionStatus>
+  <Message>Invalid Township,Range,Section... specified: AZ,14,1,0,N,1,0,E,INVALID,,0</Message>
+</TownshipGeocoderResult>

data/spec/fixtures/az_no_section.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<TownshipGeocoderResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.esri.com/">
+  <CompletionStatus>true</CompletionStatus>
+  <Message>Ok</Message>
+  <Data>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+
+&lt;rss version="2.0" xmlns:georss="http://www.georss.org/georss"&gt;
+&lt;channel&gt;
+&lt;title&gt;Township GeoCoder&lt;/title&gt;
+&lt;item&gt;
+&lt;title&gt;Lat Lon&lt;/title&gt;
+&lt;link&gt;http://www.geocommunicator.gov&lt;/link&gt;
+&lt;description&gt;Latitude(33.4211630233451), Longitude(-112.254699834217)&lt;/description&gt;
+&lt;pubDate&gt;1/18/2012 1:08:10 PM&lt;/pubDate&gt;
+&lt;georss:point&gt;-112.254699834217 33.4211630233451&lt;/georss:point&gt;
+&lt;/item&gt;
+
+&lt;item&gt;&lt;title&gt;Township Range Section&lt;/title&gt;
+&lt;link&gt;http://www.geocommunicator.gov&lt;/link&gt;
+&lt;description&gt;AZ,14,1,0,N,1,0,E,0,,0&lt;/description&gt;
+&lt;pubDate&gt;1/18/2012 1:08:10 PM&lt;/pubDate&gt;
+&lt;georss:polygon&gt;33.465903569199668,-112.20321220653472,33.462309315982509,-112.2032735108433,33.458715016199164,-112.20333483843484,33.455140739851231,-112.20334010040739,33.451566416936942,-112.20334536237994,33.447976377954433,-112.20341409398594,33.444386338971867,-112.2034828488753,33.440796299989358,-112.20355162704749,33.437206237723558,-112.20362038193667,33.433604650341124,-112.20363020738984,33.430003039675569,-112.20364000955993,33.426407552456,-112.20376417814242,33.4228120652362,-112.20388832344173,33.419203213537628,-112.2038964492312,33.415594408405241,-112.20390457502066,33.411993007287094,-112.20390508724807,33.408391582886111,-112.20390555290936,33.404755699549639,-112.20390071003197,33.401119816213395,-112.20389589043765,33.397011519500268,-112.20352035789205,33.392903222787311,-112.20314482534639,33.389017069791805,-112.202928898207,33.385130963362258,-112.20271301763404,33.38124485693271,-112.20249709049477,33.377358727220269,-112.20228120992169,33.377355607289644,-112.2028021452046,33.377352044980796,-112.20661525922719,33.377348040293725,-112.21094930853258,33.3773479937276,-112.21140542376412,33.377333325397046,-112.21530184459107,33.377316934119563,-112.21965433408337,33.377315932947795,-112.22005654902097,33.377313464942972,-112.22295871314896,33.3773114858825,-112.22400412274044,33.377309949200253,-112.22473576975597,33.377309762935738,-112.22508655240432,33.377309134293,-112.22616916833266,33.37730785372446,-112.22833437690628,33.377306363608341,-112.22906648958326,33.377305152888994,-112.23266758802146,33.377303662772874,-112.23339967741526,33.3773024054874,-112.23700079913635,33.377300938654344,-112.23773309807802,33.377296095776956,-112.24132518597031,33.377294489245514,-112.24205788072362,33.377289646368126,-112.24564782657399,33.377288039836685,-112.24638480541148,33.3772831969593,-112.24997042061182,33.377281543861727,-112.25070958805719,33.377276747550468,-112.25429306121549,33.377274931471447,-112.25503746735063,33.377269250403742,-112.25861414185431,33.377267434324722,-112.25935184246646,33.377261706690888,-112.26293498966203,33.377259890611867,-112.26366838290761,33.377254162978033,-112.26725588403616,33.377252393465142,-112.26798275802355,33.377246665831308,-112.27157675512694,33.377244873035352,-112.27229960114448,33.37723851675878,-112.27589725368904,33.377236700679759,-112.27661970389414,33.377230344403188,-112.28021735643881,33.377228528324167,-112.28094197196907,33.377222172047595,-112.28453745918876,33.377220355968575,-112.2852620747189,33.377213999692,-112.28885758522148,33.377211880933146,-112.28958573977769,33.377202497858036,-112.29318402096499,33.377200542080629,-112.29391168657651,33.377191112439561,-112.29750994448085,33.377189179945219,-112.29823758680948,33.377177142600942,-112.30182969798483,33.377175093691278,-112.30255626929238,33.3771694591897,-112.30441809953703,33.377168108771968,-112.30492422679089,33.377164360198606,-112.30614251313534,33.380698892355724,-112.30614735601273,33.380822548710739,-112.30614765869257,33.384483507907476,-112.30615336304334,33.388116620559288,-112.30615587761429,33.391749733210872,-112.30615839218524,33.395349644212729,-112.30616065064248,33.398949555214756,-112.30616288581666,33.40254986202865,-112.30616598246422,33.406150192125665,-112.30616907911178,33.409782420020974,-112.30619832264091,33.41341464791617,-112.30622754288669,33.417047341472767,-112.30625867234375,33.420680011746356,-112.30628982508392,33.424420505891021,-112.30621725177224,33.42816100003563,-112.30614472502646,33.431818490055832,-112.30626225793571,33.435475980075978,-112.30637981412781,33.439042689428049,-112.30639236369956,33.442609398780064,-112.30640491327125,33.446176084849071,-112.30641743955988,33.449742770918022,-112.30642996584862,33.453320539725667,-112.30642523938656,33.456898308533255,-112.30642046635825,33.460500152029624,-112.30641811476875,33.464101995525823,-112.30641576317925,33.464169632827975,-112.30268309214426,33.464260576477386,-112.29835511971857,33.464347399024575,-112.29404800891865,33.4644341982887,-112.28974089811879,33.464514292030117,-112.28543315867614,33.464594339205576,-112.28112541923355,33.464671359582496,-112.27681847141508,33.464748403242652,-112.27251154687957,33.464825982413288,-112.26813996527443,33.464903538300689,-112.26376838366917,33.464981094188261,-112.25939680206403,33.465058650075889,-112.25502522045878,33.465126194245613,-112.25071738788375,33.465193715132443,-112.24640957859208,33.465407593361874,-112.24212670546217,33.465621471591476,-112.23784378576619,33.465556767955604,-112.23351064450031,33.465492064319562,-112.22917752651739,33.465583380498174,-112.22487074168038,33.465674696676615,-112.22056393356036,33.465720121935362,-112.216255216229,33.465765547193939,-112.21194652218077,33.465834558196889,-112.20757936435768,33.465903569199668,-112.20321220653472&lt;/georss:polygon&gt;
+&lt;/item&gt;&lt;/channel&gt;&lt;/rss&gt;</Data>
+</TownshipGeocoderResult>

data/spec/lib/interior/geocoder_spec.rb

@@ -4,60 +4,102 @@ require 'interior/geocoder.rb'
 describe Interior::Geocoder do
   let(:coder) { Interior::Geocoder }
 
-  describe '#get_lat_lon' do
-    let (:st)     { 'AZ' }
-    let (:me)     {  14  }
-    let (:to)     {  1   }
-    let (:to_dir) {  'N' }
-    let (:ra)     {  1   }
-    let (:ra_dir) {  'E' }
+  let(:st)     { 'AZ' }
+  let(:me)     {  14  }
+  let(:to)     {  1   }
+  let(:to_dir) {  'N' }
+  let(:ra)     {  1   }
+  let(:ra_dir) {  'E' }
+  let(:se)     {  35  }
+
+  # Full integration enemy test
+  describe 'enemy_test', :enemy => true do
+    subject do
+      coder.get_lat_lon(st, me, to, to_dir, ra, ra_dir, se)
+    end
 
-    subject { coder.get_lat_lon(st, me, to, to_dir, ra, ra_dir, se) }
+    it 'returns correct response' do
+      subject.success?.should  == true
+      subject.latitude.should  == 33.384549272498
+      subject.longitude.should == -112.228362739723
+    end
+  end
+
+  describe '#get_lat_lon' do
+    subject do
+      # use xml fixtures for interior web service
+      Net::HTTP.stub(:get_response => double('response', :body => body))
+      coder.get_lat_lon(st, me, to, to_dir, ra, ra_dir, se)
+    end
 
     context 'with section' do
-      let (:se) { 35 }
+      let(:body) { File.open('spec/fixtures/az.xml').read }
 
-      it 'returns the correct latitude and longitude' do
+      it 'returns successful response' do
+        subject.success?.should == true
+      end
+
+      it 'returns correct latitude' do
         subject.latitude.should  == 33.384549272498
+      end
+
+      it 'returns correct longitude' do
         subject.longitude.should == -112.228362739723
       end
     end
 
     context 'without section' do
-      let (:se) { nil }
+      let(:se)   { nil }
+      let(:body) { File.open('spec/fixtures/az_no_section.xml').read }
 
-      it 'returns the correct latitude and longitude' do
+      it 'returns successful response' do
+        subject.success?.should == true
+      end
+
+      it 'returns correct latitude' do
         subject.latitude.should  == 33.4211630233451
+      end
+
+      it 'returns correct longitude' do
         subject.longitude.should == -112.254699834217
       end
     end
+
+    context 'with invalid parameters' do
+      let(:se)   { 'INVALID' }
+      let(:body) { File.open('spec/fixtures/az_invalid_section.xml').read }
+
+      it 'returns unsuccessful response' do
+        subject.success?.should == false
+      end
+
+      it 'returns nil for latitude' do
+        subject.latitude.should  == nil
+      end
+
+      it 'returns nil for longitude' do
+        subject.longitude.should == nil
+      end
+    end
   end
 
   describe '#build_trs_param' do
     subject { coder.send(:build_trs_param, st, me, to, to_dir, ra, ra_dir, se) }
 
     context 'when in Arizona' do
-      let (:st)     { 'AZ' }
-      let (:me)     {  14  }
-      let (:to)     {  1   }
-      let (:to_dir) {  'N' }
-      let (:ra)     {  1   }
-      let (:ra_dir) {  'E' }
-      let (:se)     {  35  }
-
       it 'returns the correct trs param' do
         subject.should == "AZ,14,1,0,N,1,0,E,35,,0"
       end
     end
 
     context 'when in Colorado' do
-      let (:st)     { 'CO' }
-      let (:me)     {  06  }
-      let (:to)     {  1   }
-      let (:to_dir) {  'S' }
-      let (:ra)     {  68  }
-      let (:ra_dir) {  'W' }
-      let (:se)     {  16  }
+      let(:st)     { 'CO' }
+      let(:me)     {  06  }
+      let(:to)     {  1   }
+      let(:to_dir) {  'S' }
+      let(:ra)     {  68  }
+      let(:ra_dir) {  'W' }
+      let(:se)     {  16  }
 
       it 'returns the correct trs param' do
         subject.should == "CO,6,1,0,S,68,0,W,16,,0"
@@ -65,13 +107,7 @@ describe Interior::Geocoder do
     end
 
     context 'when missing section' do
-      let (:st)     { 'AZ' }
-      let (:me)     {  14  }
-      let (:to)     {  1   }
-      let (:to_dir) {  'N' }
-      let (:ra)     {  1   }
-      let (:ra_dir) {  'E' }
-      let (:se)     {  nil }
+      let(:se) { nil }
 
       it 'defaults to section 0' do
         subject.should == "AZ,14,1,0,N,1,0,E,0,,0"

data/spec/lib/interior/response_spec.rb

@@ -4,7 +4,23 @@ require 'interior/response.rb'
 describe Interior::Response do
   let(:latitude)  { 30 }
   let(:longitude) { 60 }
-  let(:response)  { Interior::Response.new(latitude, longitude) }
+  let(:success)   { true }
+  let(:response)  { Interior::Response.new(latitude, longitude, success) }
+
+  describe('#success?') do
+    it 'defaults to false' do
+      Interior::Response.new.success?.should == false
+    end
+
+    it 'can be initialized' do
+      response.success?.should == true
+    end
+
+    it 'is readonly' do
+      lambda { response.success = false }.should raise_error
+    end
+
+  end
 
   describe('#latitude') do
     it 'can be initialized' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: interior
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 57
   prerelease: 
   segments: 
   - 0
   - 8
-  - 2
-  version: 0.8.2
+  - 3
+  version: 0.8.3
 platform: ruby
 authors: 
 - Chris Hunt
@@ -18,7 +18,7 @@ cert_chain: []
 date: 2012-01-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -32,7 +32,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,7 +46,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: ruby-debug
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,8 +57,22 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Find the center latitude/longitude for any grid in the PLSS given township, range, and section.
 email: 
 - chunt@climate.com
@@ -71,6 +85,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -79,9 +94,9 @@ files:
 - lib/interior/geocoder.rb
 - lib/interior/response.rb
 - lib/interior/version.rb
-- maps/meridians.jpg
-- maps/meridians_small.jpg
 - spec/fixtures/az.xml
+- spec/fixtures/az_invalid_section.xml
+- spec/fixtures/az_no_section.xml
 - spec/fixtures/co.xml
 - spec/lib/interior/geocoder_spec.rb
 - spec/lib/interior/response_spec.rb
@@ -121,6 +136,8 @@ specification_version: 3
 summary: Convert PLSS to latitude and longitude
 test_files: 
 - spec/fixtures/az.xml
+- spec/fixtures/az_invalid_section.xml
+- spec/fixtures/az_no_section.xml
 - spec/fixtures/co.xml
 - spec/lib/interior/geocoder_spec.rb
 - spec/lib/interior/response_spec.rb