google_maps_geocoder 0.6.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a87dc3867dff7a2bb8e748d7438a0f40d1b5049d
-  data.tar.gz: eb563b74b248ef2cfb77aef22f8cc19689410045
+  metadata.gz: 6f8038283c14ce1cd1991efd381e0ed95a38dea5
+  data.tar.gz: 8861a684bddf6016204a3a652cadd81c11136adb
 SHA512:
-  metadata.gz: eb7588cff150c69b84d1190bb699a10cf81b756a0a9627e4558e5e8acfe65c038328ae37ea8862556421b972f7d2d7d259af299b43f3b1b72050bc64c91db6e6
-  data.tar.gz: 9c914109a7f2b30c64713fd8ef4805f59ea558ff7b762360b06e038f77c44bd7359b1abbfa71b0e1e51335cb8b57186fd8d768459e2d34ac0c6d853d877a9da0
+  metadata.gz: c12d9c7fb0e086af148f102f00f14c72888019ff52d885319bbfabeab827d3a41ef383a0439432f181a77f7b7312b187fd2eaaf72b02ac69a2aca16dbd9cf203
+  data.tar.gz: 1e1f72808a2c9a75994f745f0719e4d7e673a81f72002c46641a4921196db418887fe4c353b332b6919272137c7f01f4abe7d3b489442833648885abe861a86e

data/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+# Description
+
+Provide as much background as you need to get the implementer up to speed on the problem to be solved. This can also include screenshots and links to other issues or pull requests.
+
+# Steps to Reproduce
+
+Don't forget to point out the difference between what *should* happen and what *does* happen. Here's an example:
+
+1. Try geocoding "1600 Pennsylvania Ave":
+    ```ruby
+    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Ave')
+    ```
+2. The formatted address doesn't match the White House:
+   ```ruby
+   white_house.formatted_address
+   => "1600 Pennsylvania Ave, Charleston, WV 25302, USA"
+   ```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+# Goal
+Explain this issue's purpose. Focus on the problem that needs to be solved and *not* a particular solution. For example: "Make it easier for users to reset their passwords."
+
+# Description
+1. Provide as much background as you need to familiarize the implementer with the problem to be solved.
+2. Include:
+    * screenshots
+    * links to other issues or pull requests
+
+# Success Criteria
+How would a stakeholder test whether the feature was completed successfully?

data/README.md

@@ -77,6 +77,17 @@ The complete, hopefully self-explanatory, API is:
 * `GoogleMapsGeocoder#state_long_name`
 * `GoogleMapsGeocoder#state_short_name`
 
+For compatibility with [Geocoder](https://github.com/alexreisner/geocoder), the following aliases are also available:
+
+* `GoogleMapsGeocoder#address`
+* `GoogleMapsGeocoder#coordinates`
+* `GoogleMapsGeocoder#country`
+* `GoogleMapsGeocoder#country_code`
+* `GoogleMapsGeocoder#latitude`
+* `GoogleMapsGeocoder#longitude`
+* `GoogleMapsGeocoder#state`
+* `GoogleMapsGeocoder#state_code`
+
 ## Google Maps API Key (Optional)
 
 To have GoogleMapsGeocoder use your Google Maps API key, set it as an environment variable:

data/lib/google_maps_geocoder/google_maps_geocoder.rb

@@ -40,6 +40,21 @@ class GoogleMapsGeocoder
   # Self-explanatory
   attr_reader(*GOOGLE_ADDRESS_SEGMENTS)
 
+  # Returns the formatted address as a comma-delimited string.
+  alias address formatted_address
+  # Returns the address' country as a full string.
+  alias country country_long_name
+  # Returns the address' country as an abbreviated string.
+  alias country_code country_short_name
+  # Returns the address' latitude as a float.
+  alias latitude lat
+  # Returns the address' longitude as a float.
+  alias longitude lng
+  # Returns the address' state as a full string.
+  alias state state_long_name
+  # Returns the address' state as an abbreviated string.
+  alias state_code state_short_name
+
   # Geocodes the specified address and wraps the results in a GoogleMapsGeocoder
   # object.
   #
@@ -60,6 +75,11 @@ class GoogleMapsGeocoder
     end
   end
 
+  # Returns the address' coordinates as an array of floats.
+  def coordinates
+    [lat, lng]
+  end
+
   # Returns true if the address Google returns is an exact match.
   #
   # @return [boolean] whether the Google Maps result is an exact match

data/lib/google_maps_geocoder/version.rb

@@ -1,4 +1,4 @@
 # A simple PORO wrapper for geocoding with Google Maps.
 class GoogleMapsGeocoder
-  VERSION = '0.6.1'.freeze unless defined?(GoogleMapsGeocoder::VERSION)
+  VERSION = '0.7'.freeze unless defined?(GoogleMapsGeocoder::VERSION)
 end

data/spec/lib/google_maps_geocoder_spec.rb

@@ -42,8 +42,18 @@ describe GoogleMapsGeocoder do
         it { expect(subject.lat).to be_within(0.005).of(38.8976633) }
         it { expect(subject.lng).to be_within(0.005).of(-77.0365739) }
       end
+      context 'Geocoder API' do
+        it { expect(subject.address).to eq subject.formatted_address }
+        it { expect(subject.coordinates).to eq [subject.lat, subject.lng] }
+        it { expect(subject.country).to eq subject.country_long_name }
+        it { expect(subject.country_code).to eq subject.country_short_name }
+        it { expect(subject.latitude).to eq subject.lat }
+        it { expect(subject.longitude).to eq subject.lng }
+        it { expect(subject.state).to eq subject.state_long_name }
+        it { expect(subject.state_code).to eq subject.state_short_name }
+      end
     end
-    context 'with an invalid address' do
+    context 'when API key is invalid' do
       before do
         @key = ENV['GOOGLE_MAPS_API_KEY']
         ENV['GOOGLE_MAPS_API_KEY'] = 'invalid_key'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_geocoder
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: '0.7'
 platform: ruby
 authors:
 - Roderick Monje
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -118,6 +118,8 @@ files:
 - ".document"
 - ".github/CONTRIBUTING.md"
 - ".github/ISSUE_TEMPLATE.md"
+- ".github/ISSUE_TEMPLATE/bug-report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".ruby-version"