dzt 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### Next
+
+### 0.2.0 (10/20/2014)
+
+* [#7](https://github.com/dblock/dzt/pull/7): Added support for storing tiles in AWS S3 and exposed all tiler and storage options via command line - [@mzikherman](https://github.com/mzikherman).
+* [#5](https://github.com/dblock/dzt/pull/5): Allow a Fog::Storage uploader to be passed in for uploading of generated tiles rather than local storage - [@mzikherman](https://github.com/mzikherman).
+
 ### 0.1.0 (3/16/2014)
 
 * Initial public release - [@dblock](https://github.com/dblock).

data/README.md

@@ -25,7 +25,21 @@ dzt help
 dzt slice image.jpg --output tiles
 ```
 
-Creates a *tiles* folder with deep-zoom tiles.
+Creates a *tiles* folder with deep-zoom tiles. This will use the defaults defined in [/lib/dzt/tiler.rb](/lib/dzt/tiler.rb#L7-L10).
+
+You can pass in flags to override all these options, such as:
+
+```
+dzt slice image.jpg --output=tiles --format=90 --tile-format=png
+```
+
+Additionally, you can have generated files uploaded to S3 for you. You can specify that like:
+
+```
+dzt slice image.jpg --acl=public-read --bucket=bucket --s3-key=prefix --aws-id=id --aws-secret=secret
+```
+
+The files will be uploaded to the bucket specified, and generated files will be prefixed by the s3 key.
 
 
 ## Contributing

data/RELEASING.md

@@ -0,0 +1,65 @@
+# Releasing Dzt
+
+There're no particular rules about when to release dzt. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/dzt) for all supported platforms.
+
+Increment the version, modify [lib/dzt/version.rb](lib/dzt/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.7.1` to `0.2.0`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.7.1` to `0.8.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.2.0 (14/10/2014)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/dzt/version.rb
+git commit -m "Preparing for release, 0.2.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+dzt 0.2.0 built to pkg/dzt-0.2.0.gem.
+Tagged v0.2.0.
+Pushed git commits and tags.
+Pushed dzt 0.2.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Comit your changes.
+
+```
+git add CHANGELOG.md
+git commit -m "Preparing for next release."
+git push origin master
+```

data/bin/dzt

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'gli'
 require 'dzt'
+require 'fog'
 
 include GLI::App
 
@@ -10,14 +11,42 @@ default_command :slice
 
 desc "Slice an image"
 command :slice do |c|
-  c.flag [:o, :output], desc: 'Output folder', default_value: File.join(Dir.pwd, "tiles")
+  c.flag [:o, :output, 'output'], desc: 'Output folder'
+  c.flag [:ts, :tilesize, 'tile-size'], desc: 'Tile size', default_value: DZT::Tiler::DEFAULT_TILE_SIZE
+  c.flag [:to, :tileoverlap, 'tile-overlap'], desc: 'Tile overlap', default_value: DZT::Tiler::DEFAULT_TILE_OVERLAP
+  c.flag [:q, :quality], desc: 'Output quality', default_value: DZT::Tiler::DEFAULT_QUALITY
+  c.flag [:f, :format], desc: 'Tile format', default_value: DZT::Tiler::DEFAULT_TILE_FORMAT
+  c.flag [:overwrite], desc: 'Overwrite output files', default_value: DZT::Tiler::DEFAULT_OVERWRITE_FLAG
+  c.flag [:acl], desc: 'S3 Acl', default_value: DZT::S3Storage::DEFAULT_ACL
+  c.flag [:bucket], desc: 'S3 Bucket'
+  c.flag [:s3_key, 's3-key'], desc: 'S3 Key', default_value: DZT::S3Storage::DEFAULT_KEY
+  c.flag [:aws_id, 'aws-id'], desc: 'AWS Id'
+  c.flag [:aws_secret, 'aws-secret'], desc: 'AWS Secret'
   c.action do |global_options, options, args|
     if args.length < 1
       raise 'You must specify an image file to slice.'
     end
+    if options[:output]
+      storage = DZT::FileStorage.new(
+        destination: options[:output]
+      )
+    else
+      storage = DZT::S3Storage.new(
+        s3_acl: options[:acl],
+        s3_bucket: options[:bucket],
+        s3_key: options[:s3_key],
+        aws_id: options[:aws_id],
+        aws_secret: options[:aws_secret]
+      )
+    end
     tiler = DZT::Tiler.new(
       source: args[0],
-      destination: options[:output]
+      size: options[:tilesize],
+      overlap: options[:tileoverlap],
+      format: options[:format],
+      quality: options[:quality],
+      overwrite: options[:overwrite],
+      storage: storage
     )
     tiler.slice! do |path|
       puts path

data/lib/dzt/file_storage.rb

@@ -0,0 +1,27 @@
+module DZT
+  class FileStorage
+    #
+    # @param destination: Full directory in which to output tiles, defaults to 'tiles' in the current dir.
+    #
+    def initialize(options = {})
+      @store_path = options[:destination] || File.join(Dir.pwd, 'tiles')
+    end
+
+    def exists?
+      File.directory?(@store_path) && ! Dir["@{@store_path}/*"].empty?
+    end
+
+    def storage_location(level)
+      File.join(@store_path, level.to_s)
+    end
+
+    def mkdir(path)
+      FileUtils.mkdir_p(path)
+    end
+
+    def write(file, dest, options = {})
+      quality = options[:quality]
+      file.write(dest) { @quality = quality if quality }
+    end
+  end
+end

data/lib/dzt/s3_storage.rb

@@ -0,0 +1,49 @@
+module DZT
+  class S3Storage
+    DEFAULT_ACL = 'public-read'
+    DEFAULT_KEY = ''
+    #
+    # @param s3_acl: ACL to use for storing, defaults to 'public-read'.
+    # @param s3_bucket: Bucket to store tiles.
+    # @param s3_key: Key to prefix stored files.
+    # @param aws_id: AWS Id.
+    # @param aws_secret: AWS Secret.
+    #
+    def initialize(options = {})
+      @s3_acl = options[:s3_acl] || DEFAULT_ACL
+      @s3_bucket = options[:s3_bucket]
+      @s3_key = options[:s3_key] || DEFAULT_KEY
+      @s3_id = options[:aws_id]
+      @s3_secret = options[:aws_secret]
+    end
+
+    def s3
+      @s3 ||= Fog::Storage.new(
+        provider: 'AWS',
+        aws_access_key_id: @s3_id,
+        aws_secret_access_key: @s3_secret
+      )
+    end
+
+    # Currently does not supporting checking S3 fo overwritten files
+    def exists?
+      false
+    end
+
+    def storage_location(level)
+      "#{@s3_key}/#{level.to_s}"
+    end
+
+    # no-op
+    def mkdir(path)
+    end
+
+    def write(file, dest, options = {})
+      quality = options[:quality]
+      s3.put_object(@s3_bucket, dest, file.to_blob { @quality = quality if quality },
+        'Content-Type' => file.mime_type,
+        'x-amz-acl' => @s3_acl
+      )
+    end
+  end 
+end

data/lib/dzt/tiler.rb

@@ -1,4 +1,6 @@
 # Deep Zoom module for generating Deep Zoom (DZI) tiles from a source image
+require_relative 'file_storage'
+require_relative 's3_storage'
 module DZT
   class Tiler
     # Defaults
@@ -6,6 +8,7 @@ module DZT
     DEFAULT_TILE_OVERLAP = 0
     DEFAULT_QUALITY = 75
     DEFAULT_TILE_FORMAT = "jpg"
+    DEFAULT_OVERWRITE_FLAG = false
 
     # Generates the DZI-formatted tiles and sets necessary metadata on this object.
     #
@@ -14,21 +17,24 @@ module DZT
     # @param format Format for output tiles (default: "jpg")
     # @param size Size, in pixels, for tile squares (default: 512)
     # @param overlap Size, in pixels, of the overlap between tiles (default: 2)
-    # @param overwrite If true, overwrites existing tiles (default: false)
-    # @param destination: Full directory in which to output tiles.
+    # @param overwrite Whether or not to overwrite if the destination exists (default: false)
+    # @param storage Either an instance of S3Storage or FileStorage
     #
     def initialize(options)
       @tile_source = options[:source]
       raise "Missing options[:source]." unless @tile_source
+
       @tile_source = Magick::Image.read(@tile_source)[0] if @tile_source.is_a?(String)
       @tile_size = options[:size] || DEFAULT_TILE_SIZE
       @tile_overlap = options[:overlap] || DEFAULT_TILE_OVERLAP
       @tile_format  = options[:format] || DEFAULT_TILE_FORMAT
+
       @max_tiled_height = @tile_source.rows
       @max_tiled_width = @tile_source.columns
+
       @tile_quality = options[:quality] || DEFAULT_QUALITY
-      @overwrite = options[:overwrite] || false
-      @destination = options[:destination] || File.join(Dir.pwd, "tiles")
+      @overwrite = options[:overwrite] || DEFAULT_OVERWRITE_FLAG
+      @storage = options[:storage]
     end
 
     ##
@@ -36,10 +42,7 @@ module DZT
     # Uses a default tile size of 512 pixels, with a default overlap of 2 pixel.
     ##
     def slice!(&block)
-      if ! @overwrite && File.directory?(@destination) && ! Dir["@{@destination}/*"].empty?
-        raise "Output directory #{@destination} already exists!"
-        @overwrite ? Rails.logger.warn(msg) : raise(msg)
-      end
+      raise "Output #{@destination} already exists!" if ! @overwrite && @storage.exists?
 
       image = @tile_source.dup
       orig_width, orig_height = image.columns, image.rows
@@ -48,11 +51,10 @@ module DZT
       max_level(orig_width, orig_height).downto(0) do |level|
         width, height = image.columns, image.rows
 
-        current_level_dir = File.join(@destination, level.to_s)
-        FileUtils.mkdir_p(current_level_dir)
-
+        current_level_storage_dir = @storage.storage_location(level)
+        @storage.mkdir(current_level_storage_dir)
         if block_given?
-          yield current_level_dir
+          yield current_level_storage_dir
         end
 
         # iterate over columns
@@ -61,7 +63,7 @@ module DZT
           # iterate over rows
           y, row_count = 0, 0
           while y < height
-            dest_path = File.join(current_level_dir, "#{col_count}_#{row_count}.#{@tile_format}")
+            dest_path = File.join(current_level_storage_dir, "#{col_count}_#{row_count}.#{@tile_format}")
             tile_width, tile_height = tile_dimensions(x, y, @tile_size, @tile_overlap)
 
             save_cropped_image(image, dest_path, x, y, tile_width, tile_height, @tile_quality)
@@ -120,7 +122,7 @@ module DZT
       # The crop method retains the offset information in the cropped image.
       # To reset the offset data, adding true as the last argument to crop.
       cropped = img.crop(x, y, width, height, true)
-      cropped.write(dest) { @quality = quality }
+      @storage.write(cropped, dest, quality: quality)
     end
   end
 end

data/lib/dzt/version.rb

@@ -1,3 +1,3 @@
 module DZT
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,41 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: dzt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -46,6 +51,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/dzt
+- lib/dzt/file_storage.rb
+- lib/dzt/s3_storage.rb
 - lib/dzt/tiler.rb
 - lib/dzt/version.rb
 - lib/dzt.rb
@@ -53,28 +60,33 @@ files:
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
+- RELEASING.md
 homepage: http://github.com/dblock/dzt
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 600770840380266267
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Tile images for deep-zoom.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9ebec393c326ec86c8abdb6f4ccc73c4c74398b8
-  data.tar.gz: 647bcbe70edcb2a8718a757cd12f2cbda0eac921
-SHA512:
-  metadata.gz: 8735da367c32b01f25ad064685ff460eeaaf874410a99c238932ec3e5a2264df35a6eff169f3057ec3bb1cfd7650a6929084faa68d3391bd111602c998ac6b9d
-  data.tar.gz: 65cdf93cb7fb7bd6a8926f9410456fbb38def9193ffb7832a7eeb1167fd61281dadf1873f0122b27c60c9cc2db121fc55ae99674f6e76e49cf090f44ec9254c3