google_distance_matrix 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 889a735e923a64e646fdd8d62f8b95e9cac813de
-  data.tar.gz: aac05a54e40741a24969c3cd7ebc07e24531a535
+  metadata.gz: 1bafa7129b5e8795d2843bf132729e31ac07079e
+  data.tar.gz: ee670023245891199fe478f084b58b1e984ae7b4
 SHA512:
-  metadata.gz: dae22319ffd3a4c144527985d729c1dfcd87432d830d7c9efa8434d8210285507f7890257a6ace2f26349dbb5f64523abee6599cec44bbd7b476e52b6e60502b
-  data.tar.gz: f5d5950aa52c3527be20fe315de87a3f0e10a636d9e0c31d563a9f4d367dbeafab61a19426e477864fc5e4213609443c45ba4e96fb434ca2713cd16bc1d34f91
+  metadata.gz: b407618b92520edcc3a84199f5ab27e9db91598fb8c6e51b851379e6b4fb82f4d2fabe783eed065f4ba3a51ccc3a81abd4b99759546ae77e82ec49efccf954f8
+  data.tar.gz: cffa738e7f599684a5107755d0945924c229dedc320daa14b5cc71f70079409f572fdff199ed04f43a12889ff603df860e9ee04340cf649a058c08fec42d7647

data/.travis.yml

@@ -1,9 +1,12 @@
+before_install:
+  - gem update bundler
 rvm:
   - 2.0.0
   - 2.1.0
   - 2.1.2
   - 2.1.5
   - 2.2.3
+  - 2.3.0
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v.0.2.1
+* Made https be default (by almnes)
+
 ## v.0.2.0
 * Dropped support for Ruby 1.9.X
 * Added new configuration options: google_api_key,

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/Skalar/google_distance_matrix.svg?branch=master)](https://travis-ci.org/Skalar/google_distance_matrix)
 
-Ruby client for The Google Distance Matrix API.
+Ruby client for the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/intro).
 
 This lib makes Google's distance matrix API easy to work with,
 allowing you to set up some origins and destinations and
@@ -12,7 +12,7 @@ Once you have the matrix you can fetch all routes from a given
 origin or to a given destination.
 
 The matrix may also be used as a data set for traveling salesman problem,
-but to solve it you may look at http://ai4r.org/.
+but to solve it you may look at <http://ai4r.org/>.
 
 
 
@@ -21,72 +21,87 @@ but to solve it you may look at http://ai4r.org/.
 
 ### Set up a matrix to work with
 
-    matrix = GoogleDistanceMatrix::Matrix.new
+```ruby
+matrix = GoogleDistanceMatrix::Matrix.new
+```
 
 ### Create some places to be used as origins or destinations for the matrix
-
-    lat_lng = GoogleDistanceMatrix::Place.new lng: 12, lat: 12
-    address = GoogleDistanceMatrix::Place.new address: "My address, Oslo"
-    dest_address = GoogleDistanceMatrix::Place.new address: "Home, Oppegaard"
-
-    point_dest = Point.new lat: 1, lng: 2
-    dest_object = GoogleDistanceMatrix::Place.new point_dest
-
+```ruby
+lat_lng = GoogleDistanceMatrix::Place.new lng: 12, lat: 12
+address = GoogleDistanceMatrix::Place.new address: "My address, Oslo"
+dest_address = GoogleDistanceMatrix::Place.new address: "Home, Oppegaard"
+
+# Just an example of an object responding to lat & lng.
+# Point class isn't included in this gem, but feel free to
+# create your own point class or use something like https://github.com/nofxx/georuby
+point_dest = Point.new lat: 1, lng: 2
+dest_object = GoogleDistanceMatrix::Place.new point_dest
+```
 ### Add places to matrix's origins and destinations
-
-    matrix.origins << lat_lng << address
-    matrix.destinations << dest_address << dest_object
-
-    # Added objects will be wrapped in a place automatically, so you may skip manyally creating Places.
-    another_point = Point.new lat: 1, lng: 3
-    matrix.origins << another_point
-
+```ruby
+matrix.origins << lat_lng << address
+matrix.destinations << dest_address << dest_object
+
+# Added objects will be wrapped in a place automatically, so you may skip manyally creating Places.
+another_point = Point.new lat: 1, lng: 3
+matrix.origins << another_point
+```
 ### Do some configuration - see GoogleDistanceMatrix.configure_defaults as well.
-
-    matrix.configure do |config|
-      config.mode = 'driving'
-      config.avoid = ['tolls']
-
-      # To build signed URLs to use with a Google Business account. You may also use google_api_key.
-      config.google_business_api_client_id = "123"
-      config.google_business_api_private_key = "your-secret-key"
-    end
-
+```ruby
+matrix.configure do |config|
+  config.mode = 'driving'
+  config.avoid = ['tolls']
+
+  # To build signed URLs to use with a Google Business account.
+  config.google_business_api_client_id = "123"
+  config.google_business_api_private_key = "your-secret-key"
+
+  # If you have an API key, you can specify that as well.	
+  config.google_api_key = "YOUR_API_KEY"
+end
+```
 ### Get the data for the matrix
 
-    # Returns the data, loaded from Google, for this matrix.
-    # It is a multi dimensional array. Rows are ordered according to the values in the origins.
-    # Each row corresponds to an origin, and each element within that row corresponds to
-    # a pairing of the origin with a destination.
-    matrix.data
+`matrix.data` returns the data, loaded from Google, for this matrix.
+ 
+ It is a multi dimensional array. Rows are ordered according to the values in the origins.
+ Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination.
 
-### Query the matrix
 
-    # Returns an array of Google::DistanceMatrix::Route, all having given origin or destination.
-    matrix.routes_for dest_address
+### Query the matrix
 
-    # Returns Google::DistanceMatrix::Route with given origin and destination
-    matrix.route_for origin: lat_lng, destination: dest_address
+Returns an array of Google::DistanceMatrix::Route, all having given origin or destination.
 
-    matrix.shortest_route_by_distance_to(dest_address) # returns Google::DistanceMatrix::Route with one origin and a destination, together with route data
-    matrix.shortest_route_by_duration_to(dest_address) # returns Google::DistanceMatrix::Route with one origin and a destination, together with route data
+```ruby
+matrix.routes_for dest_address
+```
 
-    # In cases you built the place with an object (not hash with attributes) you may provide that object
-    # as well asking for routes. This is true for route_for and shortest_route_by_* as well.
-    matrix.routes_for point_dest # Returns routes for dest_object
+Returns Google::DistanceMatrix::Route with given origin and destination
 
-You may call query methods with a bang, in which case it will fail with an error if noe all routes in your result set for the called method is ok.
+```ruby
+matrix.route_for origin: lat_lng, destination: dest_address
+# Google::DistanceMatrix::Route with one origin and a destination, together with route data
+matrix.shortest_route_by_distance_to(dest_address) 
+# Google::DistanceMatrix::Route with one origin and a destination, together with route data
+matrix.shortest_route_by_duration_to(dest_address) 
+```
 
+In cases where you built the place with an object (not hash with attributes) you may provide that object as well asking for routes. This is true for `route_for` and `shortest_route_by_*` as well.
 
+```ruby
+matrix.routes_for point_dest # Returns routes for dest_object
+```
 
+You may call query methods with a bang, in which case it will fail with an error if not all of the routes in your result set for the called method are ok.
 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'google_distance_matrix'
-
+```ruby
+gem 'google_distance_matrix'
+```
 And then execute:
 
     $ bundle
@@ -96,26 +111,25 @@ Or install it yourself as:
     $ gem install google_distance_matrix
 
 
-
-
 ## Configuration
 
-    Configuration is done directly on a matrix or via GoogleDistanceMatrix.configure_defaults.
-    Apart from configuration on requests it is also possible to provide your own logger class and
-    set a cache.
+Configuration is done directly on a matrix or via `GoogleDistanceMatrix.configure_defaults`.
+Apart from configuration on requests it is also possible to provide your own logger class and
+set a cache.
 
 ### Request cache
 
-    Given Google's limit to the service you may have the need to cache requests. This is done by simply
-    using URL as cache keys. Cache we'll accept should provide a default ActiveSupport::Cache::Store interface.
-
-    GoogleDistanceMatrix.configure_defaults do |config|
-        config.cache = ActiveSupport::Cache.lookup_store :your_store, {
-            expires_in: 12.hours
-            # ..or other options you like for your store
-        }
-    end
-
+Given Google's limit to the service you may have the need to cache requests. This is done by simply
+using URL as cache keys. Cache we'll accept should provide a default ActiveSupport::Cache::Store interface.
+
+```ruby
+GoogleDistanceMatrix.configure_defaults do |config|
+    config.cache = ActiveSupport::Cache.lookup_store :your_store, {
+        expires_in: 12.hours
+        # ..or other options you like for your store
+    }
+end
+```
 
 
 ## Contributing

data/lib/google_distance_matrix/configuration.rb

@@ -36,7 +36,7 @@ module GoogleDistanceMatrix
 
     def initialize
       self.sensor = false
-      self.protocol = "http"
+      self.protocol = "https"
       self.lat_lng_scale = 5
 
       API_DEFAULTS.each_pair do |attr_name, value|

data/lib/google_distance_matrix/version.rb

@@ -1,3 +1,3 @@
 module GoogleDistanceMatrix
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/lib/google_distance_matrix/configuration_spec.rb

@@ -77,7 +77,7 @@ describe GoogleDistanceMatrix::Configuration do
     it { expect(subject.avoid).to be_nil }
     it { expect(subject.units).to eq "metric" }
     it { expect(subject.lat_lng_scale).to eq 5 }
-    it { expect(subject.protocol).to eq 'http' }
+    it { expect(subject.protocol).to eq 'https' }
     it { expect(subject.language).to be_nil }
 
     it { expect(subject.departure_time).to be_nil }

data/spec/lib/google_distance_matrix/url_builder_spec.rb

@@ -53,12 +53,12 @@ describe GoogleDistanceMatrix::UrlBuilder do
     end
 
     it "starts with the base URL" do
-      expect(subject.url).to start_with "http://" + described_class::BASE_URL
+      expect(subject.url).to start_with "https://" + described_class::BASE_URL
     end
 
     it "has a configurable protocol" do
-      matrix.configure { |c| c.protocol = "https" }
-      expect(subject.url).to start_with "https://"
+      matrix.configure { |c| c.protocol = "http" }
+      expect(subject.url).to start_with "http://"
     end
 
     it "includes origins" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_distance_matrix
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Thorbjørn Hermansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport