plr-speedtest 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 917e92197eb60a1304f9caf430bb6c29c71d02d79a2b2c5b3cec0b59d98d53fe
+  data.tar.gz: 64494899740408ee2d7fc2d8809cdacbdc845567f0e60a5d0534996e673cfd59
+SHA512:
+  metadata.gz: b320f647b1facbdaccf131c42b1f5e6afaa9fe8dd9aa3edd543a171a1fa94771d7bf3f273fd733305026c27e538f86ce75ce579255b46492be1278c6998423f5
+  data.tar.gz: 3e340043d664bace37a2f415b0248bdd1aa31a345dcf1ccf290276b96e1c058f11fd9cb7c1158d41783ccf4c2a9fd663030e1bc6b32eea2b1ae1080260ec9830

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jerome Lacoste
+
+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,88 @@
+# Speedtest
+A ruby gem for speedtest.net results
+
+Adapted from https://github.com/lacostej/speedtest.rb
+
+## Installation
+```ruby
+$ gem install speedtest
+```
+or put it in your Gemfile
+```ruby
+gem 'speedtest'
+```
+and install with
+```ruby
+$ bundle install
+```
+
+## Usage:
+require it in your script
+```ruby
+require 'logger'
+require 'speedtest'
+```
+
+Configure a new test with whatever options you want—all are optional:
+* download_runs - The number of attempts to download each file
+* upload_runs - The number of attempts to upload each file
+* ping_runs - The number of ping attempts to establish latency
+* download_sizes - an array of .jpg dimensions (must be one or more of `[350, 500, 750, 1000, 1500, 2000, 2500, 3000, 3500, 4000]`)
+* upload_sizes
+* logger
+
+```ruby
+test = Speedtest::Test.new(
+  download_runs: 4,
+    upload_runs: 4,
+    ping_runs: 4,
+    download_sizes: [750, 1500],
+    upload_sizes: [10000, 400000],
+    logger: Logger.new(STDOUT)
+ )
+ => #<Speedtest::Test:0x007fac5ac9dca0 @download_runs=4, @upload_runs=4, @ping_runs=4, @download_sizes=[750, 1500], @upload_sizes=[10000, 400000], @debug=true>
+```
+
+test.run() returns some results:
+```ruby
+results = test.run
+```
+With logger set, this produces:
+```ruby
+Your IP: 97.126.32.16
+Your coordinates: [47.4356, -122.1141]
+Automatically selected server: http://lg.sea-z.fdcservers.net - 32.985 ms
+Server http://lg.sea-z.fdcservers.net
+
+starting download tests:
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random1500x1500.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random750x750.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random1500x1500.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random750x750.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random750x750.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random750x750.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random1500x1500.jpg
+  downloading: http://lg.sea-z.fdcservers.net/speedtest/random1500x1500.jpg
+Took 6.10022 seconds to download 22345012 bytes in 8 threads
+Download: 27.95 Mbps
+
+starting upload tests:
+  uploading size 10000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 10000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 10000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 10000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 400000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 400000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 400000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+  uploading size 400000: http://lg.sea-z.fdcservers.net/speedtest/upload.php
+Took 3.437126 seconds to upload 1644080 bytes in 8 threads
+Upload: 3.65 Mbps
+
+  => #<Speedtest::Result:0x007fac5ac1e680 @server="http://lg.sea-z.fdcservers.net", @latency=32.985, @download_size=22345012, @upload_size=1644080, @download_time=6.10022, @upload_time=3.437126>
+```
+
+## Interesting links
+* https://github.com/lacostej/speedtest.rb
+* http://www.phuket-data-wizards.com/blog/2011/09/17/speedtest-vs-dslreports-analysis/
+* https://github.com/fopina/pyspeedtest
+* http://tech.ivkin.net/wiki/Run_Speedtest_from_command_line

data/Rakefile

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

data/lib/speedtest/geo_point.rb

@@ -0,0 +1,18 @@
+module Speedtest
+  class GeoPoint
+    attr_accessor :lat, :lon
+
+    def initialize(lat, lon)
+      @lat = Float(lat)
+      @lon = Float(lon)
+    end
+
+    def to_s
+      "[#{lat}, #{lon}]"
+    end
+
+    def distance(point)
+      Math.sqrt((point.lon - lon)**2 + (point.lat - lat)**2)
+    end
+  end
+end

