geostats 0.1.0

data/lib/geostats/console.rb

@@ -0,0 +1,2 @@
+include Geostats
+Database.connect!(ENV["GEOSTATS_DIR"])

data/lib/geostats/core_ext.rb

@@ -0,0 +1,5 @@
+class Array
+  def avg
+    length.zero? ? 0 : sum.to_f / length.to_f
+  end
+end

data/lib/geostats/database.rb

@@ -0,0 +1,15 @@
+module Geostats
+  class Database
+    def self.connect!(directory=nil)
+      directory ||= File.expand_path("~/.geostats")
+
+      file = File.join(directory, "database.sqlite3")
+      raise "file does not exist: #{file}" unless File.exists?(file)
+
+      ActiveRecord::Base.establish_connection(
+        :adapter => "sqlite3",
+        :database => file
+      )
+    end
+  end
+end

data/lib/geostats/generator.rb

@@ -0,0 +1,43 @@
+require "hpricot"
+require "css_parser"
+
+require "geostats/views/base"
+require "geostats/views/default"
+
+module Geostats
+  class Generator
+    PARTS = %w(difficulty_terrain_matrix milestones monthly_founds
+      founds_by_cache_type)
+
+    def self.generate
+      new.generate
+    end
+
+    def initialize
+      @view = Views::Default.new
+      @css = CssParser::Parser.new
+
+      file = File.join(File.dirname(__FILE__), "templates", "stylesheet.css")
+      @css.add_block!(File.read(file))
+    end
+
+    def generate
+      PARTS.each do |part|
+        require "geostats/views/#{part}"
+        @view[part.to_sym] = "Geostats::Views::#{part.camelcase}".constantize.render
+      end
+
+      @doc = Hpricot(@view.render)
+
+      @css.each_selector do |selector, style|
+        @doc.search(selector) do |el|
+          if el.elem?
+            el["style"] = "#{el.attributes['style']} #{style}".strip
+          end
+        end
+      end
+
+      @doc.to_html
+    end
+  end
+end

data/lib/geostats/grabber/cache.rb

@@ -0,0 +1,95 @@
+module Geostats
+  module Grabber
+    class Cache
+      def initialize(uuid)
+        @resp, @data = HTTP.get("/seek/cache_details.aspx?guid=#{uuid}&log=y")
+      end
+
+      def code
+        if @data =~ /<div id="ctl00_cacheCodeWidget".*?>\s*<p>\s*([A-Z0-9]+)<\/p>\s*<\/div>/
+          $1
+        end
+      end
+
+      def name
+        if @data =~ /<span id="ctl00_ContentBody_CacheName">(.*?)<\/span>/
+          name = Utils.unescape($1)
+          name =~ /^<strike>(.*)<\/strike>$/ ? $1 : name
+        end
+      end
+
+      def type
+        if @data =~ /<h2.*?WptTypes\/(\d+)\.gif".*?h2>/
+          $1.to_i
+        end
+      end
+
+      def hidden_at
+        if @data =~ /<span id="ctl00_ContentBody_DateHidden">(\d{1,2})\/(\d{1,2})\/(\d{4})<\/span>/
+          Time.parse([$2, $1, $3].join("."))
+        end
+      end
+
+      def size
+        if @data =~ /<img src="\/images\/icons\/container\/(.*?)\.gif" alt="Size: .*?" \/>/
+          $1 if %w(micro small regular large other not_chosen).include?($1)
+        end
+      end
+
+      def owner
+        if @data =~ /<span id="ctl00_ContentBody_CacheOwner">by.*?\/profile\/\?guid=(.*?)&wid=.*<\/a><\/span>/
+          user = Grabber::User.new($1)
+          if name = user.username
+            name
+          end
+        end
+      end
+
+      def difficulty
+        if @data =~ /<span id="ctl00_ContentBody_Difficulty"><img src=".*?" alt="([0-9\.]+) out of 5" \/><\/span>/
+          $1.to_f
+        end
+      end
+
+      def terrain
+        if @data =~ /<span id="ctl00_ContentBody_Terrain"><img src=".*?" alt="([0-9\.]+) out of 5" \/><\/span>/
+          $1.to_f
+        end
+      end
+
+      def latitude
+        if @data =~ /\/wpt\/\?lat=(.*)&amp;lon=(.*)&amp;detail=1/
+          $1.to_f
+        end
+      end
+
+      def longitude
+        if @data =~ /\/wpt\/\?lat=(.*)&amp;lon=(.*)&amp;detail=1/
+          $2.to_f
+        end
+      end
+
+      def location
+        if @data =~ /<span id="ctl00_ContentBody_Location">In (.*?)<\/span>/
+          $1
+        end
+      end
+
+      def founds_count
+        @data.scan(/<strong><img src=".*?icon_smile\.gif" alt="" \/>&nbsp;/).length
+      end
+
+      def dnf_count
+        @data.scan(/<strong><img src=".*?icon_sad\.gif" alt="" \/>&nbsp;/).length
+      end
+
+      def archived?
+        !!(@data =~ /<li>This cache has been archived/)
+      end
+
+      def pmonly?
+        !!(@data =~ /<p class="Warning">Sorry, the owner of this listing has made it viewable to Premium Members only./)
+      end
+    end
+  end
+end

data/lib/geostats/grabber/log.rb

@@ -0,0 +1,27 @@
+module Geostats
+  module Grabber
+    class Log
+      def initialize(uuid)
+        @resp, @data = HTTP.get("/seek/log.aspx?LUID=#{uuid}")
+      end
+
+      def icon
+        if @data =~ /<img id="ctl00_ContentBody_LogBookPanel1_LogImage".*?src="\/images\/icons\/(.*?).gif" .*? \/>/
+          $1
+        end
+      end
+
+      def message
+        if @data =~ /<p><span id="ctl00_ContentBody_LogBookPanel1_LogText">(.*)<\/span><\/p>/
+          Utils.replace_smilie_img_tags(Utils.unescape($1))
+        end
+      end
+
+      def logged_at
+        if @data =~ /<span id="ctl00_ContentBody_LogBookPanel1_LogDate">(.*?)<\/span>/
+          Time.parse($1) rescue nil
+        end
+      end
+    end
+  end
+end

data/lib/geostats/grabber/logs.rb

@@ -0,0 +1,37 @@
+module Geostats
+  module Grabber
+    class Logs
+      class Log < Struct.new(:icon, :logged_at, :cache_uuid,
+        :cache_name, :location, :log_uuid)
+      end
+
+      REGEX = %r{<tr.*?>\s*<td><img src="/images/icons/([a-z_]+)\.gif" width="16" height="16" alt=".*?" /></td>\s*<td>([0-9\/]+)</td>\s*<td><a href="http://www\.geocaching\.com/seek/cache_details\.aspx\?guid=([a-f0-9\-]+)">(.*?)</a>&nbsp;</td>\s*<td>(.*?) &nbsp;</td>\s*<td><a href="http://www\.geocaching\.com/seek/log\.aspx\?LUID=([a-f0-9\-]+)" target="_blank" title="Visit Log">Visit Log</a></td>\s*</tr>}
+
+      def initialize
+        @resp, @data = HTTP.get("/my/logs.aspx?s=1")
+      end
+
+      def logs
+        @data.scan(REGEX).map do |match|
+          log             = Log.new
+
+          log.icon        = match[0]
+          log.cache_uuid  = match[2]
+          log.cache_name  = Utils.unescape(match[3])
+          log.location    = Utils.unescape(match[4])
+          log.log_uuid    = match[5]
+          log.logged_at   = match[1]
+
+          log.cache_name  = Utils.unescape($1) if log.cache_name =~ /^<span class="Strike Warning">(.*)<\/span>$/
+          log.cache_name  = Utils.unescape($1) if log.cache_name =~ /^<strike>(.*)<\/strike>$/
+
+          if log.logged_at =~ /^(\d+)\/(\d+)\/(\d+)$/
+            log.logged_at = Time.parse([$2, $1, $3].join("."))
+          end
+
+          log
+        end
+      end
+    end
+  end
+end

data/lib/geostats/grabber/user.rb

@@ -0,0 +1,15 @@
+module Geostats
+  module Grabber
+    class User
+      def initialize(uuid)
+        @resp, @data = HTTP.get("/profile/?guid=#{uuid}")
+      end
+
+      def username
+        if @data =~ /<h2><span id="ctl00_ContentBody_lblUserProfile".*?>Profile for User: (.*?)<\/span><\/h2>/
+          Utils.unescape($1)
+        end
+      end
+    end
+  end
+end

data/lib/geostats/http.rb

@@ -0,0 +1,97 @@
+require "net/http"
+
+module Geostats
+  class HTTP
+    attr_writer :username, :password
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def self.login(username, password)
+      self.instance.username = username
+      self.instance.password = password
+      self.instance.login
+    end
+
+    def self.logout
+      self.instance.logout
+    end
+
+    def self.get(path)
+      self.instance.get(path)
+    end
+
+    def self.post(path, data={})
+      self.instance.post(path, data)
+    end
+
+    def login
+      raise ArgumentError, "Missing username" unless @username
+      raise ArgumentError, "Missing password" unless @password
+
+      resp, data = post("/login/default.aspx", {
+        "ctl00$ContentBody$myUsername" => @username,
+        "ctl00$ContentBody$myPassword" => @password,
+        "ctl00$ContentBody$Button1" => "Login",
+        "ctl00$ContentBody$cookie" => "on"
+      })
+
+      @cookie = resp.response["set-cookie"]
+    end
+
+    def logout
+      get("/login/default.aspx?RESET=Y")
+      @cookie = nil
+    end
+
+    def get(path)
+      header = default_header
+      header["Cookie"] = @cookie if @cookie
+
+      http.get(path, header)
+    end
+
+    def post(path, data={})
+      metadata(path).each do |key, value|
+        data[key] = value
+      end
+
+      header = default_header
+      header["Cookie"] = @cookie if @cookie
+
+      http.post(path, data.map { |k,v| "#{k}=#{v}" }.join("&"), header)
+    end
+
+  protected
+
+    def metadata(path)
+      resp, data = get(path)
+      meta = {}
+
+      data.scan(/<input type="hidden" name="__([A-Z]+)" id="__[A-Z]+" value="(.*?)" \/>/).each do |match|
+        meta["__#{match[0]}"] = CGI.escape(match[1])
+      end
+
+      meta
+    end
+
+    def user_agent
+      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-GB; rv:1.9.0.13) Gecko/2009073022 Firefox/3.0.13 (.NET CLR 3.5.30729)"
+    end
+
+    def default_header
+      {
+        "User-Agent" => user_agent
+      }
+    end
+
+    def http
+      @http ||= begin
+        @http = Net::HTTP.new("www.geocaching.com")
+        @http.open_timeout = 5
+        @http
+      end
+    end
+  end
+end

data/lib/geostats/migrations/001_create_caches.rb

@@ -0,0 +1,27 @@
+class CreateCaches < ActiveRecord::Migration
+  def self.up
+    create_table :caches do |t|
+      t.integer   :cache_type_id
+      t.string    :uuid
+      t.string    :code
+      t.string    :name
+      t.float     :latitude
+      t.float     :longitude
+      t.float     :difficulty
+      t.float     :terrain
+      t.string    :owner
+      t.string    :size
+      t.string    :location
+      t.datetime  :hidden_at
+      t.boolean   :is_pmonly
+      t.boolean   :is_archived
+      t.integer   :gcvote_votes
+      t.float     :gcvote_average
+      t.float     :gcvote_median
+      t.integer   :founds_count
+      t.integer   :dnf_count
+      t.datetime  :synced_at
+      t.timestamps
+    end
+  end
+end

data/lib/geostats/migrations/002_create_cache_types.rb

@@ -0,0 +1,16 @@
+class CreateCacheTypes < ActiveRecord::Migration
+  def self.up
+    create_table :cache_types do |t|
+      t.string    :name
+    end
+
+    cache_types = ["Traditional Cache", "Multi-Cache", "Mystery Cache",
+      "Letterbox Hybrid", "Wherigo Cache", "EarthCache", "Virtual Cache",
+      "Webcam Cache", "Reverse Cache", "Event Cache", "Mega-Event Cache",
+      "10 Years! Event Cache"]
+
+    cache_types.each do |cache_type|
+      Geostats::CacheType.create! :name => cache_type
+    end
+  end
+end

data/lib/geostats/migrations/003_create_logs.rb

@@ -0,0 +1,13 @@
+class CreateLogs < ActiveRecord::Migration
+  def self.up
+    create_table :logs do |t|
+      t.integer   :cache_id
+      t.integer   :log_type_id
+      t.string    :uuid
+      t.text      :message
+      t.datetime  :logged_at
+      t.datetime  :synced_at
+      t.timestamps
+    end
+  end
+end

data/lib/geostats/migrations/004_create_log_types.rb

@@ -0,0 +1,15 @@
+class CreateLogTypes < ActiveRecord::Migration
+  def self.up
+    create_table :log_types do |t|
+      t.string    :name
+    end
+
+    log_types = ["Found it", "Didn't find it", "Note", "Needs archived",
+      "Needs maintenance", "Archive", "Enable Listing","Temporarily Disable Listing",
+      "Update Coordinates", "Owner Maintenance", "Will attend", "Attended"]
+
+    log_types.each do |log_type|
+      Geostats::LogType.create! :name => log_type
+    end
+  end
+end

data/lib/geostats/migrations/005_create_settings.rb

@@ -0,0 +1,9 @@
+class CreateSettings < ActiveRecord::Migration
+  def self.up
+    create_table :settings do |t|
+      t.string    :key
+      t.string    :value
+      t.timestamps
+    end
+  end
+end

data/lib/geostats/migrations/006_add_cito_cache_type.rb

@@ -0,0 +1,5 @@
+class AddCitoCacheType < ActiveRecord::Migration
+  def self.up
+    Geostats::CacheType.create! :name => "Cache In Trash Out Event"
+  end
+end

data/lib/geostats/models/cache.rb

@@ -0,0 +1,47 @@
+module Geostats
+  class Cache < ActiveRecord::Base
+    belongs_to :cache_type, :class_name => "Geostats::CacheType"
+    has_many :logs, :class_name => "Geostats::Log"
+
+    scope :found_or_attended, lambda { where("logs.log_type_id IN (?)", [1, 12]) }
+
+    validates :uuid, :presence => true, :uniqueness => true
+    validates :code, :presence => true, :uniqueness => true
+    validates :name, :presence => true
+    validates :longitude, :presence => true, :numericality => true
+    validates :latitude, :presence => true, :numericality => true
+    validates :owner, :presence => true
+    validates :hidden_at, :presence => true
+    validates :size, :presence => true
+    validates :location, :presence => true
+    validates :founds_count, :presence => true, :numericality => true
+    validates :dnf_count, :presence => true, :numericality => true
+
+    def self.create_from_website(uuid)
+      cache = Cache.new(:uuid => uuid)
+      cache.update_from_website
+      cache
+    end
+
+    def update_from_website
+      info = Grabber::Cache.new(self.uuid)
+
+      [:name, :code, :size, :latitude, :longitude, :difficulty, :terrain,
+       :location, :owner, :hidden_at, :founds_count, :dnf_count
+      ].each do |attribute|
+        if value = info.send(attribute)
+          self.attributes = { attribute => value }
+        end
+      end
+
+      self.is_pmonly = info.pmonly?
+      self.is_archived = info.archived?
+
+      if type = info.type and index = CacheType::MAPPING.index(type)
+        self.cache_type = CacheType.where(:id => index + 1).first
+      end
+
+      self.synced_at = Time.now
+    end
+  end
+end