postrunner 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7ba557bbd6fb695863134d4c073cbec45d13e50
-  data.tar.gz: 77f131a6e793fc273ab45faab2638ee6091b6322
+  metadata.gz: 1f3d16409dd73ebb5ece8d55497b5e7fcfdc1449
+  data.tar.gz: 7263f602002f1d64b13dd0c1dbaeeeb6fe1637fe
 SHA512:
-  metadata.gz: 97662af5296d68665fb4062cc20df3e76ff44f42dc5b9e755e80d8db7bdbc33c2282ead70d32dc5f9695f94cdd8399468d50b3683e9fdae3c3612e14e98543ae
-  data.tar.gz: b0b83f2b6c4e9a462b83097916221bf886c9bbe87a2a371882445dab0b21e0d4f44e85addda82072ec74cc263d6f225f1800664ab14be9b0cf7869ab2fe38a1d
+  metadata.gz: 2bd644e7c8d478cd0782e0dabf92f7eafe6f25f1043fb1af1ae7932b8cdfa67011fccd950d37c68f4eeac531117576215423f20940fec38484ea7306ec45088b
+  data.tar.gz: b44bcc85946e726fd6b5ebbf9ba6b85c96a36c40c5962e5d12b25476094373891f2e1a10d0e4881797eb40ef28264c50021127094e463dc41f5fc1e489ed9967

data/README.md

@@ -1,28 +1,48 @@
-# Postrunner
+# PostRunner
 
-TODO: Write a gem description
+PostRunner is an application to manage FIT files such as those produced by Garmin products like the Forerunner 620. It allows you to import the files from the device and inspect them.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+PostRunner is a Ruby application. You need to have a Ruby 2.0 or later runtime environment installed.
 
-    gem 'postrunner'
+    $ gem install postrunner
 
-And then execute:
+## Usage
 
-    $ bundle
+To get started you need to connect your device to your computer and mount it as a drive. Only devices that expose their data as FAT file system are supported. Older devices use proprietary drivers and are not supported by postrunner. Once the device is mounted find out the full path to the directory that contains your FIT files. You can then import all files on the device.
 
-Or install it yourself as:
+    $ postrunner import /var/run/media/user/GARMIN/GARMIN/ACTIVITY/
+    
+The above command assumes that your device is mounted as /var/run/media/user. Please replace this with the path to your device. Files that have been imported previously will not be imported again. 
 
-    $ gem install postrunner
+Now you can list all the FIT files in your data base.
 
-## Usage
+    $ postrunner list
+    
+The first column is the index you can use to reference FIT files. To get a summary of the most recent activity use the following command.
 
