shortly 0.2.6 → 0.3.0

data/README.textile

@@ -29,13 +29,20 @@ Optionally you can set apiKey and login beforehand (it would be more DRY i think
 *Goo.gl*
 
 @googl = Shortly::Clients::Googl@
-@googl.shorten('http://justatest.com').short_url@
+@googl.shorten('http://justatest.com').shortUrl@
+@googl.expand('http://goo.gl/shrt').longUrl@
+@googl.analytics('http://goo.gl/shrt').analytics@
 
 *Is.gd*
 
 @isgd = Shortly::Clients::Isgd@
 @isgd.shorten('http://justatest.com').shorturl@
 
+*V.gd*
+
+@vgd = Shortly::Clients::Vgd@
+@vgd.shorten('http://justatest.com').shorturl@
+
 *Tinyurl.com*
 
 @tinyurl = Shortly::Clients::Tinyurl@
@@ -52,10 +59,19 @@ By default it uses Googl to short urls but you can specify which service to use.
 here are options and there possible values:
 
 | *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)) |
+| -s or --service | Service to use(e.g. bitly, isgd(default googl)) |
+| -m or --method | Method to use(e.g. expand or shorten or analytics(default shorten)) |
 | -l or --login | Login credential(required for bitly) |
-| -p or --apiKey | API Key credentials (for bitly only) |
+| -p or --apiKey | API Key credentials (for bitly and googl(optional) only) |
+
+h5. Some more examples:
+
+* Google analytics
+@shortly 'http://averylong.url/that/can/frustate?you=many&times=true' -p my_api_key -m analytics@
+spits formatted json at CLI
+
+* Bitly
+@shortly 'http://bit.ly/shrt -s bitly -p my_api_key -l my_login -m expand@
 
 h2. More Info
 

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/shortly

@@ -5,6 +5,7 @@ STDOUT.sync = true
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'rubygems'
+require 'json'
 require 'optparse'
 require 'shortly'
 
@@ -13,16 +14,17 @@ ORIG_ARGV = ARGV.dup
 services = {
               :googl => Shortly::Clients::Googl, 
               :isgd => Shortly::Clients::Isgd, 
+              :vgd => Shortly::Clients::Vgd,
               :bitly => Shortly::Clients::Bitly,
               :tinyurl => Shortly::Clients::Tinyurl
             }
 
-options = {:service => :googl, :method => :shorten}
+options = {:service => :googl, :method => :shorten} #defaults to be used
 
 opts = OptionParser.new do |opts|
   opts.banner = <<-EOS
   Usage:
-    shortly url -s service -m method -l login -p apikey
+    shortly url [-s service] [-m method] [-l login] [-p apikey]
         
     Options:
   EOS
@@ -55,7 +57,7 @@ end
 opts.parse!
 
 if options[:version]
-  abort("Version: " + Shortly.version)
+  abort("Shortly: v" + Shortly.version)
 end
 
 options[:url] = ARGV.first if ARGV.length == 1
@@ -80,9 +82,23 @@ 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 :bitly
+    case options[:method]
+      when :shorten
+        response.url
+      else response.long_url
+    end
+  when :googl
+    case options[:method]
+      when :shorten
+        response.shortUrl
+      when :expand
+        response.longUrl
+      else
+        response.analytics.to_json
+    end
   when :isgd then response.shorturl
+  when :vgd then response.shorturl
   when :tinyurl then response.shorturl
   else abort("Something went wrong. Please raise an issue on Github")
 end

data/lib/shortly.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'ostruct'
+require 'json'
 require 'httparty'
 require 'shortly'
 require 'shortly/helper'
@@ -9,15 +10,20 @@ require 'shortly/clients/bitly'
 require 'shortly/clients/googl'
 require 'shortly/clients/isgd'
 require 'shortly/clients/tinyurl'
+require 'shortly/clients/vgd'
 
 module Shortly
   
-  def self.version
+  #gem version
+  def self.version #:nodoc
     File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
   end
   
+  #returns active services
   def self.active_services
     Client.registered
   end
   
+  Helper::MonkeyPatches.activate!
+  
 end

