shortly 0.2.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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.

data/README.textile

@@ -0,0 +1,41 @@
+h1. Shortly
+
+A Ruby wrapper for various url shortener services
+
+h2. Getting Started
+
+create a dependency in your Gemfile
+
+@gem 'shortly'@
+
+then run
+
+@bundle install@
+
+and shortly will be up and running.
+
+h2. Uses
+
+Coming Shortly(or see the code)
+
+h2. More Info
+
+For detailed info visit my blog "http://BagwanPankaj.com":http://bagwanpankaj.com
+
+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. 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
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+h2. Copyright
+
+Copyright (c) 2010 [Bagwan Pankaj]. See LICENSE.txt for further details.

data/lib/shortly.rb

@@ -0,0 +1,10 @@
+require 'uri'
+require 'ostruct'
+require 'httparty'
+require 'shortly'
+require 'shortly/helper'
+require 'shortly/errors'
+require 'shortly/client'
+require 'shortly/clients/bitly'
+require 'shortly/clients/googl'
+require 'shortly/clients/isgd'

data/lib/shortly/client.rb

@@ -0,0 +1,51 @@
+# 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
+  
+  class Client
+    
+    include HTTParty
+    include Shortly::Errors
+    include Shortly::Helper
+    
+    base_uri ''
+    
+    def self.shorten(url, options ={})
+      raise MethodNotAvailableError.new("Sorry. This method is not available for given service.")
+    end
+    
+    def self.expand(url, options ={})
+      raise MethodNotAvailableError.new("Sorry. This method is not available for given service.")
+    end
+    
+    def self.validate(options = {})
+      raise MethodNotAvailableError.new("Sorry. This method is not available for given service.")
+    end
+    
+    protected
+    
+    def self.valid_uri?(url)
+      !!(url =~ URI::regexp)
+    end
+    
+  end
+end

data/lib/shortly/clients/bitly.rb

@@ -0,0 +1,62 @@
+# 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 Bitly < Client
+      
+      class << self
+        #apiKey = "<your apiKey>"
+        #login = "<your login>"
+        attr_accessor :login, :apiKey
+      end
+      
+      base_uri 'api.bit.ly'
+      
+      #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})
+        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)
+        options = {:login => self.login, :apiKey => self.apiKey, :shortUrl => short_url, :format => "json"}.merge(options) 
+        response = get("/v3/expand", {:query => 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})
+        OpenStruct.new(response["data"])
+      end
+          
+    end
+    
+  end
+end

data/lib/shortly/clients/googl.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 Googl < Client
+      
+      base_uri 'goo.gl'
+      
+      #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}})
+        OpenStruct.new(response)
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/shortly/clients/isgd.rb

@@ -0,0 +1,40 @@
+# 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 Isgd < Client
+      
+      base_uri 'is.gd'
+      
+      #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)
+        options = {:format => "json", :url => url}.merge(options)
+        response = get("/create.php", {:query => options})
+        OpenStruct.new(response)
+      end
+      
+    end
+  end
+end

data/lib/shortly/clients/rubyurl.rb

@@ -0,0 +1,37 @@
+# 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 RubyUrl < Client
+      
+      base_uri 'rubyurl.com'
+      
+      def self.shorten(url)
+        post('/api/links.json', :query => { :link => { :website_url => url } })
+      end
+    end
+  
+  end
+  
+end

data/lib/shortly/errors.rb

@@ -0,0 +1,40 @@
+# 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 Errors
+    
+    class ShortlyError < StandardError
+      
+      def initialize(msg)
+        super("ShortlyError - #{msg}")
+      end
+      
+    end
+    
+    class ShortlyArgumentError < ArgumentError;       end
+    class InvalidURIError < ShortlyError;             end
+    class NotAuthorizedError < ShortlyArgumentError;  end
+    class MethodNotAvailableError < ShortlyError;     end
+  end
+  
+end

data/lib/shortly/helper.rb

@@ -0,0 +1,36 @@
+# 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 Helper
+    
+    class Hash
+      
+      def authenticable?
+        [:login, :apiKey].all?{|k| self.key?(k)} && !self.values.any?(&:empty?)
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/shortly_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Shortly" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'shortly'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: shortly
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Bagwan Pankaj
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: httparty
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: Ruby Wrapper for different Url Shortner Services Ruby Wrapper
+email: bagwanpankaj@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- lib/shortly.rb
+- lib/shortly/client.rb
+- lib/shortly/clients/bitly.rb
+- lib/shortly/clients/googl.rb
+- lib/shortly/clients/isgd.rb
+- lib/shortly/clients/rubyurl.rb
+- lib/shortly/errors.rb
+- lib/shortly/helper.rb
+- LICENSE.txt
+- README.textile
+- spec/shortly_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bagwanpankaj/shortly
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Url Shortner Services Ruby Wrapper
+test_files: 
+- spec/shortly_spec.rb
+- spec/spec_helper.rb