interior 0.8.3 → 0.9.0

data/README.md

@@ -10,8 +10,8 @@ Interior uses the GeoCommunicator GeoCoder Web Service provided by the
 [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
------
+Usage: Get Latitude / Longitude
+-------------------------------
 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:
@@ -22,6 +22,8 @@ in the state of Arizona with:
     response.latitude   => 33.384549272498
     response.longitude  => -112.228362739723
 
+![Usage Map 1](https://github.com/climate/interior/raw/master/maps/usage_map_01.png "Usage Map 1")
+
 Section is option. If omitted, the centerpoint latitude and longitude will be for
 the township and range:
 
@@ -31,6 +33,19 @@ the township and range:
     response.latitude   => 33.4211630233451
     response.longitude  => -112.254699834217
 
+![Usage Map 2](https://github.com/climate/interior/raw/master/maps/usage_map_02.png "Usage Map 2")
+
+Usage: Get Meridians
+--------------------
+For a collection of all meridians in Arizona:
+
+    require 'interior'
+    meridians = Interior::Geocoder.get_meridians('AZ')
+    meridians.inspect
+      => [ { :name => 'Gila-Salt River', :id => 14 },
+           { :name => 'Navajo',          :id => 22 },
+           { :name => 'San Bernardino',  :id => 27 } ]
+
 US Meridian Map
 ---------------
 The US is divided into several meridians. A [larger map] [3] and table are available for reference.
@@ -39,7 +54,6 @@ 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:
@@ -49,13 +63,14 @@ Each meridian has a corresponding numeric key mapping:
     <th>State</th>
     <th>Meridian</th>
     <th>Code</th>
+    <th>State</th>
+    <th>Meridian</th>
+    <th>Code</th>
   </tr>
   <tr>
     <td>AL</td>
     <td>HUNTSVILLE MER</td>
     <td>16</td>
-  </tr>
-  <tr>
     <td>AL</td>
     <td>ST. STEPHENS MER</td>
     <td>25</td>
@@ -64,8 +79,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>AL</td>
     <td>TALLAHASEE MER</td>
     <td>29</td>
-  </tr>
-  <tr>
     <td>AR</td>
     <td>5TH PM</td>
     <td>05</td>
@@ -74,8 +87,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>AZ</td>
     <td>GILA-SALT RIVER MER</td>
     <td>14</td>
-  </tr>
-  <tr>
     <td>AZ</td>
     <td>NAVAJO MER</td>
     <td>22</td>
@@ -84,8 +95,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>AZ</td>
     <td>SAN BERNARDINO MER</td>
     <td>27</td>
-  </tr>
-  <tr>
     <td>CA</td>
     <td>GILA-SALT RIVER MER</td>
     <td>14</td>
@@ -94,8 +103,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>CA</td>
     <td>HUMBOLDT MER</td>
     <td>15</td>
-  </tr>
-  <tr>
     <td>CA</td>
     <td>MOUNT DIABLO MER</td>
     <td>21</td>
@@ -104,8 +111,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>CA</td>
     <td>SAN BERNARDINO MER</td>
     <td>27</td>
-  </tr>
-  <tr>
     <td>CO</td>
     <td>6TH PM</td>
     <td>06</td>
@@ -114,8 +119,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>CO</td>
     <td>NEW MEX PM</td>
     <td>23</td>
-  </tr>
-  <tr>
     <td>CO</td>
     <td>UTE MER</td>
     <td>31</td>
@@ -124,8 +127,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>CT</td>
     <td>CONNECTICUT</td>
     <td>CT</td>
-  </tr>
-  <tr>
     <td>DE</td>
     <td>DELAWARE</td>
     <td>DE</td>
@@ -134,8 +135,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>FL</td>
     <td>TALLAHASEE MER</td>
     <td>29</td>
-  </tr>
-  <tr>
     <td>GA</td>
     <td>GEORGIA</td>
     <td>GA</td>
@@ -144,8 +143,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>IA</td>
     <td>5TH PM</td>
     <td>05</td>
-  </tr>
-  <tr>
     <td>ID</td>
     <td>BOISE MER</td>
     <td>08</td>
@@ -154,8 +151,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>IL</td>
     <td>2ND PM</td>
     <td>02</td>
-  </tr>
-  <tr>
     <td>IL</td>
     <td>3RD PM</td>
     <td>03</td>
@@ -164,8 +159,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>IL</td>
     <td>4TH PM ILLINOIS</td>
     <td>04</td>
-  </tr>
-  <tr>
     <td>IN</td>
     <td>1ST PM</td>
     <td>01</td>
@@ -174,8 +167,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>IN</td>
     <td>2ND PM</td>
     <td>02</td>
-  </tr>
-  <tr>
     <td>KS</td>
     <td>6TH PM</td>
     <td>06</td>
@@ -184,8 +175,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>KY</td>
     <td>KENTUCKY</td>
     <td>KY</td>
-  </tr>
-  <tr>
     <td>LA</td>
     <td>LOUISIANA MER</td>
     <td>18</td>
@@ -194,8 +183,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>LA</td>
     <td>ST. HELENA MER</td>
     <td>24</td>
-  </tr>
-  <tr>
     <td>MA</td>
     <td>MASSACHUSETS</td>
     <td>MA</td>
@@ -204,8 +191,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MD</td>
     <td>MARYLAND</td>
     <td>MD</td>
-  </tr>
-  <tr>
     <td>ME</td>
     <td>MAINE</td>
     <td>ME</td>
@@ -214,8 +199,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MI</td>
     <td>MICHIGAN MER</td>
     <td>19</td>
-  </tr>
-  <tr>
     <td>MN</td>
     <td>5TH PM</td>
     <td>05</td>
@@ -224,8 +207,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MN</td>
     <td>4TH PM MN-WI</td>
     <td>46</td>
-  </tr>
-  <tr>
     <td>MO</td>
     <td>5TH PM</td>
     <td>05</td>
@@ -234,8 +215,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MS</td>
     <td>CHICKASAW MER</td>
     <td>09</td>
-  </tr>
-  <tr>
     <td>MS</td>
     <td>CHOCTAW MER</td>
     <td>10</td>
@@ -244,8 +223,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MS</td>
     <td>HUNTSVILLE MER</td>
     <td>16</td>
-  </tr>
-  <tr>
     <td>MS</td>
     <td>ST. STEPHENS MER</td>
     <td>25</td>
@@ -254,8 +231,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>MS</td>
     <td>WASHINGTON MER</td>
     <td>32</td>
-  </tr>
-  <tr>
     <td>MT</td>
     <td>PRIN MER, MT</td>
     <td>20</td>
@@ -264,8 +239,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>NC</td>
     <td>NO CAROLINA</td>
     <td>NC</td>
-  </tr>
-  <tr>
     <td>ND</td>
     <td>5TH PM</td>
     <td>05</td>
@@ -274,8 +247,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>NE</td>
     <td>6TH PM</td>
     <td>06</td>
-  </tr>
-  <tr>
     <td>NH</td>
     <td>NEW HAMPSHIRE</td>
     <td>NH</td>
@@ -284,8 +255,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>NJ</td>
     <td>NEW JERSEY</td>
     <td>NJ</td>
-  </tr>
-  <tr>
     <td>NM</td>
     <td>NEW MEX PM</td>
     <td>23</td>
@@ -294,8 +263,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>NV</td>
     <td>MOUNT DIABLO MER</td>
     <td>21</td>
-  </tr>
-  <tr>
     <td>NV</td>
     <td>SAN BERNARDINO MER</td>
     <td>27</td>
@@ -304,8 +271,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>NY</td>
     <td>NEW YORK</td>
     <td>NY</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>1ST PM</td>
     <td>01</td>
@@ -314,8 +279,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>MICHIGAN MER</td>
     <td>19</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>OHIO RIVER SURVEY</td>
     <td>35</td>
@@ -324,8 +287,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>BETWEEN THE MIAMIS</td>
     <td>36</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>MUSKINGUM RIVER BASIN</td>
     <td>37</td>
@@ -334,8 +295,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>OHIO RIVER BASIN</td>
     <td>38</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>1ST SCIOTO RIVER BASE</td>
     <td>39</td>
@@ -344,8 +303,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>2ND SCIOTO RIVER BASE</td>
     <td>40</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>3RD SCIOTO RIVER BASE</td>
     <td>41</td>
@@ -354,8 +311,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>TWELVE MILE SQUARE</td>
     <td>43</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>WEST OF GREAT MIAMI</td>
     <td>47</td>
@@ -364,8 +319,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>US MILITARY SURVEY</td>
     <td>48</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>CT WEST RES-OHIO</td>
     <td>91</td>
@@ -374,8 +327,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>OHIO CO PUR-OHIO</td>
     <td>92</td>
-  </tr>
-  <tr>
     <td>OH</td>
     <td>VA MILITARY SURVEY-OHIO</td>
     <td>93</td>
@@ -384,8 +335,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OH</td>
     <td>OHIO</td>
     <td>OH</td>
-  </tr>
-  <tr>
     <td>OK</td>
     <td>CIMARRON MER</td>
     <td>11</td>
@@ -394,8 +343,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>OK</td>
     <td>INDIAN MER</td>
     <td>17</td>
-  </tr>
-  <tr>
     <td>OR</td>
     <td>WILLAMETTE MER</td>
     <td>33</td>
@@ -404,8 +351,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>PA</td>
     <td>PENNSYLVANIA</td>
     <td>PA</td>
-  </tr>
-  <tr>
     <td>RI</td>
     <td>RHODE ISLAND</td>
     <td>RI</td>
@@ -414,8 +359,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>SC</td>
     <td>SO CAROLINA</td>
     <td>SC</td>
-  </tr>
-  <tr>
     <td>SD</td>
     <td>5TH PM</td>
     <td>05</td>
@@ -424,8 +367,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>SD</td>
     <td>6TH PM</td>
     <td>06</td>
-  </tr>
-  <tr>
     <td>SD</td>
     <td>BLACK HILLS MER</td>
     <td>07</td>
@@ -434,8 +375,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>TN</td>
     <td>TENNESSEE</td>
     <td>TN</td>
-  </tr>
-  <tr>
     <td>TX</td>
     <td>TEXAS</td>
     <td>TX</td>
@@ -444,8 +383,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>UT</td>
     <td>SALT LAKE MER</td>
     <td>26</td>
-  </tr>
-  <tr>
     <td>UT</td>
     <td>UINTAH SPEC MER</td>
     <td>30</td>
@@ -454,8 +391,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>VA</td>
     <td>VIRGINIA</td>
     <td>VA</td>
-  </tr>
-  <tr>
     <td>VT</td>
     <td>VERMONT</td>
     <td>VT</td>
@@ -464,8 +399,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>WA</td>
     <td>WILLAMETTE MER</td>
     <td>33</td>
-  </tr>
-  <tr>
     <td>WI</td>
     <td>4TH PM MN-WI</td>
     <td>46</td>
@@ -474,8 +407,6 @@ Each meridian has a corresponding numeric key mapping:
     <td>WV</td>
     <td>WEST VIRGINIA</td>
     <td>WV</td>
-  </tr>
-  <tr>
     <td>WY</td>
     <td>6TH PM</td>
     <td>06</td>
@@ -484,5 +415,8 @@ Each meridian has a corresponding numeric key mapping:
     <td>WY</td>
     <td>WIND RIVER MER</td>
     <td>34</td>
+    <td></td>
+    <td></td>
+    <td></td>
   </tr>
 </table>

data/lib/interior/geocoder.rb

@@ -2,9 +2,12 @@ require 'net/http'
 require 'cgi'
 require 'nokogiri'
 require 'interior/response'
+require 'interior/meridians'
 
 module Interior
   class Geocoder
+    include Interior::Meridians
+
     API_DOMAIN = 'www.geocommunicator.gov'
     API_PATH   = 'TownshipGeocoder/TownshipGeocoder.asmx/GetLatLon'
     API_PARAM  = 'TRS'
@@ -23,6 +26,11 @@ module Interior
       result ? Interior::Response.new(result[:lat], result[:lon], true) : Interior::Response.new
     end
 
+    # st : state
+    def self.get_meridians(st)
+      MERIDIANS[st]
+    end
+
     private
 
     def self.build_trs_param(st, me, to, to_dir, ra, ra_dir, se = nil)

data/lib/interior/meridians.rb

@@ -0,0 +1,72 @@
+module Interior
+  module Meridians
+    MERIDIANS = {
+      'AL' => [ { :id => 16, :name => 'Huntsville' },
+                { :id => 25, :name => 'St. Stephens' },
+                { :id => 29, :name => 'Tallahasee' } ],
+      'AR' => [ { :id => 5,  :name => '5th' } ],
+      'AZ' => [ { :id => 14, :name => 'Gila-Salt River' },
+                { :id => 22, :name => 'Navajo' },
+                { :id => 27, :name => 'San Bernardino' } ],
+      'CA' => [ { :id => 14, :name => 'Gila-Salt River' },
+                { :id => 15, :name => 'Humboldt' },
+                { :id => 21, :name => 'Mount Diablo' },
+                { :id => 27, :name => 'San Bernardino' } ],
+      'CO' => [ { :id => 6,  :name => '6th' },
+                { :id => 23, :name => 'New Mex' },
+                { :id => 31, :name => 'Ute' } ],
+      'FL' => [ { :id => 29, :name => 'Tallahasee' } ],
+      'IA' => [ { :id => 5,  :name => '5th' } ],
+      'ID' => [ { :id => 8,  :name => 'Boise' } ],
+      'IL' => [ { :id => 2,  :name => '2nd' },
+                { :id => 3,  :name => '3rd' },
+                { :id => 4,  :name => '4th Illinois' } ],
+      'IN' => [ { :id => 1,  :name => '1st' },
+                { :id => 2,  :name => '2nd' } ],
+      'KS' => [ { :id => 6,  :name => '6th' } ],
+      'LA' => [ { :id => 18, :name => 'Louisiana' },
+                { :id => 24, :name => 'St. Helena' } ],
+      'MI' => [ { :id => 19, :name => 'Michigan' } ],
+      'MN' => [ { :id => 5,  :name => '5th' },
+                { :id => 46, :name => '4th' } ],
+      'MO' => [ { :id => 5,  :name => '5th' } ],
+      'MS' => [ { :id => 9,  :name => 'Chickasaw' },
+                { :id => 10, :name => 'Choctaw' },
+                { :id => 16, :name => 'Huntsville' },
+                { :id => 25, :name => 'St. Stephens' },
+                { :id => 32, :name => 'Washington' } ],
+      'MT' => [ { :id => 20, :name => 'Prin' } ],
+      'ND' => [ { :id => 5,  :name => '5th' } ],
+      'NE' => [ { :id => 6,  :name => '6th' } ],
+      'NM' => [ { :id => 23, :name => 'New Mex' } ],
+      'NV' => [ { :id => 21, :name => 'Mount Diablo' },
+                { :id => 27, :name => 'San Bernardino' } ],
+      'OH' => [ { :id => 1,  :name => '1st' },
+                { :id => 19, :name => 'Michigan' },
+                { :id => 35, :name => 'Ohio River Survey' },
+                { :id => 36, :name => 'Between the Miamis' },
+                { :id => 37, :name => 'Muskingum River Basin' },
+                { :id => 38, :name => 'Ohio River Basin' },
+                { :id => 39, :name => '1st Scioto River Base' },
+                { :id => 40, :name => '2nd Scioto River Base' },
+                { :id => 41, :name => '3rd Scioto River Base' },
+                { :id => 43, :name => 'Twelve Mile Square' },
+                { :id => 47, :name => 'West of Great Miami' },
+                { :id => 48, :name => 'US Military Survey' },
+                { :id => 91, :name => 'Ct West Res-Ohio' },
+                { :id => 92, :name => 'Ohio Co Pur-Ohio' },
+                { :id => 93, :name => 'Va Military Survey-ohio' } ],
+      'OK' => [ { :id => 11, :name => 'Cimarron' },
+                { :id => 17, :name => 'Indian' } ],
+      'OR' => [ { :id => 33, :name => 'Willamette' } ],
+      'SD' => [ { :id => 5,  :name => '5th' },
+                { :id => 6,  :name => '6th' },
+                { :id => 7,  :name => 'Black Hills' } ],
+      'UT' => [ { :id => 26, :name => 'Salt Lake' },
+                { :id => 30, :name => 'Uintah Spec' } ],
+      'WA' => [ { :id => 33, :name => 'Willamette' } ],
+      'WI' => [ { :id => 46, :name => '4th' } ],
+      'WY' => [ { :id => 6,  :name => '6th' },
+                { :id => 34, :name => 'Wind River' } ] }
+  end
+end

data/lib/interior/version.rb

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

data/lib/interior.rb

@@ -1,2 +1,3 @@
 require 'interior/response.rb'
+require 'interior/meridians.rb'
 require 'interior/geocoder.rb'

data/spec/lib/interior/geocoder_spec.rb

@@ -83,6 +83,36 @@ describe Interior::Geocoder do
     end
   end
 
+  describe '#get_meridians' do
+    subject { coder.get_meridians(st) }
+
+    it 'returns an array' do
+      subject.class.should == Array
+    end
+
+    context('when in Arizona') do
+      let(:st) { 'AZ' }
+
+      it 'returns the correct collection of meridians' do
+        subject.should == [
+          { :name => "Gila-Salt River", :id => 14 },
+          { :name => "Navajo",          :id => 22 },
+          { :name => "San Bernardino",  :id => 27 } ]
+      end
+    end
+
+    context('when in Colorado') do
+      let(:st) { 'CO' }
+
+      it 'returns the correct collection of meridians' do
+        subject.should == [
+          { :name => '6th',     :id => 6  },
+          { :name => 'New Mex', :id => 23 },
+          { :name => 'Ute',     :id => 31 } ]
+      end
+    end
+  end
+
   describe '#build_trs_param' do
     subject { coder.send(:build_trs_param, st, me, to, to_dir, ra, ra_dir, se) }
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: interior
 version: !ruby/object:Gem::Version 
-  hash: 57
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 8
-  - 3
-  version: 0.8.3
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Chris Hunt
@@ -92,6 +92,7 @@ files:
 - interior.gemspec
 - lib/interior.rb
 - lib/interior/geocoder.rb
+- lib/interior/meridians.rb
 - lib/interior/response.rb
 - lib/interior/version.rb
 - spec/fixtures/az.xml