ruby-bitly 0.0.9 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,6 @@
+# 0.1.0
+
+- Moving read file ~/.bitly from Bitly class to command line script
+- Using Bitly class is an OpenStruct
+- Simplified code
+- bit.ly credentials as parameters

data/README.rdoc

@@ -1,31 +1,47 @@
 = A simple bitly ruby client.
 
 == Examples
-    bitly -s http://rafael.xlii.com.br
+    bitly -s http://xlii.com.br
     bitly -e http://bit.ly/XLII42
     bitly --user-clicks http://bit.ly/XLII42
     bitly --global-clicks http://bit.ly/XLII42
 
   Other examples:
-    bitly -q -s http://rafael.xlii.com.br
+    bitly -q -s http://xlii.com.br
     bitly --verbose -e http://bit.ly/XLII42
 
-== Usage 
+== Usage
     bitly [options] url
 
     For help: bitly -h
 
 == Options
-    -s, --shorten        Shorten a long url
+    -s, --shorten        Shorten a long url (default option)
     -e, --expand         Expand a short bitly url
     -u, --user-clicks    Show user clicks from the short bitly url
     -g, --global-clicks  Show global clicks from the short bitly url
-                         
+
+    -l, --login LOGIN    Your bit.ly login
+    -k, --key KEY        Your bit.ly API key
+
     -h, --help           Displays help message, then exit
     -v, --version        Display the version, then exit
     -q, --quiet          Output as little as possible, overrides verbose
     -V, --verbose        Verbose output
 
+== Authentication
+  bit.ly API require that authentication credentials be supplied.
+
+  To get started, you'll need a free bit.ly user account and apiKey. Signup at: http://bit.ly/a/sign_up
+  If you already have an account, you can find your apiKey at: http://bit.ly/a/your_api_key
+  
+  You can supply credentials as parameters. By example:
+    bitly -l username -k key-here -s http://xlii.com.br
+  
+  Or you can create the file ~/.bitly (YAML format) with this content:
+    login: username
+    key: key-here
+
 == Author
     rafaeldx7 ~ rafaeldx7(a)gmail.com
 

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/bin/bitly

@@ -11,81 +11,94 @@ require 'date'
 
 class App
   VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
-  
-  attr_reader :options
+  ACCOUNT_FILE_PATH = "#{ENV['HOME']}/.bitly"
+
+  attr_accessor :arguments, :options, :message
 
-  def initialize(arguments, stdin)
-    @arguments = arguments
+  def initialize(arguments, stdin = nil)
+    self.options = OpenStruct.new
+    self.arguments = arguments
     @stdin = stdin
-    
-    # Set defaults
-    @options = OpenStruct.new
-    @options.verbose = false
-    @options.quiet = false
   end
 
-  # Parse options, check arguments, then process the command
   def run
-        
-    if parsed_options? && arguments_valid? 
-      
-      puts "Start at #{DateTime.now}\n\n" if @options.verbose
-      
-      output_options if @options.verbose # [Optional]
+    process_options
+    
+    if arguments_valid? 
+      output_options if options.verbose
             
-      process_arguments            
-      puts process_command.to_s
-      
-      puts "\nFinished at #{DateTime.now}" if @options.verbose
-      
+      process_arguments
+      puts "#{options.message} #{process_command}".strip
     else
-      output_usage
+      output_help
     end
-    
   end
   
   protected
   
-    def parsed_options?
+    def load_account_data
+      begin
+        account_data = YAML.load(File.read(ACCOUNT_FILE_PATH))
+      rescue
+        
+      end
+
+      if account_data
+        options.login = account_data["login"]
+        options.key = account_data["key"]
+      end
+    end
+    
+    def default_options
+      options.verbose = false
+      options.quiet = false
+    end
+    
+    def process_options
+      default_options
       
-      # Specify options
       opts = OptionParser.new 
       
-      opts.on('-s', '--shorten')       { @options.shorten = true }
-      opts.on('-e', '--expand')        { @options.expand = true }
-      opts.on('-u', '--user-clicks')   { @options.user_clicks = true }
-      opts.on('-g', '--global-clicks') { @options.global_clicks = true }
+      opts.on('-s', '--shorten')       { options.shorten = true; options.message = 'Short url:' }
+      opts.on('-e', '--expand')        { options.expand = true; options.message = 'Original url:' }
+      opts.on('-u', '--user-clicks')   { options.user_clicks = true; options.message = 'User clicks:' }
+      opts.on('-g', '--global-clicks') { options.global_clicks = true; options.message = 'Global clicks:' }
+      
+      opts.on('-l', '--login LOGIN')  { |login| options.login = login }
+      opts.on('-k', '--key KEY')      { |key| options.key = key }
       
       opts.on('-v', '--version')    { output_version ; exit 0 }
       opts.on('-h', '--help')       { output_help }
