geostats 0.1.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2010 Thomas Cyron <thomas@thcyron.de>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+Geostats — Geocaching.com Statistics Generator
+===============================================
+
+Geostats is a tool for generating statistics about your geocaching.com
+account. It generates HTML files and allows you to push them to your
+public profile at geocaching.com. It doesn’t rely on Pocket Queries.
+
+
+Getting Started
+---------------
+
+    bin/geostats init <username> <password>
+    bin/geostats update
+    bin/geostats generate > stats.html
+    open stats.html
+
+    bin/geostats console
+
+Inside the console you have access to the following
+ActiveRecord models:
+
+* Cache
+* CacheType
+* Log
+* LogType
+
+
+Todo
+----
+
+* Better error handling
+* Logging / More output
+* HTML generation
+* Pushing
+
+
+Usage
+-----
+
+Environment Variables:
+  GEOSTATS_DIR="~/geostats"
+
+Commands:
+  Initialize new database:           $ geostats init username password
+                                     $ geostats init username password directory
+
+  Update database:                   $ geostats update
+                                     $ geostats update all
+                                     $ geostats update all caches
+                                     $ geostats update all logs
+                                     $ geostats update GC12345 GC67890
+                                     
+                                     -d <secs> (delay)
+
+  Generate statistics:               $ geostats generate
+                                     $ geostats generate default
+
+  Push statistics to geocaching.com: $ geostats push

data/bin/geostats

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+begin
+  require "geostats"
+rescue LoadError
+  $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+  require "geostats"
+end
+
+command_name = ARGV.shift || "help"
+command_instance = nil
+
+possibilities = Geostats::COMMANDS.select do |cmd|
+  cmd =~ /^#{Regexp.escape(command_name)}/
+end
+
+if possibilities.length == 1
+  command_name = possibilities.first
+else
+  command_name = "help"
+end
+
+require "geostats/commands/#{command_name}"
+
+command_const = "Geostats::Commands::#{command_name.camelcase}".constantize
+command_instance = command_const.new(ARGV)
+
+begin
+  command_instance.invoke
+rescue Geostats::Commands::UsageError
+  command_instance.usage
+  exit 1
+end

data/lib/geostats.rb

@@ -0,0 +1,36 @@
+require "cgi"
+require "time"
+require "active_record"
+
+require "geostats/core_ext"
+require "geostats/version"
+
+require "geostats/models/cache"
+require "geostats/models/cache_type"
+require "geostats/models/log"
+require "geostats/models/log_type"
+require "geostats/models/setting"
+
+module Geostats
+  COMMANDS = %w(console generate help init migrate push set update)
+  ROOT = File.join(File.expand_path(File.dirname(__FILE__)), "geostats")
+
+  module Commands
+    autoload :Base, "geostats/commands/base"
+    autoload :Help, "geostats/commands/help"
+  end
+
+  autoload :Database, "geostats/database"
+
+  module Grabber
+    autoload :Cache, "geostats/grabber/cache"
+    autoload :Log, "geostats/grabber/log"
+    autoload :Logs, "geostats/grabber/logs"
+    autoload :User, "geostats/grabber/user"
+  end
+
+  autoload :Generator, "geostats/generator"
+  autoload :HTTP, "geostats/http"
+  autoload :Stats, "geostats/stats"
+  autoload :Utils, "geostats/utils"
+end

data/lib/geostats/commands/base.rb

@@ -0,0 +1,73 @@
+require "term/ansicolor"
+
+module Term::ANSIColor
+  def erase(n=nil)
+    "\e[#{n}K"
+  end
+end
+
+module Geostats
+  module Commands
+    class UsageError < Exception
+    end
+
+    class Base
+      include Term::ANSIColor
+
+      def initialize(args=[])
+        @args = args
+      end
+
+      def invoke
+        parse_args
+        before; run; after
+      end
+
+    protected
+
+      def parse_args; end
+      def before; end
+      def after; end
+
+      def log(*args)
+        print *args.join
+      end
+
+      def warn(message)
+        log "Warning: #{message}"
+      end
+
+      def error(message)
+        STDERR.puts "Error: #{message}"
+        exit 1
+      end
+
+      def verbose(message)
+        log message
+      end
+
+      def connect_database(directory = ENV["GEOSTATS_DIR"])
+        Database.connect!(directory)
+      rescue => e
+        error "could not connect to database: #{e.message}"
+      end
+
+      def login
+        HTTP.login(Setting.get(:username), Setting.get(:password))
+      rescue ArgumentError, Net::HTTPExceptions => e
+        error "Failed to log in: #{e.message}"
+      end
+
+      def logout
+        HTTP.logout
+      rescue Net::HTTPExceptions => e
+        error "Failed to log out: #{e.message}"
+      end
+
+      def usage
+        STDERR.puts "Usage: geostats command [arguments ...]"
+        exit 1
+      end
+    end
+  end
+end

