mush 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Rafael Magana
+
+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,67 @@
+= MUSh
+
+A multiple service URL shortener gem with command-line utilities
+
+NOTE: This gem only supports url shortening, nothing else, no stats, no info, no expand and it won't support any of them.
+
+== Supported services
+
+* bit.ly
+* is.gd
+* u.nu
+
+== Usage as a command line utility
+
+    $ bitly -l login -l apikey -u http://foo.raflabs.com
+
+    $ isgd http://foo.raflabs.com
+
+    $ unu foo.raflabs.com
+
+Sorry, but at this moment, if you want to use the bitly command line without -l and -k do this:
+
+Add the following alias to your ~/.bash_profile or ~/.bashrc
+
+    alias bitly='bitly -l your_login -k your_apikey'
+
+then use it this way (you won't need the -u)
+
+    $ bitly http://google.com
+		
+== Usage as a Gem
+
+    require 'mush'
+
+    bitly = Mush::Services::Bitly.new
+
+    bitly.login = "login"
+    bitly.apikey = "apikey"
+
+    bitly.shorten "http://foo.raflabs.com"
+
+    isgd = Mush::Services::IsGd.new
+    isgd.shorten "http://foo.raflabs.com"
+	
+    unu = Mush::Services:Unu.new
+    unu.shorten "http://foo.raflabs.com"
+
+== ToDo
+
+* Use bitly commmand without -l and -k, save config in home folder (.mush file)
+* Make shorten method to accept multiple URLs
+* add j.mp and maybe other services
+* Cache
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature/service addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rafael Magana. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mush"
+    gem.summary = %Q{A multiple service URL shortener gem with command-line utility}
+    gem.description = %Q{A gem to shorten URLs using different services, it has one command-line utility for each supported service.}
+    gem.email = "raf.magana@gmail.com"
+    gem.homepage = "http://github.com/rafmagana/mush"
+    gem.authors = ["Rafael Magaña"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mush #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/bitly

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'optparse'
+require 'mush'
+
+ORIGINAL_ARGV = ARGV.dup
+
+#the defaults
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+    bitly -l login -k apikey -u url
+        
+  Options:
+EOF
+
+  opts.on("-lLOGIN", "--login LOGIN", "The login to access the bit.ly API") do |login|
+    options[:login] = login
+  end
+  
+  opts.on("-kAPIKEY", "--apikey APIKEY", "API Key") do |apikey|
+    options[:apikey] = apikey
+  end
+
+  opts.on("-uURL", "--url URL", "The long URL to be shortened") do |url|
+    options[:url] = url
+  end
+  
+  opts.on("-v", "--version", "Print the version number and exit") do
+    options[:version] = true
+  end  
+end
+
+opts.parse!
+
+if options[:version]
+  abort("Version " + Mush.version)
+end
+
+options[:url] = ARGV.first if ARGV.length == 1
+
+#validate
+unless options[:login]
+  abort("You must specify a login to access the Bit.ly API")
+end
+
+unless options[:apikey]
+  abort("You must specify an API Key to access the Bit.ly API")
+end
+
+unless options[:url]
+  abort("Please provide a valid URL, including http://")
+end
+
+bitly = Mush::Services::Bitly.new
+
+bitly.login = options[:login]
+bitly.apikey = options[:apikey]
+
+puts bitly.shorten options[:url]

data/bin/isgd

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'optparse'
+require 'mush'
+
+ORIGINAL_ARGV = ARGV.dup
+
+#the defaults
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+    isgd url
+EOF
+
+  opts.on("-v", "--version", "Print the version number and exit") do
+    options[:version] = true
+  end  
+end
+
+opts.parse!
+
+if options[:version]
+  abort("Version " + Mush.version)
+end
+
+options[:url] = ARGV.first if ARGV.length == 1
+
+# validate
+unless options[:url]
+  abort("You must specify a URL to use the is.gd service")
+end
+
+puts Mush::Services::IsGd.new.shorten options[:url]

data/bin/mush

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+puts "the actual commands are:"
+puts "bitly, isgd and unu"

data/bin/unu

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'optparse'
+require 'mush'
+
+ORIGINAL_ARGV = ARGV.dup
+
+#the defaults
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+    unu url
+EOF
+
+  opts.on("-v", "--version", "Print the version number and exit") do
+    options[:version] = true
+  end
+end
+
+opts.parse!
+
+if options[:version]
+  abort("Version " + Mush.version)
+end
+
+options[:url] = ARGV.first if ARGV.length == 1
+
+# validate
+unless options[:url]
+  abort("You must specify a URL to use the u.nu service")
+end
+
+puts Mush::Services::Unu.new.shorten options[:url]

data/lib/mush.rb

@@ -0,0 +1,12 @@
+require 'httparty'
+require 'mush/errors'
+require 'mush/service'
+require 'mush/authenticated_service'
+
+Dir[File.dirname(__FILE__)+"/mush/services/*"].each { |service| require service }
+
+module Mush
+  def self.version
+    File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
+  end
+end

data/lib/mush/authenticated_service.rb

@@ -0,0 +1,33 @@
+module Mush
+  
+  class AuthenticatedService < Service
+    
+    attr_accessor :login, :apikey
+    
+    def initialize
+      @login = ''
+      @apikey = ''
+    end
+    
+    def authorize(args = {})
+      raise InvalidAuthorizationData.new("Invalid Authorization Data, please provide both login and apikey") unless valid_authorization_data? args
+      @login = options[:login]
+      @apikey = options[:apikey]
+    end
+    
+    protected
+    def valid_authorization_data?(data)
+      [:login, :apikey].all? { |key| data.key? key }
+    end
+    
+    def self.authorizable_with(*options)
+      raise InvalidAuthorizationFields.new("Should provide fields to authorize with") if options.empty?
+      @params_to_authorize = options
+      class_eval do
+        options.each { |o| attr_accessor o.to_sym }
+      end
+    end
+    
+  end
+  
+end

data/lib/mush/errors.rb

@@ -0,0 +1,6 @@
+module Mush
+  class InterfaceMethodNotImplementedError < StandardError; end
+  class InvalidURI < ArgumentError; end
+  class InvalidAuthorizationData < ArgumentError; end
+  class InvalidAuthorizationFields < ArgumentError; end
+end

data/lib/mush/service.rb

@@ -0,0 +1,37 @@
+module Mush
+  
+  # This is the class all the services must inherit from.
+  class Service
+    include HTTParty
+
+    #wrapper for HTTParty.get
+    def get(path, options = {})
+      self.class.get(path, options)
+    end
+    
+    def shorten(*)
+      raise InterfaceMethodNotImplementedError.new("Service#shorten must be overridden in subclasses")
+    end
+    
+    def authorize(args = {})
+      raise InvalidAuthorizationData.new("Invalid Authorization Data, please provide both login and apikey") unless valid_authorization_data? args
+      @login = options[:login]
+      @apikey = options[:apikey]
+    end
+    
+    protected
+    def valid_authorization_data?(data)
+      [:login, :apikey].all? { |key| data.key? key }
+    end
+    
+    def self.authorizable_with(*options)
+      raise InvalidAuthorizationFields.new("Should provide fields to authorize with") if options.empty?
+      @params_to_authorize = options
+      class_eval do
+        options.each { |o| attr_accessor o.to_sym }
+      end
+    end
+    
+  end
+  
+end

data/lib/mush/services/bitly.rb

@@ -0,0 +1,34 @@
+module Mush
+  
+  module Services
+    
+    ## bit.ly and j.mp
+    # login=bitlyapidemo
+    # apiKey=R_0da49e0a9118ff35f52f629d2d71bf07
+    # longUrl=http%3A%2F%2Fbetaworks.com%2F
+    # format=json
+    # domain=j.mp
+    class Bitly < AuthenticatedService
+      
+      base_uri 'http://api.bit.ly/v3'
+      
+      def shorten(url)
+        invalid_uri_msg = "Please provide a valid URI, including http://"
+        invalid_auth_msg = "Invalid Authorization Data, please provide both login and apikey"
+        
+        raise InvalidURI.new invalid_uri_msg if url.empty?
+        raise InvalidAuthorizationData.new(invalid_auth_msg) if login.empty? or apikey.empty?
+        
+        options = {}
+        options[:query] = {:login => self.login, :apiKey => self.apikey, :longUrl => url}
+        
+        response = get('/shorten', options)
+        
+        response["status_code"] == 200 ? response["data"]["url"].chomp : response["status_txt"]
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/mush/services/isgd.rb

@@ -0,0 +1,21 @@
+module Mush
+  
+  module Services
+    
+    class IsGd < Service
+      base_uri 'http://is.gd'
+
+      def shorten(url)
+        raise InvalidURI.new("Please provide a valid URI") if url.empty?
+        
+        options = {}
+        options[:query] = {:longurl => url}
+        get('/api.php', options).body.chomp
+      end  
+
+    end
+  
+  end
+
+end
+

data/lib/mush/services/unu.rb

@@ -0,0 +1,20 @@
+module Mush
+  
+  module Services
+    
+    class Unu < Service
+      base_uri 'http://u.nu/'
+      
+      def shorten(url)
+        raise InvalidURI.new("Please provide a valid URI") if url.empty?
+        
+        options = {}
+        options[:query] = {:url => url}
+        get('/unu-api-simple', options).body.chomp
+      end
+      
+    end
+    
+  end
+  
+end

data/mush.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mush}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rafael Maga\303\261a"]
+  s.date = %q{2010-08-26}
+  s.description = %q{A gem to shorten URLs using different services, it has one command-line utility for each supported service.}
+  s.email = %q{raf.magana@gmail.com}
+  s.executables = ["bitly", "isgd", "mush", "unu"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/bitly",
+     "bin/isgd",
+     "bin/mush",
+     "bin/unu",
+     "lib/mush.rb",
+     "lib/mush/authenticated_service.rb",
+     "lib/mush/errors.rb",
+     "lib/mush/service.rb",
+     "lib/mush/services/bitly.rb",
+     "lib/mush/services/isgd.rb",
+     "lib/mush/services/unu.rb",
+     "mush.gemspec",
+     "test/helper.rb",
+     "test/test_mush.rb"
+  ]
+  s.homepage = %q{http://github.com/rafmagana/mush}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A multiple service URL shortener gem with command-line utility}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_mush.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
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mush'
+
+class Test::Unit::TestCase
+end

data/test/test_mush.rb

@@ -0,0 +1,113 @@
+require 'helper'
+
+class TestMush < Test::Unit::TestCase
+  
+  context "Mush::Service class" do
+    should "include HTTParty module" do
+      assert Mush::Service.include? HTTParty
+    end
+    
+    should "define a #shorten method" do
+      assert Mush::Service.new.respond_to? :shorten
+    end
+    
+    should "raise and exception if use tries to use #shorten method" do
+      assert_raise Mush::InterfaceMethodNotImplementedError do
+         Mush::Service.new.shorten
+      end
+    end
+    
+    should "add an instance method called 'get' that wrappes the HTTParty#get method" do
+      assert Mush::Service.new.respond_to? :get
+    end
+  end
+  
+  context "All Services" do
+    setup do
+      s = Mush::Services
+      @services = [s::IsGd, s::Bitly, s::Unu]
+    end
+    
+    should "be subclasses of Mush::Service" do
+      @services.each do |service|
+        assert Mush::Service, service.superclass
+      end
+    end
+      
+    should "raise an exception if shorten is called with an empty url" do
+      @services.each do |service|
+        assert_raise Mush::InvalidURI do
+          service.new.shorten('')
+        end
+      end
+    end
+    
+  end
+  
+  context "Service" do
+    setup do
+      @long_url = "http://www.a_very_long_url.com"
+      @shortened_url = "http://is.gd/test"
+      @httparty_response = stub('HTTParty::Reponse', :body => @shortened_url)
+    end
+    
+    context "not authorizable" do
+
+      setup do
+        @httparty_response = stub('HTTParty::Reponse', :body => @shortened_url)
+      end
+    
+      context "IsGd" do
+      
+        should "return a shortened url" do
+          Mush::Services::IsGd.any_instance.stubs(:get).with(instance_of(String), instance_of(Hash)).returns(@httparty_response)
+      
+          isgd = Mush::Services::IsGd.new      
+          isgd_result = isgd.shorten(@long_url)
+      
+          assert_equal @shortened_url, isgd_result
+        end
+      
+      end
+      
+      context "Unu" do
+        should "return a shortened url" do
+          Mush::Services::Unu.any_instance.stubs(:get).with(instance_of(String), instance_of(Hash)).returns(@httparty_response)
+    
+          unu = Mush::Services::Unu.new
+          unu_result = unu.shorten(@long_url)
+    
+          assert_equal @shortened_url, unu_result
+        end
+      end
+    end
+  
+    context "authorizable" do
+      setup do
+        @response = @shortened_url
+      end
+      
+      context "Bitly" do
+        should "has authentication credentials to return a shortened url" do
+          
+          httparty_response = stub('HTTParty::Response', :[] => @shortened_url)
+          bitly = Mush::Services::Bitly.new
+          
+          assert_raise Mush::InvalidAuthorizationData do
+            bitly.shorten(@long_url)
+          end
+          
+          bitly.login = "login"
+          bitly.apikey = "apikey"
+
+          assert_nothing_raised do
+            bitly.shorten(@long_url)
+          end
+          
+          Mush::Services::Bitly.any_instance.stubs(:get).with(instance_of(String), instance_of(Hash)).returns(httparty_response)
+          assert_equal @shortened_url, bitly.shorten(@long_url)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: mush
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Rafael Maga\xC3\xB1a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A gem to shorten URLs using different services, it has one command-line utility for each supported service.
+email: raf.magana@gmail.com
+executables: 
+- bitly
+- isgd
+- mush
+- unu
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/bitly
+- bin/isgd
+- bin/mush
+- bin/unu
+- lib/mush.rb
+- lib/mush/authenticated_service.rb
+- lib/mush/errors.rb
+- lib/mush/service.rb
+- lib/mush/services/bitly.rb
+- lib/mush/services/isgd.rb
+- lib/mush/services/unu.rb
+- mush.gemspec
+- test/helper.rb
+- test/test_mush.rb
+has_rdoc: true
+homepage: http://github.com/rafmagana/mush
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A multiple service URL shortener gem with command-line utility
+test_files: 
+- test/helper.rb
+- test/test_mush.rb