-      opts.on('-V', '--verbose')    { @options.verbose = true }
-      opts.on('-q', '--quiet')      { @options.quiet = true }
-
-      opts.parse!(@arguments) rescue return false
-
-      process_options
-      true      
-    end
-
-    # Performs post-parse processing on options
-    def process_options
-      @options.verbose = false if @options.quiet
+      opts.on('-V', '--verbose')    { options.verbose = true }
+      opts.on('-q', '--quiet')      { options.quiet = true; options.verbose = false;  options.message = '' }
+      
+      post_process_options
+      
+      opts.parse!(arguments) rescue return false
     end
     
+    def post_process_options
+      # Bitly API Login / Key
+      load_account_data unless options.login and options.key
+      
+      # Default option: --shorten
+      options.shorten = true unless options.expand or options.user_clicks or options.global_clicks
+    end
+
     def output_options
       puts "Options:\n"
       
-      @options.marshal_dump.each do |name, val|        
+      options.marshal_dump.each do |name, val|        
         puts "  #{name} = #{val}"
       end
+      
+      puts "  URL: #{arguments.first}\n"
     end
 
-    # True if required arguments were provided
     def arguments_valid?
-      @arguments.length == 1 and (@options.shorten or @options.expand or @options.user_clicks or @options.global_clicks)
+      arguments.length == 1
     end
     
-    # Setup the arguments
     def process_arguments
     end
     
@@ -93,21 +106,17 @@ class App
       Readme::usage() #exits app
     end
     
-    def output_usage
-      Readme::usage('usage') # gets usage from comments above
-    end
-    
     def output_version
-      puts "#{File.basename(__FILE__)} version #{VERSION}"
+      puts "bitly version #{VERSION.chomp} [gem ruby-bitly]"
     end
     
     def process_command
-      return Bitly.shorten(@arguments[0]).short_url if @options.shorten
-      return Bitly.expand(@arguments[0]).long_url if @options.expand
-      return Bitly.clicks(@arguments[0]).user_clicks.to_s if @options.user_clicks
-      return Bitly.clicks(@arguments[0]).global_clicks.to_s if @options.global_clicks
+      return Bitly.shorten(arguments.first, options.login, options.key).url if options.shorten
+      return Bitly.expand(arguments.first, options.login, options.key).long_url if options.expand
+      return Bitly.get_clicks(arguments.first, options.login, options.key).user_clicks.to_s if options.user_clicks
+      return Bitly.get_clicks(arguments.first, options.login, options.key).global_clicks.to_s if options.global_clicks
     end
 end
 
-app = App.new(ARGV, STDIN)
+app = App.new(ARGV)
 app.run

data/lib/ruby-bitly.rb

@@ -2,137 +2,44 @@ require 'rubygems'
 require 'yaml'
 require 'restclient'
 require 'json'
+require 'ostruct'
 
-class Bitly
+class Bitly < OpenStruct
   
-  attr_reader :response, :status_code, :status_txt, :new_hash, :global_hash, :user_hash, :hash, :response, :long_url, :short_url, :global_clicks, :user_clicks
-  
-  PERSONAL_FILE_PATH = "#{ENV['HOME']}/.bitly"
   REST_API_URL = "http://api.bit.ly"
   ACTION_PATH = { :shorten => '/v3/shorten', :expand => '/v3/expand', :clicks => '/v3/clicks' }
-  
-  def initialize
-    @read_only = false
-  end
-  
-  def read_only?
-    @read_only
-  end
-  
-  def long_url=(url)
-    @long_url = url unless read_only?
-  end
-
-  def short_url=(url)
-    @short_url = url unless read_only?
-  end
-  
-  def Bitly.load_personal_data
-    personal_data = YAML.load(File.read(PERSONAL_FILE_PATH))
     
