discord_distance_calculator 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3094986bb0f2d6986375cc52576fb037a9f01fd5
+  data.tar.gz: 2d933a4dd4dccc46a93c74a8e2c0b7540dcc3e54
+SHA512:
+  metadata.gz: 4e79534687ddc5198c9b81441de75a75f3b4d6f095d0a60c44d2c5b47670423cfe16f8dbcc1da79ea466beb64c3320159c0b34c7ee7767aed9466a5c622e20c2
+  data.tar.gz: '09851c55a38ec9af11d1d84fdb7a85d989d74e7384aecbd1601ae55f368911edeb19bd757fe1b9f16dd7a734a5aeb07158bce68509157beab40d3c4235750af0'

data/.gitignore

@@ -0,0 +1,14 @@
+# ignore files with personal credentials
+.env
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2017 Ryan Murphy
+
+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,30 @@
+# Discord Distance Calculator
+
+# What does this do?
+This is a simple gem that can be setup as a Discord bot to calculate the distance between two geographical points.
+Distance can be returned in miles and kilometers.
+
+# Installation
+First install as a global gem.
+```
+gem install discord_distance_calculator
+```
+Navigate to your gem path. This will vary based on your ruby version and your ruby environment manager (rbenv or rvm).
+For example on my machine with rbenv and ruby 2.4.1, it would be installed here:
+```
+~/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/discord_distance_calculator<version>
+```
+Create a `.env` file in this directory. Inside here you will need 3 API keys: A map service key for Geocoder (usually sourced from Google Maps API), a Discord token, and a Discord client id. Insert these into your `.env` file as the following variables:
+
+```
+GEOCODER=
+DISCORD_TOKEN=
+DISCORD_CLIENT_ID=
+```
+
+# Start your bot
+Now you are ready to start your bot. This will run as a server, so open a new terminal or start it as a daemon.
+`bundle exec discord_distance_calculator discord_distance_bot`
+
+The distance calculator will now listen for ```!distance```  along with two parameters representing the two locations.
+

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,7 @@
+#!/user/bin/env ruby
+
+require "bundler/setup"
+require "discord_distance_calculator"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/discord_distance_bot

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/discord_distance_calculator/bot"
+require 'dotenv/load'
+DiscordDistanceCalculator::Bot.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install

data/discord_distance_calculator.gemspec

@@ -0,0 +1,32 @@
+# coding utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "discord_distance_calculator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "discord_distance_calculator"
+  spec.version = DiscordDistanceCalculator::VERSION
+  spec.authors = ["Ryan Murphy"]
+  spec.email = ["murjax@gmail.com"]
+
+  spec.summary = %q{Discord bot for calculating distance}
+  spec.description = %q{Discord Distance Calculator is a bot for calculating direct mileage between two geographic points}
+  spec.homepage = "https://github.com/murjax/Discord-Distance-Calculator"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = "bin"
+  spec.executables = "discord_distance_bot"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "discordrb"
+  spec.add_dependency "geocoder"
+  spec.add_dependency "dotenv"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/discord_distance_calculator.rb

@@ -0,0 +1,8 @@
+require 'dotenv/load'
+require 'geocoder'
+
+require "discord_distance_calculator/message_handler"
+require "discord_distance_calculator/distance_calculator"
+
+module DiscordDistanceCalculator
+end

data/lib/discord_distance_calculator/bot.rb

@@ -0,0 +1,16 @@
+require 'discordrb'
+module DiscordDistanceCalculator
+  class Bot
+    def self.start
+      bot = Discordrb::Bot.new token: ENV['DISCORD_TOKEN'] , client_id: ENV['DISCORD_CLIENT_ID']
+      puts "This bot's invite URL is #{bot.invite_url}."
+
+      bot.message do |event|
+        handler = DiscordDistanceCalculator::MessageHandler.new(event.message.to_s)
+        event.respond handler.get_response
+      end
+
+      bot.run
+    end
+  end
+end

data/lib/discord_distance_calculator/distance_calculator.rb

@@ -0,0 +1,29 @@
+module DiscordDistanceCalculator
+  class DistanceCalculator
+    attr_reader :locations
+
+    def initialize(locations)
+      @locations = locations
+      Geocoder.configure(api_key: ENV['GEOCODER'])
+    end
+
+    def get_miles
+      distance = get_distance
+      distance.nan? ? 0 : distance.round(0)
+    end
+
+    def get_kilometers
+      distance = get_distance
+      distance.nan? ? 0 : (distance * 1.609347218694).round(0)
+    end
+
+    def get_distance
+      coordinates = get_coordinates
+      Geocoder::Calculations.distance_between(coordinates[0], coordinates[1])
+    end
+
+    def get_coordinates
+      [Geocoder.coordinates(locations[0]),Geocoder.coordinates(locations[1])]
+    end
+  end
+end

data/lib/discord_distance_calculator/message_handler.rb

@@ -0,0 +1,34 @@
+module DiscordDistanceCalculator
+  class MessageHandler
+    attr_reader :message, :calculator
+
+    def initialize(message)
+      @message = message
+      @calculator = DistanceCalculator.new(get_locations)
+    end
+
+    def has_command?
+      message.start_with?('!distance')
+    end
+
+    def has_km?
+      message.end_with?(' km')
+    end
+
+    def get_locations
+      parts = message.split(" ")
+      [parts[1], parts[2]]
+    end
+
+    def distance_calculator(unit_type = "mi")
+      unit_type == "mi" ? calculator.get_miles : calculator.get_kilometers
+    end
+
+    def get_response
+      response = "The distance between these two points is"
+      if has_command?
+        has_km? ? "#{response} #{distance_calculator("km")} kilometers." : "#{response} #{distance_calculator} miles."
+      end
+    end
+  end
+end

data/lib/discord_distance_calculator/version.rb

@@ -0,0 +1,3 @@
+module DiscordDistanceCalculator
+  VERSION = "1.0.5"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: discord_distance_calculator
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- Ryan Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  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'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  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'
+description: Discord Distance Calculator is a bot for calculating direct mileage between
+  two geographic points
+email:
+- murjax@gmail.com
+executables:
+- discord_distance_bot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/discord_distance_bot
+- bin/setup
+- discord_distance_calculator.gemspec
+- lib/discord_distance_calculator.rb
+- lib/discord_distance_calculator/bot.rb
+- lib/discord_distance_calculator/distance_calculator.rb
+- lib/discord_distance_calculator/message_handler.rb
+- lib/discord_distance_calculator/version.rb
+homepage: https://github.com/murjax/Discord-Distance-Calculator
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Discord bot for calculating distance
+test_files: []