-TODO: Write usage instructions here
+    $ postrunner summary :1
+    
+To get a summary of the oldest activity you can use
+
+    $ postrunner summary :-1
+    
+You can also get a full dump of the content of a FIT file.
+
+    $ postrunner dump 1234568.FIT
+    
+If the file is already in the data base you can also use the reference notation.
+
+    $ postrunner dump :1
+    
+This will provide you with a lot more information contained in the FIT files that is not available through Garmin Connect or most other tools.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/postrunner/fork )
+PostRunner is currently work in progress. It does some things I want with files from my Garmin FR620. It's certainly possible to do more things and support more devices. Patches are welcome!
+
+1. Fork it ( https://github.com/scrapper/postrunner/fork )
 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`)

data/lib/postrunner/ActivitiesDB.rb

@@ -42,6 +42,11 @@ module PostRunner
         return false
       end
 
+      if File.exists(File.join(@fit_dir, base_fit_file))
+        Log.debug "Activity #{fit_file} has been deleted before"
+        return false
+      end
+
       begin
         fit_activity = Fit4Ruby.read(fit_file)
       rescue Fit4Ruby::Error
@@ -65,6 +70,12 @@ module PostRunner
       true
     end
 
+    def delete(fit_file)
+      base_fit_file = File.basename(fit_file)
+      index = @activities.index { |a| a.fit_file == base_fit_file }
+      @activities.delete_at(index)
+      sync
+    end
 
     def rename(fit_file, name)
       base_fit_file = File.basename(fit_file)
@@ -129,16 +140,16 @@ module PostRunner
     end
 
     def create_directories
-      Log.info "Creating data directory #{@db_dir}"
-      begin
-        Dir.mkdir(@db_dir)
-      rescue
-        Log.fatal "Cannot create data directory #{@db_dir}: #{$!}"
-      end
+      create_directory(@db_dir, 'data')
+      create_directory(@fit_dir, 'fit')
+    end
+
+    def create_directory(dir, name)
+      Log.info "Creating #{name} directory #{dir}"
       begin
-        Dir.mkdir(@fit_dir)
+        Dir.mkdir(dir)
       rescue
-        Log.fatal "Cannot create fit directory #{@fit_dir}: #{$!}"
+        Log.fatal "Cannot create #{name} directory #{dir}: #{$!}"
       end
     end
 

data/lib/postrunner/Main.rb

@@ -6,7 +6,11 @@ require 'postrunner/ActivitiesDB'
 
 module PostRunner
 
+  # Use the Logger provided by Fit4Ruby for all console output.
   Log = Fit4Ruby::ILogger.new(STDOUT)
+  Log.formatter = proc { |severity, datetime, progname, msg|
+    "#{severity == Logger::INFO ? '' : "#{severity}:"} #{msg}\n"
+  }
 
   class Main
 
@@ -23,9 +27,18 @@ module PostRunner
     def parse_options(args)
       parser = OptionParser.new do |opts|
         opts.banner = "Usage postrunner <command> [options]"
+
+        opts.separator <<"EOT"
+
+Copyright (c) 2014 by Chris Schlaeger
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of version 2 of the GNU General Public License as published by the
+Free Software Foundation.
+EOT
+
         opts.separator ""
         opts.separator "Options for the 'dump' command:"
-
         opts.on('--filter-msg N', Integer,
                 'Only dump messages of type number N') do |n|
           @filter = Fit4Ruby::FitFilter.new unless @filter
@@ -50,21 +63,66 @@ module PostRunner
           @filter.ignore_undef = true
         end
 
+        opts.separator ""
         opts.separator "Options for the 'import' and 'rename' command:"
-
         opts.on('--name name', String,
                 'Name or rename the activity to the specified name') do |n|
           @name = n
         end
+
+        opts.separator ""
+        opts.separator "General options:"
+        opts.on('-v', '--verbose',
+                'Show internal messages helpful for debugging problems') do
+          Log.level = Logger::DEBUG
+        end
+        opts.on('-h', '--help', 'Show this message') do
+          $stderr.puts opts
+          exit
+        end
+        opts.on('--version', 'Show version number') do
+          $stderr.puts VERSION
+          exit
+        end
+
+        opts.separator <<"EOT"
+
+Commands:
+
+check <fit file> ...
+          Check the provided FIT file(s) for structural errors.
+
+dump <fit file> | <ref>
+          Dump the content of the FIT file.
+
+import <fit file> | <directory>
+          Import the provided FIT file(s) into the postrunner database.
+
+delete <ref>
+          Delete the activity from the archive.
+
+list
+          List all FIT files stored in the data base.
+
+rename <ref>
+          Replace the FIT file name with a more meaningful name that describes
+          the activity.
+
+summary <fit file> | <ref>
+          Display the summary information for the FIT file.
+EOT
+
       end
 
       parser.parse!(args)
     end
 
     def execute_command(args)
-      case args.shift
+      case (cmd = args.shift)
       when 'check'
         process_files_or_activities(args, :check)
+      when 'delete'
+        process_activities(args, :delete)
       when 'dump'
         @filter = Fit4Ruby::FitFilter.new unless @filter
         process_files_or_activities(args, :dump)
@@ -76,8 +134,12 @@ module PostRunner
         process_activities(args, :rename)
       when 'summary'
         process_files_or_activities(args, :summary)
+      when nil
+        Log.fatal("No command provided. " +
+                  "See 'postrunner -h' for more information.")
       else
-        Log.fatal("No command provided")
+        Log.fatal("Unknown command '#{cmd}'. " +
+                  "See 'postrunner -h' for more information.")
       end
     end
 
@@ -131,6 +193,8 @@ module PostRunner
 
     def process_file(file, command)
       case command
+      when :delete
+        @activities.delete(file)
       when :import
         @activities.add(file)
       when :rename

data/lib/postrunner/version.rb

@@ -1,3 +1,3 @@
 module PostRunner
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/postrunner.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["chris@linux.com"]
   spec.summary       = %q{Application to manage and analyze Garmin FIT files.}
   spec.description   = %q{This application will allow you to manage and analyze .FIT files as generated by Garmin GPS devices. The application was developed for the Garmin Forerunner 620. Other devices may or may not work. Only devices that expose themselves as USB Mass Storage devices are supported.}
-  spec.homepage      = 'https://github.com/scrapper/fit4ruby'
+  spec.homepage      = 'https://github.com/scrapper/postrunner'
   spec.license       = "GNU GPL version 2"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postrunner
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,7 +62,7 @@ files:
 - lib/postrunner/RuntimeConfig.rb
 - lib/postrunner/version.rb
 - postrunner.gemspec
-homepage: https://github.com/scrapper/fit4ruby
+homepage: https://github.com/scrapper/postrunner
 licenses:
 - GNU GPL version 2
 metadata: {}