-    if personal_data
-      @@login = personal_data["login"]
-      @@key = personal_data["key"]
-      personal_data
-    end
-  end
-  
-  def read_only_now!
-    @read_only = true
-  end
-  
-  def shorten
-    unless read_only?
-      if @response = Bitly.post_shorten(@long_url)
-        
-        @status_code = @response["status_code"]
-        @status_txt = @response["status_txt"]
-        @long_url = @response["data"]["long_url"]
-        @new_hash = @response["data"]["new_hash"]
-        @global_hash = @response["data"]["global_hash"]
-        @hash = @response["data"]["hash"]
-        @short_url = @response["data"]["url"]
-        
-        read_only_now!
-      end
-    end
-  end
-  
-  def expand
-    if @response = Bitly.post_expand(@short_url)
+  def Bitly.shorten(new_long_url, login, key)
+    response = JSON.parse RestClient.post(REST_API_URL + ACTION_PATH[:shorten], { :longURL => new_long_url, :login => login, :apiKey => key })
     
-      @long_url = @response["data"]["expand"].first["long_url"]
-      @global_hash = @response["data"]["expand"].first["global_hash"]
-      @user_hash = @response["data"]["expand"].first["user_hash"]
-      @status_code = @response["status_code"]
-      @status_txt = @response["status_txt"]
-      
-      read_only_now!
-    end
-  end
-  
-  def clicks
-    if @response = Bitly.get_clicks(@short_url)
+    bitly = Bitly.new response["data"]
     
-      @global_clicks = @response["data"]["clicks"].first["global_clicks"]
-      @user_clicks = @response["data"]["clicks"].first["user_clicks"]
-      @global_hash = @response["data"]["clicks"].first["global_hash"]
-      @user_hash = @response["data"]["clicks"].first["user_hash"]
-      @status_code = @response["status_code"]
-      @status_txt = @response["status_txt"]
+    bitly.hash_path = response["data"]["hash"] if response["status_code"] == 200
+    bitly.status_code = response["status_code"]
+    bitly.status_txt = response["status_txt"]
 
-      read_only_now!
-    end
+    bitly
   end
   
-  def Bitly.request
-    Bitly.load_personal_data
+  def Bitly.expand(new_short_url, login, key)
+    response = JSON.parse RestClient.post(REST_API_URL + ACTION_PATH[:expand], { :shortURL => new_short_url, :login => login, :apiKey => key })
     
-    begin
-      response = yield
-      JSON.parse(response)
-    rescue
-      response[:error] = "error"
-    end
-  end
-  
-  def Bitly.post_shorten(new_long_url)
-    Bitly.request do
-      RestClient.post(REST_API_URL + ACTION_PATH[:shorten], { :longURL => new_long_url, :login => @@login, :apiKey => @@key })
-    end
-  end
-  
-  def Bitly.post_expand(new_short_url)
-    Bitly.request do
-      RestClient.post(REST_API_URL + ACTION_PATH[:expand], { :shortURL => new_short_url, :login => @@login, :apiKey => @@key })
-    end
-  end
-  
-  def Bitly.get_clicks(new_short_url)
-    Bitly.request do
-      RestClient.get("#{REST_API_URL}#{ACTION_PATH[:clicks]}?login=#{@@login}&apiKey=#{@@key}&shortUrl=#{new_short_url}")
-      # RestClient.get(REST_API_URL + ACTION_PATH[:clicks], { :login => @@login, :apiKey => @@key, :shortUrl => new_short_url })
-    end
-  end
+    bitly = Bitly.new(response["data"]["expand"].first)
+    bitly.status_code = response["status_code"]
+    bitly.status_txt = response["status_txt"]
+    bitly.long_url = bitly.error if bitly.error
     
-  def Bitly.shorten(new_long_url)
-    bitly = Bitly.new
-    bitly.long_url = new_long_url
-    bitly.shorten
     bitly
   end
   
-  def Bitly.expand(new_short_url)
-    bitly = Bitly.new
-    bitly.short_url = new_short_url
-    bitly.expand
-    bitly
-  end
-  
-  def Bitly.clicks(new_short_url)
-    bitly = Bitly.new
-    bitly.short_url = new_short_url
-    bitly.clicks
+  def Bitly.get_clicks(new_short_url, login, key)
+    response = JSON.parse RestClient.get("#{REST_API_URL}#{ACTION_PATH[:clicks]}?login=#{login}&apiKey=#{key}&shortUrl=#{new_short_url}")
+    # response = JSON.parse RestClient.get(REST_API_URL + ACTION_PATH[:clicks], { :login => login, :apiKey => key, :shortUrl => new_short_url })
+
+    bitly = Bitly.new(response["data"]["clicks"].first)
+    bitly.status_code = response["status_code"]
+    bitly.status_txt = response["status_txt"]
+    
     bitly
   end
 end