data/lib/geostats/commands/console.rb

@@ -0,0 +1,17 @@
+module Geostats
+  module Commands
+    class Console < Base
+      def usage
+        STDERR.puts "Usage: geostats console"
+      end
+
+      def parse_args
+        raise UsageError unless @args.length.zero?
+      end
+
+      def run
+        exec "irb -I lib -r geostats -r geostats/console"
+      end
+    end
+  end
+end

data/lib/geostats/commands/generate.rb

@@ -0,0 +1,21 @@
+module Geostats
+  module Commands
+    class Generate < Base
+      def usage
+        STDERR.puts "Usage: geostats generate"
+      end
+
+      def parse_args
+        raise UsageError unless @args.length.zero?
+      end
+
+      def before
+        connect_database
+      end
+
+      def run
+        puts Generator.generate
+      end
+    end
+  end
+end

data/lib/geostats/commands/help.rb

@@ -0,0 +1,20 @@
+module Geostats
+  module Commands
+    class Help < Base
+      def usage
+        run
+      end
+
+      def run
+        STDERR.puts "Usage:     geostats <command> [...]"
+        STDERR.puts
+        STDERR.puts "Commands:  init <username> <password> [<directory>]"
+        STDERR.puts "           update [all | <code>]"
+        STDERR.puts "           generate [<template>]"
+        STDERR.puts "           push"
+        STDERR.puts "           console"
+        STDERR.puts "           set [<key>] [<value>]"
+      end
+    end
+  end
+end

data/lib/geostats/commands/init.rb

@@ -0,0 +1,31 @@
+require "fileutils"
+require "geostats/commands/migrate"
+
+module Geostats
+  module Commands
+    class Init < Base
+      def usage
+        STDERR.puts "Usage: geostats init <username> <password> [<directory>]"
+      end
+
+      def parse_args
+        raise UsageError unless @args.length == 2 or @args.length == 3
+
+        @username, @password, @directory = @args
+        @directory ||= File.expand_path("~/.geostats")
+
+        FileUtils.mkdir_p(@directory) unless File.exists?(@directory)
+      end
+
+      def before
+        connect_database(@directory)
+      end
+
+      def run
+        Migrate.new.invoke
+        Setting.set(:username, @username)
+        Setting.set(:password, @password)
+      end
+    end
+  end
+end

data/lib/geostats/commands/migrate.rb

@@ -0,0 +1,21 @@
+module Geostats
+  module Commands
+    class Migrate < Base
+      def usage
+        STDERR.puts "Usage: geostats migrate"
+      end
+
+      def parse_args
+        raise UsageError unless @args.length.zero?
+      end
+
+      def before
+        connect_database
+      end
+
+      def run
+        ActiveRecord::Migrator.migrate(File.join(Geostats::ROOT, "migrations"))
+      end
+    end
+  end
+end

data/lib/geostats/commands/push.rb

@@ -0,0 +1,41 @@
+module Geostats
+  module Commands
+    class Push < Base
+      def usage
+        STDERR.puts "Usage: geostats push"
+      end
+
+      def parse_args
+        raise UsageError unless @args.length.zero?
+      end
+
+      def before
+        connect_database
+        login
+      end
+
+      def after
+        logout
+      end
+
+      def run
+        log yellow("Generating statistics")
+        @html = Generator.generate
+        log "\r", green("Successfully generated statistics"), erase, "\n"
+
+        log yellow("Pushing statistics to geocaching.com")
+
+        resp, data = HTTP.post("/account/editprofiledetails.aspx", {
+          "ctl00$ContentBody$uxProfileDetails" => @html,
+          "ctl00$ContentBody$uxSave" => "Save Changes"
+        })
+
+        log "\r",
+          green("Successfully pushed statistics to geocaching.com"),
+          erase, "\n"
+      rescue Net::HTTPExceptions => e
+        error e.message
+      end
+    end
+  end
+end

data/lib/geostats/commands/set.rb

@@ -0,0 +1,35 @@
+module Geostats
+  module Commands
+    class Set < Base
+      def usage
+        STDERR.puts "Usage: geostats set"
+        STDERR.puts "                set <key>"
+        STDERR.puts "                set <key> <value>"
+      end
+
+      def parse_args
+        raise UsageError if @args.length > 2
+        @key, @value = @args
+      end
+
+      def before
+        connect_database
+      end
+
+      def run
+        if @key
+          if @value
+            Setting.set(@key, @value)
+            puts "#{@key} = #{@value}"
+          else
+            puts "#{@key} = #{Setting.get(@key) || "<null>"}"
+          end
+        else
+          Setting.all.each do |setting|
+            puts "#{setting.key} = #{setting.value || "<null>"}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/geostats/commands/update.rb