data/lib/speedtest/result.rb

@@ -0,0 +1,14 @@
+module Speedtest
+  class Result
+    attr_accessor :server, :latency, :download_size, :upload_size, :download_time, :upload_time
+
+    def initialize(values = {})
+      @server = values[:server]
+      @latency = values[:latency]
+      @download_size = values[:download_size]
+      @upload_size = values[:upload_size]
+      @download_time = values[:download_time]
+      @upload_time = values[:upload_time]
+    end
+  end
+end

data/lib/speedtest/version.rb

@@ -0,0 +1,3 @@
+module Speedtest
+  VERSION = "0.2.3"
+end

data/lib/speedtest.rb

@@ -0,0 +1,186 @@
+require 'httparty'
+
+require_relative 'speedtest/result'
+require_relative 'speedtest/geo_point'
+
+module Speedtest
+  class Test
+
+    class FailedTransfer < StandardError; end
+
+    def initialize(options = {})
+      @download_runs = options[:download_runs]     || 4
+      @upload_runs = options[:upload_runs]         || 4
+      @ping_runs = options[:ping_runs]             || 4
+      @download_sizes = options[:download_sizes]   || [750, 1500]
+      @upload_sizes = options[:upload_sizes]       || [197190, 483960]
+      @logger = options[:logger]
+    end
+
+    def run()
+      server = pick_server
+      @server_root = server[:url]
+      log "Server #{@server_root}"
+
+      latency = server[:latency]
+
+      download_size, download_time = download
+      download_rate = download_size / download_time
+      log "Download: #{pretty_speed download_rate}"
+
+      upload_size, upload_time = upload
+      upload_rate = upload_size / upload_time
+      log "Upload: #{pretty_speed upload_rate}"
+
+      Result.new(:server => @server_root, :latency => latency,
+        download_size: download_size, download_time: download_time,
+        upload_size: upload_size, upload_time: upload_time)
+    end
+
+    def pretty_speed(speed)
+      units = ["bps", "Kbps", "Mbps", "Gbps", "Tbps"]
+      i = 0
+      while speed > 1024
+        speed /= 1024
+        i += 1
+      end
+      "%.2f #{units[i]}" % speed
+    end
+
+    def log(msg)
+      @logger.debug msg if @logger
+    end
+
+    def error(msg)
+      @logger.error msg if @logger
+    end
+
+    def downloadthread(url)
+      log "  downloading: #{url}"
+      page = HTTParty.get(url)
+      unless page.code / 100 == 2
+        error "GET #{url} failed with code #{page.code}"
+        Thread.current["error"] = true
+      end
+      Thread.current["downloaded"] = page.body.length
+    end
+
+    def download
+      log "\nstarting download tests:"
+      threads = []
+
+      start_time = Time.new
+      @download_sizes.each { |size|
+        1.upto(@download_runs) { |i|
+          threads << Thread.new { |thread|
+            downloadthread("#{@server_root}/speedtest/random#{size}x#{size}.jpg")
+          }
+        }
+      }
+
+      total_downloaded = 0
+      threads.each { |t|
+        t.join
+        total_downloaded += t["downloaded"]
+        raise FailedTransfer.new("Download failed.") if t["error"] == true
+      }
+
+      total_time = Time.new - start_time
+      log "Took #{total_time} seconds to download #{total_downloaded} bytes in #{threads.length} threads\n"
+
+      [ total_downloaded * 8, total_time ]
+    end
+
+    def uploadthread(url, content)
+      page = HTTParty.post(url, :body => { "content" => content })
+      unless page.code / 100 == 2
+        error "GET #{url} failed with code #{page.code}"
+        Thread.current["error"] = true
+      end
+      Thread.current["uploaded"] = page.body.split('=')[1].to_i
+    end
+
+    def randomString(alphabet, size)
+      (1.upto(size)).map { alphabet[rand(alphabet.length)] }.join
+    end
+
+    def upload
+      log "\nstarting upload tests:"
+
+      data = []
+      @upload_sizes.each { |size|
+        1.upto(@upload_runs) {
+          data << randomString(('A'..'Z').to_a, size)
+        }
+      }
+
+      threads = []
+      start_time = Time.new
+      threads = data.map { |data|
+        Thread.new(data) { |content|
+          log "  uploading size #{content.size}: #{@server_root}/speedtest/upload.php"
+          uploadthread("#{@server_root}/speedtest/upload.php", content)
+        }
+      }
+
+      total_uploaded = 0
+      threads.each { |t|
+        t.join
+        total_uploaded += t["uploaded"]
+        raise FailedTransfer.new("Upload failed.") if t["error"] == true
+      }
+      total_time = Time.new - start_time
+      log "Took #{total_time} seconds to upload #{total_uploaded} bytes in #{threads.length} threads\n"
+
+      # bytes to bits / time = bps
+      [ total_uploaded * 8, total_time ]
+    end
+
+    def pick_server
+      page = HTTParty.get("http://www.speedtest.net/speedtest-config.php")
+      ip,lat,lon = page.body.scan(/<client ip="([^"]*)" lat="([^"]*)" lon="([^"]*)"/)[0]
+      orig = GeoPoint.new(lat, lon)
+      log "Your IP: #{ip}\nYour coordinates: #{orig}\n"
+
+      page = HTTParty.get("http://www.speedtest.net/speedtest-servers.php")
+      sorted_servers=page.body.scan(/<server url="([^"]*)" lat="([^"]*)" lon="([^"]*)/).map { |x| {
+        :distance => orig.distance(GeoPoint.new(x[1],x[2])),
+        :url => x[0].split(/(http:\/\/.*)\/speedtest.*/)[1]
+      } }
+      .reject { |x| x[:url].nil? } # reject 'servers' without a domain
+      .sort_by { |x| x[:distance] }
+
+      # sort the nearest 10 by download latency
+      latency_sorted_servers = sorted_servers[0..9].map { |x|
+        {
+        :latency => ping(x[:url]),
+        :url => x[:url]
+        }}.sort_by { |x| x[:latency] }
+      selected = latency_sorted_servers[0]
+      log "Automatically selected server: #{selected[:url]} - #{selected[:latency]} ms"
+
+      selected
+    end
+
+    def ping(server)
+      times = []
+      1.upto(@ping_runs) {
+        start = Time.new
+        begin
+          page = HTTParty.get("#{server}/speedtest/latency.txt")
+          times << Time.new - start
+        rescue Timeout::Error, Net::HTTPNotFound, Errno::ENETUNREACH => e
+          log "#{e.class} #{e}"
+          times << 999999
+        end
+      }
+      times.sort
+      times[1, @ping_runs].inject(:+) * 1000 / @ping_runs # average in milliseconds
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  x = Speedtest::Test.new(ARGV)
+  x.run
+end