data/ruby-bitly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-bitly}
-  s.version = "0.0.9"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rafaeldx7"]
-  s.date = %q{2010-08-04}
+  s.date = %q{2010-08-10}
   s.default_executable = %q{bitly}
   s.description = %q{This is a simple bit.ly ruby client}
   s.email = %q{rafaeldx7@gmail.com}
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

data/spec/ruby-bitly_spec.rb

@@ -2,188 +2,57 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "RubyBitly" do
   
-  it "Load personal data from ~/.bitly" do
-    file_data = Bitly.load_personal_data
-    file_data["key"].should_not be_empty
-    file_data["login"].should_not be_empty
+  before(:all) do
+    @login = 'rafaeldx7'
+    @key = 'R_59c1b174b21d92b2beeb4787a6d7ebaf'
   end
-  
-  it "Shorten log url staticaly and return a hash" do
-    response = Bitly.post_shorten "http://google.com"
-  
-    response["status_code"].should == 200
-    response["status_txt"].should == "OK"
-    response["data"]["new_hash"].should == 0
-    response["data"]["global_hash"].should == "zzzzzzz"
-    response["data"]["hash"].length.should_not == 0
-    response["data"]["url"].should match /^http:\/\/bit\.ly\/[A-Za-z0-9]*/
-  end
-  
-  it "Shorten log url with an object" do
-    url = Bitly.new
-    url.long_url = "http://google.com"
-    url.shorten
-    
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-    url.new_hash.should == 0
-    url.global_hash == "zzzzzzz"
-    url.hash.length.should_not == 0
-    url.short_url.should match /^http:\/\/bit\.ly\/[A-Za-z0-9]*/
-  end
-  
-  it "Expand short url to long url staticaly and return a hash" do
-    Bitly.post_expand("http://bit.ly/bcvNe5").should == { "data"=> 
-                                                            { "expand" => [ 
-                                                              { "long_url" => "http://google.com",
-                                                                "short_url" => "http://bit.ly/bcvNe5",
-                                                                "global_hash" => "zzzzzzz", 
-                                                                "user_hash" => "bcvNe5"}]
-                                                              }, 
-                                                          "status_txt" => "OK", 
-                                                          "status_code" => 200
-                                                        }
-  end
-  
-  it "Expand short url to long url with an object" do
-    url = Bitly.new
-    url.short_url = "http://bit.ly/bcvNe5"
-    url.expand
-  
-    url.long_url.should == "http://google.com"
-    url.short_url.should == "http://bit.ly/bcvNe5"
-    url.global_hash.should == "zzzzzzz"
-    url.user_hash.should == "bcvNe5"
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-  end
-  
-  it "Update object as read only" do
-    url = Bitly.new
-    url.read_only?.should be false
-    url.read_only_now!
-    url.read_only?.should be true
-  end
-  
-  it "Shorten url and return an object" do
-    url = Bitly.shorten("http://google.com")
-    url.should be_an_instance_of(Bitly)
-  
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-    url.long_url.should == "http://google.com"
-    url.new_hash.should == 0
-    url.global_hash.should == "zzzzzzz"
-    url.hash.should match /^[A-Za-z0-9]*$/
-    url.short_url.should match /^http:\/\/bit\.ly\/[A-Za-z0-9]*/
-  end
-  
-  it "New bitly object should be not read only" do
-    url = Bitly.new
-    url.read_only?.should be false
-  end
-  
-  it "Shortened object should be read only" do
-    url = Bitly.shorten "http://google.com"
-    url.read_only?.should be true
-  end
-  
-  it "Expanded object should be read only" do
-    url = Bitly.expand "http://bit.ly/bcvNe5"
-    url.read_only?.should be true
-  end
-  
-  it "Stats object should be read only" do
-    url = Bitly.clicks "http://bit.ly/bcvNe5"
-    url.read_only?.should be true
-  end
-  
-  it "Attribute long_url should be updatable when object is not read only" do
-    url = Bitly.new
-    url.long_url = "http://google.com"
-    url.long_url.should == "http://google.com"
+
+  it "Shorten long url" do
+    response = Bitly.shorten("http://google.com", @login, @key)
     
-    url.long_url = "http://xlii.com.br"
-    url.long_url.should == "http://xlii.com.br"
+    response.status_code.should == 200
+    response.status_txt.should == "OK"
+    response.new_hash.should == 0
+    response.global_hash.should == "zzzzzzz"
+    response.hash_path.length.should_not == 0
+    response.url.should match /^http:\/\/bit\.ly\/[A-Za-z0-9]*/
   end
   
