url2png 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 wout fierens
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,77 @@
+# url2png gem
+
+## What is it?
+A Ruby gem wrapping the url2png.com API.
+
+## Who should use it?
+Any Ruby on Rails developer who wants/needs to generate screenshots from sites using url2png.com.
+
+## Usage
+
+### Installation
+
+    gem install url2png
+
+
+### Configuration
+
+First define your public key and shared secret:
+
+    Url2png::Config.public_key = 'PXXXXXXXXXXXXX'
+    Url2png::Config.shared_secret = 'SXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+
+In Rails you probably want to do that in your application file.
+
+
+### Helpers
+
+Generate an image tag:
+
+    site_image_tag url, [options]
+
+Options are the same as the image_tag in Rails.
+
+By default the size is set to 400 x 400 px.
+To generate an image with a specific site:
+
+    site_image_tag url, :size => '300x200'
+
+To only get the image url:
+
+    site_image_url url, :size => '300x200'
+
+
+## Important
+
+This gem is written for Rails 3.
+Rails 2 might work but it's not tested.
+
+Note that this gem is still under development.
+
+
+## Contributing to url2png
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Wout Fierens. See LICENSE.txt for
+further details.
+
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "url2png"
+  gem.homepage = "http://github.com/wout/url2png"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby gem for the url2png screenshot service API}
+  gem.description = %Q{A ruby gem wrapping the url2png screenshot service API}
+  gem.email = "wout@boysabroad.com"
+  gem.authors = ["wout fierens"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  
+  gem.add_development_dependency 'rspec', '> 2.6.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "url2png #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/url2png/config.rb

@@ -0,0 +1,45 @@
+module Url2png
+  module Config
+    
+    def self.api_url
+      Thread.current[:url2png_url] ||= 'http://api.url2png.com'
+    end
+
+    def self.api_version
+      Thread.current[:url2png_version] ||= 'v3'
+    end
+
+    # public key setter and getter
+    def self.public_key= key
+      raise 'Url2png error: Invalid public key!' unless key.match(/^P/)
+
+      Thread.current[:url2png_key] ||= key
+    end
+    def self.public_key
+      raise 'Url2png error: No public key defined!' if Thread.current[:url2png_key].nil?
+
+      Thread.current[:url2png_key]
+    end
+
+    # shared secret setter and getter
+    def self.shared_secret= secret
+      raise 'Url2png error: Invalid shared secret!' unless secret.match(/^S/)
+
+      Thread.current[:url2png_secret] ||= secret
+    end
+    def self.shared_secret
+      raise 'Url2png error: No shared secret defined!' if Thread.current[:url2png_secret].nil?
+
+      Thread.current[:url2png_secret]
+    end
+
+    # size
+    def self.default_size= size
+      Thread.current[:url2png_size] ||= size
+    end
+    def self.default_size
+      Thread.current[:url2png_size] ||= '400x400'
+    end
+    
+  end
+end

data/lib/url2png/dimensions.rb

@@ -0,0 +1,15 @@
+module Url2png
+  module Dimensions
+    
+    def self.parse options
+      size = options[:size] || Url2png::Config.default_size
+
+      {
+        :size   => size,
+        :width  => options[:width]  || size.split('x')[0],
+        :height => options[:height] || size.split('x')[1]
+      }
+    end
+    
+  end
+end

data/lib/url2png/helpers/common.rb

@@ -0,0 +1,35 @@
+module Url2png
+  module Helpers
+    module Common
+      
+      def site_image_tag url, options = {}
+        dim = Url2png::Dimensions.parse(options)
+
+        # build image tag
+        img =  '<img'
+        img << " src='#{ site_image_url(url, options) }'"
+        img << " alt='#{ options[:alt] || url }'"
+        img << " width='#{ dim[:width] }'"
+        img << " height='#{ dim[:height] }'"
+        options.each_pair do |k, v|
+          img << " #{ k }='#{ v }'" unless v.nil? || v == ''
+        end
+        img << ' />'
+      end
+
+      def site_image_url url, options = {}
+        dim = Url2png::Dimensions.parse(options)
+
+        # escape the url
+        safe_url = URI.escape(url)
+
+        # generate token
+        token = Digest::MD5.hexdigest("#{ Url2png::Config.shared_secret }+#{ safe_url }")
+
+        # build image url
+        File.join(Url2png::Config.api_url, Url2png::Config.api_version, Url2png::Config.public_key, token, dim[:size], safe_url)
+      end
+      
+    end
+  end
+end

data/lib/url2png.rb

@@ -0,0 +1,9 @@
+require 'uri'
+require 'digest'
+
+require 'url2png/config'
+require 'url2png/dimensions'
+require 'url2png/helpers/common'
+
+module Url2png
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'url2png'
+
+class Test::Unit::TestCase
+end

data/test/test_url2png.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestUrl2png < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: url2png
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- wout fierens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A ruby gem wrapping the url2png screenshot service API
+email: wout@boysabroad.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/url2png.rb
+- lib/url2png/config.rb
+- lib/url2png/dimensions.rb
+- lib/url2png/helpers/common.rb
+- test/helper.rb
+- test/test_url2png.rb
+has_rdoc: true
+homepage: http://github.com/wout/url2png
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4190063888804664978
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A ruby gem for the url2png screenshot service API
+test_files: 
+- test/helper.rb
+- test/test_url2png.rb