shorty 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+doc/
+features/

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2009 Alex Coomans
+
+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.rdoc

@@ -0,0 +1,76 @@
+= Shorty
+
+shorty makes interfacing with url shortening services easy, so far the following are supported:
+- http://bit.ly
+- http://tr.im - only URL API implemented, not media ones
+- http://is.gd
+- http://tinyurl.com
+- http://cli.gs - only shorten implemented, expand not
+- http://twurl.nl
+- http://su.pr
+
+== Install
+
+  sudo gem install drcapulet-shorty
+
+== Usage
+
+Yeah just read the rdocs. But to get started, make sure the gem is installed. Require:
+
+  require 'shorty'
+
+or with Rails:
+
+  config.gem 'drcapulet-shorty', :lib => 'shorty'
+
+== Possible Additions
+
+- http://ow.ly - currently no API, says it is coming soon
+
+== Other Possible Gems
+
+- http://post.ly - Not really a shortener
+- http://ping.fm - Not really a shortener
+- http://ff.im - Not a shortener either
+- http://yfrog.com - Not a shortener, maybe expand this gem or a media gem. API docs: http://code.google.com/p/imageshackapi
+- http://twitpic.com - Same as yfrog. API docs: http://twitpic.com/api.do
+
+== Other Ideas
+
+* Possibly use OpenStruct to make data access easier
+* Possibly set a user agent using
+
+    class Foo
+      include HTTParty
+      headers 'Accept' => 'text/html'
+    end
+
+* Also possibly create a command line app
+* Any other ideas create an issue and start the title with [feature]
+
+== Contributing
+
+I invite anyone who wants to help to fork and then when you've made your changes, send me a pull request. I'd love to keep everything central.
+
+== License
+
+Copyright (c) 2009 Alex Coomans
+ 
+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/Rakefile

@@ -0,0 +1,68 @@
+
+
+# begin
+#   require 'cucumber/rake/task'
+# 
+#   Cucumber::Rake::Task.new(:features) do |t|
+#     t.fork = true
+#     t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+#   end
+# rescue LoadError
+#   desc 'Cucumber rake task not available'
+#   task :features do
+#     abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+#   end
+# end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "shorty"
+    gemspec.summary = "Gem that talks to APIs for shortening urls"
+    gemspec.description = "Makes it easy to shorten URLs"
+    gemspec.email = "alex@alexcoomans.com"
+    gemspec.homepage = "http://github.com/drcapulet/shorty"
+    gemspec.authors = ["Alex Coomans"]
+    gemspec.add_dependency('httparty', '>= 0.4.4')
+    gemspec.add_dependency('crack', '>= 0.1.4')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "shorty #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/features/bitly.feature

@@ -0,0 +1,4 @@
+Feature: Interface with the bit.ly API
+	As a user
+	I want to be able to interface with the bit.ly API
+	So that I can shorten URLs

data/features/step_definitions/api.rb

