geo_distance 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdce01bb820d0696ee51e1641b57a44e744484bca4568190e539868ddea6b6d5
+  data.tar.gz: c54ec69ae551761eaad81a275aa9b10f3595272738f61c3aed28b4dd840f86bc
+SHA512:
+  metadata.gz: fbd9064cf33b56c7d6afc898bc8c80822bedbb4e5730dd6e28b44bf32b676bc74cb3a62112ad3949ffea92687e3d7f1f666ee6641030c7fe5efc0aba8bd12dde
+  data.tar.gz: add248e7eb781848964f2a34547d8d6e0d670df9f34d34afdad459fbe14c7c780af866324514a81828acae42e138374167b6a1b2264fe5e833a667703d32c677

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.16.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 zeljkokalezic@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 geo_distance.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    geo_distance (0.1.1)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.6)
+      childprocess (>= 0.6.3, < 0.10.0)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    ast (2.3.0)
+    backports (3.11.4)
+    builder (3.2.3)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    contracts (0.16.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.0)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (>= 5.0.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    gherkin (5.1.0)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    thor (0.19.4)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.16)
+  cucumber
+  geo_distance!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zeljko Kalezic
+
+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,51 @@
+# GeoDistance
+
+This gem is used to provide a list of customer records that are within desired distance from specified location.
+Customer records are a text file -- one customer per line, JSON lines formatted.
+This gem will read the full list of customers and output the names and user ids of matching customers (within X meters), sorted by User ID (ascending).
+
+## Installation
+
+This gem is a CLI tool.
+
+Install it yourself as:
+
+    $ gem install geo_distance
+
+## Usage
+
+    $ geo_distance get_customers_in_radius valid_customers.txt 53.339428 -6.257664 100000
+    ["Ian Kehoe", 4]
+    ["Nora Dempsey", 5]
+    ["Theresa Enright", 6]
+    ["Eoin Ahearn", 8]
+    ["Richard Finnegan", 11]
+    ["Christina McArdle", 12]
+    ["Olive Ahearn", 13]
+    ["Michael Ahearn", 15]
+    ["Patricia Cahill", 17]
+    ["Eoin Gallagher", 23]
+    ["Rose Enright", 24]
+    ["Stephen McArdle", 26]
+    ["Oliver Ahearn", 29]
+    ["Nick Enright", 30]
+    ["Alan Behan", 31]
+    ["Lisa Ahearn", 39]
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/zeljkokalezic/geo_distance. 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 GeoDistance project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/geo_distance/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geo_distance"
+
+# 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/geo_distance

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "geo_distance/cli"
+
+GeoDistance::CLI.start

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/geo_distance.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geo_distance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geo_distance"
+  spec.version       = GeoDistance::VERSION
+  spec.authors       = ["Zeljko Kalezic"]
+  spec.email         = ["zeljkokalezic@gmail.com"]
+
+  spec.summary       = "Generates list of places within desired distance from a point."
+  spec.homepage      = "https://github.com/zeljkokalezic/geo_locator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "rubocop"
+
+  spec.add_dependency "thor"
+end

data/lib/geo_distance.rb

@@ -0,0 +1,14 @@
+require "geo_distance/version"
+require "geo_distance/input/file"
+require "geo_distance/parser/json"
+require "geo_distance/splitter/character"
+require "geo_distance/persistence/console"
+require "geo_distance/operation/customer"
+require "geo_distance/model/customer"
+require "geo_distance/model/location"
+require "geo_distance/serializer/customer"
+require "geo_distance/transformer/sort"
+require "geo_distance/cli"
+
+module GeoDistance
+end

data/lib/geo_distance/cli.rb

@@ -0,0 +1,19 @@
+require 'thor'
+require 'geo_distance'
+
+module GeoDistance
+  class CLI < Thor
+
+    desc "get_customers_in_radius customers_file_path latitude longitude radius",
+         "Outputs a list of customers that are inside deisred radius (in meters) from specified location coordinates"
+    def get_customers_in_radius(customers_file_path, latitude, longitude, radius)
+      customers = GeoDistance::Parser::Json.get_customers_from_file(customers_file_path)
+      location = GeoDistance::Model::Location.new(latitude, longitude)
+      result = GeoDistance::Operation::Customer.get_customers_in_radius(customers, location, radius)
+      sorted_result = GeoDistance::Transformer::Sort.acsending(result, "id")
+      serialized_result = GeoDistance::Serializer::Customer.serialize_array(sorted_result, ["name", "id"])
+      GeoDistance::Persistence::Console.print_array(serialized_result)
+    end
+
+  end
+end

data/lib/geo_distance/input/file.rb

@@ -0,0 +1,9 @@
+module GeoDistance::Input
+  class File
+    class << self
+      def get_file_content(path)
+        IO.read(path)
+      end
+    end
+  end
+end

data/lib/geo_distance/input/web.rb

@@ -0,0 +1,5 @@
+module GeoDistance::Input
+  class Web
+    # TODO
+  end
+end

data/lib/geo_distance/model/customer.rb

