zipcodeservices 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjI5MDFjZTFmMzRmODg5OGVmNzk3YmVhODI5NTJkYTNkMmVkODdkNg==
+    MmE3MWYxNzU4NWIyNTdkMzJiNzYzYzNhZjNmNDA0ZjMxYzc0ZTQ5ZQ==
   data.tar.gz: !binary |-
-    ZWNhZmE2YWIyMGM5ZTM1YjlkNDU4NDEyNWZiNjhhMGRjNDJlMjI2NQ==
+    ZDQ4MzM5OTEzYTNkOGU1ZjdlMjU3MmY0ODg4ZjYzOGExZDlhMzE3Zg==
 SHA512:
   metadata.gz: !binary |-
-    MjZiZTBiNzlmZTE3NzBkMDAxMjkyMTE1MDM3ZTcyOTc1YzgwOThhMmM4MThm
-    ODM0MmE3ODFmNWI3MDE2ZDg2MTJkMzY3YjAzMmMwMzBhOTE0ZjAwNzVmYmIy
-    ZDMxMjkyNDE2MzZmMmE1MTczNTdhNGQ3ZjZlNmNlZDMyZTlkZTI=
+    ZDJiYWU0N2EwYTFiZGZkMzhiYTQ1NDk0YjVhY2YzOTQ4ZTJlYWQ5ZTBlMmYx
+    NTc1M2NhNWI5NDBhYjlmZThjNjM1MDM5YTRhOTU4Mzg5MDkyYWQ0NDdhOTk5
+    ZDI3OTY2YjM0MjA1MGY0YjBhNWFkZmM4NzAwMDIxMjBkNzQzMGU=
   data.tar.gz: !binary |-
-    YThlYTg4NWQ3MWI1MTlhNjc1YjBkNTdmNmJiZWU3ZGRiOTEzOGQyNDI4NjIx
-    OGQwZjUwODVlYzk3MjRmYzUwNmVmYTg0ODZkN2MzYmUzMTE5ZDZlODY2OWRh
-    ZjNhZjI5ZDZiM2RkZTEyMmU3OGQwYzViM2FlZjRkY2Y0MjAzMWU=
+    YzA5NzY0YjkwNmUzZTU0YWExOGU5NWUzZTAyZWZhOGIzMzA0NmU5Y2JjMDMy
+    YTcwMjkyYWY0ZGI1YWJhZmY2ZTE2MjI0NGVhNzM3NGVhN2M1M2ZhZjFkMmRm
+    MzczODQ5NmUwNDk1NDE2M2Y3MmQ3NGU2MjRjZDRmZjQzM2ViYmI=

data/.env.example

@@ -0,0 +1 @@
+export ZIP_CODE_SERVICES_API_KEY="YOUR API KEY HERE" 

data/.gitignore

@@ -11,6 +11,7 @@ capybara-*.html
 .rspec
 /.bundle
 /vendor/bundle