@@ -0,0 +1,18 @@
+Given /I have created a new (.*) instance/ do |n|
+  @instance = Shorty::Trim.new()
+end
+
+Given /I want to shorten (.*)/ do |n|
+  @url = @instance.shorten(n)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /the URL should look like "([^\"]*)"$/ do |text|
+  @url.should contain(text)
+end
+
+

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,163 @@
+# Given /^this project is active project folder/ do
+#   @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+# end
+# 
+# Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+#   ENV[env_var] = value
+# end
+# 
+# Given /"(.*)" folder is deleted/ do |folder|
+#   in_project_folder { FileUtils.rm_rf folder }
+# end
+# 
+# When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+#   @stdout = StringIO.new
+#   in_project_folder do
+#     if Object.const_defined?("APP_ROOT")
+#       APP_ROOT.replace(FileUtils.pwd)
+#     else 
+#       APP_ROOT = FileUtils.pwd
+#     end
+#     run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+#   end
+#   File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+#     @stdout.rewind
+#     f << @stdout.read
+#   end
+# end
+# 
+# When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+#   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+#   in_project_folder do
+#     system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+#   end
+# end
+# 
+# When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+#   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+#   in_project_folder do
+#     system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+#   end
+# end
+# 
+# When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+#   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+#   executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+#   in_project_folder do
+#     system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+#   end
+# end
+# 
+# When /^I invoke task "rake (.*)"/ do |task|
+#   @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+#   in_project_folder do
+#     system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+#   end
+# end
+# 
+# Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+#   in_project_folder do
+#     File.exists?(folder).should(is == 'is' ? be_true : be_false)
+#   end
+# end
+# 
+# Then /^file "(.*)" (is|is not) created/ do |file, is|
+#   in_project_folder do
+#     File.exists?(file).should(is == 'is' ? be_true : be_false)
+#   end
+# end
+# 
+# Then /^file with name matching "(.*)" is created/ do |pattern|
+#   in_project_folder do
+#     Dir[pattern].should_not be_empty
+#   end
+# end
+# 
+# Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+#   in_project_folder do
+#     actual_output = File.read(file)
+#     (does == 'does') ?
+#       actual_output.should(match(/#{regex}/)) :
+#       actual_output.should_not(match(/#{regex}/))
+#   end
+# end
+# 
+# Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+#   File.exists?(gem_file).should be_true
+#   File.exists?(project_file).should be_true
+#   gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+#   project_file_contents = File.read(File.join(@active_project_folder, project_file))
+#   project_file_contents.should == gem_file_contents
+# end
+# 
+# Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+#   actual_output = File.read(@stdout)
+#   does_invoke == "does" ?
+#     actual_output.should(match(/dependency\s+#{generator}/)) :
+#     actual_output.should_not(match(/dependency\s+#{generator}/))
+# end
+# 
+# Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+#   actual_output = File.read(@stdout)
+#   actual_output.should match(/#{opt1}/)
+#   actual_output.should match(/#{opt2}/)
+# end
+# 
+# Then /^I should see$/ do |text|
+#   actual_output = File.read(@stdout)
+#   actual_output.should contain(text)
+# end
+# 
+# Then /^I should not see$/ do |text|
+#   actual_output = File.read(@stdout)
+#   actual_output.should_not contain(text)
+# end
+# 
+# Then /^I should see exactly$/ do |text|
+#   actual_output = File.read(@stdout)
+#   actual_output.should == text
+# end
+# 
+# Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+#   expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+#   actual_output = File.read(@stdout)
+#   actual_output.should match(expected)
+# end
+# 
+# Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+#   expected = %r{^#{expected_test_count} examples?, 0 failures}
+#   actual_output = File.read(@stdout)
+#   actual_output.should match(expected)
+# end
+# 
+# Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+#   in_project_folder do
+#     yaml = eval yaml
+#     YAML.load(File.read(file)).should == yaml
+#   end
+# end
+# 
+# Then /^Rakefile can display tasks successfully/ do
+#   @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+#   in_project_folder do
+#     system "rake -T > #{@stdout} 2> #{@stdout}"
+#   end
+#   actual_output = File.read(@stdout)
+#   actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+# end
+# 
+# Then /^task "rake (.*)" is executed successfully/ do |task|
+#   @stdout.should_not be_nil
+#   actual_output = File.read(@stdout)
+#   actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+#   actual_output.should_not match(/Error/i)
+# end
+# 
+# Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+#   in_project_folder do
+#     gem_file = Dir["pkg/*.gem"].first
+#     gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+#     spec_value = gem_spec.send(key.to_sym)
+#     spec_value.to_s.should match(/#{regex}/)
+#   end
+# end

data/features/support/common.rb

@@ -0,0 +1,29 @@
+module CommonHelpers
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    @project_name = project_name
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + "/../../lib/shorty"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'
+
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  FileUtils.rm_rf   @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+end

data/features/support/matchers.rb

@@ -0,0 +1,11 @@
+module Matchers
+  def contain(expected)
+    simple_matcher("contain #{expected.inspect}") do |given, matcher|
+      matcher.failure_message = "expected #{given.inspect} to contain #{expected.inspect}"
+      matcher.negative_failure_message = "expected #{given.inspect} not to contain #{expected.inspect}"
+      given.index expected
+    end
+  end
+end
+
+World(Matchers)

data/features/trim.feature

@@ -0,0 +1,8 @@
+Feature: Interface with the tr.im API
+	As a user
+	I want to be able to interface with the tr.im API
+	So that I can shorten URLs
+	
+	Scenario: Shorten URL
+		Given I want to shorten "http://google.com"
+		Then the URL should look like "http://tr.im/szkO"

data/lib/shorty/bitly.rb