@@ -0,0 +1,175 @@
+module Geostats
+  module Commands
+    class Update < Base
+      def usage
+        STDERR.puts "Usage: geostats update"
+        STDERR.puts "                update all"
+      end
+
+      def parse_args
+        @update_all = (@args.first == "all")
+      end
+
+      def before
+        connect_database
+        login
+
+        @delay = Setting.get(:delay) || 5
+        @sleep = false
+      end
+
+      def after
+        logout
+      end
+
+      def run
+        begin
+          @logs = Grabber::Logs.new.logs
+        rescue Net::HTTPExceptions => e
+          error "Failed to fetch your logs: #{e.message}"
+        end
+
+        @logs.reverse.each do |loginfo|
+          handle_log(loginfo)
+
+          if @sleep
+            sleep(@delay + rand(@delay))
+            @sleep = false
+          end
+        end
+      end
+
+    private
+
+      def handle_log(loginfo)
+        missing = []
+
+        [:log_uuid, :logged_at, :icon, :cache_uuid, :cache_name].each do |attribute|
+          missing << attribute unless loginfo.send(attribute)
+        end
+
+        if missing.any?
+          log red("Skipping log because there are missing attributes: #{attributes.join(", ")}")
+          return
+        end
+
+        cache = create_or_update_cache(loginfo)
+        return unless cache
+
+        log = create_or_update_log(loginfo)
+        return unless log
+
+        cache.logs << log
+      end
+
+      def create_or_update_cache(loginfo)
+        cache = Cache.where(:uuid => loginfo.cache_uuid).first
+
+        if cache.nil?
+          log \
+            yellow("Adding new cache "),
+            yellow(bold(loginfo.cache_name))
+
+          @sleep = true
+
+          begin
+            cache = Cache.create_from_website(loginfo.cache_uuid)
+          rescue Net::HTTPError => e
+            log "\r",
+              red("Failed to add new cache "),
+              red(bold(loginfo.cache_name)),
+              red(": "),
+              red("Could not fetch cache information from website: #{e.message}"),
+              erase, "\n"
+            return
+          end
+
+          if cache.save
+            log "\r",
+              green("Successfully added new cache "),
+              green(bold(cache.name)),
+              erase, "\n"
+          else
+            log "\r",
+              red("Failed to add new cache "),
+              red(bold(loginfo.cache_name)),
+              red(": "),
+              red("Could not fetch all needed information from website"),
+              erase, "\n"
+
+            cache.errors.full_messages.each do |msg|
+              verbose "    o  #{msg}"
+            end
+
+            cache = nil
+          end
+        else
+          cache.update_attribute(:name, loginfo.cache_name)
+        end
+
+        cache
+      end
+
+      def create_or_update_log(loginfo)
+        # Don't handle reviewer notes
+        return nil if loginfo.icon == "big_smile"
+
+        log = Log.where(:uuid => loginfo.log_uuid).first
+
+        if log.nil?
+          log \
+            yellow("Adding new log for "),
+            yellow(bold(loginfo.cache_name)),
+            yellow(" from "),
+            yellow(bold(loginfo.logged_at.strftime("%F")))
+
+          @sleep = true
+
+          begin
+            log = Log.create_from_website(loginfo.log_uuid)
+          rescue Net::HTTPEeror => e
+            log "\r",
+              red("Failed to add new log for "),
+              red(bold(loginfo.cache_name)),
+              red(" from "),
+              red(bold(loginfo.logged_at.strftime("%F"))),
+              red(": "),
+              red("Could not fetch log information from website: #{e.message}"),
+              erase, "\n"
+            return
+          end
+
+          if log.save
+            log "\r",
+              green("Successfully added log for "),
+              green(bold(loginfo.cache_name)),
+              green(" from "),
+              green(bold(log.logged_at.strftime("%F"))),
+              erase, "\n"
+          else
+            log "\r",
+              red("Failed to add new log for "),
+              red(bold(loginfo.cache_name)),
+              red(" from "),
+              red(bold(loginfo.logged_at.strftime("%F"))),
+              red(": "),
+              red("Could not fetch all needed information from website"),
+              erase, "\n"
+
+            log.errors.full_messages.each do |msg|
+              verbose "    o  #{msg}"
+            end
+
+            log = nil
+          end
+        else
+          log.logged_at = loginfo.logged_at
+          log.set_type_from_icon(loginfo.icon)
+          log.save
+        end
+
+        log
+      end
+    end
+  end
+end