interior 0.8.1 → 0.8.2

data/README.md

@@ -3,13 +3,29 @@ Interior
 
 Township GeoCoder Web Service
 -----------------------------
-This gem uses the GeoCommunicator GeoCoder Web Service provided by the
+Interior uses the GeoCommunicator GeoCoder Web Service provided by the
 [US Department of the Interior] [1]. For detailed documentation on the web service API, consult the
 [Methods, Parameters, and Results PDF] [2].
 
 [1]: http://www.geocommunicator.gov/GeoComm/lsis_home/townshipdecoder/index.htm "US Department of the Interior"
 [2]: http://www.blm.gov/nils/GeoComm/documents/NILS_GeoCommunicator_Web_Services_TGC_Formats.pdf "Methods, Parameters, and Results PDF"
 
+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:
+
+    require 'interior'
+    response = Interior::Geocoder.get_lat_lon('AZ', 14, 1, 'N', 1, 'E', 35)
+    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:
+
+    require 'interior'
+    response = Interior::Geocoder.get_lat_lon('AZ', 14, 1, 'N', 1, 'E') # No section
+    response.latitude    => 33.4211630233451
+    response.longitude   => -112.254699834217
+
 US Meridian Map
 ---------------
 The US is divided into several meridians. A [larger map] [3] and table are available for reference.
@@ -18,6 +34,7 @@ The US is divided into several meridians. A [larger map] [3] and table are avail
 
 [3]: https://github.com/climate/interior/raw/master/maps/meridians.jpg "Larger Map"
 
+
 US Meridian Table
 -----------------
 Each meridian has a corresponding numeric key mapping:

data/lib/interior/geocoder.rb

@@ -16,7 +16,7 @@ module Interior
     # ra     : range
     # ra_dir : range_direction
     # se     : section
-    def self.get_lat_lon(st, me, to, to_dir, ra, ra_dir, se)
+    def self.get_lat_lon(st, me, to, to_dir, ra, ra_dir, se = nil)
       trs    = build_trs_param(st, me, to, to_dir, ra, ra_dir, se)
       xml    = get_response_body(trs)
       result = parse_xml(xml)

data/lib/interior/version.rb

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

data/spec/lib/interior/geocoder_spec.rb

@@ -5,22 +5,32 @@ 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' }
+
     subject { coder.get_lat_lon(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  }
+    context 'with section' do
+      let (:se) { 35 }
 
       it 'returns the correct latitude and longitude' do
         subject.latitude.should  == 33.384549272498
         subject.longitude.should == -112.228362739723
       end
     end
+
+    context 'without section' do
+      let (:se) { nil }
+
+      it 'returns the correct latitude and longitude' do
+        subject.latitude.should  == 33.4211630233451
+        subject.longitude.should == -112.254699834217
+      end
+    end
   end
 
   describe '#build_trs_param' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: interior
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 8
-  - 1
-  version: 0.8.1
+  - 2
+  version: 0.8.2
 platform: ruby
 authors: 
 - Chris Hunt