shortly 0.3.1 → 0.3.2

data/README.textile

@@ -33,11 +33,11 @@ Optionally you can set apiKey and login beforehand (it would be more DRY i think
 @googl.expand('http://goo.gl/shrt').longUrl@
 @googl.analytics('http://goo.gl/shrt').analytics@
 
-*Lggd* (Credit 'Steve Price (steveprice67)'. See Credits section)
+*ShortSwitch* (Credit 'Steve Price (steveprice67)'. See Credits section)
 
-@lggd = Shortly::Clients::Lggd@
-@lggd.apiKey = '<api-key>'@
-@lggd.shorten('http://justatest.com').shortUrl@
+@shortswitch = Shortly::Clients::ShortSwitch@
+@shortswitch.apiKey = '<api-key>'@
+@shortswitch.shorten('http://justatest.com').shortUrl@
 
 *Is.gd*
 
@@ -54,6 +54,13 @@ Optionally you can set apiKey and login beforehand (it would be more DRY i think
 @tinyurl = Shortly::Clients::Tinyurl@
 @tinyurl.shorten('http://justatest.com').shorturl@
 
+*Sn.im*
+@snim = Shortly::Clients::Snim@
+@snim.apiKey = "<apiKey>"@
+@snim.login = "<login>"@
+@snim.shorten(long_url).shortUrl@
+@snim.expand(url_id/shorturl).url@
+
 h4. Command Line Utility
 
 Shortly also provides command line utility. See some uses below.
@@ -91,6 +98,11 @@ For more info write me at bagwanpankaj[at]gmail.com or me[at]bagwanpankaj.com
 
 Copyright (c) 2010 Bagwan Pankaj: http://bagwanpankaj.com, released under the MIT license
 
+h2. TODO's
+
+* Better documentation
+* Example series
+
 h2. Contributing to shortly
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/bin/shortly

@@ -15,9 +15,12 @@ services = {
               :googl => Shortly::Clients::Googl, 
               :isgd => Shortly::Clients::Isgd, 
               :vgd => Shortly::Clients::Vgd,
-              :lggd => Shortly::Clients::Lggd, 
+              :lggd => Shortly::Clients::ShortSwitch, 
+              :shortswitch => Shortly::Clients::ShortSwitch,
               :bitly => Shortly::Clients::Bitly,
-              :tinyurl => Shortly::Clients::Tinyurl
+              :jmp => Shortly::Clients::Jmp,
+              :tinyurl => Shortly::Clients::Tinyurl,
+              :snim => Shortly::Clients::Snim,
             }
 
 options = {:service => :googl, :method => :shorten} #defaults to be used
@@ -30,15 +33,15 @@ opts = OptionParser.new do |opts|
     Options:
   EOS
 
-  opts.on("-s", "--service SERVICE", "Service to be used in shortner(e.g. bitly, googl(default), isgd)") do |service|
+  opts.on("-s", "--service SERVICE", "Service to be used in shortner(e.g. bitly, googl(default), isgd etc..)") do |service|
     options[:service] = service.to_sym
   end
 
-  opts.on("-l", "--login LOGIN", "Login creadential (for bitly only)") do |login|
+  opts.on("-l", "--login LOGIN", "Login creadential") do |login|
     options[:login] = login
   end
   
-  opts.on("-p", "--apikey APIKEY", "API Key credentials (for bitly only)") do |apikey|
+  opts.on("-p", "--apikey APIKEY", "API Key credentials") do |apikey|
     options[:apikey] = apikey
   end
 
@@ -52,7 +55,8 @@ opts = OptionParser.new do |opts|
   
   opts.on("-v", "--version", "Version of shortly") do
     options[:version] = true
-  end  
+  end
+  
 end
 
 opts.parse!
@@ -63,14 +67,16 @@ end
 
 options[:url] = ARGV.first if ARGV.length == 1
 
-#validate for bitly services
-if options[:service] == :bitly
-  abort("login is required for Bitly Services") unless options[:login]
-  abort("API Key is required for Bitly Services") unless options[:apikey]
+#validate for bitly/jmp services
+if [:bitly, :jmp, :snim].include? options[:service]
+  abort("login is required this service") unless options[:login]
+  abort("API Key is required this services") unless options[:apikey]
+elsif [:shortswitch].include? options[:service]
+  abort("API Key is required this services") unless options[:apikey]
 end
 
 unless options[:url]
-  abort("Please provide atleast a valid URL. To see help type --help or -h")
+  abort("Please provide atleast a valid URL. To see help type --help or -h") and exit(1)
 end
 unless services.include?(options[:service])
   abort("#{options[:service]} sevice is not supported currently.")
@@ -78,17 +84,17 @@ end
 
 command = services[options[:service]]
 
-if options[:service] == :bitly
+if [:bitly, :jmp, :snim].include? options[:service]
   command.login = options.delete(:login)
   command.apiKey = options.delete(:apikey)
-elsif options[:service] == :lggd
+elsif [:lggd, :googl, :shortswitch].include? options[:service]
   command.apiKey = options.delete(:apikey)
 end
 
 response = command.send(options[:method], options[:url])
 
 output = case options[:service]
-  when :bitly
+  when :bitly, :jmp
     case options[:method]
       when :shorten
         response.url
@@ -103,9 +109,15 @@ output = case options[:service]
       else
         response.analytics.to_json
     end
-  when :isgd then response.shorturl
-  when :vgd then response.shorturl
-  when :lggd then response.shortUrl
+  when :snim
+    case options[:method]
+      when :shorten
+        response.shortUrl
+      when :expand
+        response.url
+    end
+  when :isgd, :vgd then response.shorturl
+  when :lggd, :shortswitch then response.shortUrl
   when :tinyurl then response.shorturl
   else abort("Something went wrong. Please raise an issue on Github")
 end

data/lib/shortly/clients/{rubyurl.rb → jmp.rb}

@@ -22,16 +22,14 @@
 module Shortly
   
   module Clients
-
-    class RubyUrl < Client
-      
-      base_uri 'rubyurl.com'
+    
+    class Jmp < Bitly
       
-      def self.shorten(url)
-        post('/api/links.json', :query => { :link => { :website_url => url } })
-      end
+      self.register!
+
+      base_uri 'api.j.mp'
+          
     end
-  
+    
   end
-  
 end

data/lib/shortly/clients/{lggd.rb → shortswitch.rb}

@@ -23,7 +23,7 @@ module Shortly
 
   module Clients
 
-    class Lggd < Client
+    class ShortSwitch < Client
 
       self.register!
 
@@ -31,7 +31,7 @@ module Shortly
         attr_accessor :apiKey
       end
 
-      base_uri 'lg.gd'
+      base_uri 'api.shortswitch.com'
 
       #shorts provided url by making call to is.gd api with given options.      
       def self.shorten(url, options = {})

data/lib/shortly/clients/snim.rb

@@ -0,0 +1,75 @@
+# 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 Snim < Client
+      
+      self.register!
+      
+      class << self
+        #login = "<your login>"
+        #apiKey = "<your apiKey>"
+        attr_accessor :login, :apiKey
+      end
+
+      base_uri 'http://sn.im/site'
+      
+      #shorts provided url by making call to bitly api with given options.      
+      def self.shorten(url, options = {})
+        validate_uri!(url)
+        options = {:snipapi => self.apiKey,:snipuser => self.login, :sniplink => url}.merge(options)
+        validate!(options)
+        response = post("/getsnip", post_params(options))
+        OpenStruct.new(response["snip"].merge(:shortUrl => response["snip"]["id"]))
+      end
+      
+      #expands provided url by making call to bitly api with given options.      
+      def self.expand(short_url, options = {})
+        analytics(short_url.gsub('http://sn.im/', ''), options)
+      end
+      
+      #gets analytics
+      def self.analytics(short_id, options = {})
+        options = {:snipapi => self.apiKey,:snipuser => self.login, :snipid => short_id}.merge(options)
+        validate!(options)
+        response = post("/getsnipdetails", post_params(options))
+        OpenStruct.new(unescape_url(response)["snip"])
+      end
+      
+      private
+      
+      def self.validate!(options)
+        raise NotAuthorizedError.new("Credentials required(login and apiKey)") unless 
+          options.authenticable?(:snipapi, :snipuser)
+      end
+      
+      def self.unescape_url(response)
+        response["snip"]["url"] = CGI.unescape(response["snip"]["url"]) if response["snip"]
+        response
+      end
+          
+    end
+    
+  end
+end

data/lib/shortly.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'cgi'
 require 'ostruct'
 require 'json'
 require 'httparty'
@@ -7,11 +8,13 @@ require 'shortly/helper'
 require 'shortly/errors'
 require 'shortly/client'
 require 'shortly/clients/bitly'
+require 'shortly/clients/jmp'
 require 'shortly/clients/googl'
 require 'shortly/clients/isgd'
-require 'shortly/clients/lggd'
+require 'shortly/clients/shortswitch'
 require 'shortly/clients/tinyurl'
 require 'shortly/clients/vgd'
+require 'shortly/clients/snim'
 
 module Shortly
   

data/spec/shortly_spec.rb

@@ -9,9 +9,11 @@ describe "Shortly" do
       @invalid_url = "bagwanpankaj.com"
       @short_url = "http://goo.gl/17pbM"
       @googl = Shortly::Clients::Googl
+      @uri = @googl.base_uri + @googl.send(:relative_path)
     end
     
     it "should get a short url from googl(provided valid url)" do
+      mock_request_for(@uri, :method => :post, :fixture => "googl_shorten")
       res = @googl.shorten(@long_url)
       res.shortUrl.should_not be_empty
       res.shortUrl.should == @short_url
@@ -23,6 +25,7 @@ describe "Shortly" do
     end
     
     it "should get a long url back for given valid short url" do
+      mock_request_for(@uri + "?shortUrl=#{CGI.escape(@short_url)}", :method => :get, :fixture => "googl_expand")
       res = @googl.expand(@short_url)
       res.longUrl.should_not be_empty
       res.longUrl.should == @long_url
@@ -34,9 +37,14 @@ describe "Shortly" do
     end
     
     it "should give analytics for given short url" do
+      mock_request_for(@uri + "?shortUrl=#{CGI.escape(@short_url)}&projection=FULL",
+        :fixture => "googl_analytics")
+      
       res = @googl.analytics(@short_url)
       res.analytics.should_not be_empty
       res.analytics.should be_an_instance_of(Hash)
+      res.analytics["week"].should be_an_instance_of(Hash)
+      res.analytics["day"].should be_an_instance_of(Hash)
     end
     
     it "should throw an error on wrong uri format" do
@@ -52,13 +60,18 @@ describe "Shortly" do
     before(:all) do
       @isgd = Shortly::Clients::Isgd
       @long_url = "http://bagwanpankaj.com"
+      @shorturl = "http://is.gd/bs9smw"
       @invalid_url = "bagwanpankaj.com"
+      @uri = @isgd.base_uri
     end
     
     it "should get a short url from Is.gd(provided valid url)" do
+      mock_request_for(@uri + "/create.php?url=#{CGI.escape(@long_url)}&format=json",
+        :fixture => "isgd_shorten")
+      
       res = @isgd.shorten(@long_url)
       res.shorturl.should_not be_empty
-      res.shorturl.should == @isgd.shorten(@long_url).shorturl
+      res.shorturl.should == @shorturl
     end
     
     it "result should be an instance of OpenStruct" do
@@ -85,25 +98,29 @@ describe "Shortly" do
        @vgd = Shortly::Clients::Vgd
        @long_url = "http://bagwanpankaj.com"
        @invalid_url = "bagwanpankaj.com"
+       @uri = @vgd.base_uri
      end
-
-     it "should get a short url from Is.gd(provided valid url)" do
+  
+     it "should get a short url from v.gd(provided valid url)" do
+       mock_request_for(@uri + "/create.php?url=#{CGI.escape(@long_url)}&format=json", 
+        :fixture => "vgd_shorten")
+       
        res = @vgd.shorten(@long_url)
        res.shorturl.should_not be_empty
        res.shorturl.should == @vgd.shorten(@long_url).shorturl
      end
-
+  
      it "result should be an instance of OpenStruct" do
        res = @vgd.shorten(@long_url)
        res.should be_an_instance_of(OpenStruct)
      end
-
+  
      it "should throw an error on wrong uri format" do
        lambda do
          @vgd.shorten(@invalid_url)
        end.should raise_error(Shortly::Errors::InvalidURIError)
      end
-
+  
      it "should raise MethodNotAvailableError if method is not implemented for" do
        lambda do
          @vgd.expand(@long_url)
@@ -116,14 +133,18 @@ describe "Shortly" do
     
     before(:all) do
       @bitly = Shortly::Clients::Bitly
-      @bitly.login = "modulo9"
-      @bitly.apiKey = "R_0f17f32f11de7e3e953de49c6f255104"
+      @bitly.login = "TEST_LOGIN"
+      @bitly.apiKey = "R_TEST_API_KEY"
       @long_url = "http://bagwanpankaj.com"
       @invalid_url = "bagwanpankaj.com"
       @short_url = "http://bit.ly/dUdiIJ"
+      @uri = @bitly.base_uri + "/v3"
     end
     
-    it "should get a short url from googl(provided valid url)" do
+    it "should get a short url from bitly(provided valid url)" do
+      mock_request_for(@uri + "/shorten?longUrl=#{CGI.escape(@long_url)}&format=json&login=#{@bitly.login}&apiKey=#{@bitly.apiKey}", 
+       :fixture => "bitly_shorten")
+       
       res = @bitly.shorten(@long_url)
       res.url.should_not be_empty
       res.url.should == @short_url
@@ -141,20 +162,70 @@ describe "Shortly" do
     end
     
     it "should expand a given short url" do
+      mock_request_for(@uri + "/expand?shortUrl=#{CGI.escape(@short_url)}&format=json&login=#{@bitly.login}&apiKey=#{@bitly.apiKey}", 
+       :fixture => "bitly_expand")
+       
       res = @bitly.expand("http://bit.ly/dUdiIJ")
       res.long_url.should == @long_url
     end
     
   end
   
+  #tests for client jmp
+  describe "Jmp" do
+    
+    before(:all) do
+      @jmp = Shortly::Clients::Jmp
+      @jmp.login = "TEST_LOGIN"
+      @jmp.apiKey = "R_TEST_API_KEY"
+      @long_url = "http://bagwanpankaj.com"
+      @invalid_url = "bagwanpankaj.com"
+      @short_url = "http://j.mp/dUdiIJ"
+      @uri = @jmp.base_uri + '/v3'
+    end
+    
+    it "should get a short url from jmp(provided valid url)" do
+      mock_request_for(@uri + "/shorten?longUrl=#{CGI.escape(@long_url)}&format=json&login=#{@jmp.login}&apiKey=#{@jmp.apiKey}", 
+       :fixture => "jmp_shorten")
+       
+      res = @jmp.shorten(@long_url)
+      res.url.should_not be_empty
+      res.url.should == @short_url
+    end
+    
+    it "result should be an instance of OpenStruct" do
+      res = @jmp.shorten(@long_url)
+      res.should be_an_instance_of(OpenStruct)
+    end
+    
+    it "should throw an error on wrong uri format" do
+      lambda do
+        @jmp.shorten(@invalid_url)
+      end.should raise_error(Shortly::Errors::InvalidURIError)
+    end
+    
+    it "should expand a given short url" do
+      mock_request_for(@uri + "/expand?shortUrl=#{CGI.escape(@short_url)}&format=json&login=#{@jmp.login}&apiKey=#{@jmp.apiKey}", 
+       :fixture => "jmp_expand")
+       
+      res = @jmp.expand(@short_url)
+      res.long_url.should == @long_url
+    end
+    
+  end
+  
   #tests for client tinyurl
   describe "TinyUrl" do
     before(:all) do
       @long_url = "http://bagwanpankaj.com"
       @invalid_url = "bagwanpankaj.com"
+      @uri = Shortly::Clients::Tinyurl.base_uri
     end
     
     it "should get a short url from TinyUrl(provided valid url)" do
+      mock_request_for(@uri + "/api-create.php", :method => :post,
+       :fixture => "tinyurl_shorten", :content_type => "text/plain")
+       
       res = Shortly::Clients::Tinyurl.shorten(@long_url)
       res.shorturl.should_not be_empty
       res.shorturl.should == "http://tinyurl.com/6jt3pjr"
@@ -178,35 +249,81 @@ describe "Shortly" do
     end
   end
   
-  #tests for client lg.gd
-  describe "Lggd" do
+  #tests for client ShortSwitch
+  describe "ShortSwitch" do
     
     before(:all) do
-      Shortly::Clients::Lggd.apiKey = "87171b48ff5487f8817021667298e059081d7cc0"
-      @long_url = "http://google.com"
+      @ss = Shortly::Clients::ShortSwitch
+      Shortly::Clients::ShortSwitch.apiKey = "TESTKEY"
+      @long_url = "http://bagwanpankaj.com"
       @invalid_url = "bagwanpankaj.com"
-      @short_url = "http://demo.shortswitch.com/1"
+      @short_url = "http://demo.shortswitch.com/t"
+      @uri = @ss.base_uri
     end
+
+    it "should get a short url from ShortSwitch(provided valid url)" do
+      mock_request_for(@uri + "/shorten?longUrl=#{CGI.escape(@long_url)}&format=json&apiKey=TESTKEY",
+       :fixture => "shortswitch_shorten")
     
-    it "should get a short url from lg.gd(provided valid url)" do
-      res = Shortly::Clients::Lggd.shorten(@long_url)
+      res = Shortly::Clients::ShortSwitch.shorten(@long_url)
       res.shortUrl.should_not be_empty
       res.shortUrl.should == @short_url
     end
     
     it "result should be an instance of OpenStruct" do
-      res = Shortly::Clients::Lggd.shorten(@long_url)
+      res = Shortly::Clients::ShortSwitch.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::Lggd.shorten(@invalid_url)
+        Shortly::Clients::ShortSwitch.shorten(@invalid_url)
       end.should raise_error(Shortly::Errors::InvalidURIError)
     end
     
   end
   
+  #tests for client sn.im
+  describe "Snim" do
+    before(:all) do
+      @snim = Shortly::Clients::Snim
+      @snim.apiKey = "TESTKEY"
+      @snim.login = "TESTER"
+      @long_url = "http://bagwanpankaj.com/"
+      @invalid_url = "bagwanpankaj.com"
+      @short_url = "http://sn.im/1wvkof"
+      @uri = @snim.base_uri
+    end
+    
+    it "should get a short url from Snim(provided valid url)" do
+      mock_request_for(@uri + "/getsnip", :method => :post,
+       :fixture => "snim_shorten")
+    
+      res = @snim.shorten(@long_url)
+      res.shortUrl.should_not be_empty
+      res.shortUrl.should == @short_url
+    end
+    
+    it "should get analytics from Snim(provided valid id)" do
+      mock_request_for(@uri + "/getsnipdetails", :method => :post,
+       :fixture => "snim_analytics")
+    
+      res = @snim.analytics("1wvkof")
+      res.url.should_not be_empty
+      res.clicks.should_not be_nil
+      res.clicks.should == 10000
+    end
+    
+    it "should get long url from Snim(provided valid shorturl)" do
+      mock_request_for(@uri + "/getsnipdetails", :method => :post,
+       :fixture => "snim_analytics")
+    
+      res = @snim.expand(@short_url)
+      res.url.should_not be_empty
+      res.url.should == @long_url
+    end
+  end
+  
   describe "Client" do
     
     before(:all) do

data/spec/spec_helper.rb

@@ -1,11 +1,14 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cgi'
 require 'rspec'
 require 'shortly'
-
+require 'fakeweb'
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+include FakewebStub
+FakeWeb.allow_net_connect = false
 
 RSpec.configure do |config|
   

data/spec/support/fakeweb_stub.rb

@@ -0,0 +1,16 @@
+module FakewebStub
+  
+  def mock_request_for(url, options = {})
+
+    method  = options[:method] || :get
+    fixture = options[:fixture] || "Fakeweb request body"
+    content_type =  options[:content_type] || "application/json"
+    body    = begin
+      File.read(File.expand_path(File.dirname(__FILE__)) + "/../fixtures/#{fixture}.json")
+    rescue Errno::ENOENT
+      raise "Could not find fixture file named '#{fixture}'!"
+    end
+    
+    FakeWeb.register_uri(method, url, :body => body, :status => ["200", "OK"], :content_type => content_type)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shortly
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Bagwan Pankaj
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-23 00:00:00 +05:30
+date: 2011-01-26 00:00:00 +05:30
 default_executable: shortly
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,20 @@ dependencies:
         - 0
         version: "0"
   requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: fakeweb
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
 description: Ruby Wrapper for different Url Shortner Services Ruby Wrapper
 email: bagwanpankaj@gmail.com
 executables: 
@@ -126,8 +140,9 @@ files:
 - lib/shortly/clients/bitly.rb
 - lib/shortly/clients/googl.rb
 - lib/shortly/clients/isgd.rb
-- lib/shortly/clients/lggd.rb
-- lib/shortly/clients/rubyurl.rb
+- lib/shortly/clients/jmp.rb
+- lib/shortly/clients/shortswitch.rb
+- lib/shortly/clients/snim.rb
 - lib/shortly/clients/tinyurl.rb
 - lib/shortly/clients/vgd.rb
 - lib/shortly/errors.rb
@@ -135,6 +150,7 @@ files:
 - README.textile
 - spec/shortly_spec.rb
 - spec/spec_helper.rb
+- spec/support/fakeweb_stub.rb
 has_rdoc: true
 homepage: http://github.com/bagwanpankaj/shortly
 licenses: 
@@ -172,3 +188,4 @@ summary: Url Shortner Services Ruby Wrapper
 test_files: 
 - spec/shortly_spec.rb
 - spec/spec_helper.rb
+- spec/support/fakeweb_stub.rb