tairu 0.8.2 → 0.9.0

data/README.md

@@ -1,3 +1,46 @@
 tairu ... simple map tile server
 
-To play with the library in irb: `rake console`
+In development mode (irb): `rake console`
+
+To run: `tairu -c /path/to/config/file`
+
+Example config file:
+
+```ruby
+
+name: tairu_config_example
+cache:
+  type: memory
+layers:
+  geo:
+    provider: mbtiles
+    tileset: geography-class.mbtiles
+    location: ~/.tairu/tilesets
+    format: png
+
+```
+
+Tairu relies on a valid configuration object assigned to `Tairu::CONFIG`
+
+This may be read from a yaml file (see example above) using `Tairu::Configuration.config_from_file(file_name)`
+
+or by assigning default values for layers, cache, and name (optional):
+
+```ruby
+
+layers = {
+  'geo' => {
+    'provider' => 'mbtiles',
+    'tileset' => 'geography-class.mbtiles',
+    'location' => '~/.tairu/tilesets',
+    'format' => 'png'
+  }
+}
+
+cache = Tairu::Configuration.start_cache('memory', {})
+
+name = 'tairu_config_example'
+
+Tairu::CONFIG = Tairu::Configuration.new(layers, cache, name)
+
+```

data/bin/tairu

@@ -10,6 +10,12 @@ opts = {}
 OptionParser.new do |o|
   o.banner = 'Usage: tairu.rb [options]'
 
+  o.on('-v', '--version', '') do
+    require 'tairu'
+    puts "Tairu v#{Tairu::VERSION}"
+    exit(0)
+  end
+
   o.on('-c', '--config CONFIG', '') do |config|
     opts[:config] = File.expand_path(config)
   end
@@ -26,7 +32,7 @@ end.parse!
 if opts[:config]
   require 'tairu'
 
-  Tairu::CONFIG = Tairu::Configuration.new(opts[:config])
+  Tairu::CONFIG = Tairu::Configuration.config_from_file(opts[:config])
   Tairu::CACHE = Tairu::CONFIG.cache
 else
   puts "No valid config file specified. Use -c / --config option."

data/lib/tairu.rb

@@ -11,14 +11,14 @@ module Tairu
   TILE_404 = Tairu::Tile.new(File.read(File.join(File.expand_path(File.dirname(__FILE__)), 'tairu', 'images', '404.png')), 'image/png')
 
   def self.get_tile(name, coord, format = nil)
-    tileset = Tairu::CONFIG.data['cache']['layers'][name]
+    tileset = Tairu::CONFIG.layers[name]
 
     unless tileset.nil?
       tile = Tairu::CACHE.get(tileset, coord)
 
       if tile.nil?
         provider = Tairu::Store::TYPES[tileset['provider']]
-        provider_tile = provider.get(name, tileset['tileset'], coord)
+        provider_tile = provider.get(name, tileset['tileset'], coord, tileset['format'])
 
         unless provider_tile.nil?
           tile = provider_tile

data/lib/tairu/cache/disk.rb

@@ -1,7 +1,69 @@
+require 'fileutils'
+
 module Tairu
   module Cache
     class Disk
-      def initialize(options = nil)
+      def initialize(options = {})
+        raise "No path specified." unless options['path']
+        @path = options['path']
+        @expire = options['expire'] || 300
+        @tiles = {}
+      end
+
+      def lock_write(path, data)
+        File.open(path, 'wb') do |f|
+          begin
+            f.flock(File::LOCK_EX)
+            f.write(data)
+          ensure
+            f.flock(File::LOCK_UN)
+          end
+        end
+      end
+
+      def lock_read(path)
+        if File.exists?(path)
+          if File.mtime(path) > (Time.now - @expire)
+            data = File.open(path, 'rb') do |f|
+              begin
+                f.flock(File::LOCK_SH)
+                f.read
+              ensure
+                f.flock(File::LOCK_UN)
+              end
+            end
+          else
+            FileUtils.rm(path)
+          end
+        end
+
+        data
+      end
+
+      def add(layer, coord, tile)
+        expire = Time.now + @expire
+        tileset = layer['tileset']
+        base_path = File.join(File.expand_path(@path), tileset, "#{coord.zoom}", "#{coord.column}")
+        FileUtils.mkdir_p(base_path)
+        path = File.join(base_path, "#{coord.row}.#{layer['format']}")
+        lock_write(path, tile.data)
+        purge_expired(layer)
+      end
+
+      def get(layer, coord)
+        tileset = layer['tileset']
+        path = File.join(File.expand_path(@path), tileset, "#{coord.zoom}", "#{coord.column}", "#{coord.row}.#{layer['format']}")
+        data = lock_read(path)
+        
+        return nil if data.nil?
+
+        Tairu::Tile.new(data, layer['format'])
+      end
+
+      def purge_expired(layer)
+        Dir.glob(File.join(File.expand_path(@path), "**/*.#{layer['format']}")).each do |f|
+          FileUtils.rm(f) if File.mtime(f) < (Time.now - @expire)
+        end
       end
     end
   end

data/lib/tairu/cache/memory.rb

@@ -9,7 +9,7 @@ module Tairu
         key = Tairu::Cache::Key.new(layer, coord)
         expire = Time.now + age
         @tiles[key] = {tile: tile, expire: expire}
