url2png-dc 0.1.3 → 0.1.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Yung Hwa Kwon
+
+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.md

@@ -0,0 +1,97 @@
+#Url2Png-dc
+
+---
+
+Url2Png-dc is a gem rewritten for the new /v6/ api version of the popular screenshot service [URL2PNG](http://url2png.com).
+
+Includes URL Helpers for:
+
+* Basic (default) image retrieval `beta.url2png.com/.../png/?...`
+* Retrieving the new JSON playload `beta.url2png.com/.../json/?...`
+* And a special method to retrieve the "Cache" URL*
+
+\* Outlook was not rendering screenshots using the standard API call for image retrieval.
+
+
+##Install
+
+    gem install url2png-dc
+
+Or add to Gemfile
+
+    gem 'url2png-dc',  :require => 'url2png_dc'
+
+You may always require later, as you see fit.
+
+
+##Configure
+
+Maybe in an initalizer file or something.
+
+    Url2PngDc.configure do |config|
+      config.url2png_apikey      = ENV['URL2PNG_APIKEY']
+      config.url2png_secret      = ENV['URL2PNG_SECRET']
+      # config.viewport_dimensions = '1280x1024'
+      # config.fullpage            = true
+      # config.force_refresh       = true
+    end
+
+*Currently this gem only supports the /v6/ API.  You can take a look at [https://github.com/robinhoudmeyers/url2png-gem](https://github.com/robinhoudmeyers/url2png-gem) if you need support for the older API versions (Also includes HTML tag creation and support for v6).*
+
+
+##Usage
+
+*__Currently all the helpers are just URL generators. HTML tag building is not included.__*
+
+You will have to `require` (maybe, depending on how you set this up) and `include Url2PngDc::UrlHelpers`. That will give you access to 3 methods.
+
+
+Generate the basic URL2PNG url
+
+    url_2png "http://twitter.com"
+
+Generate the JSON playload url
+
+    url_2json "http://twitter.com"
+
+Generate and `get` the cache url
+
+    url_2cache "http://twitter.com"
+
+`url_2cache` will make a request out to the JSON payload url and parse the `png` key in order to get the cached url. So this could take a moment, if you are doing things in real-time.
+
+The cache url (to my knowledge) is removed on a 30 day basis. 
+
+If anytime the request or the parsing of the payload fails, it defers to the `url_2png` method and returns the basic API url instead.
+
+
+*\*Standard Rails hooks, so you can just plug and play, will be added shortly. But, if you want to get a jump on things, you can view the `quick_start` branch, that does a basic include into the view helpers. __At this point, I've only tested this on Rails 3.__ But there will be a larger range of support once the Rails hooks are written.*
+
+
+##Fork it!
+
+After you've done that just run `rake` for the tests or
+
+    rake test
+
+I have an actually "live" test that will make an actual call out to URL2PNG. *You will need to add your credentials in order to get a screenshot.*
+
+    export URL2PNG_APIKEY = 'PXXXXX'
+    export URL2PNG_SECRET = 'SXXXXX'
+
+Some where Ruby can find it. 
+
+Then you can run it with 
+
+    rake test:rl
+
+
+
+## Copyright
+
+Copyright (c) 2012 Yung Hwa Kwon. See [MIT-LICENSE](blob/master/MIT-LICENSE) for details.
+    
+
+---
+
+__PS__ If my spelling and/or grammar is incorrect anywhere, I'm sorry. =)

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/url2png-dc.gemspec

@@ -5,17 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png-dc"
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Yung Hwa Kwon"]
   s.date = "2012-09-01"
   s.description = "Gem to use Url2Png"
   s.email = "yung.kwon@damncarousel.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
   s.files = [
     ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/url2png/cache.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url2png-dc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -79,11 +79,14 @@ description: Gem to use Url2Png
 email: yung.kwon@damncarousel.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- MIT-LICENSE
+- README.md
 - Rakefile
 - VERSION
 - lib/url2png/cache.rb
@@ -112,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2977091029262403901
+      hash: -2426482288326668947
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: