flickrcaptionr 1.0.0 → 1.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/flickrcaptionr.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format html
+--out spec/reports/index.html

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 1.1.0 - 1st July 2012
+
+### Bugfixes
+
+* Flickr fetcher was greedily picking up on some non-flickr URLs
+* Spaces in image names no longer result in abject failure
+* Quotes are now properly escaped in text (single and double)
+* OEmbed API fetcher wouldn't work for some response types
+
+### Features
+
+* Tests - RSpec suite to cover the basics added (fetcher, processor)

data/README.md

@@ -8,7 +8,7 @@ You will need your own API key for flickr if you want to get images from there.
 
 ## Dependencies
 
-flickrcaptionr has no non-gem dependencies other than ImageMagick's convert tool, Ruby 1.9 or greater (1.9.3 recommended) and the standard Ruby net/http library.
+flickrcaptionr has no non-gem dependencies other than ImageMagick's convert tool, Ruby 1.9.2 or greater (1.9.3 recommended) and the standard Ruby net/http library.
 
 On Ubuntu systems, ImageMagick can be installed with:
 
@@ -20,6 +20,8 @@ On Mac systems, ImageMagick can be installed with:
 
 You can check everything is working by running `convert -version`. If you see something like `Version: ImageMagick 6.6.0-4 2012-04-30 Q16 http://www.imagemagick.org`, everything is probably just fine. Greater version numbers are untested, but anything newer than 6.4.x the line *should* work fine.
 
+Gem dependencies are pulled in by installation of the gem or by inclusion with bundler. If checking out the source to develop, `bundle install` in the source directory will set you up.
+
 
 ## Installation
 
@@ -45,7 +47,7 @@ To provide a web service, spin up the webapp with:
 
     $ flickrcaptionr-web [options]
 
-Point your browser at the URL given in the output, typically `http://localhost:4567`. You'll probably want to read the help on these.
+Point your browser at the URL given in the output, typically `http://localhost:4567`. You'll probably want to read the help on these commands.
 
 Configuration for flickrcaptionr is stored in a Yaml file, by default at ~/.flickrcaptionr.yml. You can change this if you like. The CLI or web tools can create this file for you, and set options in it. For instance, to set your Flickr API key:
 
@@ -58,6 +60,54 @@ A more comprehensive example of the CLI follows:
     $ flickrcaptionr-cli --caption-font-size=48 --caption "BLUE. BLUE EVERYWHERE." \
       --resize 400x400 "http://assets.talkunafraid.co.uk/img/IMG_0311.jpg"
 
+### HTTP API
+
+There is a web-based user interface to allow end users to easily generate images, located at the root of the web server URL.
+
+You can make simple GET-based requests for resizing and the like to the web server. Here are some examples:
+
+    # No resizing
+    /get/flickr-id-or-encoded-url
+    # No resizing, add caption
+    /get/flickr-id-or-encoded-url/caption
+    # Resize to 400x300, no caption
+    /get/flickr-id-or-encoded-url/400/300
+    # Resize to 400x300, caption
+    /get/flickr-id-or-encoded-url/400/300/caption
+
+You can append the `?redirect=true` option if you'd like to be redirected to a direct image path instead of being served the image directly from that URL.
+
+### Ruby API
+
+Building applications around Flickrcaptionr is fairly straightforward. You'll need to initialize the config class, fetcher, and optionally the processor:
+
+    c = Flickrcaptionr::Config.new(config_path, {:output_path => 'optionally override', :flickr_api_key=>'optionally override'})
+    # Note the options hash to the config class is optional.
+    f = Flickrcaptionr::Fetcher.new
+    # And only if you need to resize or add text:
+    p = Flickrcaptionr::Processor.new
+
+Once you've got the framework set up, you can fetch images:
+
+    output_path = f.fetch(some_url)
+
+Resize images:
+
+    output_path = p.resize!(some_path, width, height)
+
+And overlay text:
+
+    output_path = p.add_text!(some_path, text, opts)
+
+When adding text, opts is an optional hash that lets you set `:font_size`, `:font_stroke`, and `:font_path` to override font behaviour.
+
+## Tests
+
+A test suite is included (RSpec based). You must configure the test suite with a Flickr API key in the spec/flickrcaptionr.yml file. An example file is provided in that folder.
+
+To run all tests:
+
+    rake spec
 
 ## Contributing
 
@@ -67,6 +117,13 @@ A more comprehensive example of the CLI follows:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## License
+## License and Credits
+
+Copyright (c) 2012, James Harrison. All rights reserved.
+
+See the LICENSE file. Long story short, the code is MIT, go crazy.
+
+The included Coda-Heavy font is licensed under the SIL Open Font License. See the fonts/LICENSE file for details.
+
+The Twitter Bootstrap framework is licensed under the Apache License 2.0.
 
-See the LICENSE file. Long story short, MIT, go crazy.

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/flickrcaptionr.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency("sinatra", ">= 1.3.2")
   gem.add_dependency("haml", ">= 3.1.6")
   gem.add_dependency("thin", ">= 1.3.1")
+  gem.add_development_dependency("rspec", ">= 2.10.0")
 end

data/fonts/LICENSE

@@ -0,0 +1,94 @@
+Copyright (c) 2010, Vernon Adams (vern@newtypography.co.uk),
+with Reserved Font Name Coda.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/lib/flickrcaptionr/exceptions.rb

@@ -1,2 +1,5 @@
 class Flickrcaptionr::RequestNotFetchableException < ArgumentError; end
-class Flickrcaptionr::FetcherNotConfiguredException < ArgumentError; end
+class Flickrcaptionr::FetcherNotConfiguredException < ArgumentError; end
+class Flickrcaptionr::ResizeFailedException < ArgumentError; end
+class Flickrcaptionr::TextGenerationFailedException < ArgumentError; end
+class Flickrcaptionr::CompositionFailedException < ArgumentError; end

data/lib/flickrcaptionr/fetchers/flickr.rb

@@ -5,7 +5,7 @@ require 'json'
 class Flickrcaptionr::Fetchers::Flickr < Flickrcaptionr::Fetchers::Base
   def initialize
     @@api_key = Flickrcaptionr::Config.flickr_api_key
-    @@flickr_regexes = [/(?!www\.flickr.com|secure\.flickr.com|flickr.com).+\/(\d+)\/.*/,/^(\d+)$/]
+    @@flickr_regexes = [/(?:www\.flickr.com|secure\.flickr.com|flickr.com)+\/.+\/(\d+)\/.*$/,/^(\d+)$/]
   end
   def fetch(url)
     unless @@api_key

data/lib/flickrcaptionr/fetchers/oembed.rb

@@ -9,11 +9,8 @@ class Flickrcaptionr::Fetchers::OEmbed < Flickrcaptionr::Fetchers::Base
     resp = OEmbed::Providers.get(url)
     # Now figure out what the heck in our oembed response is actually the image we're seeking
     if resp
-      for key in %w(url thumbnail_url)
-        if resp[key] and resp[key] != nil
-          return resp[key]
-        end
-      end
+      return resp.url if (resp.url rescue nil)
+      return resp.thumbnail_url if (resp.thumbnail_url rescue nil)
     end
     # If we're here, we either didn't retrieve any suitable image URL, or our provider broke
     raise Flickrcaptionr::RequestNotFetchableException, "Could not retrieve #{url}"

data/lib/flickrcaptionr/processor.rb

@@ -13,7 +13,10 @@ class Flickrcaptionr::Processor
       puts "Not resizing, #{out_filename} already exists"
     else
       puts "Resizing #{path} to #{width.to_i.to_s}x#{height.to_i.to_s} at #{out_filename}"
-      res = `convert #{path} -resize #{width.to_i.to_s}x#{height.to_i.to_s}^ -gravity center -extent #{width.to_i.to_s}x#{height.to_i.to_s} #{out_filename}`
+      res = `convert '#{path}' -resize #{width.to_i.to_s}x#{height.to_i.to_s}^ -gravity center -extent #{width.to_i.to_s}x#{height.to_i.to_s} '#{out_filename}'`
+      if !File.exists?(out_filename)
+        raise Flickrcaptionr::ResizeFailedException, "Failed to write output file, check your ImageMagick installation and output path setting"
+      end
     end
     return out_filename
   end
@@ -27,10 +30,18 @@ class Flickrcaptionr::Processor
     if File.exists?(out_filename)
       puts "Already added text to this image, not doing it again"
     else
-      puts "Adding text '#{text}' to #{path}"
-      `convert -background none -fill white -font "#{opts[:font_path] ? opts[:font_path] : (File.join(File.dirname(__FILE__), '..', '..', 'fonts', 'Coda-Heavy.ttf' ))}" -stroke black -strokewidth #{opts[:font_stroke] ? opts[:font_stroke].to_s : 2.to_s} -pointsize #{opts[:font_size] ? opts[:font_size].to_s : 36.to_s} -size #{((Dimensions.width(path)-10).to_s)}  -gravity Center caption:'#{text.gsub(/[^A-Za-z0-9 \-"\.,\?\!]/,"")}' caption-tmp.png`
-      `composite caption-tmp.png #{path} -compose atop -gravity South #{out_filename}`
-      `rm -rf caption-tmp.png`
+      escaped_text = text.gsub('"',"''").gsub(/[^A-Za-z0-9 '\-\.,\?\!]/,"")
+      puts "Adding text '#{escaped_text}' to #{path} (original text '#{text}')"
+
+      `convert -background none -fill white -font "#{opts[:font_path] ? opts[:font_path] : (File.join(File.dirname(__FILE__), '..', '..', 'fonts', 'Coda-Heavy.ttf' ))}" -stroke black -strokewidth #{opts[:font_stroke] ? opts[:font_stroke].to_s : 2.to_s} -pointsize #{opts[:font_size] ? opts[:font_size].to_s : 36.to_s} -size #{((Dimensions.width(path)-10).to_s)}  -gravity Center caption:"#{escaped_text}" /tmp/caption-tmp.png`
+      if !File.exists?('/tmp/caption-tmp.png')
+        raise Flickrcaptionr::TextGenerationFailedException, "Couldn't generate text to overlay! Check your ImageMagick installation and that /tmp is writeable."
+      end
+      `composite /tmp/caption-tmp.png '#{path}' -compose atop -gravity South '#{out_filename}'`
+      if !File.exists?(out_filename)
+        raise Flickrcaptionr::CompositionFailedException, "Failed to write output composite file, check your ImageMagick installation and output path setting"
+      end
+      `rm -rf /tmp/caption-tmp.png`
     end
     return out_filename
   end

data/lib/flickrcaptionr/version.rb

@@ -1,3 +1,3 @@
 module Flickrcaptionr
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/fetcher_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+describe Flickrcaptionr::Fetcher do
+  before(:each) do
+    @fetcher = Flickrcaptionr::Fetcher.new
+  end
+  it "fetches an image given a Flickr photo ID" do
+    path = @fetcher.fetch("6630238837")
+    File.exists?(path).should be_true
+    File.delete(path)
+  end
+
+  it "fetches an image given a Flickr photo URL" do
+    path = @fetcher.fetch("http://flickr.com/photos/james_harrison/6630238837/in/photostream")
+    File.exists?(path).should be_true
+    File.delete(path)
+  end
+
+  it "fetches an image given a direct image URL" do
+    path = @fetcher.fetch("http://assets.talkunafraid.co.uk/img/wish_you_were_partying_by_purpletinker-d3fjcgw.png.jpg")
+    File.exists?(path).should be_true
+    File.delete(path)
+  end
+
+  it "fetches an image given an OEmbed API supported address" do
+    path = @fetcher.fetch("http://www.youtube.com/watch?v=UzsxfO7dBlA")
+    File.exists?(path).should be_true
+    File.delete(path)
+  end
+end

data/spec/flickrcaptionr.yml.example.yml

@@ -0,0 +1,3 @@
+---
+:flickr_api_key: SETMETOSOEMTHING
+:output_path: /tmp

data/spec/processor_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+describe Flickrcaptionr::Processor do
+  before(:each) do
+    @fetcher = Flickrcaptionr::Fetcher.new
+    @processor = Flickrcaptionr::Processor.new
+    @path = @fetcher.fetch("6630238837")
+  end
+  after(:all) do
+    File.delete(@path)
+  end
+
+  it "can resize an image to a smaller size" do
+    path = @processor.resize!(@path, 320, 240)
+    File.exists?(path).should be_true
+    Dimensions.width(path).should eq(320)
+    Dimensions.height(path).should eq(240)
+    File.delete(path)
+  end
+  
+  it "can enlarge an image" do
+    path = @processor.resize!(@path, 3200, 2400)
+    File.exists?(path).should be_true
+    Dimensions.width(path).should eq(3200)
+    Dimensions.height(path).should eq(2400)
+    File.delete(path)
+  end
+
+  it "can overlay text on an image" do
+    path = @processor.add_text!(@path, "Hello, world!")
+    File.exists?(path).should be_true
+  end
+
+  it "can overlay text with double quotes on an image" do
+    path = @processor.add_text!(@path, "\"Hello, world!\"")
+    File.exists?(path).should be_true
+  end
+
+  it "can overlay text with single quotes on an image" do
+    path = @processor.add_text!(@path, "'Hello, world!'")
+    File.exists?(path).should be_true
+  end
+
+  it "can overlay text on an image when faced with blank input" do
+    path = @processor.add_text!(@path, "")
+    File.exists?(path).should be_true
+  end
+
+  it "can overlay text on an image when faced with nasty characters" do
+    path = @processor.add_text!(@path, '#\{32asdAS~!~5"l}')
+    File.exists?(path).should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'flickrcaptionr'
+
+RSpec.configure do |config|
+  config.before(:suite) { Flickrcaptionr::Config.new(File.expand_path('../flickrcaptionr.yml', __FILE__)) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrcaptionr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-oembed
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 description: flickrcaptionr generates images, given a Flickr or other oEmbed-supported
   source, at the resolution of your choice and optionally with image-macro-style captions
 email:
@@ -118,6 +134,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -126,6 +144,7 @@ files:
 - bin/flickrcaptionr-web
 - flickrcaptionr.gemspec
 - fonts/Coda-Heavy.ttf
+- fonts/LICENSE
 - lib/flickrcaptionr.rb
 - lib/flickrcaptionr/app.rb
 - lib/flickrcaptionr/config.rb
@@ -137,6 +156,10 @@ files:
 - lib/flickrcaptionr/processor.rb
 - lib/flickrcaptionr/version.rb
 - pub/bootstrap.min.css
+- spec/fetcher_spec.rb
+- spec/flickrcaptionr.yml.example.yml
+- spec/processor_spec.rb
+- spec/spec_helper.rb
 - views/index.haml
 homepage: http://github.com/JamesHarrison/flickrcaptionr
 licenses: []
@@ -162,4 +185,8 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: flickrcaptionr turns Flickr images into (optionally) captioned thumbnails
-test_files: []
+test_files:
+- spec/fetcher_spec.rb
+- spec/flickrcaptionr.yml.example.yml
+- spec/processor_spec.rb
+- spec/spec_helper.rb