google_distance_matrix 0.0.1

data/spec/lib/google_distance_matrix/places_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe GoogleDistanceMatrix::Places do
+  let(:values) { [{address: "one"}, {address: "two"}, {address: "three"}] }
+  let(:places) { values.map { |v| GoogleDistanceMatrix::Place.new v } }
+
+  let(:place_4) { GoogleDistanceMatrix::Place.new address: "four" }
+  let(:place_5) { GoogleDistanceMatrix::Place.new address: "five" }
+  let(:place_6) { GoogleDistanceMatrix::Place.new address: "six" }
+
+  subject { described_class.new places }
+
+  it { should include *places }
+  it { should_not include 5 }
+
+
+  %w[<< push unshift].each do |attr|
+    describe "#{attr}" do
+      it "adds value" do
+        expect {
+          subject.public_send attr, place_4
+        }.to change { subject.include? place_4 }.to true
+      end
+
+      it "keeps uniq values" do
+        subject.public_send attr, place_4
+
+        expect {
+          subject.public_send attr, place_4
+        }.to_not change subject, :length
+      end
+
+      it "is chanable" do
+        subject.public_send(attr, place_5).public_send(attr, place_6)
+
+        expect(subject).to include place_5, place_6
+      end
+
+      it "wraps values in a Place" do
+        subject.public_send attr, {address: "four"}
+
+        expect(subject.all? { |place| place.is_a? GoogleDistanceMatrix::Place }).to be_true
+        expect(subject.any? { |place| place.address == "four" }).to be_true
+      end
+    end
+  end
+
+  %w[push unshift].each do |attr|
+    describe "#{attr}" do
+      it "adds multiple values at once" do
+        subject.public_send attr, place_4, place_5
+        expect(subject).to include place_4, place_5
+      end
+    end
+  end
+
+  describe "#concat" do
+    let(:places_2) { [place_4, place_5, place_6] }
+
+    it "adds the given array" do
+      subject.concat places_2
+      expect(subject).to include *places_2
+    end
+
+    it "keeps values uniq" do
+      subject.concat places_2
+
+      expect {
+        subject.concat places_2
+      }.to_not change subject, :length
+    end
+
+    it "returns self" do
+      expect(subject.concat places_2).to eq subject
+    end
+  end
+end

data/spec/lib/google_distance_matrix/route_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe GoogleDistanceMatrix::Route do
+  let(:attributes) do
+    {
+      "distance" => {"text" => "2.0 km", "value" => 2032},
+      "duration" => {"text" =>"6 mins",  "value" => 367},
+      "status" =>"OK"
+    }
+  end
+
+  subject { described_class.new attributes }
+
+  its(:status) { should eq "ok" }
+  its(:distance_in_meters) { should eq 2032 }
+  its(:distance_text) { should eq "2.0 km" }
+  its(:duration_in_seconds) { should eq 367 }
+  its(:duration_text) { should eq "6 mins" }
+
+  describe "deprecations" do
+    around { |example| ActiveSupport::Deprecation.silence { example.run } }
+
+    its(:duration_value) { should eq 367 }
+    its(:distance_value) { should eq 2032 }
+  end
+
+  it { should be_ok }
+end

data/spec/lib/google_distance_matrix/routes_finder_spec.rb