@@ -0,0 +1,101 @@
+module Shorty
+  # The bit.ly API class. API documentation: http://code.google.com/p/bitly-api/wiki/ApiDocumentation
+  # For testing, use:
+  #   require 'lib/shorty'
+  #   bitly = Shorty::Bitly.new('bitlyapidemo', 'R_0da49e0a9118ff35f52f629d2d71bf07')
+  class Bitly
+    attr_reader :options
+    include HTTParty
+    
+    # Standard Error Class
+    class Error < StandardError; end
+    
+    API_URL = 'api.bit.ly'
+    API_VERSION = '2.0.1'
+    base_uri API_URL
+    
+    # Options to pass:
+    #
+    # - login
+    # - apikey
+    def initialize(login, apikey)
+      @options = {
+        :login => login,
+        :apiKey => apikey,
+        :version => API_VERSION
+      }
+    end
+    
+    # shorten, pass:
+    #
+    # - longurl: the URL to be shortened
+    def shorten( longurl )
+      query = {:longUrl => longurl}
+      query.merge!(@options)
+      short = self.class.get('/shorten', :query => query)
+      short = Crack::JSON.parse(short)
+      short["errorCode"].zero? ? short["results"][longurl]["shortUrl"] : raise_error(short["errorCode"], short["errorMessage"])
+    end
+    
+    # expand- given a bit.ly url, returns long source url, takes:
+    #
+    # - shorturl: the bit.ly url, can either be the full url or missing http://bit.ly
+    def expand(shorturl)
+      shorturl = gsub_url(shorturl)
+      query = {:hash => shorturl}
+      query.merge!(@options)
+      expand = self.class.get('/expand', :query => query)
+      expand = Crack::JSON.parse(expand)
+      expand["errorCode"].zero? ? expand["results"][shorturl]["longUrl"] : raise_error(expand["errorCode"], expand["errorMessage"])
+    end
+    
+    # info - Given a bit.ly url or hash, return information about that page, such as the long source url, ...
+    def info(urlorhash, keys = [])
+      urlhash = gsub_url(urlorhash)
+      if keys != []
+        query = {:hash => urlhash, :keys => keys.join(',')}
+      else
+        query = {:hash => urlhash}
+      end
+      query.merge!(@options)
+      stats = self.class.get('/info', :query => query)
+      stats = Crack::JSON.parse(stats)
+      stats["errorCode"].zero? ? stats["results"][urlhash] : raise_error(stats["errorCode"], stats["errorMessage"])
+    end
+    
+    # stats - get stats on clicks and reffers, pass either:
+    #
+    # - shortURL: A single bitly url, eg: http://bit.ly/1RmnUT
+    # - hash: A single hash, eg: 1RmnUT
+    #
+    # Example:
+    #   bitly = Shorty::Bitly.new('login', 'apikey')
+    #   bitly.expand('1RmnUT')
+    # Or:
+    #   bitly = Shorty::Bitly.new('login', 'apikey')
+    #   bitly.expand('http://bit.ly/1RmnUT')
+    def stats(urlorhash)
+      urlhash = gsub_url(urlorhash)
+      query = {:hash => urlhash}
+      query.merge!(@options)
+      stats = self.class.get('/stats', :query => query)
+      stats = Crack::JSON.parse(stats)
+      stats["errorCode"].zero? ? stats["results"] : raise_error(stats["errorCode"], stats["errorMessage"])
+    end
+    
+    
+    protected
+    
+    def gsub_url(shorturl) 
+      shorturl.split('/').last
+      # shorturl = shorturl.gsub(/http:\/\//, '') if shorturl.include?('http://')
+      # shorturl = shorturl.gsub(/bit.ly\//, '') if shorturl.include?('bit.ly/')
+    end  
+    
+    def raise_error(code, message = '(no error message)')
+      error = message + " (error code: #{code})"
+      raise Shorty::Bitly::Error, error
+    end
+    
+  end
+end

data/lib/shorty/cligs.rb

@@ -0,0 +1,56 @@
+module Shorty
+  # The cli.gs API class. API documentation: http://blog.cli.gs/api
+  # For testing, use:
+  #   require 'lib/shorty'
+  #   cligs = Shorty::Cligs.new
+  class Cligs
+    attr_reader :options
+    include HTTParty
+    
+    # Standard Error Class
+    class Error < StandardError; end
+    
+    API_URL = 'http://cli.gs/api/v1/cligs'
+    API_VERSION = '1'
+    base_uri API_URL
+    
+    # Options to pass:
+    #
+    # - API key: f given it associates the new clig with a user account so that they can view the traffic statistics. If not given, then a Public clig is created.
+    # - AppId: a simple string, HTML allowed, that identifies your App when the API usage is listed in the user’s control panel. Keep it short and simple please.
+    #
+    #     cligs = Shorty::Cligs.new(:apikey => 'apikey', :appid => 'appid')
+    def initialize(options = {})
+      @options = {}
+      @options[:key] = options[:apikey] if options[:apikey]
+      @options[:appid] = options[:appid] if options[:appid]
+    end
+    
+    # shorten. pass:
+    #
+    # - url: the url to shorten
+    def shorten(url)
+      query = {:url => url}
+      query.merge!(@options)
+      self.class.get('/create', :query => query)
+    end
+    
+    # expand. pass either:
+    #
+    # - A valid clig ID, like Ts8p6Y
+    # - A clig URL, like http://cli.gs/Ts8p6Y
+    # 
+    # Currently not implemented due to the fact this method wont work for demo.
+    def expand(urlorhash)
+      raise StandardError, 'Method not implemented'
+    end
+    
+    protected
+    
+    def raise_error(code, message = '(no error message)')
+      error = message + " (error code: #{code})"
+      raise Shorty::Bitly::Error, error
+    end
+    
+  end
+end

data/lib/shorty/isgd.rb

@@ -0,0 +1,14 @@
+module Shorty
+  # is.gd API as defined http://is.gd/api_info.php
+  class Isgd
+    include HTTParty
+    
+    def shorten(url)
+      self.class.get('http://is.gd/api.php', :query => {:longurl => url})
+    end
+    
+    def self.shorten(url)
+      get('http://is.gd/api.php', :query => {:longurl => url})
+    end
+  end
+end