osrm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abbba908db095f586a1d939d8d935868805e67d5
-  data.tar.gz: 8915dca7dbf9e5979776c721e78ec4b3a4ac6c75
+  metadata.gz: 8597e75fad0414f8f8aa2b9ebce485b0f9ccd712
+  data.tar.gz: 698e2fc52de22d09adfe7a06e57ba8f889a286f2
 SHA512:
-  metadata.gz: cda0b0be5ea7b71b488c283cd9e2200a75f7f785baf9a8b5fd01eefa6b2e937a7edc109aab14c86f2382bfe53339982cb18794b985c936101611683681aa70b6
-  data.tar.gz: 94e4f2a643f72c09a56cd7ee7941f1ae65228095d76ad15227ed943da6ff8b2119d977b4fc6c797c02d61aadc98c79e4fe52e7ce0a1d85b0a97da9f9ef71ad90
+  metadata.gz: dfc6876e927a578f05261f6519f9025040045ac49cbe2e785b81fed5f459b90c9f2425dc1954c358e883c9eff91db6b21f87eb5a8dae30ef77439d1378e15e74
+  data.tar.gz: bf665ae1f754cd6486c9da9cb479b969fe5e277629759430e2979e367362ad8aa06f6d5887f80ab8c0220144fca0d1c0580d660bbbf4b0612a699a4c0651dae6

data/README.md

@@ -18,8 +18,12 @@ You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki)
           server:     'example.com',      # Must be specified
           port:       8080,               # Default: 80 or 443 if SSL
           use_ssl:    true,               # Default: false
-          timeout:    10,                 # Default: 3
-          user_agent: 'MyScript/1.1',     # Default: 'OSRMRubyGem/{version}'
+
+          # Connection (advanced)
+          timeout:        10,                               # Default: 3
+          user_agent:     'MyScript/1.1',                   # Default: 'OSRMRubyGem/{version}'
+          before_request: -> { sleep 1 },                   # Default: nil
+          after_request:  -> { puts 'Request performed!' }, # Default: nil
 
           # Caching
           # The cache can be any object providing [] and []= methods.

data/lib/osrm/configuration.rb

@@ -6,13 +6,17 @@ module OSRM
     include Singleton
 
     DEFAULTS = {
-      server:     nil,
-      port:       nil,
-      use_ssl:    false,
-      timeout:    3,
-      user_agent: "OSRMRubyGem/#{OSRM::VERSION}",
-      cache:      nil,
-      cache_key:  'osrm:{url}'
+      server:  nil,
+      port:    nil,
+      use_ssl: false,
+
+      timeout:        3,
+      user_agent:     "OSRMRubyGem/#{OSRM::VERSION}",
+      before_request: nil,
+      after_request:  nil,
+
+      cache:     nil,
+      cache_key: 'osrm:{url}'
     }.freeze
 
     DEMO_SERVER = 'router.project-osrm.org'.freeze
@@ -51,6 +55,22 @@ module OSRM
       @data[:timeout] = timeout && timeout.to_i
     end
 
+    def before_request=(before_request)
+      if before_request && !before_request.is_a?(Proc)
+        fail "OSRM API error: Invalid before request #{before_request.inspect}"
+      end
+
+      @data[:before_request] = before_request
+    end
+
+    def after_request=(after_request)
+      if after_request && !after_request.is_a?(Proc)
+        fail "OSRM API error: Invalid after request #{after_request.inspect}"
+      end
+
+      @data[:after_request] = after_request
+    end
+
     def cache_key=(cache_key)
       unless cache_key.include?('{url}')
         fail "OSRM API error: Invalid cache key #{cache_key.inspect}"

data/lib/osrm/query.rb

@@ -11,6 +11,9 @@ module OSRM
       @locations = locations.compact.reject(&:empty?)
     end
 
+    # OPTIMIZE: Implement a custom locations= method
+    #   -> Remove consecutive duplicate locations (http://stackoverflow.com/a/8105422)
+
     # OPTIMIZE: Don't execute if 0 or 1 location(s)
     def execute
       json = fetch_json_data
@@ -51,7 +54,12 @@ module OSRM
     end
 
     def fetch_raw_data
+      configuration.before_request.call if configuration.before_request
       response = api_request
+      configuration.after_request.call if configuration.after_request
+      # TODO: Be sure that after request is ALWAYS called???
+      #   (even if api_request failed)
+
       response.body if valid_response?(response)
     rescue SocketError
       warn 'OSRM API error: Unable to establish connection'

data/lib/osrm/version.rb

@@ -1,3 +1,3 @@
 module OSRM
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osrm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Freayd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2014-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +70,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.2
@@ -66,7 +80,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.2
@@ -103,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: OSRM API for Ruby