url2png-dc 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290 --create

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'httparty'
+
+group :development do
+  gem 'minitest'
+  gem 'turn'
+
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    minitest (3.3.0)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    turn (0.9.6)
+      ansi
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  jeweler
+  minitest
+  turn

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+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-dc"
+  gem.homepage = "http://github.com/nowk/url2png-dc"
+  gem.license = "MIT"
+  gem.summary = %Q{Url2Png Gem .v6}
+  gem.description = %Q{Gem to use Url2Png}
+  gem.email = "yung.kwon@damncarousel.com"
+  gem.authors = ["Yung Hwa Kwon"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = !!ENV["VERBOSE"]
+  test.warning = !!ENV["WARNING"]
+end
+Rake::TestTask.new('test:rl') do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/really/*_test.rb'
+  t.verbose = !!ENV["VERBOSE"]
+  t.warning = !!ENV["WARNING"]
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/url2png/cache.rb

@@ -0,0 +1,22 @@
+module Url2PngDc
+  # TODO Rename this, "Cache" sounds a bit misleading in this context
+  #
+  class Cache
+    def initialize(json_payload)
+      @payload = json_payload
+    end
+
+    def url
+      parse_out_cache_url_from_payload
+    end
+
+
+  private
+
+    def parse_out_cache_url_from_payload
+      _json = JSON.parse(@payload)
+      _png = _json['png']
+      _png if _png && !_png.empty?
+    end
+  end
+end

data/lib/url2png/configuration.rb

@@ -0,0 +1,28 @@
+module Url2PngDc
+  class Configuration
+    URL2PNG_API_URL     = 'http://beta.url2png.com'
+    URL2PNG_API_VERSION = 'v6'
+
+    attr_accessor :url2png_apikey
+    attr_accessor :url2png_secret
+    attr_accessor :viewport_dimensions
+    attr_accessor :fullpage
+    attr_accessor :force_refresh
+
+    def initialize
+      @url2png_apikey      = 'PXXXX'
+      @url2png_secret      = 'SXXXX'
+      @viewport_dimensions = '1280x1024'
+      @fullpage            = false
+      @force_refresh       = false
+    end
+
+    def url2png_api_url
+      URL2PNG_API_URL
+    end
+
+    def url2png_api_version
+      URL2PNG_API_VERSION
+    end
+  end
+end

data/lib/url2png/url_helper.rb

@@ -0,0 +1,79 @@
+module Url2PngDc
+  module UrlHelpers
+    def self.included(base)
+      base.instance_eval do
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def url_2png(url, options = {})
+        url_builder(query_string_builder(url, options))
+      end
+
+      def url_2json(url, options = {})
+        url_builder(query_string_builder(url, options), :json)
+      end
+
+      def url_2cache(url, options = {})
+        response = ::HTTParty.get(url_2json(url, options))
+        _cache = Cache.new response.body
+        _cache.url || url_2png(url, options)
+      end
+
+
+    private
+
+      def url2png_conf
+        Url2PngDc.configuration
+      end
+
+      def url_builder(query_string, url2png_api_format = :png)
+        File.join(
+          url2png_conf.url2png_api_url,
+          url2png_conf.url2png_api_version,
+          url2png_conf.url2png_apikey,
+          generate_url2png_token(query_string),
+          url2png_api_format.to_s,
+          "?#{query_string}"
+        )
+      end
+
+      def query_string_builder(url, options = {})
+        params = {
+          :url                  => url,
+
+          :force                => 
+            int_my_bool(options[:force] || url2png_conf.force_refresh),
+          :fullpage             => 
+            int_my_bool(options[:fullpage] || url2png_conf.fullpage),
+
+          :thumbnail_max_width  => options[:thumbnail_max_width],
+          :thumbnail_max_height => options[:thumbnail_max_height],
+
+          :viewport             => 
+            options[:viewport] || url2png_conf.viewport_dimensions
+        }
+
+        params.sort_by { |o| o[0] }.inject([]) { |memo, obj|
+          k, v = *obj.map(&:to_s)
+          memo << [CGI.escape(k), CGI.escape(v)].join("=") if v && !v.empty?
+          memo
+        }.join("&")
+      end
+
+      def generate_url2png_token(query_string)
+        raise ArgumentError, "Query string can't be blank" unless 
+          query_string && !query_string.empty?
+
+        Digest::MD5.hexdigest(query_string+url2png_conf.url2png_secret)
+      end
+
+
+      def int_my_bool(val)
+        return val if val.is_a?(Fixnum)
+        val === true ? 1 : 0
+      end
+    end
+  end
+end

data/lib/url2png_dc.rb

@@ -0,0 +1,24 @@
+require 'digest'
+require 'cgi'
+require 'json'
+require 'httparty'
+
+require 'url2png/configuration'
+require 'url2png/url_helper'
+require 'url2png/cache'
+
+module Url2PngDc
+  include HTTParty
+
+  class << self
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+      configuration
+    end
+  end
+end
+

data/test/cache_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+module Url2PngDc
+  class TestCache < MiniTest::Unit::TestCase
+    # This provides a solution to insert images properly for display on
+    # Microsoft Outlook email clients
+    #
+    def test_url_to_return_cached_url
+      cache = Cache.new json_payload
+      assert_match(/cache(-[\d]+)\.url2png\.com/, cache.url)
+    end
+
+    def test_url_returns_nil_if_png_key_is_empty_or_missing
+      json = JSON.parse(json_payload)
+      json['png'] = ''
+      cache = Cache.new json.to_json
+      assert_nil cache.url
+
+      json.delete('png')
+      cache = Cache.new json.to_json
+      assert_nil cache.url
+    end
+
+    def test_test_url_returns_nil_if_request_to_url2png_is_not_successful
+      flunk "We need to test this"
+    end
+  end
+end
+

data/test/configuration_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Url2PngDc
+  class TestConfiguration < MiniTest::Unit::TestCase
+    def test_configuration_defaults
+      configuration = Configuration.new
+
+      assert_equal 'PXXXX',                   configuration.url2png_apikey
+      assert_equal 'SXXXX',                   configuration.url2png_secret
+      assert_equal 'http://beta.url2png.com', configuration.url2png_api_url
+      assert_equal 'v6',                      configuration.url2png_api_version
+
+      assert_equal '1280x1024',               configuration.viewport_dimensions
+      assert_equal false,                     configuration.fullpage
+      assert_equal false,                     configuration.force_refresh
+    end
+  end
+end
+

data/test/really/make_call_to_url2png_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class TestReallyMakeCallToUrl2Png < MiniTest::Unit::TestCase
+  def teardown
+    Url2PngDc.instance_eval do
+      @_configuration = nil
+    end
+  end
+
+  def test_retrieving_an_actual_cache_url
+    Url2PngDc.configure do |config|
+      config.url2png_apikey = ENV['URL2PNG_APIKEY']
+      config.url2png_secret = ENV['URL2PNG_SECRET']
+    end
+
+    url = Sandbox.new.url_2cache "http://google.com"
+    assert_match /cache(-[\d]+)\.url2png\.com/, url
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+gem 'minitest'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'url2png_dc'
+
+require 'turn'
+require 'minitest/autorun'
+
+def json_payload
+  # TODO pay attention to disclaimer
+  # TODO sample data comes from: http://beta.url2png.com/v6/P4DE5D1C99D8EF/c9d1c2e545d1280fb6c249aed4031c4b/json/?url=twitter.github.com%2Fbootstrap&viewport=1024x1024&thumbnail_max_width=275
+  <<-json
+{"_disclaimer_":"This is a draft format is subject to change. Changes will be announced on twitter @url2png -- dan@url2png.com if you have suggestions or comments. Thanks!","status":"ok","job_id":"5ca8fac5a6c33f62bfb0f5d36a388e6219180414","request":{"submitted":"2012-08-31 21:18:52","viewport":"1024x1024","url":"http:\/\/twitter.github.com\/bootstrap","fullpage":false,"thumbnail_max_height":0,"thumbnail_max_width":275},"png":"http:\/\/cache-01.url2png.com\/P4DE5D1C99D8EF\/12244\/5ca8fac5a6c33f62bfb0f5d36a388e6219180414_1.png","meta":{"title":null,"dimensions_original":"1024x1976","dimensions_final":"1024x1976"},"headers":{"X-submitted":"1346447932","X-Original-Status":"HTTP\/1.1 301 Moved Permanently","Etag":"5ca8fac5a6c33f62bfb0f5d36a388e6219180414","X-Status":"OK"},"debug":["Curl Status is 0"]}
+  json
+end
+
+
+class Sandbox
+  include Url2PngDc::UrlHelpers
+end
+

data/test/url2png_dc_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class TestUrl2PngDc < MiniTest::Unit::TestCase
+  def teardown
+    Url2PngDc.instance_eval do
+      @_configuration = nil
+    end
+  end
+
+  def test_overriding_configuration_defaults
+    # must reset configuration on teardown, or it will act as configuration
+    # for test suite
+    #
+    Url2PngDc.configure do |config|
+      config.url2png_apikey      = 'abcdefg'
+      config.url2png_secret      = 'hijklmn'
+      config.viewport_dimensions = '1080x720'
+      config.fullpage            = true
+      config.force_refresh       = true
+    end
+
+    configuration = Url2PngDc.configuration
+
+    assert_equal 'abcdefg',  configuration.url2png_apikey
+    assert_equal 'hijklmn',  configuration.url2png_secret
+    assert_equal '1080x720', configuration.viewport_dimensions
+    assert_equal true,       configuration.fullpage
+    assert_equal true,       configuration.force_refresh
+  end
+
+  def test_cant_override_api_url
+    assert_raises NoMethodError do
+      Url2PngDc.configure do |config|
+        config.url2png_api_url = 'http://google.com'
+      end
+    end
+  end
+
+  def test_cant_override_api_version
+    assert_raises NoMethodError do
+      Url2PngDc.configure do |config|
+        config.url2png_api_version = 'v3'
+      end
+    end
+  end
+end

data/test/url_helper_test.rb

@@ -0,0 +1,141 @@
+require 'test_helper'
+
+module Url2PngDc
+  class TestUrlHelper < MiniTest::Unit::TestCase
+    def url2png_apikey
+      Url2PngDc.configuration.url2png_apikey
+    end
+
+    def a_url
+      "http://google.com/maps/"
+    end
+
+    def query_string_with_defaults
+      "force=0&fullpage=0&url=#{CGI.escape(a_url)}&viewport=1280x1024"
+    end
+
+    def token(query_string)
+      Digest::MD5.hexdigest(query_string+Url2PngDc.configuration.url2png_secret)
+    end
+
+    def mock_my_httparty!
+      # mocky
+      HTTParty.instance_eval do
+        def get(url)
+          obj = Object.new
+          def obj.body
+              json_payload
+          end
+          obj
+        end
+      end
+    end
+
+
+    def test_url_2png_generates_valid_url2png_url_for_png
+      token = token(query_string_with_defaults)
+      url   = Sandbox.new.url_2png a_url
+
+      assert_equal "http://beta.url2png.com/v6/#{url2png_apikey}/#{token}/png/?#{query_string_with_defaults}", url
+    end
+
+    def test_url_2png_generates_valid_url2png_url_for_png_with_options
+      query_string_with_options = 
+        "force=0&fullpage=1&url=#{CGI.escape(a_url)}&viewport=720x480"
+      token = token(query_string_with_options)
+      url   = Sandbox.new.url_2png a_url, {:fullpage => true, :viewport => '720x480'}
+
+      assert_equal "http://beta.url2png.com/v6/#{url2png_apikey}/#{token}/png/?#{query_string_with_options}", url
+    end
+
+
+    def test_url_2json_generates_valid_url2png_url_for_json
+      token = token(query_string_with_defaults)
+      url   = Sandbox.new.url_2json a_url
+
+      assert_equal "http://beta.url2png.com/v6/#{url2png_apikey}/#{token}/json/?#{query_string_with_defaults}", url
+    end
+
+    def test_url_2json_generates_valid_url2png_url_for_json_with_options
+      query_string_with_options = 
+        "force=0&fullpage=1&url=#{CGI.escape(a_url)}&viewport=1080x720"
+      token = token(query_string_with_options)
+      url   = Sandbox.new.url_2json a_url, {:fullpage => true, :viewport => '1080x720'}
+
+      assert_equal "http://beta.url2png.com/v6/#{url2png_apikey}/#{token}/json/?#{query_string_with_options}", url
+    end
+
+
+    def test_url_2cache_returns_a_url2png_cache_url
+      mock_my_httparty!
+
+      token = token(query_string_with_defaults)
+      url   = Sandbox.new.url_2cache a_url
+      assert_match(/cache(-[\d]+)\.url2png\.com/, url)
+    end
+
+    def test_url_2cache_resolves_to_url_2png_if_cache_url_is_empty_or_nil
+      mock_my_httparty!
+
+      # mocky
+      Url2PngDc::Cache.class_eval do
+        alias_method :url_original, :url
+        def url
+          nil
+        end
+      end
+
+      resolved_url = Sandbox.new.url_2png a_url
+      url          = Sandbox.new.url_2cache a_url
+
+      assert_match resolved_url, url
+
+      # put things back as they were
+      Url2PngDc::Cache.class_eval do
+        alias_method :url, :url_original
+      end
+    end
+
+
+    def test_query_string_builder_builds_query_string_with_configuration
+      query_string = Sandbox.new.__send__ :query_string_builder, a_url
+      assert_equal query_string_with_defaults, query_string
+    end
+
+    def test_query_string_builder_builds_query_string_override_params
+      expected_query_string = 
+        "force=1&fullpage=1&thumbnail_max_height=300&thumbnail_max_width=400&url=#{CGI.escape(a_url)}&viewport=1080x720"
+
+      query_string = Sandbox.new.__send__ :query_string_builder, a_url, {
+        :force                => true,
+        :fullpage             => true,
+        :thumbnail_max_height => '300',
+        :thumbnail_max_width  => '400',
+        :viewport             => '1080x720'
+        }
+      assert_equal expected_query_string, query_string
+    end
+
+    def test_query_string_builder_ignores_non_related_options
+      query_string = Sandbox.new.__send__ :query_string_builder, a_url, {
+        :not_used_or_need_by_url2png => true
+        }
+      assert_equal query_string_with_defaults, query_string
+    end
+
+    def test_generate_url2png_token_generates_md5_token
+      expected_token = token(query_string_with_defaults)
+      query_string   = Sandbox.new.__send__ :query_string_builder, a_url
+      token          = Sandbox.new.__send__ :generate_url2png_token, query_string
+
+      assert_equal expected_token, token
+    end
+
+    def test_generate_url2png_token_must_have_query_string
+      assert_raises ArgumentError do
+        Sandbox.new.__send__ :generate_url2png_token, ''
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: url2png-dc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Yung Hwa Kwon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to use Url2Png
+email: yung.kwon@damncarousel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- lib/url2png/cache.rb
+- lib/url2png/configuration.rb
+- lib/url2png/url_helper.rb
+- lib/url2png_dc.rb
+- test/cache_test.rb
+- test/configuration_test.rb
+- test/really/make_call_to_url2png_test.rb
+- test/test_helper.rb
+- test/url2png_dc_test.rb
+- test/url_helper_test.rb
+homepage: http://github.com/nowk/url2png-dc
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -110950005258160162
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Url2Png Gem .v6
+test_files: []