-        :purge_expired_tiles
+        :purge_expired
       end
 
       def get(layer, coord) # format?

data/lib/tairu/configuration.rb

@@ -2,20 +2,48 @@ require 'yaml'
 
 module Tairu
   class Configuration
-    attr_accessor :data, :cache
+    attr_accessor :layers, :cache, :name
 
-    def initialize(config = nil)
-      raise "No config file specified." unless config
-      @data = YAML.load_file(config)
-      @cache = start_cache
+    def initialize(layers, cache, name = nil)
+      @layers = layers
+      @cache = cache
+      @name = name
     end
 
-    def start_cache
-      cache_type = @data['cache']['type']
-      cache_options = @data['cache']['options']
+    def self.config_from_file(file)
+      file = File.expand_path(file)
 
+      if File.exists?(file)
+        data = YAML.load_file(file)
+      else
+        raise 'Configuration file not found at specified location.'
+      end
+
+      name = data['name'] if data['name']
+
+      if data['layers']
+        layers = data['layers']
+      else
+        raise 'Layers must be specified.'
+      end
+
+      if data['cache'] && data['cache']['type']
+        cache_type = data['cache']['type']
+        options = data['cache']['options'] ? data['cache']['options'] : {}
+
+        cache = start_cache(cache_type, options)
+      end
+
+      cache = Tairu::Cache::Memory.new if cache.nil?
+
+      config = Configuration.new(layers, cache, name)
+
+      config
+    end
+
+    def self.start_cache(cache_type = nil, options = nil)
       if cache_type
-        cache = Tairu::Cache::TYPES[cache_type].new(cache_options)
+        cache = Tairu::Cache::TYPES[cache_type].new(options)
       else
         cache = Tairu::Cache::Memory.new
       end

data/lib/tairu/server.rb

@@ -5,7 +5,7 @@ module Tairu
   class Server < Sinatra::Base
     get '/:tileset/:zoom/:row/:col.grid.json' do
       coord = Tairu::Coordinate.new(Integer(params[:row]), Integer(params[:col]), Integer(params[:zoom]))
-      tileset = Tairu::CONFIG.data['cache']['layers'][params[:tileset]]
+      tileset = Tairu::CONFIG.layers[params[:tileset]]
       tile = Tairu::Store::MBTiles.get_grid(params[:tileset], tileset['tileset'], coord)
 
       callback = params.delete('callback')

data/lib/tairu/store/esri.rb

@@ -1,12 +1,3 @@
-# Integer("0x0000000a") => 10
-# 10.to_s(16) => "a"
-# "%x" % 10 => "a"
-# "%08x" % 10 => "0000000a"
-# "#%02x%02x%02x" % [255, 0, 10] => #ff000a
-# /Layers/_alllayers/Lxx/Rhex/Chex.fmt => L15/R0000000a/C0000000a.jpg
-# http://services.arcgisonline.com/cache_im/l3_imagery_Prime_world_2D/Layers/_alllayers/L15/R000027f9/C00002d2c.jpg
-# http://proceedings.esri.com/library/userconf/devsummit07/papers/building_and_using_arcgis_server_map_caches-best_practices.pdf
-
 module Tairu
   module Store
     class Esri
@@ -20,12 +11,22 @@ module Tairu
       end
 
       def self.get(layer, tileset, coord, format = 'png')
-        loc = File.expand_path(Tairu::CONFIG.data['cache']['layers'][layer]['location'])
+        loc = File.expand_path(Tairu::CONFIG.layers[layer]['location'])
         path = File.join(loc, tileset, 'Layers', '_alllayers', "L#{'%02i' % coord.zoom}", "R#{encode_hex(coord.row)}", "C#{encode_hex(coord.column)}.#{format}")
 
         return nil unless File.exists?(path)
 
-        data = File.read(path)
+        if File.exists?(path)
+          data = File.open(path, 'r') do |f|
+            begin
+              f.flock(File::LOCK_SH)
+              f.read
+            ensure
+              f.flock(File::LOCK_UN)
+            end
+          end
+        end
+
         mime_type = "image/#{format}"
         Tairu::Tile.new(data, mime_type)
       end

data/lib/tairu/store/mbtiles.rb

@@ -15,7 +15,7 @@ module Tairu
       end
 
       def self.connection_string(layer)
-        loc = File.expand_path(Tairu::CONFIG.data['cache']['layers'][layer]['location'])
+        loc = File.expand_path(Tairu::CONFIG.layers[layer]['location'])
         conn = defined?(JRUBY_VERSION) ? "jdbc:sqlite:#{loc}" : "sqlite://#{loc}"
         conn
       end
@@ -77,7 +77,7 @@ module Tairu
       end
 
       def self.info(layer, file)
-        file_loc = File.join(File.expand_path(Tairu::CONFIG.data['cache']['layers'][layer]['location']), file)
+        file_loc = File.join(File.expand_path(Tairu::CONFIG.layers[layer]['location']), file)
         raise "Tileset does not exist." unless exists? file_loc
 
         conn = connection_string(layer)
@@ -112,7 +112,7 @@ module Tairu
         list
       end
 
-      def self.get(layer, file, coord)
+      def self.get(layer, file, coord, format = nil)
         conn = connection_string(layer)
         db = Sequel.connect(File.join(conn, file))
 

data/lib/tairu/version.rb

@@ -1,3 +1,3 @@
 module Tairu
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tairu
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel