snapimage 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # Snapimage
 
-TODO: Write a gem description
+SnapImage is a Rack middleware that supports server-side image uploading for [SnapEditor](http://snapeditor.com), an online HTML5 WYSIWYG text editor. It also provides a self-contained server that is ready to roll.
 
 ## Installation
 
@@ -16,9 +16,34 @@ Or install it yourself as:
 
     $ gem install snapimage
 
+## Configuration
+
+Generate a config file (default is "config/snapimage\_config.yml"). SnapImage comes with a script to do that.
+
+    $ snapimage_generate_config <local root>
+
+The local root argument is a path that tells SnapImage where to store the uploaded files. For other options, use the -h flag.
+
+    $ snapimage_generate_config -h
+
 ## Usage
 
-TODO: Write usage instructions here
+The middleware class is SnapImage::Middleware. It takes the following options.
+
+    path: The URL path that SnapImage listens to and accepts image uploads from (default is "/snapimage_api").
+    config: The path to the config file (default is "config/snapimage_config.yml").
+
+### Rails
+
+Add the following to application.rb.
+
+    config.middleware.use SnapImage::Middleware
+
+### Other Rack Applications
+
+Add the following to your server.
+
+    use SnapImage::Middleware
 
 ## Contributing
 

data/bin/snapimage_generate_config

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 
 require "optparse"
+require "fileutils"
 
 options = {
-  file: "snapimage_config.yml",
+  file: "config/snapimage_config.yml",
   size: 10485760,
   force: false
 }
@@ -17,7 +18,7 @@ optparse = OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Options:"
 
-  opts.on("-f", "--file FILE", "File to generate (Default: snapimage_config.yml)") do |file|
+  opts.on("-f", "--file FILE", "File to generate (Default: config/snapimage_config.yml)") do |file|
     options[:file] = file
   end
 
@@ -51,6 +52,7 @@ if !options[:force] && File.exists?(options[:file])
   exit
 end
 
+FileUtils.mkdir_p(File.dirname(options[:file]))
 File.open(options[:file], "w") do |f|
   f.write(<<-EOF
 directory: "#{local_root}"

data/bin/snapimage_server

@@ -7,7 +7,7 @@ options = {
 }
 
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: snapimage_server config [options]"
+  opts.banner = "Usage: snapimage_server [options]"
 
   opts.on("-p", "--port PORT", "Set the port (Default: 54321)") do |port|
     options[:port] = port.to_i
@@ -17,6 +17,10 @@ optparse = OptionParser.new do |opts|
     options[:path] = path
   end
 
+  opts.on("-c", "--config CONFIG", "Config file (Default: config/snapimage_config.yml") do |config|
+    options[:config] = config
+  end
+
   opts.on("-h", "--help", "Display the help screen") do
     puts opts
     exit
@@ -24,12 +28,6 @@ optparse = OptionParser.new do |opts|
 end
 optparse.parse!
 
-unless ARGV.length == 1
-  puts optparse.help
-  exit
-end
-options[:config] = ARGV[0]
-
 require "sinatra"
 require "snapimage"
 

data/lib/snapimage/middleware.rb

@@ -3,16 +3,15 @@ module SnapImage
   class Middleware
     # Arguments:
     # * app:: Rack application
+    # * options:: Options for the middleware
+    #
+    # Options:
     # * path:: The URL path to access the SnapImage API (defaults to "/snapimage_api")
-    # * config:: Filename of the YAML or JSON config file or a config Hash
+    # * config:: Filename of the YAML or JSON config file or a config Hash # (defaults to "config/snapimage_config.yml")
     def initialize(app, options = {})
       @app = app
       @path = options[:path] || "/snapimage_api"
-      # TODO: If no config is given, set defaults.
-      # For example, if it's a Rails app, set the filename to
-      # config/snapimage.yml.
-      raise SnapImage::MissingConfig, "Missing config." if options[:config].nil?
-      @config = SnapImage::Config.new(options[:config])
+      @config = SnapImage::Config.new(options[:config] || "config/snapimage_config.yml")
     end
 
     def call(env)

data/lib/snapimage/version.rb

@@ -1,3 +1,3 @@
 module SnapImage
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/acceptance/upload_spec.rb

@@ -23,7 +23,7 @@ describe "Upload" do
       SnapImage::Middleware.new(
         app,
         path: "/snapimage_api",
-        config: { "directory" => File.join(RSpec.root, "storage") }
+        config: { "directory" => File.join(RSpec.root, "storage"), "max_file_size" => 600 }
       )
     end
 
@@ -41,34 +41,28 @@ describe "Upload" do
       end
 
       it "stores the image" do
-        json = JSON.parse(last_response.body)
         path = File.join(@local_root, @directory, File.basename(@image_path))
         File.exist?(path).should be_true
       end
     end
 
-    #context "upload too large" do
-      #before do
-        #json = { action: "generate_image", resource_identifier: @resource_id }.to_json
-        #post "/snapimage_api", "file" => Rack::Test::UploadedFile.new(@large_image_path, "image/png"), "json" => json
-      #end
+    context "upload too large" do
+      before do
+        post "/snapimage_api", "file" => Rack::Test::UploadedFile.new(@large_image_path, "image/png"), "directory" => @directory
+      end
 
-      #it "resizes successfully" do
-        #last_response.should be_successful
-        #last_response["Content-Type"].should eq "text/json"
-        #json = JSON.parse(last_response.body)
-        #json["status_code"].should eq 200
-        #json["message"].should eq "Get Modified Image Successful"
-        #json["image_url"].should match Regexp.new("^//example.com/images/abc/123/[a-z0-9]{8}-1024x50.png$")
-        #json["image_width"].should eq 1024
-        #json["image_height"].should eq 50
-      #end
+      it "fails" do
+        last_response.should be_successful
+        last_response["Content-Type"].should eq "text/json"
+        json = JSON.parse(last_response.body)
+        json["status_code"].should eq 405
+        json["message"].should eq "File Too Large"
+      end
 
-      #it "stores the image" do
-        #json = JSON.parse(last_response.body)
-        #path = File.join(@local_root, @resource_id, File.basename(json["image_url"]))
-        #File.exist?(path).should be_true
-      #end
-    #end
+      it "does not store the image" do
+        path = File.join(@local_root, @directory, File.basename(@image_path))
+        File.exist?(path).should be_false
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapimage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -222,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1529708753880950657
+      hash: 2769920436023059955
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1529708753880950657
+      hash: 2769920436023059955
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23