peepshot 0.0.2 → 0.0.3

data/Gemfile

@@ -6,4 +6,5 @@ group :development do
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
   gem "rdoc"
+  gem "json"
 end

data/README.md

@@ -3,20 +3,71 @@ PeepShot
 
 Provides rails helpers for interfacing with [PeepShot](http://peepshot.com).
 
-Example
--------
+Examples
+--------
 
-0- Prerequisite: You need a peepshot.com account. Have your API Key and API Secret handy.
+PeepShot can be integrated into your Rails application in two ways:
 
-1- Install peepshot as a gem in your rails app.
+### Use the PeepShot image tag helper: peepshot_image_tag(url, options)
 
-2- Create `config/peepshot.yml` with the appropriate environment.
+The minimum requirements for the peepshot_image_tag is an url and a width. When no height is given, PeepShot will return an un-cropped screenshot of the full page. The following example will return an 320px wide image with a height above 1000px.
+
+    <%= peepshot_image_tag("http://ui-patterns.com", :width => 450) %>
+
+Will return something like this:
+
+    <img alt="Ui-patterns" src="http://api.peepshot.com/v1/0d03a6bc89/d06c16f085ceba605b5294126517d03a/450?url=http://ui-patterns.com" width="450" />
+
+The maximum width of a screenshot is 1024 pixels.
+
+Adding a height to the options hash will make PeepShot crop the screenshot with basis in the top left corner.
+
+    <%= peepshot_image_tag("http://ui-patterns.com", :width => 450, :height => 337) %>
+
+Will return something like this:
+
+    <img alt="Ui-patterns" height="337" src="http://api.peepshot.com/v1/0d03a6bc89/d06c16f085ceba605b5294126517d03a/450x337?url=http://ui-patterns.com" width="450" />
+
+You can add any HTML options you'd like as you would with a regular image_tag in rails:
+
+    <%= peepshot_image_tag("http://ui-patterns.com", :width => 450, :height => 337, :class => 'thumbnail', :alt => "Go to UI-Patterns.com") %>
+
+### Use the PeepShot url helper: peepshot_url(url, options)
+
+If you'd like to use peepshot in your own homebrewn way, you can skip the image tag, and just get the URL for the thumbnail:
+
+    peepshot_url("http://ui-patterns.com", :width => 320)
+
+### Use a webservice (json or XML) to check if screenshot is ready
+
+If you're not interested in showing a "queued" message to your users, you can use the following method to check if the screenshot has been grabbed and is ready to be shown. It calls a webservice, so calling this method a hundred times on one page can be slow.
+
+    peepshot_image_ready?(url)
+
+For instance:
+
+    peepshot_image_ready?("http://ui-patterns.com")
+
+Installation
+------------
+
+Prerequisite: You need a peepshot.com account. Have your API Key and API Secret handy.
+
+### 1. Install peepshot as a gem in your rails app.
+
+Add this to your Gemfile: (change version numbers if needed)
+
+    gem 'peepshot', '0.2.0'
+
+Don’t forget to run “bundle install” command every time you change something in the Gemfile.
+
+### 2. Create `config/peepshot.yml` with the appropriate environment.
 
     production:
       api_key: <your API key>
       api_secret: <your API secret>
 
-3- Create `config/initializers/peepshot.rb` and place the following line in it
+### 3. Create `config/initializers/peepshot.rb` and place the following line in it
 
     PeepShot.load_peepshot_yaml
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/peepshot/rails/helpers.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'open-uri'
 require 'cgi'
 require 'digest'
 
@@ -8,6 +9,17 @@ module PeepShot
       class InvalidDimensions < Exception; end
       include ImageTags
       
+      def peepshot_image_ready?(url)
+        host       = 'api.peepshot.com'
+        token      = Digest::MD5.hexdigest(PeepShot.api_secret + url)
+
+        url = URI.escape("http://#{host}/v1/#{PeepShot.api_key}/#{token}/ready?url=#{url}")
+
+        data = JSON.parse(open(url).read)
+
+        data['status'] == 'OK' ? true : false
+      end
+      
       def peepshot_url(url, options)
         options = {:width => 200, 
                    :height => nil

data/lib/peepshot/rails/helpers/image_tags.rb

@@ -5,7 +5,7 @@ module PeepShot
         def peepshot_image_tag(url, options)
           width = find_width(options).to_s.downcase == 'original' ? 1024 : find_width(options)
           height = find_height(options)
-          image_tag(peepshot_url(url, options), :width => width, :height => height)
+          image_tag(peepshot_url(url, options), {:width => width, :height => height}.merge(options.except(:width, :height)))
         end
       end
     end

data/peepshot.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "peepshot"
-  s.version = "0.0.2"
+  s.name = %q{peepshot}
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Anders Toxboe"]
-  s.date = "2012-02-14"
-  s.description = "Use this gem in your rails applications to capture thumbnail screenshots through the PeepShot API"
-  s.email = "info@ui-patterns.com"
+  s.date = %q{2013-11-26}
+  s.description = %q{Use this gem in your rails applications to capture thumbnail screenshots through the PeepShot API}
+  s.email = %q{info@ui-patterns.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -31,17 +31,18 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_peepshot.rb"
   ]
-  s.homepage = "https://github.com/PeepShot/peepshot"
+  s.homepage = %q{https://github.com/PeepShot/peepshot}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
-  s.summary = "PeepShot URL and view helpers"
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{PeepShot URL and view helpers}
   s.test_files = [
     "test/helper.rb",
     "test/test_peepshot.rb"
   ]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
@@ -50,12 +51,14 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.6.0"])
@@ -63,6 +66,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: peepshot
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  hash: 25
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Anders Toxboe
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-14 00:00:00 Z
+date: 2013-11-26 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -29,10 +30,10 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
+  requirement: *id001
+  type: :development
   name: rspec
   prerelease: false
-  type: :development
-  requirement: *id001
 - !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -45,10 +46,10 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  requirement: *id002
+  type: :development
   name: bundler
   prerelease: false
-  type: :development
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,10 +62,10 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
+  requirement: *id003
+  type: :development
   name: jeweler
   prerelease: false
-  type: :development
-  requirement: *id003
 - !ruby/object:Gem::Dependency 
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -75,10 +76,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id004
+  type: :development
   name: rcov
   prerelease: false
-  type: :development
-  requirement: *id004
 - !ruby/object:Gem::Dependency 
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -89,10 +90,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id005
+  type: :development
   name: rdoc
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
   type: :development
-  requirement: *id005
+  name: json
+  prerelease: false
 description: Use this gem in your rails applications to capture thumbnail screenshots through the PeepShot API
 email: info@ui-patterns.com
 executables: []
@@ -116,6 +131,7 @@ files:
 - peepshot.gemspec
 - test/helper.rb
 - test/test_peepshot.rb
+has_rdoc: true
 homepage: https://github.com/PeepShot/peepshot
 licenses: 
 - MIT
@@ -145,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: PeepShot URL and view helpers