@@ -0,0 +1,190 @@
+require "spec_helper"
+
+describe GoogleDistanceMatrix::RoutesFinder, :request_recordings do
+  let(:origin_1) { GoogleDistanceMatrix::Place.new address: "Karl Johans gate, Oslo" }
+  let(:origin_2) { GoogleDistanceMatrix::Place.new address: "Askerveien 1, Asker" }
+
+  let(:destination_1) { GoogleDistanceMatrix::Place.new address: "Drammensveien 1, Oslo" }
+
+  let(:destination_2_built_from) { mock address: "Skjellestadhagen, Heggedal" }
+  let(:destination_2) { GoogleDistanceMatrix::Place.new destination_2_built_from }
+
+  let(:url_builder) { GoogleDistanceMatrix::UrlBuilder.new matrix }
+  let(:url) { url_builder.url }
+
+  let(:matrix) do
+    GoogleDistanceMatrix::Matrix.new(
+      origins: [origin_1, origin_2],
+      destinations: [destination_1, destination_2]
+    )
+  end
+
+  subject { described_class.new matrix }
+
+  context "success" do
+    let!(:api_request_stub) { stub_request(:get, url).to_return body: recorded_request_for(:success) }
+
+    describe "#routes_for" do
+      it "fails if given place does not exist" do
+        expect { subject.routes_for "foo" }.to raise_error ArgumentError
+      end
+
+      it "returns routes for given origin" do
+        routes = subject.routes_for origin_1
+
+        expect(routes.length).to eq 2
+        expect(routes.map(&:origin).all? { |o| o == origin_1 }).to be true
+      end
+
+      it "returns routes for given destination" do
+        routes = subject.routes_for destination_2
+
+        expect(routes.length).to eq 2
+        expect(routes.map(&:destination).all? { |d| d == destination_2 }).to be true
+      end
+
+      it "returns routes for given object a place was built from" do
+        routes = subject.routes_for destination_2_built_from
+
+        expect(routes.length).to eq 2
+        expect(routes.map(&:destination).all? { |d| d == destination_2 }).to be true
+      end
+    end
+
+    describe "#routes_for!" do
+      it "returns the same as routes_for" do
+        expect(subject.routes_for! origin_1).to eq subject.routes_for(origin_1)
+      end
+    end
+
+    describe "#route_for" do
+      it "returns route" do
+        route = subject.route_for(origin: origin_1, destination: destination_1)
+        expect(route.origin).to eq origin_1
+        expect(route.destination).to eq destination_1
+      end
+
+      it "returns route when you give it the object a place was built from" do
+        route = subject.route_for(origin: origin_1, destination: destination_2_built_from)
+        expect(route.origin).to eq origin_1
+        expect(route.destination).to eq destination_2
+      end
+
+      it "fails with argument error if origin is missing" do
+        expect { subject.route_for destination: destination_2 }.to raise_error ArgumentError
+      end
+
+      it "fails with argument error if destination is missing" do
+        expect { subject.route_for origin: origin_1 }.to raise_error ArgumentError
+      end
+
+      it "fails with argument error if sent in object is neither place nor something it was built from" do
+        expect { subject.route_for origin: origin_1, destination: mock }.to raise_error ArgumentError
+      end
+    end
+
+    describe "#route_for!" do
+      it "returns the same as route_for" do
+        route = subject.route_for(origin: origin_1, destination: destination_1)
+        route_bang = subject.route_for!(origin: origin_1, destination: destination_1)
+
+        expect(route).to eq route_bang
+      end
+    end
+
+    describe "#shortest_route_by_distance_to" do
+      it "returns route representing shortest distance to given origin" do
+        expect(subject.shortest_route_by_distance_to(origin_1)).to eq matrix.data[0][0]
+      end
+
+      it "returns route representing shortest distance to given destination" do
+        expect(subject.shortest_route_by_distance_to(destination_2)).to eq matrix.data[1][1]
+      end
+    end
+
+    describe "#shortest_route_by_distance_to!" do
+      it "returns the same as shortest_route_by_distance_to" do
+        expect(subject.shortest_route_by_distance_to!(origin_1)).to eq subject.shortest_route_by_distance_to(origin_1)
+      end
+    end
+
+    describe "#shortest_route_by_duration_to" do
+      it "returns route representing shortest duration to given origin" do
+        expect(subject.shortest_route_by_duration_to(origin_1)).to eq matrix.data[0][0]
+      end
+
+      it "returns route representing shortest duration to given destination" do
+        expect(subject.shortest_route_by_duration_to(destination_2)).to eq matrix.data[1][1]
+      end
+    end
+
+    describe "#shortest_route_by_duration_to!" do
+      it "returns the same as shortest_route_by_duration_to" do
+        expect(subject.shortest_route_by_duration_to!(origin_1)).to eq subject.shortest_route_by_duration_to(origin_1)
+      end
+    end
+  end
+
+  context "routes mssing data" do
+    let!(:api_request_stub) { stub_request(:get, url).to_return body: recorded_request_for(:zero_results) }
+
+    describe "#routes_for" do
+      it "returns routes for given origin" do
+        routes = subject.routes_for origin_1
+
+        expect(routes.length).to eq 2
+        expect(routes.map(&:origin).all? { |o| o == origin_1 }).to be true
+      end
+    end
+
+    describe "#routes_for!" do
+      it "fails upon any non-ok route" do
+        expect {
+          subject.routes_for! origin_1
+        }.to raise_error GoogleDistanceMatrix::InvalidRoute
+      end
+    end
+
+
+    describe "#route_for" do
+      it "returns route" do
+        route = subject.route_for origin: origin_1, destination: destination_2
+        expect(route.origin).to eq origin_1
+        expect(route.destination).to eq destination_2
+      end
+    end
+
+    describe "#route_for!" do
+      it "fails upon non-ok route" do
+        expect {
+          subject.route_for! origin: origin_1, destination: destination_2
+        }.to raise_error GoogleDistanceMatrix::InvalidRoute
+      end
+    end
+
+
+    describe "#shortest_route_by_distance_to" do
+      it "returns route representing shortest distance to given origin" do
+        expect(subject.shortest_route_by_distance_to(origin_1)).to eq matrix.data[0][0]
+      end
+    end
+
+    describe "#shortest_route_by_distance_to!" do
+      it "fails upon non-ok route" do
+        expect { subject.shortest_route_by_distance_to!(origin_1) }.to raise_error GoogleDistanceMatrix::InvalidRoute
+      end
+    end
+
+    describe "#shortest_route_by_duration_to" do
+      it "returns route representing shortest distance to given origin" do
+        expect(subject.shortest_route_by_duration_to(origin_1)).to eq matrix.data[0][0]
+      end
+    end
+
+    describe "#shortest_route_by_duration_to!" do
+      it "fails upon non-ok route" do
+        expect { subject.shortest_route_by_duration_to!(origin_1) }.to raise_error GoogleDistanceMatrix::InvalidRoute
+      end
+    end
+  end
+end

