corto 0.80.1 → 0.80.2

data/README

@@ -7,8 +7,63 @@ CORTO - your url shortner gem
 	Why the world needs another url shortener? Well, true to be told I don't know the answer and I'm 
 	pretty sure this code is far away from being revolutionary.
 	
-	However... it's fun!
+	However... corto is funniest!
 
+- Usage
+	
+	Using corto as standalone utility is straightforward. In case you want to shorten an url you just 
+	launch the program with the url as parameter.
+	
+		% bin/corto http://www.armoredcode.com
+		% corto: http://www.armoredcode.com shrunk as ji5jnu
+	
+	Please note that you've to supply a valid URL, since internally it's parsed and rejected anything but
+	HTTP and HTTPS verbs.
+	
+		% bin/corto funnystatementhere
+		% corto: it seems funnystatementhere is not a valid url to shrink
+	
+	If you want to deflate a shrunk url, you have just to specify the '-d' flag this way.
+		
+		% bin/corto -d ji5jnu
+		% corto: ji5jnu deflated is http://www.armoredcode.com
+
+	Super easy, isn't it? Now, go ahead and shrink the web!
+	
+- API
+
+	A simple corto shortening session start with class initialization, optionally telling which SQLite3 
+	database to use and then mastering the parameter.
+	
+		require 'corto'
+		
+		...
+		corto = Corto.new # we're now saying the gem we want to use it's internal database stored in db/corto.db
+		s = corto.shrink('http://www.armoredcode.com')
+	
+		# s now stores the shrinked url that is already added to database if not present.
+		# If you'll pass an invalid url to shrink(), nil will be returned instead
+	
+	Deflating a URL is super easy as well
+	
+		# The deflate process is quite straightforward as well
+		
+		d = corto.deflate(s)
+		# d has now the deflated url or nil if that url was not found
+	
+	You can also count how many urls contained into db
+		
+		# If you want to know how many urls you have in your database, just call the count() method.
+		puts 'Hey, I have stored ' + corto.count() + ' urls'
+	
+	And finally you can purge your db
+		
+		# Tired of your database and time for a massive clean has come? Let's purge the db.
+		corto.purge
+		
+		# corto.count == 0 now
+		 
+	
 - Note on Patches/Pull Requests
 
 	* Fork the project.

data/VERSION

@@ -1 +1 @@
-0.80.1
+0.80.2

data/bin/corto

@@ -53,7 +53,7 @@ corto = Corto.new
 if (shrink)
   s = corto.shrink(ARGV[0])
   if (!s.nil?) 
-    puts 'corto: ' + ARGV[0] + ' shrinked as ' + s
+    puts 'corto: ' + ARGV[0] + ' shrunk as ' + s
   else
     puts 'corto: it seems ' + ARGV[0] + ' is not a valid url to shrink'
   end
@@ -62,7 +62,7 @@ else
   if (!s.nil?) 
     puts 'corto: ' + ARGV[0] + ' deflated is ' + s
   else
-    puts 'corto: it seems ' + ARGV[0] + ' is not a known shrinked url'
+    puts 'corto: it seems ' + ARGV[0] + ' is not a known shrunk url'
   end
 end
 

data/lib/corto.rb

@@ -45,9 +45,9 @@ class Corto
     url.hash.abs.to_s(36)
   end
   
-  def deflate(shrinked_url)
+  def deflate(shrunk_url)
     @db = SQLite3::Database.new(@db_name)
-    result = @db.execute("SELECT original FROM urls WHERE url='" +shrinked_url+"'")
+    result = @db.execute("SELECT original FROM urls WHERE url='" +shrunk_url+"'")
     (! result.first.nil?) ? result.first.first : nil
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: corto
 version: !ruby/object:Gem::Version 
-  hash: 349
+  hash: 347
   prerelease: false
   segments: 
   - 0
   - 80
-  - 1
-  version: 0.80.1
+  - 2
+  version: 0.80.2
 platform: ruby
 authors: 
 - Paolo Perego
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
+date: 2011-02-11 00:00:00 +01:00
 default_executable: corto
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,7 +84,60 @@ description: "CORTO - your url shortner gem\n\
   \tWhy the world needs another url shortener? Well, true to be told I don't know the answer and I'm \n\
   \tpretty sure this code is far away from being revolutionary.\n\
   \t\n\
-  \tHowever... it's fun!\n\n\
+  \tHowever... corto is funniest!\n\n\
+  - Usage\n\
+  \t\n\
+  \tUsing corto as standalone utility is straightforward. In case you want to shorten an url you just \n\
+  \tlaunch the program with the url as parameter.\n\
+  \t\n\
+  \t\t% bin/corto http://www.armoredcode.com\n\
+  \t\t% corto: http://www.armoredcode.com shrunk as ji5jnu\n\
+  \t\n\
+  \tPlease note that you've to supply a valid URL, since internally it's parsed and rejected anything but\n\
+  \tHTTP and HTTPS verbs.\n\
+  \t\n\
+  \t\t% bin/corto funnystatementhere\n\
+  \t\t% corto: it seems funnystatementhere is not a valid url to shrink\n\
+  \t\n\
+  \tIf you want to deflate a shrunk url, you have just to specify the '-d' flag this way.\n\
+  \t\t\n\
+  \t\t% bin/corto -d ji5jnu\n\
+  \t\t% corto: ji5jnu deflated is http://www.armoredcode.com\n\n\
+  \tSuper easy, isn't it? Now, go ahead and shrink the web!\n\
+  \t\n\
+  - API\n\n\
+  \tA simple corto shortening session start with class initialization, optionally telling which SQLite3 \n\
+  \tdatabase to use and then mastering the parameter.\n\
+  \t\n\
+  \t\trequire 'corto'\n\
+  \t\t\n\
+  \t\t...\n\
+  \t\tcorto = Corto.new # we're now saying the gem we want to use it's internal database stored in db/corto.db\n\
+  \t\ts = corto.shrink('http://www.armoredcode.com')\n\
+  \t\n\
+  \t\t# s now stores the shrinked url that is already added to database if not present.\n\
+  \t\t# If you'll pass an invalid url to shrink(), nil will be returned instead\n\
+  \t\n\
+  \tDeflating a URL is super easy as well\n\
+  \t\n\
+  \t\t# The deflate process is quite straightforward as well\n\
+  \t\t\n\
+  \t\td = corto.deflate(s)\n\
+  \t\t# d has now the deflated url or nil if that url was not found\n\
+  \t\n\
+  \tYou can also count how many urls contained into db\n\
+  \t\t\n\
+  \t\t# If you want to know how many urls you have in your database, just call the count() method.\n\
+  \t\tputs 'Hey, I have stored ' + corto.count() + ' urls'\n\
+  \t\n\
+  \tAnd finally you can purge your db\n\
+  \t\t\n\
+  \t\t# Tired of your database and time for a massive clean has come? Let's purge the db.\n\
+  \t\tcorto.purge\n\
+  \t\t\n\
+  \t\t# corto.count == 0 now\n\
+  \t\t \n\
+  \t\n\
   - Note on Patches/Pull Requests\n\n\
   \t* Fork the project.\n\
   \t* Make your feature addition or bug fix.\n\