data/speedtest.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'speedtest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plr-speedtest"
+  spec.version       = Speedtest::VERSION
+  spec.authors       = ["Pete Myron", "Philippe Le Rohellec"]
+  spec.email         = ["pete.myron@gmail.com", "philippe.lerohellec@gmail.com"]
+
+  spec.summary       = %q{Gemmed version of lacostej's speedtest.rb script - Test your speed with speedtest.net!}
+  spec.description   = %q{Gemmed version of lacostej's speedtest.rb script @ https://github.com/lacostej/speedtest.rb - Test your speed with speedtest.net!}
+  spec.homepage      = "https://github.com/petemyron/speedtest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: plr-speedtest
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Pete Myron
+- Philippe Le Rohellec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Gemmed version of lacostej's speedtest.rb script @ https://github.com/lacostej/speedtest.rb
+  - Test your speed with speedtest.net!
+email:
+- pete.myron@gmail.com
+- philippe.lerohellec@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/speedtest.rb
+- lib/speedtest/geo_point.rb
+- lib/speedtest/result.rb
+- lib/speedtest/version.rb
+- speedtest.gemspec
+homepage: https://github.com/petemyron/speedtest
+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.6
+signing_key: 
+specification_version: 4
+summary: Gemmed version of lacostej's speedtest.rb script - Test your speed with speedtest.net!
+test_files: []