osrm_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 238aeb1689da90fbecf6c1af2deba2058d5e1745
-  data.tar.gz: bbb3387c67f31b68b7771f1c5acea7c71d7ded9c
+  metadata.gz: a102047d344d59c5fe684fc9e3d6c48774f49a0c
+  data.tar.gz: 0fe7b46ef8d7736fb528b9952479b8d85850abd0
 SHA512:
-  metadata.gz: 6744e8a869f4bdf3108d6c03cf59a3f6d6dbbf0d5711d4dfafc30f2e861ef86065ae74fbd4fb2294c5a026668c731f2dd016e8a35ba26a8428c60951173d6182
-  data.tar.gz: 10afa72994fbb1c4afd0ae2231af01ca46f530ee9b4c647d1e2f7a365bbf6ceb37814a818f74bdf7cc242f22b46c86f5bfcae5cc20ee0449825e536893133fed
+  metadata.gz: aa44e3fb76385d4f639ebdeb88f48787b32f99bd704ae313499a7588161a477969d10983b6b322cfb175f6a0d482f3ac9e358fb458f633bf8f9322f09e8031b3
+  data.tar.gz: 80d7510320d118f28b38d42778793a50f1ef7cc1c6c4307a68750e82e9bd58dc2a300aa39180670e8ddb4a10db15be17b27f643e51d4b64b50cc1191c7e29eb8

data/README.md

@@ -33,8 +33,45 @@ route = client.route('40.723279,-73.937766', '40.90,-73.10', '40.823279,-73.9377
 locate = client.locate('53.911808, 27.595035')
 nearest = client.nearest('53.911808, 27.595035')
 ```
+To connect any special settings it’s necessary to use block construction like the following one:
+
+```ruby
+route = client.route('40.723279,-73.937766', '40.90,-73.10') do |request| 
+        request.add_param 'z', 7 
+end
+```
 ### Response
 
+There are 4 types of responses.
+
+LocateObject extends base class.
+There arise new property @lat and @lon which contain point position.
+```ruby
+lc = client.locate('40.723279,-73.9377')
+lc.lat # => '40.723274'
+lc.lon # => '-73.937408'
+```
+
+NearestObject extends Locate and adds new property @name, which contains the name of object on the map.
+```ruby
+nr = client.nearest('40.723279,-73.9377')
+nr.lat # => '40.723274'
+nr.lon # => '-73.937408'
+nr.name # => 'Anthony Street'
+```
+
+DistanceObject contains in the @distance_table property the amount which reflects the distance between the points of the request.
+```ruby
+dc = client.distance('40.723279,-73.9377', '40.723279,-73.9877')
+dc.distance_table # => [[0, 3551], [4116,0]]
+``` 
+
+RouteObject contains geometry, summary, instructions, name properties. If there is a necessity to get other properties of the route, you need to call to them via @orgin_response property of the parent class.
+```ruby
+rt = client.route('40.723279,-73.9377', '40.723279,-73.9877')
+rt.summary['total_time'] # => 355
+``` 
+
 ## Contributing
 
 1. Fork it ( https://github.com/ikantam/osrm-api/fork )

data/lib/osrm_api/client.rb

@@ -29,21 +29,21 @@ module OSRM
     # @return [Response::LocateObject]
     def locate(location)
       request = Request::LocateRequest.new(location)
-      yield if block_given?
+      request = yield request if block_given?
       Response::LocateObject.new execute request
     end
 
     # @return [Response::RouteObject]
     def route(*locations)
       request = Request::RouteRequest.new(*locations)
-      yield if block_given?
+      yield request if block_given?
       Response::RouteObject.new execute request
     end
 
     # @return [Response::NearestObject]
     def nearest(location)
       request = Request::NearestRequest.new(location)
-      yield if block_given?
+      yield request if block_given?
       Response::NearestObject.new execute request
     end
 
@@ -52,7 +52,7 @@ module OSRM
     # @return [Response::DistanceObject]
     def distance(*locations)
       request = Request::DistanceRequest.new(*locations)
-      yield if block_given?
+      yield request if block_given?
       Response::DistanceObject.new execute request
     end
 

data/lib/osrm_api/version.rb

@@ -1,4 +1,4 @@
 # :nodoc
 module OSRM
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/osrm_api.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version     = '>= 2.0.0'
+  spec.required_rubygems_version = '>= 1.8.11'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/spec/osrm_api/client_spec.rb

@@ -3,11 +3,12 @@ require 'rspec'
 require 'osrm_api'
 
 describe OSRM::Client do
+  TEST_HOST = 'example.com'
   subject(:factory) { described_class }
 
   describe '#Instantiate object' do
-    WebMock.disable!
     it '#with invalid params' do
+      WebMock.disable!
       obj = factory.new(host: 'bla-bla-bla')
       expect { obj.route('12.12,-12.1', '123.1,-34.1') }
         .to raise_error(SocketError)
@@ -15,9 +16,8 @@ describe OSRM::Client do
 
     it '#with correct' do
       WebMock.enable!
-      TEST_HOST = 'example.com'
-      QUERY_STRING  = 'locate?loc=12.12,-12.12'
-      stub_request(:any, 'http://' + TEST_HOST + ':5000/' + QUERY_STRING)
+      query_string  = 'locate?loc=12.12,-12.12'
+      stub_request(:any, 'http://' + TEST_HOST + ':5000/' + query_string)
         .to_return(body: JSON.generate(status: 0, mapped_coordinate: [1, 2]))
       obj = factory.new(host: TEST_HOST)
       expect(obj.locate('12.12, -12.12')).to_not eq(nil)

data/spec/osrm_api/response/nearest_object_spec.rb

@@ -4,7 +4,7 @@ describe OSRM::Response::NearestObject do
   subject(:factory) { described_class }
   describe '#Instantiate' do
     it '#with valid params' do
-      json = JSON.parse(fixture('nearest.json'))
+      json = JSON.parse(fixture('nearest.json').read)
       obj = factory.new json
       expect(obj.name).to eq(json['name'])
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osrm_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - IgorPetuh
@@ -88,12 +88,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5