distance_fox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 989ce144fd8f843cfb86e145fee8fd0b836ae396cc15ce90e1ea0c7028116ee5
+  data.tar.gz: 439f855b025a9763c31ec4fd30058448c86f47cd4568f39926b3bcafa27c47c5
+SHA512:
+  metadata.gz: d671f620f3a0c0e01e731d929c31362b9fc1b016530fd2c8893d84915e1c85e87060b310652e3a74cda98ae99cd9936e4acd5de6f737097eb5bea440be428fe0
+  data.tar.gz: 67105a86d674103aab093567469df988c52a3d5ea863965b435d85e2a7615f8e706433d374b13e61b3910925c3f417ae0cd7bc74af8acfffa8ea4550e09df4a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at d.wollendorfer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in distance_fox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    distance_fox (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.1)
+  distance_fox!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 danielwollen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# DistanceFox
+
+DistanceFox was extracted from our Rails API at GoFoxBox. DistanceFox calculates the driving distance from a given destination to the nearest of multiple warehouses. We use the tool at the checkout of our shop for real-time calculations of distance based shipping rates. For fast calculations the tool finds the nearest warehouse location based on the harversine distance formula, which calculates distances based on the coordinates and earth radius. For accuracy the driving distance to the nearest warehouse will be fetched with the Google Distance Matrix API. This has proven to be a very accurate and fast way to find the nearest location across multiple warehouses without losing accuracy in the result.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'distance_fox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install distance_fox
+
+## Configuration
+
+```ruby
+DistanceFox.configure do |config|
+  config.google_api_key = 'YOUR_API_KEY'
+end
+```
+
+## Usage
+
+```ruby
+# Origin can be:
+# * an array of coordinates ([lat,lon])
+# * an array of coordinates (['lat','lon'])
+# * a geocodable address (string)
+#
+# Destinations can be:
+# * a hash of arrays ({['city' => 'City', 'coordinates' => ['lat','lon']]})
+DistanceFox::Calculations.nearest_driving_distance(origin_coordinates, destinations)
+
+# Origin can be:
+# * an array of float coordinates ([lat,lon])
+# * an array of string coordinates (['lat','lon'])
+#
+# Destinations can be:
+# * a hash of arrays ({['city' => 'City', 'coordinates' => ['lat','lon']]})
+DistanceFox::Calculations.nearest_linear_distance(origin, destinations)
+
+# Origin and destination can be:
+#
+# * an array of coordinates ([lat,lon])
+# * an array of coordinates (['lat','lon'])
+# * a geocodable address (string)
+DistanceFox::Calculations.driving_distance(origin, destination)
+
+# Origin and destination can be:
+#
+# * an array of coordinates ([lat,lon])
+# * an array of coordinates (['lat','lon'])
+# * a geocodable address (string)
+DistanceFox::Calculations.linear_distance(origin, destination)
+
+# Address can be:
+# a geocodable address (string)
+DistanceFox::Calculations.geocode(address)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielwollen/distance_fox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DistanceFox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/danielwollen/distance_fox/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'distance_fox'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/distance_fox.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'distance_fox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'distance_fox'
+  spec.version       = DistanceFox::VERSION
+  spec.authors       = ['danielwollen']
+  spec.email         = ['d.wollendorfer@gmail.com']
+
+  spec.summary       = 'Calculate the driving distance from a destination to the nearest of multiple locations'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/distance_fox.rb

@@ -0,0 +1,7 @@
+require 'distance_fox/version'
+require 'distance_fox/configuration'
+require 'distance_fox/calculations'
+
+module DistanceFox
+  class Error < StandardError; end
+end

data/lib/distance_fox/calculations.rb

@@ -0,0 +1,117 @@
+require 'httparty'
+
+module DistanceFox
+  class Calculations
+    EARTH_RADIUS = 6371.0
+
+    # Origin and destination can be:
+    #
+    # * an array of coordinates ([lat,lon])
+    # * an array of coordinates (['lat','lon'])
+    # * a geocodable address (string)
+    def self.linear_distance(origin, destination)
+      lat_origin, lon_origin = extract_coordinates origin
+      lat_destination, lon_destination = extract_coordinates destination
+
+      delta_lat = (lat_destination - lat_origin) * Math::PI / 180
+      delta_lon = (lon_destination - lon_origin) * Math::PI / 180
+
+      a = Math.sin(delta_lat / 2) *
+          Math.sin(delta_lat / 2) +
+          Math.cos(lat_origin * Math::PI / 180) *
+          Math.cos(lat_destination * Math::PI / 180) *
+          Math.sin(delta_lon / 2) * Math.sin(delta_lon / 2)
+
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
+
+      d = EARTH_RADIUS * c
+      d.round(3)
+    end
+
+    ##
+    # Linear Distance to nearest location from multiple locations
+    # Origin can be:
+    # * an array of float coordinates ([lat,lon])
+    # * an array of string coordinates (['lat','lon'])
+    #
+    # Destinations can be:
+    # * a hash of arrays ({['city' => 'City', 'coordinates' => ['lat','lon']]})
+    def self.nearest_linear_distance(origin, destinations)
+      origins_with_distance = []
+      origin_coordinates = extract_coordinates origin
+      destinations.each do |destination|
+        distance = linear_distance(origin_coordinates, destination['coordinates'])
+        origins_with_distance.push(
+          'destination' => destination['city'],
+          'distance' => distance,
+          'coordinates' => {
+            'origin' => origin_coordinates,
+            'destination' => destination['coordinates']
+          }
+        )
+      end
+      origins_with_distance.min_by { |key| key['distance'] }
+    end
+
+    ##
+    # Origin and destination can be:
+    #
+    # * an array of coordinates ([lat,lon])
+    # * an array of coordinates (['lat','lon'])
+    # * a geocodable address (string)
+    def self.driving_distance(origin, destination)
+      origin = origin.to_s
+      destination = destination.to_s
+      google_distance_query = "https://maps.googleapis.com/maps/api/distancematrix/json?mode=driving&origins=#{origin}&destinations=#{destination}&key=#{DistanceFox.configuration.api_key}"
+      google_distance_object = HTTParty.get(URI.escape(google_distance_query))
+      google_distance_object['rows'].first['elements'].first['distance']['value'].to_f / 1000
+    end
+
+    ##
+    # Driving Distance to nearest location from multiple locations
+    #
+    # Origin can be:
+    # * an array of coordinates ([lat,lon])
+    # * an array of coordinates (['lat','lon'])
+    # * a geocodable address (string)
+    #
+    # Destinations can be:
+    # * a hash of arrays ({['city' => 'City', 'coordinates' => ['lat','lon']]})
+    def self.nearest_driving_distance(origin, destinations)
+      origin = origin.join(',')
+      destination = nearest_linear_distance(origin, destinations)['coordinates']['destination'].join(',')
+      driving_distance(origin, destination)
+    end
+
+    # Address can be:
+    # a geocodable address (string)
+    def self.geocode(address)
+      google_distance_query = "https://maps.googleapis.com/maps/api/geocode/json?address=#{address}&key=#{DistanceFox.configuration.api_key}"
+      google_distance_object = HTTParty.get(URI.escape(google_distance_query))
+      coordinates = google_distance_object['results'][0]['geometry']['location']
+      [coordinates['lat'], coordinates['lng']]
+    end
+
+    private
+
+    ##
+    # Takes an object which is a [lat,lon] array or a geocodable string.
+    # Note that if a string is passed this may be a slow-
+    # running method and may return nil.
+    def self.extract_coordinates(point)
+      case point
+      when Array
+        if point.size == 2
+          lat, lon = point
+          if !lat.nil? && lat.respond_to?(:to_f) &&
+             !lon.nil? && lon.respond_to?(:to_f)
+            return [lat.to_f, lon.to_f]
+          end
+        end
+      when String
+        (point = geocode(point)) && (return point)
+      end
+      [NAN, NAN]
+    end
+  end
+end

data/lib/distance_fox/configuration.rb

@@ -0,0 +1,22 @@
+module DistanceFox
+  #
+  # DistanceFox.configure do |config|
+  #  config.google_api_key = 'YOUR_API_KEY'
+  # end
+  #
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/distance_fox/version.rb

@@ -0,0 +1,3 @@
+module DistanceFox
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: distance_fox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- danielwollen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- d.wollendorfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- distance_fox.gemspec
+- lib/distance_fox.rb
+- lib/distance_fox/calculations.rb
+- lib/distance_fox/configuration.rb
+- lib/distance_fox/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Calculate the driving distance from a destination to the nearest of multiple
+  locations
+test_files: []