data/lib/shortly/client.rb

@@ -31,24 +31,37 @@ module Shortly
     
     @@registered = []
     
-    def self.method_missing(method_sym, *params)
+    def self.method_missing(method_sym, *params) #:nodoc
       raise MethodNotAvailableError.new("Sorry, #{method_sym} method is not implemented/available for this service.")
     end
     
     protected
     
-    def self.register!
+    def self.register! #:nodoc
       @@registered = [] unless @@registered
       @@registered << self.name.to_sym
     end
     
-    def self.registered
+    def self.registered #:nodoc
       @@registered
     end
     
+    def self.validate_uri!(url)
+      raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(url)
+    end
+    
+    #returns a uri is valid or not
     def self.valid_uri?(url)
       !!(url =~ URI::regexp)
     end
     
+    def self.post_params(options = {})
+      {:body => options}
+    end
+    
+    def self.get_params(options = {})
+      {:query => options}
+    end
+    
   end
 end

data/lib/shortly/clients/bitly.rb

@@ -37,26 +37,33 @@ module Shortly
       
       #shorts provided url by making call to bitly api with given options.      
       def self.shorten(url, options = {})
-        raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(url)
-        options = {:login => self.login, :apiKey => self.apiKey, :longUrl => url, :format => "json"}.merge(options) 
-        response = get("/v3/shorten", {:query => options})
+        validate_uri!(url)
+        options = {:login => self.login, :apiKey => self.apiKey,:longUrl => url, :format => "json"}.merge(options)
+        validate!(options)
+        response = get("/v3/shorten", get_params(options))
         OpenStruct.new(response["data"])
       end
       
       #expands provided url by making call to bitly api with given options.      
-      def self.expand(short_url, options ={})
-        raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(short_url)
+      def self.expand(short_url, options = {})
+        validate_uri!(short_url)
         options = {:login => self.login, :apiKey => self.apiKey, :shortUrl => short_url, :format => "json"}.merge(options) 
-        response = get("/v3/expand", {:query => options})
+        response = get("/v3/expand", get_params(options))
         OpenStruct.new(response["data"]["expand"].first)
       end
       
       #validates given login(as x_login) and apiKey (as x_api_key)
       #options = {:x_login => xlogin, :x_api_key => x_api_key, :apiKey => apiKey, :login => login, :format => "json"}
       def self.validate(options = {})
-        response = get("/v3/validate", {:query => options})
+        response = get("/v3/validate", get_params(options))
         OpenStruct.new(response["data"])
       end
+      
+      private
+      
+      def self.validate!(options)
+        raise NotAuthorizedError.new("Credentials required(login and apiKey)") unless options.authenticable?
+      end
           
     end
     

data/lib/shortly/clients/googl.rb

@@ -26,12 +26,45 @@ module Shortly
     class Googl < Client
       
       self.register!
-      base_uri 'goo.gl'
+      class << self
+        #apiKey = "<your apiKey>"
+        attr_accessor :apiKey
+      end
+      
+      base_uri 'https://www.googleapis.com' #'goo.gl/api/shorten'
+      headers "Content-Type" => "application/json"
       
       #shorts provided url by making call to goo.gl api with given options.      
       def self.shorten(url, options = {})
-        raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(url)
-        response = post("/api/shorten", {:body => {:url => url}})
+        validate_uri!(url)
+        response = post(relative_path_with_key(options), post_params({:longUrl => url}.to_json))
+        OpenStruct.new(response.merge(:shortUrl => response["id"]))
+      end
+      
+      def self.expand(url, options ={})
+        validate_uri!(url)
+        info(options.merge(:shortUrl => url))
+      end
+      
+      def self.analytics(url, options ={})
+        validate_uri!(url)
+        info(options.merge(:shortUrl => url), true)
+      end
+      
+      private
+      
+      def self.relative_path
+        "/urlshortener/v1/url"
+      end
+      
+      def self.relative_path_with_key(options)
+        self.apiKey ? [relative_path, {:key => self.apiKey}.to_params].join("?") : relative_path
+      end
+      
+      def self.info(options, full = false)
+        options.merge!({:projection => 'FULL'}) if full
+        options.merge!({:key => self.apiKey}) if !!self.apiKey
+        response = get(relative_path, get_params(options))
         OpenStruct.new(response)
       end
       

data/lib/shortly/clients/isgd.rb

@@ -30,9 +30,9 @@ module Shortly
       
       #shorts provided url by making call to is.gd api with given options.      
       def self.shorten(url, options = {})
-        raise InvalidURIError.new("provided URI is invalid.") unless valid_uri?(url)
+        validate_uri!(url)
         options = {:format => "json", :url => url}.merge(options)
-        response = get("/create.php", {:query => options})
+        response = get("/create.php", get_params(options))
         OpenStruct.new(response)
       end
       

data/lib/shortly/clients/tinyurl.rb

@@ -30,8 +30,8 @@ module Shortly
       
       #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
+        validate_uri!(url)
+        response = post("/api-create.php", post_params({:url => url})).chomp
         OpenStruct.new({:shorturl => response})
       end
       

data/lib/shortly/clients/vgd.rb

@@ -0,0 +1,33 @@
+# 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 Vgd < Isgd
+      
+      self.register!
+      base_uri 'v.gd'
+            
+    end
+  end
+end

data/lib/shortly/helper.rb

@@ -23,10 +23,31 @@ module Shortly
   
   module Helper
     
-    class Hash
+    module MonkeyPatches
       
-      def authenticable?
-        [:login, :apiKey].all?{|k| self.key?(k)} && !self.values.any?(&:empty?)
+      def self.activate!
+        Hash.send(:include, MonkeyHash)
+        Object.send(:include, MonkeyObject)
+      end
+      
+      module MonkeyHash
+      
+        def authenticable?
+          [:login, :apiKey].all?{|k| self.key?(k)} && !self.values.any?(&:blank?)
+        end
+      
+      end
+      
+      module MonkeyObject
+        
+        def blank?
+          instance_of? Array ? empty? : nil?
+        end
+        
+        def present?
+          !blank?
+        end
+        
       end
       
     end

data/spec/shortly_spec.rb

@@ -5,99 +5,143 @@ describe "Shortly" do
   #tests for client googl
   describe "Googl" do
     before(:all) do
-      @long_url = "http://bagwanpankaj.com"
+      @long_url = "http://bagwanpankaj.com/"
       @invalid_url = "bagwanpankaj.com"
+      @short_url = "http://goo.gl/17pbM"
+      @googl = Shortly::Clients::Googl
     end
     
     it "should get a short url from googl(provided valid url)" do
-      res = Shortly::Clients::Googl.shorten(@long_url)
-      res.short_url.should_not be_empty
-      res.short_url.should == "http://goo.gl/17pbM"
+      res = @googl.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::Googl.shorten(@long_url)
+    it "result of shorten should be an instance of OpenStruct" do
+      res = @googl.shorten(@long_url)
+      res.should be_an_instance_of(OpenStruct)
+    end
+    
+    it "should get a long url back for given valid short url" do
+      res = @googl.expand(@short_url)
+      res.longUrl.should_not be_empty
+      res.longUrl.should == @long_url
+    end
+    
+    it "result of expand should be an instance of OpenStruct" do
+      res = @googl.expand(@short_url)
       res.should be_an_instance_of(OpenStruct)
     end
     
-    it "should not be added to history(by default)" do
-      res = Shortly::Clients::Googl.shorten(@long_url)
-      res.added_to_history.should be_an_instance_of(FalseClass)
+    it "should give analytics for given short url" do
+      res = @googl.analytics(@short_url)
+      res.analytics.should_not be_empty
+      res.analytics.should be_an_instance_of(Hash)
     end
     
     it "should throw an error on wrong uri format" do
       lambda do
-        Shortly::Clients::Googl.shorten(@invalid_url)
+        @googl.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::Googl.expand(@long_url)
-      end.should raise_error(Shortly::Errors::MethodNotAvailableError)
-    end
   end
   
   #tests for client isgd
   describe "Isgd" do
     before(:all) do
