shortly 0.2.4 → 0.2.5

data/README.textile

@@ -2,21 +2,60 @@ h1. Shortly
 
 A Ruby wrapper for various url shortener services
 
-h2. Getting Started
+h2. Installation
 
 create a dependency in your Gemfile
+@gem 'shortly'@  then run
+@bundle install@
+and shortly will be up and running. or @gem install shortly@
 
-@gem 'shortly'@
+h2. Uses
 
-then run
+Currently Shortly supports three services (Bit.ly, Goo.gl, is.gd, tinyurl). All supported methods have been provided for all services, so you can expect at least one method(shorten) will be available for every service.
 
-@bundle install@
+*Bit.ly*
 
-and shortly will be up and running.
+@bitly = Shortly::Clients::Bitly
+bitly.shorten('http://justatest.com', {:apiKey => 'R_your_api_key', :login => 'your_login'})@
 
-h2. Uses
+Optionally you can set apiKey and login beforehand (it would be more DRY i think if you only gonna use bitly services).
+
+@bitly = Shortly::Clients::Bitly@
+@bitly.apiKey  = 'your_api_key'@
+@bitly.login   = 'your_login'@
+@bitly.shorten('http://justatest.com').url@
+@bitly.expand('http://bit.ly/imshort').long_url@
+
+*Goo.gl*
+
+@googl = Shortly::Clients::Googl@
+@googl.shorten('http://justatest.com').short_url@
+
+*Is.gd*
+
+@isgd = Shortly::Clients::Isgd@
+@isgd.shorten('http://justatest.com').shorturl@
+
+*Tinyurl.com*
+
+@tinyurl = Shortly::Clients::Tinyurl@
+@tinyurl.shorten('http://justatest.com').shorturl@
+
+h4. Command Line Utility
+
+Shortly also provides command line utility. See some uses below.
+@shortly 'http://shortme.com/'@
+
+By default it uses Googl to short urls but you can specify which service to use. Type @shortly -h@ for more info
+@shortly 'http://shortme.com/' -s bitly -l '<your-login>' -p '<your-apiKey>' -m method-to-use@ 
+
+here are options and there possible values:
 
-Coming Shortly(or see the code)
+| *Options* | *What value do they take* |
+| -s or --service | Service to use(e.g. bitly, isgd(default)) |
+| -m or --method | Method to use(e.g. expand or shorten(default)) |
+| -l or --login | Login credential(required for bitly) | 
+| -p or --apiKey | API Key credentials (for bitly only) |
 
 h2. More Info
 

data/bin/shortly

@@ -10,7 +10,12 @@ require 'shortly'
 
 ORIG_ARGV = ARGV.dup
 
-services = {:googl => Shortly::Clients::Googl, :isgd => Shortly::Clients::Isgd, :bitly => Shortly::Clients::Bitly}
+services = {
+              :googl => Shortly::Clients::Googl, 
+              :isgd => Shortly::Clients::Isgd, 
+              :bitly => Shortly::Clients::Bitly,
+              :tinyurl => Shortly::Clients::Tinyurl
+            }
 
 options = {:service => :googl, :method => :shorten}
 
@@ -75,10 +80,11 @@ end
 response = command.send(options[:method], options[:url])
 
 output = case options[:service]
-   when :bitly then response.url || response.long_url
-   when :googl then response.short_url
-   when :isgd then response.shorturl
-   else abort("Something went wrong. Please raise an issue on Github")
+  when :bitly then response.url || response.long_url
+  when :googl then response.short_url
+  when :isgd then response.shorturl
+  when :tinyurl then response.shorturl
+  else abort("Something went wrong. Please raise an issue on Github")
 end
 
 puts output

data/lib/shortly.rb

@@ -8,6 +8,7 @@ require 'shortly/client'
 require 'shortly/clients/bitly'
 require 'shortly/clients/googl'
 require 'shortly/clients/isgd'
+require 'shortly/clients/tinyurl'
 
 module Shortly
   

data/lib/shortly/clients/tinyurl.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2011 Bagwan Pankaj
+# 
+# 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.
+
+module Shortly
+  
+  module Clients
+    
+    class Tinyurl < Client
+      
+      base_uri 'tinyurl.com'
+      
+      #shorts provided url by making call to tinyurl api with given options.      
+      def self.shorten(url, options = {})
+        raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(url)
+        response = post("/api-create.php", {:body => {:url => url}}).chomp
+        OpenStruct.new({:shorturl => response})
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/shortly_spec.rb

@@ -103,4 +103,35 @@ describe "Shortly" do
     
   end
   
+  #tests for client tinyurl
+  describe "TinyUrl" do
+    before(:all) do
+      @long_url = "http://bagwanpankaj.com"
+      @invalid_url = "bagwanpankaj.com"
+    end
+    
+    it "should get a short url from TinyUrl(provided valid url)" do
+      res = Shortly::Clients::Tinyurl.shorten(@long_url)
+      res.shorturl.should_not be_empty
+      res.shorturl.should == "http://tinyurl.com/6jt3pjr"
+    end
+    
+    it "result should be an instance of OpenStruct" do
+      res = Shortly::Clients::Tinyurl.shorten(@long_url)
+      res.should be_an_instance_of(OpenStruct)
+    end
+    
+    it "should throw an error on wrong uri format" do
+      lambda do
+        Shortly::Clients::Tinyurl.shorten(@invalid_url)
+      end.should raise_error(Shortly::Errors::InvalidURIError)
+    end
+    
+    it "should raise MethodNotAvailableError if method is not implemented for" do
+      lambda do
+        Shortly::Clients::Tinyurl.expand(@long_url)
+      end.should raise_error(Shortly::Errors::MethodNotAvailableError)
+    end
+  end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shortly
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Bagwan Pankaj
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 +05:30
+date: 2011-01-17 00:00:00 +05:30
 default_executable: shortly
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,6 +111,7 @@ files:
 - lib/shortly/clients/googl.rb
 - lib/shortly/clients/isgd.rb
 - lib/shortly/clients/rubyurl.rb
+- lib/shortly/clients/tinyurl.rb
 - lib/shortly/errors.rb
 - lib/shortly/helper.rb
 - LICENSE.txt