gpx_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f76bf78f2d9cd33da17c24b1fe7ae0b3e772173
+  data.tar.gz: 56a6db69ab36cbf3137989395d2aae479e358fc6
+SHA512:
+  metadata.gz: 7eb9cb1f3cf4c4354332c52612191c84521c7d2bdafabe76d180f668065b4a43abb1a01547655da1f62cb3607f8e7970b9e15be598ed3af7a412984213bd9a5c
+  data.tar.gz: 86cf40a4f04a1a9387257fdc4f75c5e61a1175b28145fa12f41def2666774bffb69b90ccb577caa89059665be9af0ff6bb00afca5b776b3d1410ff1f070b038d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gpx_reader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolas Aguttes
+
+MIT License
+
+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,56 @@
+# Gpx Reader
+
+gem to read a gpx file
+
+**ATTENTION**: this version works but is still under (slow) development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gpx_reader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gpx_reader
+
+## Usage
+
+  gpx_reader accept a file as argument or a string.
+
+  To read a gpx file just call @gpx = GPXReader::Gpx.new(file) or @gpx = GPXReader::Gpx.new(string)
+
+  Then use it as follow:
+
+  - @gpx.creator => creator of the file
+  - @gpx.time   => Time of creation
+  - @gpx.tracks   => array of track
+  - for the track inside @gpx.tracks
+    - track.name
+    - track.desc
+    - track.segments
+  - ...
+
+## Notes
+The distance is calculated based on the haversine method ( http://en.wikipedia.org/wiki/Haversine_formula) and implementation of the algorithm is based on the following source: http://www.movable-type.co.uk/scripts/latlong.html
+
+This gem has been written for my own needs, if you feel something is missing don't hesitate to ask
+
+
+## TODO
+  - list all the points directly from the track
+  - calculate boundaries of the tracks/segments unless in the metadata
+  - calculate elapsed time
+  - write more tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gpx_reader.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gpx_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gpx_reader"
+  spec.version       = GpxReader::VERSION
+  spec.authors       = ["Nicolas Aguttes"]
+  spec.email         = ["nicolas.aguttes@gmail.com"]
+  spec.description   = %q{Gem to parse a gpx file or string}
+  spec.summary       = %q{gpx reader}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "nokogiri", "1.6.1"
+
+end

data/lib/gpx_reader/gpx.rb

@@ -0,0 +1,51 @@
+#--
+# Copyright (c) 2014 Nicolas Aguttes
+#
+# 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.
+#++
+module GPXReader
+  class Gpx
+    attr_accessor :creator, :tracks, :boundaries, :lowest_point, :highest_point, :duration, :version, :time, :name, :namespaces
+      # read the file containing the tracks
+      # get the different information of the file
+      # get the tracks
+      def initialize(file)
+        if file.is_a?(File)
+          @gpx=Nokogiri::XML(File.open(file))
+        else
+          @gpx=Nokogiri::XML(file)
+        end
+        @creator = @gpx.at_css("gpx")["creator"] rescue nil
+        @time = Time.parse(@gpx.at_css("metadata time").text) rescue nil
+        @tracks = []
+        @gpx.css("trk").each do |trk|
+           trk = Track.new(trk)
+           @tracks << trk
+        end
+        # get name spaces
+        ns = @gpx.collect_namespaces
+        # Strip the leading xmlns: from each namespace key, and store in a new hash
+        @namespaces= {}
+        ns.each_pair do |key, value|
+          @namespaces[key.sub(/^xmlns:/, '')] = value
+        end
+      end
+  end
+end

data/lib/gpx_reader/point.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2014 Nicolas Aguttes
+#
+# 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.
+#++
+module GPXReader
+  class Point
+    attr_accessor :lat, :lon, :elevation, :time, :hr
+
+    def initialize(point)
+      @lat = point["lat"].to_f rescue nil
+      @lon = point["lon"].to_f rescue nil
+      @elevation = point.at_css("ele").text.to_f rescue nil
+      @time = Time.parse(point.at_css("time").text) rescue nil
+      @hr = point.at_xpath(".//gpxtpx:hr").text.to_i rescue nil
+    end
+  end
+end

data/lib/gpx_reader/segment.rb

@@ -0,0 +1,61 @@
+#--
+# Copyright (c) 2014 Nicolas Aguttes
+#
+# 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.
+#++
+module GPXReader
+  class Segment
+    attr_accessor :points, :distance
+
+    def initialize(segment)
+      @distance = 0
+      @points = []
+      previous_pt = nil
+      segment.css("trkpt").each do |pt|
+        point = Point.new(pt)
+        @points << point
+        # calculate distance
+        @distance += haversine_distance(previous_pt, point) unless previous_pt.nil?
+        previous_pt = point
+        # puts @points.size if @points.size.modulo(100).zero?
+      end
+    end
+
+    # caluclate the distance between 2 points
+    # http://en.wikipedia.org/wiki/Haversine_formula
+    # http://www.movable-type.co.uk/scripts/latlong.html
+    # the "Earth radius" R varies from 6356.752 km at the poles to 6378.137 km
+    # we calculate  with the average radius (in km)
+    RADIUS = 6371
+    # Calculate the Haversine distance between two points
+    def haversine_distance(pt1, pt2)
+      # lat/lon are in degrees, need to convert in radiant
+      # formula ==> Degrees * PI / 180
+      d_lat = (pt2.lat - pt1.lat) * Math::PI / 180
+      d_lon = (pt2.lon - pt1.lon) * Math::PI / 180
+      lat1_r = pt1.lat * Math::PI / 180
+      lat2_r = pt2.lat * Math::PI / 180
+      a = Math.sin(d_lat/2) * Math.sin(d_lat/2) + Math.cos(lat1_r) * Math.cos(lat2_r) * Math.sin(d_lon/2) * Math.sin(d_lon/2)
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
+      d = RADIUS * c
+      return d
+    end
+  end
+end

data/lib/gpx_reader/track.rb

@@ -0,0 +1,39 @@
+#--
+# Copyright (c) 2014 Nicolas Aguttes
+#
+# 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.
+#++
+module GPXReader
+  class Track
+    attr_accessor :segments, :name, :desc, :distance
+
+    def initialize(trk)
+      @distance = 0
+      @name = trk.at_css("name").text rescue ""
+      @desc = trk.at_css("desc").text rescue ""
+      @segments = []
+      trk.css("trkseg").each do |seg|
+        seg = Segment.new(seg)
+        @segments << seg
+        @distance += seg.distance
+      end
+    end
+	end
+end

data/lib/gpx_reader/version.rb

@@ -0,0 +1,3 @@
+module GpxReader
+  VERSION = "0.1.0"
+end

data/lib/gpx_reader.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2014 Nicolas Aguttes
+#
+# 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.
+#++
+$:.unshift(File.dirname(__FILE__))
+require "gpx_reader/version"
+require "nokogiri"
+
+require 'date'
+require 'time'
+require 'gpx_reader/gpx'
+require 'gpx_reader/track'
+require 'gpx_reader/segment'
+require 'gpx_reader/point'
+

data/tests/gpx_1track_4points.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require File.expand_path('../.') + '/gpx_reader/lib/gpx_reader'
+
+class GPXFileTest < Test::Unit::TestCase
+
+  ONE_TRACK_FILE = File.join(File.dirname(__FILE__), "gpx_files/1track_4points.gpx")
+
+  def test_load_data_from_file
+    gpx = GPXReader::Gpx.new(File.open(ONE_TRACK_FILE))
+    assert_equal(1, gpx.tracks.size)
+    assert_equal(1, gpx.tracks.first.segments.size)
+    assert_equal(4, gpx.tracks.first.segments.first.points.size)
+    assert_equal("Track One", gpx.tracks.first.name)
+    assert_equal("Track One, one segment, 4 points", gpx.tracks.first.desc)
+    assert_equal(Time.parse("2014-02-20 08:42:59 UTC"), gpx.time)
+    assert_equal(1349, gpx.tracks.first.segments.first.points[0].elevation)
+    assert_equal(1350, gpx.tracks.first.segments.first.points[1].elevation)
+    assert_equal(1351, gpx.tracks.first.segments.first.points[2].elevation)
+    assert_equal(1352, gpx.tracks.first.segments.first.points[3].elevation)
+    assert_equal(91, gpx.tracks.first.segments.first.points[0].hr)
+    assert_equal(92, gpx.tracks.first.segments.first.points[1].hr)
+    assert_equal(93, gpx.tracks.first.segments.first.points[2].hr)
+    assert_equal(94, gpx.tracks.first.segments.first.points[3].hr)
+    assert_equal(6.934360396116972, gpx.tracks.first.segments.first.points[0].lon)
+    assert_equal(6.93439643830061, gpx.tracks.first.segments.first.points[1].lon)
+    assert_equal(6.934469779953361, gpx.tracks.first.segments.first.points[2].lon)
+    assert_equal(6.934554101899266, gpx.tracks.first.segments.first.points[3].lon)
+    assert_equal(46.03442206978798, gpx.tracks.first.segments.first.points[0].lat)
+    assert_equal(46.03444067761302, gpx.tracks.first.segments.first.points[1].lat)
+    assert_equal(46.03447579778731, gpx.tracks.first.segments.first.points[2].lat)
+    assert_equal(46.03450287133455, gpx.tracks.first.segments.first.points[3].lat)
+  end
+
+
+end

data/tests/gpx_files/1track_4points.gpx

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gpx version="1.1" creator="Garmin Connect"
+  xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd http://www.garmin.com/xmlschemas/GpxExtensions/v3 http://www.garmin.com/xmlschemas/GpxExtensionsv3.xsd http://www.garmin.com/xmlschemas/TrackPointExtension/v1 http://www.garmin.com/xmlschemas/TrackPointExtensionv1.xsd"
+  xmlns="http://www.topografix.com/GPX/1/1"
+  xmlns:gpxtpx="http://www.garmin.com/xmlschemas/TrackPointExtension/v1"
+  xmlns:gpxx="http://www.garmin.com/xmlschemas/GpxExtensions/v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <metadata>
+    <link href="connect.garmin.com">
+      <text>Garmin Connect</text>
+    </link>
+    <time>2014-02-20T08:42:59.000Z</time>
+  </metadata>
+  <trk>
+    <name>Track One</name>
+    <desc>Track One, one segment, 4 points</desc>
+    <trkseg>
+      <trkpt lon="6.934360396116972" lat="46.03442206978798">
+        <ele>1349</ele>
+        <time>2014-02-20T08:42:59.000Z</time>
+        <extensions>
+          <gpxtpx:TrackPointExtension>
+            <gpxtpx:hr>91</gpxtpx:hr>
+          </gpxtpx:TrackPointExtension>
+        </extensions>
+      </trkpt>
+      <trkpt lon="6.93439643830061" lat="46.03444067761302">
+        <ele>1350</ele>
+        <time>2014-02-20T08:43:00.000Z</time>
+        <extensions>
+          <gpxtpx:TrackPointExtension>
+            <gpxtpx:hr>92</gpxtpx:hr>
+          </gpxtpx:TrackPointExtension>
+        </extensions>
+      </trkpt>
+      <trkpt lon="6.934469779953361" lat="46.03447579778731">
+        <ele>1351</ele>
+        <time>2014-02-20T08:43:02.000Z</time>
+        <extensions>
+          <gpxtpx:TrackPointExtension>
+            <gpxtpx:hr>93</gpxtpx:hr>
+          </gpxtpx:TrackPointExtension>
+        </extensions>
+      </trkpt>
+      <trkpt lon="6.934554101899266" lat="46.03450287133455">
+        <ele>1352</ele>
+        <time>2014-02-20T08:43:05.000Z</time>
+        <extensions>
+          <gpxtpx:TrackPointExtension>
+            <gpxtpx:hr>94</gpxtpx:hr>
+          </gpxtpx:TrackPointExtension>
+        </extensions>
+      </trkpt>
+    </trkseg>
+  </trk>
+</gpx>