@@ -0,0 +1,11 @@
+module GeoDistance::Model
+  class Customer
+    attr_reader :id, :name, :location
+
+    def initialize(data_hash)
+      @location = Location.new(data_hash.fetch("latitude"), data_hash.fetch("longitude"))
+      @id = data_hash.fetch("user_id")
+      @name = data_hash.fetch("name")
+    end
+  end
+end

data/lib/geo_distance/model/location.rb

@@ -0,0 +1,36 @@
+module GeoDistance::Model
+  class Location
+    attr_reader :latitude, :longitude
+
+    def initialize(latitude, longitude)
+      @latitude = Float(latitude)
+      @longitude = Float(longitude)
+    end
+
+    # Calculates distance to other location in meters
+    # using Haversine formula: https://en.wikipedia.org/wiki/Haversine_formula
+    def distance_to(location)
+      delta_latitude_radians = degrees_to_radians(location.latitude - latitude)
+      delta_longitude_radians = degrees_to_radians(location.longitude - longitude)
+
+      a = Math.sin(delta_latitude_radians/2)**2 +
+          Math.cos(degrees_to_radians(latitude)) *
+          Math.cos(degrees_to_radians(location.latitude)) *
+          Math.sin(delta_longitude_radians/2)**2
+
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
+      c * earth_radius_in_meters
+    end
+
+    private
+
+    def degrees_to_radians(degrees)
+      degrees * Math::PI / 180
+    end
+
+    def earth_radius_in_meters
+      6371 * 1000
+    end
+  end
+end
+

data/lib/geo_distance/operation/customer.rb

@@ -0,0 +1,20 @@
+module GeoDistance::Operation
+  class Customer
+    class << self
+
+      def get_customers_in_radius(customers, location, radius)
+        result = []
+        maximum_distance = Float(radius)
+        # rewrite as map?
+        customers.each do |customer|
+          distance_to_location = customer.location.distance_to(location)
+          if distance_to_location <= maximum_distance
+            result << customer
+          end
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/geo_distance/parser/json.rb

@@ -0,0 +1,26 @@
+require "json"
+
+module GeoDistance::Parser
+  class Json
+    class << self
+
+      def get_customers_from_file(file_path)
+        raw_data = GeoDistance::Input::File.get_file_content(file_path)
+        raw_records = GeoDistance::Splitter::Character.split(raw_data, "\n")
+        raw_records.map do |record|
+          begin
+            record_hash = JSON.parse(record)
+            GeoDistance::Model::Customer.new(record_hash)
+          rescue JSON::ParserError
+            p "Parsing error occurred for row: #{record}"
+            raise
+          rescue ArgumentError
+            p "Invalid data in row: #{record}"
+            raise
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/geo_distance/persistence/console.rb

@@ -0,0 +1,15 @@
+module GeoDistance::Persistence
+  class Console
+    class << self
+      def print(data)
+        p data
+      end
+
+      def print_array(data)
+        data.each do |row|
+          p row
+        end
+      end
+    end
+  end
+end

data/lib/geo_distance/serializer/customer.rb

@@ -0,0 +1,17 @@
+module GeoDistance::Serializer
+  class Customer
+    class << self
+      def serialize(data, attributes)
+        attributes.map do |attribute|
+          data.public_send(attribute)
+        end
+      end
+
+      def serialize_array(data, attributes)
+        data.map do |row|
+          serialize(row, attributes)
+        end
+      end
+    end
+  end
+end

data/lib/geo_distance/splitter/character.rb

@@ -0,0 +1,9 @@
+module GeoDistance::Splitter
+  class Character
+    class << self
+      def split(input, split_symbol)
+        input.split(split_symbol)
+      end
+    end
+  end
+end

data/lib/geo_distance/transformer/sort.rb

@@ -0,0 +1,12 @@
+module GeoDistance::Transformer
+  class Sort
+    class << self
+      def acsending(data, sort_by)
+        data.sort_by do |row|
+          row.public_send(sort_by)
+        end
+      end
+    end
+  end
+end
+

data/lib/geo_distance/version.rb

@@ -0,0 +1,3 @@
+module GeoDistance
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: geo_distance
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Zeljko Kalezic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- zeljkokalezic@gmail.com
+executables:
+- console
+- geo_distance
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/geo_distance
+- bin/setup
+- geo_distance.gemspec
+- lib/geo_distance.rb
+- lib/geo_distance/cli.rb
+- lib/geo_distance/input/file.rb
+- lib/geo_distance/input/web.rb
+- lib/geo_distance/model/customer.rb
+- lib/geo_distance/model/location.rb
+- lib/geo_distance/operation/customer.rb
+- lib/geo_distance/parser/json.rb
+- lib/geo_distance/persistence/console.rb
+- lib/geo_distance/serializer/customer.rb
+- lib/geo_distance/splitter/character.rb
+- lib/geo_distance/transformer/sort.rb
+- lib/geo_distance/version.rb
+homepage: https://github.com/zeljkokalezic/geo_locator
+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: Generates list of places within desired distance from a point.
+test_files: []