+/vendor/*
 /log/*
 /tmp/*
 /db/*.sqlite3
@@ -27,6 +28,8 @@ coverage
 config/database.yml
 /public/uploads
 .*.swp
+.*.swo
 .env
 *.gem
 /spec/vcr_cassettes/*
+/tags

data/Gemfile.lock

@@ -2,6 +2,8 @@ PATH
   remote: .
   specs:
     zipcodeservices (0.0.1)
+      multi_xml
+      nokogiri
       typhoeus (= 0.3.3)
 
 GEM
@@ -40,7 +42,11 @@ GEM
     lumberjack (1.0.5)
     method_source (0.8.2)
     mime-types (2.2)
+    mini_portile (0.5.3)
+    multi_xml (0.5.5)
     nio4r (1.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -61,7 +67,7 @@ GEM
     timers (1.1.0)
     typhoeus (0.3.3)
       mime-types
-    vcr (2.2.4)
+    vcr (2.9.2)
 
 PLATFORMS
   ruby
@@ -70,5 +76,5 @@ DEPENDENCIES
   debugger
   guard-rspec
   rspec (~> 2.13)
-  vcr
+  vcr (~> 2.4)
   zipcodeservices!

data/README.md

@@ -0,0 +1,38 @@
+Zipcode Services.
+=================
+
+This is a ruby library that interfaces Zip Code Services -- a IP Address and Zip Code database with Zip Code Distance Search and IP Address Distance Search APIs available to members.
+
+---
+
+## Installation 
+
+```
+gem install zipcodeservices
+```
+
+Use
+```
+ZipCodeServices.apikey = ENV['ZIP_CODE_SERVICES_API_KEY']
+ZipCodeServices.data_format = :json
+zips = ZipCodeServices.zipcode("78702") 
+```
+
+## Contribution
+
+Installation for contributors
+
+ 1. Get an api key from zipcodeservices.com
+ 2. Fork the repo
+ 3. Add the API key as the environment variable ZIP_CODE_SERVICES_API_KEY
+    - Linux:
+      * First -- add ```ZIP_CODE_SERVICES_API_KEY=YOUR_KEY``` to .env
+      * Next -- Type ```. .env``` before running any tests
+    - Windows: Add your environment variables using the following instructions: http://www.computerhope.com/issues/ch000549.htm
+ 4. Ensure all tests pass by running ```rspec spec```
+ 5. Submit a pull request with your changes
+
+Please write tests for any changes you make or we will have our way with you
+ 
+
+

data/foo.xml

@@ -0,0 +1 @@
+<GetAllProvincesByCountryIdResponse xmlns="http://tempuri.org/"><GetAllProvincesByCountryIdResult xmlns:a="http://schemas.datacontract.org/2004/07/Zips.DTO" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><a:StateDTO><a:Abbreviation>AL</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>1</a:Id><a:State>Alabama</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>AK</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>2</a:Id><a:State>Alaska</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>AS</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>3</a:Id><a:State>American Samoa</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>AZ</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>4</a:Id><a:State>Arizona</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>AR</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>5</a:Id><a:State>Arkansas</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>CA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>6</a:Id><a:State>California</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>CO</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>7</a:Id><a:State>Colorado</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>CT</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>8</a:Id><a:State>Connecticut</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>DC</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>9</a:Id><a:State>District Of Columbia</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>DE</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>10</a:Id><a:State>Delaware</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>FM</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>11</a:Id><a:State>Federated States of Micronesia</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>FL</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>12</a:Id><a:State>Florida</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>GA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>13</a:Id><a:State>Georgia</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>GU</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>14</a:Id><a:State>Guam</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>HI</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>15</a:Id><a:State>Hawaii</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>ID</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>16</a:Id><a:State>Idaho</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>IL</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>17</a:Id><a:State>Illinois</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>IN</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>18</a:Id><a:State>Indiana</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>IA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>19</a:Id><a:State>Iowa</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>KS</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>20</a:Id><a:State>Kansas</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>KY</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>21</a:Id><a:State>Kentucky</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>LA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>22</a:Id><a:State>Louisiana</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>ME</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>23</a:Id><a:State>Maine</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MH</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>24</a:Id><a:State>Marshall Islands</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MD</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>25</a:Id><a:State>Maryland</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>26</a:Id><a:State>Massachusetts</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MI</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>27</a:Id><a:State>Michigan</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MN</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>28</a:Id><a:State>Minnesota</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MS</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>29</a:Id><a:State>Mississippi</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MO</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>30</a:Id><a:State>Missouri</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>MT</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>31</a:Id><a:State>Montana</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NE</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>32</a:Id><a:State>Nebraska</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NV</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>33</a:Id><a:State>Nevada</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NH</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>34</a:Id><a:State>New Hampshire</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NJ</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>35</a:Id><a:State>New Jersey</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NM</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>36</a:Id><a:State>New Mexico</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NY</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>37</a:Id><a:State>New York</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>NC</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>38</a:Id><a:State>North Carolina</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>ND</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>39</a:Id><a:State>North Dakota</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>OH</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>40</a:Id><a:State>Ohio</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>OK</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>41</a:Id><a:State>Oklahoma</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>OR</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>42</a:Id><a:State>Oregon</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>PW</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>43</a:Id><a:State>Palau</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>PA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>44</a:Id><a:State>Pennsylvania</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>PR</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>45</a:Id><a:State>Puerto Rico</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>RI</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>46</a:Id><a:State>Rhode Island</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>SC</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>47</a:Id><a:State>South Carolina</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>SD</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>48</a:Id><a:State>South Dakota</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>TN</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>49</a:Id><a:State>Tennessee</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>TX</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>50</a:Id><a:State>Texas</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>UT</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>51</a:Id><a:State>Utah</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>VT</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>52</a:Id><a:State>Vermont</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>VI</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>53</a:Id><a:State>Virgin Islands</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>VA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>54</a:Id><a:State>Virginia</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>WA</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>55</a:Id><a:State>Washington</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>WV</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>56</a:Id><a:State>West Virginia</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>WI</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>57</a:Id><a:State>Wisconsin</a:State></a:StateDTO><a:StateDTO><a:Abbreviation>WY</a:Abbreviation><a:Continent>North America</a:Continent><a:ContinentCode>NA</a:ContinentCode><a:Country>United States</a:Country><a:CountryAbbreviation>US</a:CountryAbbreviation><a:CountryId>1</a:CountryId><a:Id>58</a:Id><a:State>Wyoming</a:State></a:StateDTO></GetAllProvincesByCountryIdResult></GetAllProvincesByCountryIdResponse>

data/lib/zipcodeservices/version.rb

@@ -1,3 +1,3 @@
 module ZipCodeServices
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/zipcodeservices.rb

@@ -2,21 +2,34 @@
 %w[
   rubygems
   typhoeus
+  multi_xml
 ].each { |r| require r }
 
 module ZipCodeServices
-  @base_uri = 'https://www.zipcodeservices.com/services/rest/json' #/zipcodes.svc'
+  @base_uri = 'https://www.zipcodeservices.com/services/rest' #/json' #/zipcodes.svc'
+  #MultiXml.parser = :ox
+  MultiXml.parser = :nokogiri
 
   class << self; 
-    #attr_accessor :base_uri 
+    attr_accessor :data_format
     attr_accessor :apikey
 
+    def base_uri
+      fmt = data_format == :xml ? 'xml' : 'json'
+      "#{@base_uri}/#{fmt}"
+    end
+
     def zipcode(zip) 
       #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/#{apikey}/#{zip}") 
-      if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j.first[1]["City"] == nil 
+      response = Typhoeus::Request.get( "#{base_uri}/zipcodes.svc/#{apikey}/#{zip}") 
+		 	if response.code == 200 
+        if data_format == :xml
+          j = MultiXml.parse(response.body)
+          raise "BAD API KEY" if j.first[1].first[1]["City"] == nil
+        else
+          j = JSON::parse(response.body)
+          raise "BAD API KEY" if j.first[1]["City"] == nil 
+        end
         j
       elsif response.code == 404
         nil 
@@ -26,11 +39,15 @@ module ZipCodeServices
     end
 
     def radius(zip, rad)
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/#{apikey}/#{zip}/#{rad}") 
+      response = Typhoeus::Request.get( "#{base_uri}/zipcodes.svc/#{apikey}/#{zip}/#{rad}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["RetrieveZipCodesInRadiusResult"] == nil 
+        if data_format == :xml
+          j = MultiXml.parse(response.body)
+          raise "BAD API KEY" if j.first[1].first[1] == nil
+        else
+          j = JSON::parse(response.body)
+          raise "BAD API KEY" if j["RetrieveZipCodesInRadiusResult"] == nil 
+        end
         j
       elsif response.code == 404
         nil 
@@ -39,13 +56,18 @@ module ZipCodeServices
       end 
     end
 
-    def radius_by_latlong(lat, long, rad)
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/GetZipCodesInRadiusLatLong?apikey=#{apikey}&latitude=#{lat}&longitude=#{lon}&radius=#{rad}") 
+    def radius_by_latlong(lat, lon, rad)
+      response = Typhoeus::Request.get( "#{base_uri}/zipcodes.svc/GetZipCodesInRadiusLatLong?apikey=#{apikey}&latitude=#{lat}&longitude=#{lon}&radius=#{rad}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["GetZipCodesInRadiusOfLatLongResult"] == nil 
-        j
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+          raise "BAD API KEY" if j.first[1].first[1].first[1][0]["PostalCode"] == nil
+				else	
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j.first[1].first["PostalCode"] == nil 
+				#	["GetZipCodesInRadiusOfLatLongResult"] ==nil 
+				end
+				j
       elsif response.code == 404
         nil 
       else 
@@ -54,26 +76,34 @@ module ZipCodeServices
     end
 
     def distance_between_zipcodes(zip1, zip2) 
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/GetDistanceBetweenZipCodes?apikey=#{apikey}&zipcode1=#{zip1}&zipcode2=#{zip2}") 
+      response = Typhoeus::Request.get( "#{base_uri}/zipcodes.svc/GetDistanceBetweenZipCodes?apikey=#{apikey}&zipcode1=#{zip1}&zipcode2=#{zip2}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j.first[1]["ZipCode1"] == nil 
-        j
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+					raise "BAD API KEY" if j.first[1].first[1]["DistanceAwayInMiles"] == nil
+				else
+					j = JSON::parse(response.body)
+        	raise "BAD API KEY" if j.first[1]["ZipCode1"] == nil 
+				end
+					j
       elsif response.code == 404
         nil 
       else 
         raise response.body 
-      end 
-    end
+      	end 
+		end
 
     def countries
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/countries.svc/#{apikey}") 
+      response = Typhoeus::Request.get( "#{base_uri}/countries.svc/#{apikey}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["GetCountriesResult"] == nil 
-        j
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+					raise "BAD API KEY" if j.first[1].first[1].first[1][0]["Abbreviation"] == nil
+				else
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j["GetCountriesResult"] == nil 
+				end
+					j
       elsif response.code == 404
         nil 
       else 
@@ -82,12 +112,17 @@ module ZipCodeServices
     end
 
     def states(country_id)
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/provinces.svc/#{apikey}/#{country_id}") 
-      if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["GetAllProvincesByCountryIdResult"] == nil 
-        j
+      response = Typhoeus::Request.get( "#{base_uri}/provinces.svc/#{apikey}/#{country_id}") 
+			if response.code == 200 
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+					raise "BAD API KEY" if j.first[1].first[1].first[1][0]["Abbreviation"] == nil 
+          j
+				else
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j["GetAllProvincesByCountryIdResult"] == nil 
+					j
+				end
       elsif response.code == 404
         nil 
       else 
@@ -98,11 +133,17 @@ module ZipCodeServices
 
     def cities(province_id)
       #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/cities.svc/#{apikey}/#{province_id}") 
+      response = Typhoeus::Request.get( "#{base_uri}/cities.svc/#{apikey}/#{province_id}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["GetCitiesByProvinceResult"] == nil 
-        j
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+					raise "BAD API KEY" if j.first[1].first[1].first[1][0]["City"] == nil 
+          j
+				else
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j["GetCitiesByProvinceResult"] == nil 
+					j
+				end
       elsif response.code == 404
         nil 
       else 
@@ -111,12 +152,17 @@ module ZipCodeServices
     end
 
     def cities_by_state_and_country(province_id, country_id)
-      #/{apikey}/{zipcode}
-      response = Typhoeus::Request.get( "#{@base_uri}/cities.svc/#{apikey}/#{province_id}/#{country_id}") 
+      response = Typhoeus::Request.get( "#{base_uri}/cities.svc/#{apikey}/#{province_id}/#{country_id}") 
       if response.code == 200 
-        j = JSON::parse(response.body)
-        raise "BAD API KEY" if j["GetCitiesByProvinceAndCountryResult"] == nil # NOTE: also happens when a province id is not valid for a country
-        j
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+					raise "BAD API KEY" if j.first[1].first[1].first[1][20]["City"] == nil 
+          j
+				else
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j["GetCitiesByProvinceAndCountryResult"] == nil # NOTE: also happens when a province id is not valid for a country
+					j
+				end
       elsif response.code == 404
         nil 
       else 
@@ -124,7 +170,42 @@ module ZipCodeServices
       end 
     end
 
+    def ipaddress(ip)
+      response = Typhoeus::Request.get( "#{base_uri}/ipaddress.svc/GetIP?apikey=#{apikey}&ip=#{ip}") 
+		 	if response.code == 200 
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+          raise "BAD API KEY" if j.first[1].first[1]["ZipCode"] == nil 
+          j
+				else
+					j = JSON::parse(response.body)
+          raise "BAD API KEY" if j["RetrieveIPAddressDataResult"] == nil # NOTE: also happens when a province id is not valid for a country
+					j
+				end
+      elsif response.code == 404
+        nil 
+      else 
+				raise response.body 
+      end 
+    end
 
-  end 
+    def ipaddress_radius(ip, rad)
+      response = Typhoeus::Request.get( "#{base_uri}/ipaddress.svc/GetZipsInRadiusOfIP?apikey=#{apikey}&ip=#{ip}&radius=#{rad}") 
+			if response.code == 200 
+				if data_format == :xml
+					j = MultiXml.parse(response.body) 
+          raise "BAD API KEY" if j.first[1].first[1].first[1]["PostalCode"] == nil 
+          j
+				else
+					j = JSON::parse(response.body)
+					raise "BAD API KEY" if j["RetrieveZipCodesInRadiusOfIPResult"] == nil # NOTE: also happens when a province id is not valid for a country
+					j
+				end
+      elsif response.code == 404
+        nil 
+      else 
+				raise response.body 
+      end 
+    end
+	end
 end
-

data/spec/client_spec.rb

@@ -1,52 +1,117 @@
 require 'zipcodeservices'
 require 'spec_helper'
 
-describe "client" do 
-
+describe "json client" do 
   before(:each) do
-    ZipCodeServices.apikey = 'YOUR_API_KEY_HERE'
+    ZipCodeServices.data_format = :json
   end
 
-  it "should retrieve zip code info", :vcr, record: :new_episodes do 
+  it "should retrieve zip code info", :vcr, record: :all do 
     zips = ZipCodeServices.zipcode("78702") 
     zips.first[1]["City"].should == "Austin" 
     # test other item 
   end
 
-  it "should get zip codes in radius of zip code", :vcr,  record: :new_episodes do
+  it "should get zip codes in radius of zip code", :vcr,  record: :all do
     zips = ZipCodeServices.radius(78702, 1)
     zips.first[1].first["PostalCode"].should == "78701"
   end
 
-  it "should get zip codes in radius of latitude and longitude", :vcr,  record: :new_episodes do
+  it "should get zip codes in radius of latitude and longitude", :vcr,  record: :all do
     zips = ZipCodeServices.radius_by_latlong("30.2645715", "-97.7284341", 1)
     zips.first[1].first["PostalCode"].should == "73301"
   end
 
-  it "should get the distance between zip codes", :vcr,  record: :new_episodes do
+  it "should get the distance between zip codes", :vcr,  record: :all do
     zips = ZipCodeServices.distance_between_zipcodes("78702", "01109")
     zips.first[1]["DistanceAwayInMiles"].should == 1616.501295
   end
 
 
-  it "should get countries", :vcr,  record: :new_episodes do
+  it "should get countries", :vcr,  record: :all do
     countries = ZipCodeServices.countries
     countries.first[1].first["Abbreviation"].should == "US"
   end
 
-  it "should get states / provinces by country id (country id attained by request to countries list)", :vcr,  record: :new_episodes do
+  it "should get states-provinces by country id", :vcr,  record: :all do
     states = ZipCodeServices.states(1)
-    states.first[1].first["Abbreviation"].should == "AL"
+		states.first[1].first["Abbreviation"].should == "AL"
   end
 
-  it "should get cities by province id / provinces id (country id attained by request to states list)", :vcr,  record: :new_episodes do
+  it "should get cities by state id (province id)", :vcr,  record: :all do
     cities = ZipCodeServices.cities(200)
-    cities.first[1].first["City"].should == "Alamo"
+		cities.first[1].first["City"].should == "Alamo"
   end
 
-  it "should get cities by state id (provinces id) and country id (country id attained by request for country list, province id attained by request for states list)", :vcr,  record: :new_episodes do
+  it "should get cities by state id (provinces id) and country id", :vcr,  record: :all do
     cities = ZipCodeServices.cities_by_state_and_country(1, 1)
     cities.first[1][20]["City"].should == "Arlington"
   end
 
+  it "should return information on ip addresses", :vcr, record: :all do 
+    data = ZipCodeServices.ipaddress("184.98.179.3")
+    data.first[1]["ZipCode"].should == "85001"
+  end
+
+  it "should return zips in radius of ip address", :vcr, record: :all do 
+    data = ZipCodeServices.ipaddress_radius("184.98.179.3", 1)
+    data.first[1].first["PostalCode"].should == "86323"
+  end
+end
+
+
+describe "xml client" do 
+  before(:each) do
+    ZipCodeServices.data_format = :xml
+  end
+
+  it "should retrieve zip code info", :vcr, record: :all do 
+    zips = ZipCodeServices.zipcode("78702") 
+    zips.first[1].first[1]["City"].should == "Austin"
+  end
+
+  it "should get zip codes in radius of zip code", :vcr,  record: :all do
+    zips = ZipCodeServices.radius(78702, 1)
+    zips.first[1].first[1].first[1].first["PostalCode"].should == "78701"
+  end
+
+  it "should get zip codes in radius of latitude and longitude", :vcr,  record: :all do
+    zips = ZipCodeServices.radius_by_latlong("30.2645715", "-97.7284341", 1)
+    zips.first[1]["GetZipCodesInRadiusOfLatLongResult"]["ZipCodeWithDistanceDTO"][0]["PostalCode"].should == "73301"
+  end
+
+  it "should get the distance between zip codes", :vcr,  record: :all do
+    zips = ZipCodeServices.distance_between_zipcodes("78702", "01109")
+    zips.first[1]["RetrieveDistanceBetweenZipCodesResult"]["DistanceAwayInMiles"].should == "1616.501295"
+  end
+
+	it "should get countries", :vcr,  record: :all do
+    countries = ZipCodeServices.countries
+    countries.first[1].first[1].first[1][0]["Abbreviation"].should == "US"
+  end
+
+  it "should get states-provinces by country id", :vcr,  record: :all do
+    states = ZipCodeServices.states(1)
+    states.first[1].first[1].first[1][0]["Abbreviation"].should == "AL"
+  end
+
+  it "should get cities by state id (province id)", :vcr,  record: :all do
+    cities = ZipCodeServices.cities(200)
+		cities.first[1].first[1].first[1][0]["City"].should == "Alamo"
+  end
+
+  it "should get cities by state id (provinces id) and country id", :vcr,  record: :all do
+    cities = ZipCodeServices.cities_by_state_and_country(1, 1)
+    cities.first[1].first[1].first[1][20]["City"].should == "Arlington"
+  end
+
+  it "should return information on ip addresses", :vcr, record: :all do 
+    data = ZipCodeServices.ipaddress("184.98.179.3")
+    data.first[1].first[1]["ZipCode"].should == "85001"
+  end
+
+  it "should return zips in radius of ip address", :vcr, record: :all do 
+    data = ZipCodeServices.ipaddress_radius("184.98.179.3", 1)
+    data.first[1].first[1].first[1]["PostalCode"].should == "86323"
+  end
 end

data/spec/spec_helper.rb

@@ -2,10 +2,13 @@ require 'rspec'
 require 'vcr'
 #require 'webmock/rspec'
 
+ZipCodeServices.apikey = ENV['ZIP_CODE_SERVICES_API_KEY']
+
 VCR.configure do |c|
   c.allow_http_connections_when_no_cassette = true
   c.cassette_library_dir = 'spec/vcr_cassettes'
   c.hook_into :typhoeus
+  c.filter_sensitive_data("<API_KEY>") { ZipCodeServices.apikey }
 end
 
 RSpec.configure do |config|