-  it "Attribute long_url should not be updatable when object is read only" do
-    url = Bitly.new
-    url.long_url = "http://google.com"
-    url.long_url.should == "http://google.com"
-    url.read_only_now!
+  it "Shorten bitly url" do
+    response = Bitly.shorten("http://bit.ly/bcvNe5", @login, @key)
     
-    url.long_url = "http://xlii.com.br"
-    url.long_url.should == "http://google.com"
-  end
-  
-  it "Expand url and return an object" do
-    url = Bitly.expand "http://bit.ly/bcvNe5"
-    url.should be_an_instance_of(Bitly)
-  
-    url.long_url.should == "http://google.com"
-    url.short_url.should == "http://bit.ly/bcvNe5"
-    url.global_hash.should == "zzzzzzz"
-    url.user_hash.should == "bcvNe5"
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-  end
-  
-  it "Get clicks and return an object" do
-    url = Bitly.clicks "http://bit.ly/xlii42"
-    url.should be_an_instance_of(Bitly)
-  
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-    url.global_clicks.should be_an_instance_of Fixnum
-    url.user_clicks.should be_an_instance_of Fixnum
-    url.short_url.should == "http://bit.ly/xlii42"
-    url.global_hash == "cunZEP"
-    url.user_hash.should == "cT1Izu"
+    response.status_code.should == 500
   end
-  
-  it "Attribute short_url should be updated when object is not read only" do
-    url = Bitly.new
-    url.short_url = "http://bit.ly/bcvNe5"
-    url.short_url.should == "http://bit.ly/bcvNe5"
+
+  it "Expand a short url to it long url" do
+    response = Bitly.expand("http://bit.ly/bcvNe5", @login, @key)
     
-    url.short_url = "http://bit.ly/xlii42"
-    url.short_url.should == "http://bit.ly/xlii42"
+    response.status_code.should == 200
+    response.status_txt.should == "OK"
+    response.long_url.should == "http://google.com"
+    response.short_url.should == "http://bit.ly/bcvNe5"
+    response.user_hash.should == "bcvNe5"
   end
-  
-  it "Attribute short_url should not be updated when object is read only" do
-    url = Bitly.new
-    url.short_url = "http://bit.ly/xlii42"
-    url.short_url.should == "http://bit.ly/xlii42"
-    url.read_only_now!
+
+  it "Expand a long url should result an error" do
+    response = Bitly.expand("http://google.com", @login, @key)
     
-    url.short_url = "http://bit.ly/bcvNe5"
-    url.short_url.should == "http://bit.ly/xlii42"
+    response.status_code.should == 200
+    response.status_txt.should == "OK"
+    response.long_url.should == "NOT_FOUND"
+    response.short_url.should == "http://google.com"
   end
+
   
   it "Get clicks by short_url" do
-    bitly = Bitly.get_clicks("http://bit.ly/xlii42")
-    
-    bitly["status_txt"].should == "OK"
-    bitly["status_code"].should == 200
-    bitly["data"]["clicks"].first["global_clicks"].should be_an_instance_of Fixnum
-    bitly["data"]["clicks"].first["user_clicks"].should be_an_instance_of Fixnum
-    bitly["data"]["clicks"].first["short_url"].should == "http://bit.ly/xlii42"
-    bitly["data"]["clicks"].first["global_hash"].should == "cunZEP"
-    bitly["data"]["clicks"].first["user_hash"].should == "cT1Izu"
-  end
-  
-  it "Clicks with an object" do
-    url = Bitly.new
-    url.short_url = "http://bit.ly/xlii42"
-    url.clicks
+    bitly = Bitly.get_clicks("http://bit.ly/xlii42", @login, @key)
     
-    url.status_code.should == 200
-    url.status_txt.should == "OK"
-    url.global_clicks.should be_an_instance_of Fixnum
-    url.user_clicks.should be_an_instance_of Fixnum
-    url.short_url.should == "http://bit.ly/xlii42"
-    url.global_hash == "cunZEP"
-    url.user_hash.should == "cT1Izu"
+    bitly.status_txt.should == "OK"
+    bitly.status_code.should == 200
+    bitly.global_clicks.should be_an_instance_of Fixnum
+    bitly.user_clicks.should be_an_instance_of Fixnum
+    bitly.short_url.should == "http://bit.ly/xlii42"
+    bitly.global_hash.should == "cunZEP"
+    bitly.user_hash.should == "cT1Izu"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-bitly
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - rafaeldx7
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-04 00:00:00 -03:00
+date: 2010-08-10 00:00:00 -03:00
 default_executable: bitly
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,6 +94,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile