cached_bitly 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+services:
+  - redis-server

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.0.1
+
+- Initial release.
+
+# 0.0.2
+
+- Allow you to set the returned short url's scheme to either https or http [#1](https://github.com/dewski/cached_bitly/issues/1)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cached_bitly.gemspec
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'shoulda-context', '1.0.0', :require => false
+  gem 'mocha', '0.11.4', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 dewski
+
+MIT License
+
+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,77 @@
+CachedBitly [![Build Status](https://secure.travis-ci.org/dewski/cached_bitly.png)](http://travis-ci.org/dewski/cached_bitly)
+===========
+
+An easy bit.ly toolkit with Redis as a caching layer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cached_bitly'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install cached_bitly
+```
+
+## Usage
+
+To communicate with bit.ly you'll need your login and API key which you can get from the [Advanced tab](https://bitly.com/a/settings/advanced) within your account settings.
+
+If you set the bit.ly environment variables everything will just work:
+
+```
+BITLY_LOGIN=dewski
+BITLY_API_KEY=Z_bf4b4fg16991dd72d276e7z9d94d1bc00b
+```
+
+You may also set the bit.ly client directly with your own configuration:
+
+```ruby
+CachedBitly.bitly_client = Bitly.new('username', 'password')
+```
+
+There are 2 main methods to interface with bit.ly, the first being a way to retreive already generated URLs:
+
+```ruby
+# First lookup will generate the URL from bit.ly
+CachedBitly.fetch('https://github.com') # => http://bit.ly/WuNWHc
+
+# Hits redis with no additional HTTP request
+CachedBitly.fetch('https://github.com') # => http://bit.ly/WuNWHc
+```
+
+If you'd like to just pass in a large block of HTML you can cache multiple links at once:
+
+```ruby
+content = "<a href='https://github.com'>GitHub</a> and <a href='https://github.com/dewski'>@dewski</a> join forces"
+CachedBitly.clean(content) # => "<a href='http://bit.ly/WuNWHc'>GitHub</a> and <a href='http://bit.ly/10p297A'>@dewski</a> join forces"
+```
+
+## Configuring CachedBitly
+
+If you don't want to shorten all links within your HTML you can bypass bit.ly by setting your allowed hostnames:
+
+```ruby
+CachedBitly.allowed_hostnames = ['github.com']
+content = "<a href='https://github.com'>GitHub</a> and <a href='http://garrettbjerkhoel.com'>Garrett</a> join forces"
+CachedBitly.clean(content) # => "<a href='https://github.com'>GitHub</a> and <a href='http://bit.ly/10p297A'>@dewski</a> join forces"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Default: run tests'
+task :default => :test
+
+desc 'Run CachedBitly tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/cached_bitly.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cached_bitly/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'cached_bitly'
+  gem.version       = CachedBitly::VERSION
+  gem.authors       = ['Garrett Bjerkhoel']
+  gem.email         = ['me@garrettbjerkhoel.com']
+  gem.description   = %q{An easy Bitly toolkit with Redis being the caching layer.}
+  gem.summary       = %q{An easy Bitly toolkit with Redis being the caching layer.}
+  gem.homepage      = 'https://github.com/dewski/cached_bitly'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'redis'
+  gem.add_dependency 'bitly', '~> 0.8'
+end

data/lib/cached_bitly.rb

@@ -0,0 +1,145 @@
+require 'cached_bitly/version'
+require 'redis'
+require 'bitly'
+require 'nokogiri'
+
+module CachedBitly
+  extend self
+
+  def redis
+    @redis ||= Redis.new
+  end
+
+  def redis=(redis)
+    @redis = redis
+  end
+
+  def redis_namespace
+    @redis_namespace ||= 'bitly'
+  end
+
+  def redis_namespace=(namespace)
+    @redis_namespace = namespace
+  end
+
+  def allowed_hostnames
+    @allowed_hostnames ||= []
+  end
+
+  def allowed_hostnames=(hostnames=[])
+    @allowed_hostnames = hostnames
+  end
+
+  def bitly_client
+    @bitly_client ||= begin
+      Bitly.use_api_version_3
+      Bitly.new(ENV['BITLY_LOGIN'], ENV['BITLY_API_KEY'])
+    end
+  end
+
+  def bitly_client=(client)
+    @bitly_client = client
+  end
+
+  def stats_enabled?
+    !!@stats_enabled
+  end
+
+  def stats_enabled
+    @stats_enabled ||= false
+  end
+
+  def stats_enabled=(enabled)
+    @stats_enabled = enabled
+  end
+
+  def url_scheme
+    @url_scheme ||= 'http'
+  end
+
+  def url_scheme=(scheme)
+    raise ArgumentError unless ['http', 'https'].include?(scheme)
+    @url_scheme = scheme
+  end
+
+  def clean(html)
+    clean_doc(html).css('body').inner_html
+  end
+
+  def clean_doc(doc)
+    doc = doc.is_a?(String) ? Nokogiri::HTML(doc) : doc
+    doc.css('a[href^=http]').each do |link|
+      url = link.attributes['href'].value
+      if !allowed_hostnames.empty? && url.match(Regexp.union(*allowed_hostnames))
+        next
+      end
+      link.attributes['href'].value = fetch(url)
+    end
+    doc
+  end
+
+  # Handles retreiving cached short urls and generating new
+  # ones if we don't have the short url for a particular url.
+  #
+  # Returns short url, default if save goes wrong.
+  def fetch(url, default=url)
+    short_url = shortened(url)
+    if short_url
+      hit!
+      short_url.gsub(/^http\:/, url_scheme + ':')
+    else
+      miss!
+      shorten(url) || default
+    end
+  end
+
+  # Handles generating the short url and storing it.
+  #
+  # Returns short url if stored, false if not.
+  def shorten(url)
+    url = bitly_client.shorten(url)
+    if save(url.long_url, url.short_url)
+      url.short_url
+    else
+      false
+    end
+  end
+
+  # Look to see if the url has already been shortened.
+  # If the url has been shortened, return the url.
+  #
+  # Returns short url if it has been shortened, nil if not
+  def shortened(url)
+    redis.hget("#{redis_namespace}:url", digest(url))
+  end
+
+  # Save the url along with it's associated short url
+  # for easy retrieval.
+  #
+  # Returns true if saved, false if not.
+  def save(long_url, short_url)
+    !!redis.hset("#{redis_namespace}:url", digest(long_url), short_url)
+  end
+
+  def totals
+    { :hit   => redis.get("#{redis_namespace}:url:hit").to_i,
+      :miss  => redis.get("#{redis_namespace}:url:miss").to_i,
+      :total => redis.hlen("#{redis_namespace}:url") }
+  end
+
+  private
+
+  def hit!
+    return unless stats_enabled?
+    redis.incr "#{redis_namespace}:url:hit"
+  end
+
+  def miss!
+    return unless stats_enabled?
+    redis.incr "#{redis_namespace}:url:miss"
+  end
+
+  def digest(object)
+    Digest::MD5.hexdigest object.to_s
+  end
+end

data/lib/cached_bitly/version.rb

@@ -0,0 +1,3 @@
+module CachedBitly
+  VERSION = '0.0.2'
+end

data/test/cached_bitly_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class TestCachedBitly < Test::Unit::TestCase
+  def setup
+    CachedBitly.redis.flushdb
+    CachedBitly.allowed_hostnames = []
+    CachedBitly.stats_enabled = false
+  end
+
+  def stub_remote_bitly
+    response = Class.new
+    response.stubs(:short_url).returns('http://bit.ly/233')
+    response.stubs(:long_url).returns('https://garrettbjerkhoel.com')
+    CachedBitly.bitly_client.stubs(:shorten).returns(response)
+  end
+
+  def test_clean_with_whitelisted_urls
+    stub_remote_bitly
+    CachedBitly.allowed_hostnames = ['garrettbjerkhoel.com']
+    content = "<p>Welcome <a href=\"http://garrettbjerkhoel.com\">@dewski</a>!</p>"
+    assert_equal content, CachedBitly.clean(content)
+  end
+
+  def test_clean_without_whitelisted_urls
+    stub_remote_bitly
+    content = "<p>Welcome <a href=\"http://garrettbjerkhoel.com\">@dewski</a>!</p>"
+    rendered_content = "<p>Welcome <a href=\"http://bit.ly/233\">@dewski</a>!</p>"
+    assert_equal rendered_content, CachedBitly.clean(content)
+  end
+
+  def test_remote_shorten_url
+    stub_remote_bitly
+    assert_equal \
+      'http://bit.ly/233',
+      CachedBitly.shorten('https://garrettbjerkhoel.com'),
+      'should return the shortened url'
+  end
+
+  def test_saving_long_and_short_url
+    assert CachedBitly.save('https://github.com/dewski', 'http://bit.ly/123df'), 'should save'
+    assert_equal 'http://bit.ly/123df', CachedBitly.fetch('https://github.com/dewski'), 'should have stored url'
+  end
+
+  def test_failing_url_fetch_with_fallback
+    CachedBitly.stubs(:shortened).returns(false)
+    CachedBitly.stubs(:shorten).returns(false)
+
+    assert_equal \
+      'http://garrett.com',
+      CachedBitly.fetch('https://garrettbjerkhoel.com', 'http://garrett.com'),
+      'should return the fallback url'
+  end
+
+  # Stats
+  def test_stats_enabled
+    stub_remote_bitly
+    CachedBitly.stats_enabled = true
+    CachedBitly.redis.expects(:incr).once
+    CachedBitly.fetch('https://garrettbjerkhoel.com')
+  end
+
+  def test_stats_disabled
+    stub_remote_bitly
+    CachedBitly.stats_enabled = false
+    CachedBitly.redis.expects(:incr).never
+    CachedBitly.fetch('https://garrettbjerkhoel.com')
+  end
+
+  def test_setting_url_scheme
+    stub_remote_bitly
+    CachedBitly.url_scheme = 'https'
+    assert CachedBitly.save('https://github.com/github', 'http://bit.ly/gzdf13'), 'should save'
+    assert_equal 'https://bit.ly/gzdf13', CachedBitly.fetch('https://github.com/github'), 'should return https version'
+  end
+
+  def test_setting_invalid_url_scheme
+    assert_raises(ArgumentError) {
+      CachedBitly.url_scheme = 'ftp'
+    }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha'
+require 'cached_bitly'
+
+if ENV.key?('GH_REDIS_URL')
+  uri = URI.parse(ENV['GH_REDIS_URL'])
+  redis = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password, :db => 1)
+  CachedBitly.redis = redis
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: cached_bitly
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Garrett Bjerkhoel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: redis
+  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: bitly
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: An easy Bitly toolkit with Redis being the caching layer.
+email:
+- me@garrettbjerkhoel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cached_bitly.gemspec
+- lib/cached_bitly.rb
+- lib/cached_bitly/version.rb
+- test/cached_bitly_test.rb
+- test/test_helper.rb
+homepage: https://github.com/dewski/cached_bitly
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An easy Bitly toolkit with Redis being the caching layer.
+test_files:
+- test/cached_bitly_test.rb
+- test/test_helper.rb