data/spec/lib/google_distance_matrix/url_builder_spec.rb

@@ -0,0 +1,105 @@
+require "spec_helper"
+
+describe GoogleDistanceMatrix::UrlBuilder do
+  let(:delimiter) { described_class::DELIMITER }
+  let(:comma) { CGI.escape "," }
+
+  let(:origin_1) { GoogleDistanceMatrix::Place.new address: "address_origin_1" }
+  let(:origin_2) { GoogleDistanceMatrix::Place.new address: "address_origin_2" }
+
+  let(:destination_1) { GoogleDistanceMatrix::Place.new lat: 1, lng: 11 }
+  let(:destination_2) { GoogleDistanceMatrix::Place.new lat: 2, lng: 22 }
+
+  let(:origins) { [origin_1, origin_2] }
+  let(:destinations) { [destination_1, destination_2] }
+
+  let(:matrix) do
+    GoogleDistanceMatrix::Matrix.new(
+      origins: origins,
+      destinations: destinations
+    )
+  end
+
+  subject { described_class.new matrix }
+
+  describe "#initialize" do
+    it "has a matrix" do
+      expect(described_class.new(matrix).matrix).to eq matrix
+    end
+
+    it "fails if matrix is invalid" do
+      expect {
+        described_class.new GoogleDistanceMatrix::Matrix.new
+      }.to raise_error GoogleDistanceMatrix::InvalidMatrix
+    end
+
+    it "fails if matrix's configuration is invalid" do
+      expect {
+        matrix.configure { |c| c.sensor = nil }
+        described_class.new matrix
+      }.to raise_error GoogleDistanceMatrix::InvalidMatrix
+    end
+  end
+
+
+  describe "#url" do
+    it "fails if the url is more than 2048 characters" do
+      long_string = ""
+      2049.times { long_string << "a" }
+
+      subject.stub(:get_params_string).and_return long_string
+
+      expect { subject.url }.to raise_error GoogleDistanceMatrix::MatrixUrlTooLong
+    end
+
+    it "starts with the base URL" do
+      expect(subject.url).to start_with "http://" + described_class::BASE_URL
+    end
+
+    it "has a configurable protocol" do
+      matrix.configure { |c| c.protocol = "https" }
+      expect(subject.url).to start_with "https://"
+    end
+
+    it "includes origins" do
+      expect(subject.url).to include "origins=address_origin_1#{delimiter}address_origin_2"
+    end
+
+    it "includes destinations" do
+      expect(subject.url).to include "destinations=1#{comma}11#{delimiter}2#{comma}22"
+    end
+
+    describe "lat lng scale" do
+      let(:destination_1) { GoogleDistanceMatrix::Place.new lat: 10.123456789, lng: "10.987654321" }
+
+      it "rounds lat and lng" do
+        subject.matrix.configure { |c| c.lat_lng_scale = 5 }
+
+        expect(subject.url).to include "destinations=10.12346#{comma}10.98765"
+      end
+    end
+
+    describe "configuration" do
+      it "includes sensor" do
+        expect(subject.url).to include "sensor=#{matrix.configuration.sensor}"
+      end
+
+      context "with google business client id and private key set" do
+        before do
+          matrix.configure do |config|
+            config.google_business_api_client_id = "123"
+            config.google_business_api_private_key = "secret"
+          end
+        end
+
+        it "includes client" do
+          expect(subject.url).to include "client=#{matrix.configuration.google_business_api_client_id}"
+        end
+
+        it "has signature" do
+          expect(subject.url).to include "signature=gskXXJxOmPDXE1jAwafNGM2CVTI"
+        end
+      end
+    end
+  end
+end

data/spec/request_recordings/success

@@ -0,0 +1,62 @@
+{
+   "destination_addresses" : [
+      "Drammensveien 1, 0271 Oslo, Norway",
+      "Skjellestadhagen, 1389 Heggedal, Norway"
+   ],
+   "origin_addresses" : [ "Karl Johans gate, Oslo, Norway", "Askerveien 1, 1384 Asker, Norway" ],
+   "rows" : [
+      {
+         "elements" : [
+            {
+               "distance" : {
+                  "text" : "2.0 km",
+                  "value" : 2032
+               },
+               "duration" : {
+                  "text" : "6 mins",
+                  "value" : 367
+               },
+               "status" : "OK"
+            },
+            {
+               "distance" : {
+                  "text" : "30.3 km",
+                  "value" : 30345
+               },
+               "duration" : {
+                  "text" : "32 mins",
+                  "value" : 1924
+               },
+               "status" : "OK"
+            }
+         ]
+      },
+      {
+         "elements" : [
+            {
+               "distance" : {
+                  "text" : "21.2 km",
+                  "value" : 21246
+               },
+               "duration" : {
+                  "text" : "22 mins",
+                  "value" : 1315
+               },
+               "status" : "OK"
+            },
+            {
+               "distance" : {
+                  "text" : "9.1 km",
+                  "value" : 9103
+               },
+               "duration" : {
+                  "text" : "15 mins",
+                  "value" : 878
+               },
+               "status" : "OK"
+            }
+         ]
+      }
+   ],
+   "status" : "OK"
+}