+      @isgd = Shortly::Clients::Isgd
       @long_url = "http://bagwanpankaj.com"
       @invalid_url = "bagwanpankaj.com"
     end
     
     it "should get a short url from Is.gd(provided valid url)" do
-      res = Shortly::Clients::Isgd.shorten(@long_url)
+      res = @isgd.shorten(@long_url)
       res.shorturl.should_not be_empty
-      # res.shorturl.should == "http://is.gd/KasWXL"
+      res.shorturl.should == @isgd.shorten(@long_url).shorturl
     end
     
     it "result should be an instance of OpenStruct" do
-      res = Shortly::Clients::Isgd.shorten(@long_url)
+      res = @isgd.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::Isgd.shorten(@invalid_url)
+        @isgd.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::Isgd.expand(@long_url)
+        @isgd.expand(@long_url)
       end.should raise_error(Shortly::Errors::MethodNotAvailableError)
     end
   end
   
+  #tests for client vgd
+   describe "Vgd" do
+     before(:all) do
+       @vgd = Shortly::Clients::Vgd
+       @long_url = "http://bagwanpankaj.com"
+       @invalid_url = "bagwanpankaj.com"
+     end
+
+     it "should get a short url from Is.gd(provided valid url)" do
+       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)
+       end.should raise_error(Shortly::Errors::MethodNotAvailableError)
+     end
+   end
+  
   #tests for client bitly
   describe "Bitly" do
     
     before(:all) do
-      Shortly::Clients::Bitly.login = "modulo9"
-      Shortly::Clients::Bitly.apiKey = "R_0f17f32f11de7e3e953de49c6f255104"
+      @bitly = Shortly::Clients::Bitly
+      @bitly.login = "modulo9"
+      @bitly.apiKey = "R_0f17f32f11de7e3e953de49c6f255104"
       @long_url = "http://bagwanpankaj.com"
       @invalid_url = "bagwanpankaj.com"
+      @short_url = "http://bit.ly/dUdiIJ"
     end
     
     it "should get a short url from googl(provided valid url)" do
-      res = Shortly::Clients::Bitly.shorten(@long_url)
+      res = @bitly.shorten(@long_url)
       res.url.should_not be_empty
-      res.url.should == "http://bit.ly/dUdiIJ"
+      res.url.should == @short_url
     end
     
     it "result should be an instance of OpenStruct" do
-      res = Shortly::Clients::Bitly.shorten(@long_url)
+      res = @bitly.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::Bitly.shorten(@invalid_url)
+        @bitly.shorten(@invalid_url)
       end.should raise_error(Shortly::Errors::InvalidURIError)
     end
     
     it "should expand a given short url" do
-      res = Shortly::Clients::Bitly.expand("http://bit.ly/dUdiIJ")
+      res = @bitly.expand("http://bit.ly/dUdiIJ")
       res.long_url.should == @long_url
     end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shortly
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 6
-  version: 0.2.6
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bagwan Pankaj
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-18 00:00:00 +05:30
+date: 2011-01-22 00:00:00 +05:30
 default_executable: shortly
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,11 +32,25 @@ dependencies:
         - 0
         version: "0"
   requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: json
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +61,12 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: bundler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +77,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +93,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id004
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: rcov
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,7 +107,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
+  requirement: *id006
 description: Ruby Wrapper for different Url Shortner Services Ruby Wrapper
 email: bagwanpankaj@gmail.com
 executables: 
@@ -104,6 +118,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.textile
 files: 
+- LICENSE.txt
+- VERSION
 - bin/shortly
 - lib/shortly.rb
 - lib/shortly/client.rb
@@ -112,9 +128,9 @@ files:
 - lib/shortly/clients/isgd.rb
 - lib/shortly/clients/rubyurl.rb
 - lib/shortly/clients/tinyurl.rb
+- lib/shortly/clients/vgd.rb
 - lib/shortly/errors.rb
 - lib/shortly/helper.rb
-- LICENSE.txt
 - README.textile
 - spec/shortly_spec.rb
 - spec/spec_helper.rb