multi_shorten 0.0.1

data/README.md

@@ -0,0 +1,51 @@
+README
+======
+
+Use multiple url shorteners with a single gem
+
+Install
+-------
+
+<code>gem install multi_shorten</code>
+
+Usage
+-----
+<code>
+require 'multi_shorten'
+client = MultiShorten::Client.new
+</code>
+<b>For single shortener apis</b>
+<code>
+client.shorten({:mode => "single", :url => "http://www.google.com", :shortener => "b54"})
+</code>
+
+<b>Sample response for this request</b>
+<code>
+{:status => :success, :short_url => "http://b54.in/9o"}
+</code>
+
+<b>For multiple apis</b>
+<code>
+client.shorten({:mode => "multiple", :url => "http://www.google.com", :shorteners => ["b54", "qr_cx"]})
+</code>
+
+<b>Sample response for this request </b>
+<code>
+{"b54" => {:status => :fail }, "qr_cx" => {:status => :success, :short_url => "http://qr.cx/9o"}}
+</code>
+
+Available Shortener Codes
+--------------------
+
+[b54](http://b54.in)
+[linkee](http://linkee.com)
+[goo_gl](http://goo.gl)
+[is_gd](htpp://is.gd)
+[jumbo_tweet](http://jmb.tw/)
+[meta_mark](http://metamark.net)
+[mt_ny](http://mtny.mobi")
+[qr_cx](http://qr.cx)
+[shortr](http://shortr.info)
+
+Use the above codes to shorten your urls with the respective service
+    

data/lib/multi_shorten/client.rb

@@ -0,0 +1,48 @@
+require_relative 'url_shorteners'
+require 'active_support/inflector'
+module MultiShorten
+	# Client class for MultiShorten
+	# initialize the client with 
+	# client = MultiShorten::Client.new
+	class Client
+		# The only method required to use all the features
+		# @param [Hash] params hash with all the required parameters
+		# @return [Hash] the result hash with status and if successful, the shortened url as well. 
+		def shorten params
+			raise "Parameter should be a hash" unless params.is_a?(Hash)
+			return missing_parameter_error(:url) if params[:url].nil?
+			return missing_parameter_error(:mode) if params[:mode].nil?
+			case params[:mode]
+			when "single"
+				return missing_parameter_error(:shortener) if params[:shortener].nil?
+				single(params[:shortener], params[:url])
+			when "multiple"
+				return missing_parameter_error(:shorteners) if params[:shorteners].nil
+				multiple(params[:shorteners], params[:url])
+			end
+		end
+
+		private
+
+		def single shortener, url
+			"MultiShorten::#{shortener.camelize}".constantize.shorten(url) rescue fail
+		end
+
+		def multiple shorteners, url
+			result = {}
+			shorteners.each do |shortener|
+				result[shortener] = single(shortener, url)
+			end
+			result
+		end
+
+		def missing_parameter_error param
+			raise "Missing required parameter: #{param}"
+		end
+
+		def fail
+			{:status => :fail}
+		end
+	end
+
+end

data/lib/multi_shorten/url_shorteners.rb

@@ -0,0 +1,157 @@
+require 'httparty'
+require 'open-uri'
+require 'pp'
+require 'json'
+# The main MultiShorten module
+module MultiShorten
+
+  # Base class from which all other classes are derived
+  class UrlShortener
+    # HTTPArty is included here so that its appicable to all the sub classes
+    include HTTParty
+
+    # Returns shortened version of the url for the corresponding. This is the abstract class
+    # @param [String] url the url to be shortened
+    # @return [Hash] the resulting hash with status -> either :success or :fail. If success it also includes the :short_url
+    def self.shorten url
+    end
+
+    # The hash that is returned when there is a failure
+    def fail
+      { :status => :fail }
+    end
+
+  end
+
+  # URL Shortener for B54
+  class B54 < UrlShortener
+
+    base_uri "http://b54.in"
+    format :json
+
+    def self.shorten url
+      response = get "/api", :query => {:action => "shorturl", :url => URI.encode(url), :format => "json"} rescue return fail
+      if response["shorturl"]
+        {:status => :success, :short_url => URI.unescape(response["shorturl"])}
+      else
+        fail
+      end
+    end
+
+  end
+
+  # URL Shortener for Linkee
+  class Linkee < UrlShortener
+    base_uri "http://api.linkee.com"
+    format :json
+    def self.shorten url
+      response = get "/1.0/shorten", :query => {:input => URI.encode(url)}
+      if response["status"]["code"] == 200
+        {:status => :success, :short_url => response["result"]}
+      else
+        {:status => :fail}
+      end
+    end
+  end
+
+  # URL Shortener for goo.gl
+  class GooGl < UrlShortener
+    base_uri "https://www.googleapis.com/urlshortener"
+    format :json
+    def self.shorten url
+      response = post "/v1/url", :headers => {"Content-Type" => "application/json"}, :body => JSON.dump({:longUrl => URI.encode(url)})
+      unless response.parsed_response["id"].nil?
+        { :status => :success, :short_url => response.parsed_response["id"] }
+      else
+        fail
+      end
+    end
+  end
+
+  # URL Shortener for is.gd
+  class IsGd < UrlShortener
+    base_uri "http://is.gd/"
+    format :json
+    def self.shorten url
+      response = get "/create.php", :query => {:format => "json", :url => URI.encode(url)}
+      unless response.parsed_response["shorturl"].nil?
+        { :status => :success, :short_url => response.parsed_response["shorturl"] }
+      else
+        fail
+      end
+    end
+  end
+
+  # URL Shortener for Jumbo Tweet
+  class JumboTweet < UrlShortener
+    base_uri "http://jmb.tw"
+    format :plain
+    def self.shorten url
+      response = get "/api/create", :query => { :newurl => URI.encode(url)}
+      if response.match("^http://jmb.tw/.+")
+        { :status => :success, :short_url => response.parsed_response }
+      else
+        fail
+      end
+    end
+  end
+
+  # URL Shortener for metamark
+  class MetaMark < UrlShortener
+    base_uri "http://metamark.net"
+    format :plain
+    def self.shorten url
+      response = get "/api/rest/simple", :query => { :long_url => URI.encode(url)}
+      if response.match("^http://xrl.us/.+")
+        { :status => :success, :short_url => response.parsed_response }
+      else
+        fail
+      end
+    end
+  end
+
+  # URL Shortener for mtny.mobi
+  class MtNy < UrlShortener
+    base_uri "http://mtny.mobi"
+    format :json
+    def self.shorten url
+      response = get "/api", :query => {:type => "json", :source => "web", :url => URI.encode(url)}
+      unless response.parsed_response["url"].nil?
+        { :status => :success, :short_url => response.parsed_response["url"] }
+      else
+        fail
+      end
+    end
+  end
+
+  # URL Shortener for  qr.cx
+  class QrCx < UrlShortener
+    base_uri "http://qr.cx"
+    format :plain
+
+    def self.shorten url
+      response = get "/api/?", :query => {:longurl => URI.encode(url)}
+      if response.match("^http://qr.cx/.+")
+        { :status => :success, :short_url => response.parsed_response }
+      else
+        fail
+      end
+    end
+
+  end
+
+  # URL Shortener for shortr.info
+  class Shortr < UrlShortener
+    base_uri "http://shortr.info"
+    format :json
+    def self.shorten url
+      response = get "/make-shortr.php", :query => {:format => "json", :url => URI.encode(url)}
+      unless response.parsed_response["shortr"]["result"]["created"].nil?
+        { :status => :success, :short_url => response.parsed_response["shortr"]["result"]["created"] }
+      else
+        fail
+      end
+    end
+  end
+  
+end

data/lib/multi_shorten.rb

@@ -0,0 +1,4 @@
+require "httparty"
+Dir[File.dirname(__FILE__) + '/multi_shorten/*.rb'].each do |file|
+  require file
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: multi_shorten
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rony Varghese
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-31 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: active_support
+  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'
+description: Use multiple url shorteners to shorten single or multiple urls
+email: ronyv250289@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/multi_shorten/client.rb
+- lib/multi_shorten/url_shorteners.rb
+- lib/multi_shorten.rb
+- README.md
+homepage: http://rubygems.org/gems/multi_shorten
+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.24
+signing_key: 
+specification_version: 3
+summary: Multiple URL Shorteners in one place
+test_files: []