simple_bitly 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/README.mdown

@@ -0,0 +1,27 @@
+# Simple Bitly
+
+A simple and lightweight wrapper for the Bitly API (v3).
+
+## Installation
+
+> [sudo] gem install simple_bitly
+
+## Usage
+
+> bitly = SimpleBitly.new(USERNAME, API_KEY)
+
+##### shorten a URL
+
+> result = bitly.shorten('http://reddit.com')
+> result.short_url
+> result.long_url
+> result.hash
+> result.qr_code
+
+##### expand one or more URLs
+
+> results = bitly.expand('http://bit.ly/9QePJB', 'http://bit.ly/CuJU')
+> results.first.long_url
+> results.first.short_url
+> results.first.hash
+> results.first.qr_code

data/lib/simple_bitly/version.rb

@@ -1,3 +1,3 @@
 module SimpleBitly
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/simple_bitly.rb

@@ -1,47 +1,79 @@
 require 'json'
 require 'net/http'
+require 'open-uri'
 
 module SimpleBitly
 
-    def self.new(username, api_key)
-      SimpleBitly::Client.new(username, api_key)
-    end
+  ENDPOINT = "http://api.bitly.com/v3/" # The endpoint for Bitly's V3 API
+  
+  # Creates a new client.
+  # Requires a username and api_key which can be found at http://bitly.com/a/your_api_key
+  def self.new(username, api_key)
+    SimpleBitly::Client.new(username, api_key)
+  end
   
   class Client
-    
+
     def initialize(username, api_key)
       @username, @api_key = username, api_key
     end
     
+    # Shortens a long url
+    #
+    # Returns a SimpleBitly::URL class with the following instance variables: short_url, hash, qr_code, long_url
     def shorten(long_url)
-      SimpleBitly::URL.new(@username, @api_key, long_url)
+      SimpleBitly::URL
+      url = ENDPOINT + "shorten?login=#{@username}&apiKey=#{@api_key}&longUrl=#{long_url}&format=json"
+      resp = get(url)
+      if resp['status_code'] == 200
+        return SimpleBitly::URL.new(resp['data'])
+      else
+        bitly_error(resp['status_code'], resp['status_txt'])
+      end
     end
     
+    # Expands one or more short urls
+    #
+    # Returns an array of SimpleBitly::URL classes with the following instance variables: short_url, hash, qr_code, long_url
+    # Results are returned in the order they were entered
+    def expand(*short_urls)
+      expanded_urls = []
+      url = ENDPOINT + "expand?login=#{@username}&apiKey=#{@api_key}&format=json"
+      short_urls.each {|u| url += "&shortUrl=#{u}"}
+      resp = get(url)
+      if resp['status_code'] == 200
+        resp['data']['expand'].each do |result|
+          expanded_urls << SimpleBitly::URL.new(result)
+        end
+        return expanded_urls
+      else
+        bitly_error(resp['status_code'], resp['status_txt'])
+      end
+    end
+    
+    # Raises an error containing the 'Status Code' and the 'Status Message' sent by Bitly's server
+    def bitly_error(code, message)
+      raise "Error from Bitly: #{code.to_s}, #{message}"
+    end
+    
+    # Retrieves and parses a response from Bitly
+    def get(url)
+      JSON.parse(Net::HTTP.get(URI.parse(URI.escape(url))))
+    end
   end
   
   class URL
     
-    attr_reader :short_url, :long_url, :hash
+    attr_reader :long_url, :short_url, :hash, :qr_code
     
-    def initialize(username, api_key, long_url)
-      @username, @api_key, @long_url = username, api_key, long_url
-      shorten
+    # SimpleBitly::URL class receives the JSON parsed hash from Bitly and assigns the results to instance variables
+    def initialize(opts={})
+      @short_url = opts['url'] || opts['short_url']
+      @long_url = opts['long_url']
+      @hash = opts['hash'] || opts['user_hash']
+      @qr_code = @short_url + ".qrcode"
     end
     
-    private
-    
-    def shorten
-      url = "http://api.bitly.com/v3/shorten?login=#{@username}&apiKey=#{@api_key}&longUrl=#{@long_url}&format=json"
-      resp = JSON.parse(Net::HTTP.get(URI.parse(url)))
-      if resp['status_code'] == 200
-        data = resp['data']
-        @long_url = data['long_url']
-        @short_url = data['url']
-        @hash = data['hash']
-      else
-        raise "Error from bitly: #{resp['status_code']}, #{resp['status_txt']}"
-      end
-    end
   end
   
 end

data/simple_bitly.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new do |s|
   s.homepage    = ""
   s.summary     = %q{A lightweight wrapper for the bit.ly API}
   s.description = %q{lightweight bit.ly API wrapper}
+  
+  s.add_development_dependency('rspec', '>= 2.0.0')
 
   s.rubyforge_project = "simple_bitly"
 

data/spec/helper.rb

@@ -0,0 +1,9 @@
+require 'simple_bitly'
+
+def username
+  'username here'
+end
+
+def api_key
+  'api_key here'
+end

data/spec/simple_bitly/client_spec.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+describe "Simple Bitly" do
+  
+  it "should create a new bitly client" do
+    bitly = SimpleBitly.new(username, api_key)
+    bitly.class.should == SimpleBitly::Client
+  end
+  
+  context "client" do
+    
+    context "shorten" do
+
+      before(:all) do
+        @bitly = SimpleBitly.new(username, api_key)
+        @result = @bitly.shorten('http://reddit.com/')
+      end
+      
+      it "should return a SimpleBitly::URL" do
+        @result.class.should == SimpleBitly::URL
+      end
+      
+      it "should return a short bitly url" do
+        @result.short_url[0..13].should == "http://bit.ly/"
+      end
+      
+      it "should return a long url" do
+        @result.long_url.should == "http://reddit.com/"
+      end
+      
+      it "should return a qr code" do
+        @result.qr_code.should == @result.short_url + ".qrcode"
+      end
+    end
+    
+    context "expand" do
+      
+      before(:all) do
+        @bitly = SimpleBitly.new(username, api_key)
+        @result = @bitly.expand('http://bit.ly/9QePJB', 'http://tcrn.ch/bkNy6W')
+      end
+      
+      it "should return an array of SimpleBitly::URLs" do
+        @result.each do |result|
+          result.class.should == SimpleBitly::URL
+        end
+      end
+      
+      it "should return the correct amount of results" do
+        @result.size.should == 2
+      end
+      
+      it "should return the correct long url" do
+        @result.first.long_url.should == "http://reddit.com/"
+      end
+      
+      it "should return the short url" do
+        @result.first.short_url.should == "http://bit.ly/9QePJB"
+      end
+      
+      it "should return the qr code" do
+        @result.first.qr_code.should == "http://bit.ly/9QePJB.qrcode"
+      end
+    end
+    
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_bitly
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nizar Dhamani
@@ -15,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 -05:00
+date: 2011-07-08 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
 description: lightweight bit.ly API wrapper
 email: 
 - nizar.dhamani@gmail.com
@@ -30,12 +45,15 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
-- README.txt
+- README.mdown
 - Rakefile
 - lib/simple_bitly.rb
 - lib/simple_bitly/version.rb
 - simple_bitly.gemspec
+- spec/helper.rb
+- spec/simple_bitly/client_spec.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -70,5 +88,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A lightweight wrapper for the bit.ly API
-test_files: []
-
+test_files: 
+- spec/helper.rb
+- spec/simple_bitly/client_spec.rb

data/README.txt

@@ -1,18 +0,0 @@
-Description:
-
-A simple and lightweight wrapper for the Bitly API.
-
-
-Installation:
-
-[sudo] gem install simple_bitly
-
-
-Usage:
-
-bitly = SimpleBitly.new(USERNAME, API_KEY)
-data = bitly.shorten('http://github.com')
-
-data.short_url
-data.long_url
-data.hash