google_url_shortener 0.0.4 → 0.0.5

data/USAGE

@@ -0,0 +1,10 @@
+Google URL Shortener
+
+Examples:
+
+  googl install myapikey
+  googl {shorten,s} http://example.com
+  googl {expand,e} http://goo.gl/1234
+  googl expand http://goo.gl/1234 -a
+
+Options:

data/bin/googl

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby
+require 'google_url_shortener'
+require 'google/url_shortener/cli'
+
+runner = Google::UrlShortener::CLI.new(ARGV)
+runner.run!

data/google_url_shortener.gemspec

@@ -5,6 +5,7 @@ Gem::Specification.new do |s|
   s.name        = "google_url_shortener"
   s.version     = Google::UrlShortener::VERSION
   s.platform    = Gem::Platform::RUBY
+  s.executables = %w{ googl }
   s.authors     = ["Josh Nesbitt"]
   s.email       = ["josh@josh-nesbitt.net"]
   s.homepage    = "http://rubygems.org/gems/google_url_shortener"
@@ -15,6 +16,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "google_url_shortener"
   s.add_dependency "json", "1.4.6"
   s.add_dependency "rest-client", "1.6.1"
+  s.add_dependency('trollop', '1.16.2')
   s.add_development_dependency "bundler", ">= 1.0.0"
   
   s.files        = `git ls-files`.split("\n")

data/lib/google/url_shortener/cli.rb

@@ -0,0 +1,122 @@
+require 'trollop'
+module Google
+  module UrlShortener
+    class CLI
+      KEY_FILE = ".googl"
+      KEY_PATH = "#{ENV["HOME"]}/#{KEY_FILE}"
+      attr_reader :key, :options
+      
+      def initialize(args)
+        @options = parse!(args)
+      end
+      
+      def run!
+        command = self.options[:command].to_sym
+        args    = self.options[:args]
+        
+        unless [:install].include?(command)
+          validate_key!
+        end
+        
+        case command
+        when :shorten, :s
+          url   = validate!(:url, args.first)
+          short = UrlShortener.shorten!(url)
+          
+          log(short)
+        when :expand, :e
+          short = validate!(:url, args.first)
+          url   = Url.new(:short_url => short)
+          url.expand!
+          
+          out = [url.long_url]
+          
+          if self.options[:analytics]
+            out << decode_analytics(url)
+            out.flatten!
+          end
+          
+          log(out)
+       when :install
+         key = validate!(:key, args.first)
+         
+         install_key!(key)
+         log "+ Installed key '#{key}' to #{KEY_PATH}"
+        else
+          die("unknown command '#{self.options[:command]}'")
+        end
+      end
+      
+      private
+      def decode_analytics(url)
+        out = [""]
+        groups = [:all, :month, :week, :day, :two_hours]
+        sub_groups = [:short_url_clicks, :long_url_clicks, :referrers, :countries, :browsers, :platforms]
+        
+        groups.each do |g|
+          out << g.upcase
+          group = url.analytics.send(g)
+          
+          sub_groups.each do |s|
+            sub = group.send(s)
+            
+            if sub.is_a?(Hash)
+              out << "#{" " * 2}#{s}:"
+              out << sub.collect do |k, v|
+                "#{" " * 4}#{k}: #{v}"
+              end
+            else
+              out << "#{" " * 2}#{s}: #{sub}"
+            end
+          end
+          
+          out << ""
+        end
+        
+        out
+      end
+      
+      def parse!(args)
+        opts = Trollop::options(args) do
+          version VERSION
+          banner File.read("#{GEM_ROOT}/USAGE")
+          
+          opt :analytics, "Show analytics when expanding a URL", :short => "-a", :default => false
+        end
+        
+        opts.merge!(:command => args.shift)
+        opts.merge!(:args => args)
+        
+        die("missing parameter (command)") if opts[:command].nil?
+        
+        opts
+      end
+      
+      def install_key!(key)
+        File.open(KEY_PATH, 'w') {|f| f.write(key) }
+      end
+      
+      def validate_key!
+        if File.exists?(KEY_PATH)
+          @key = File.read(KEY_PATH)
+          
+          Base.api_key = @key
+        else
+          die("could not find API key. Please run the 'install' command to initialize.")
+        end
+      end
+      
+      def log(*things)
+        $stdout.puts(*things)
+      end
+      
+      def validate!(key, value)
+        value.nil? ? die("missing parameter (#{key})") : value
+      end
+      
+      def die(message)
+        Trollop::die(message)
+      end
+    end
+  end
+end

data/lib/google/url_shortener/errors.rb

@@ -9,6 +9,6 @@ module Google
       end
     end
     
-    class MissingApiKey < UrlShortenerError;end
+    class MissingApiKey < UrlShortenerError; end
   end
 end

data/lib/google/url_shortener/version.rb

@@ -1,6 +1,6 @@
 module Google
   module UrlShortener
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
     
   end
 end

data/readme.textile

@@ -3,13 +3,18 @@ h1. Google Url Shortener.
 * Overview
 * Installation
 * Usage
+* CLI
 * Bugs
 
 
 
 h2. Overview
 
-Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to review the analytics of a short URL.
+Google URL Shortener is a library to interact with the goo.gl URL shortener API. It provides:
+
+* A CLI to easily shorten/expand URL's
+* A clean API to handle shortening/expanding URL's in an application
+* An interface to view analytical data for any short URL
 
 
 
@@ -26,7 +31,7 @@ h2. Usage
 
 h3. Setup
 
-You need to provide an API key to use the URL shortener service. To do this set the @api_key@ class variable:
+You need to provide an API key (get one "here":https://code.google.com/apis/console) to use the URL shortener service. To do this set the @api_key@:
 
 pre. Google::UrlShortener::Base.api_key = "KEY"
 
@@ -83,6 +88,53 @@ two_hours
 
 E.g: @url.analytics.month@.
 
+
+
+h2. CLI
+
+
+h3. Basic usage
+
+There is also a CLI wrapper for Google URL Shortener. Firstly, you need to tell the CLI your API key (get one "here":https://code.google.com/apis/console):
+
+pre. googl install AIzaSyByl4x5CMcnm2rNWafmaUz5sljmzMWIgZ0
+
+This saves your API key in @~/.googl@.
+
+To shorten a URL:
+
+pre. googl shorten http://example.com
+googl s http://example.com
+
+To expand a URL:
+
+pre. googl expand http://goo.gl/1234
+googl e http://goo.gl/1234
+
+You can also get analytical data from a short URL using the @-a@ or @--analytics@ flag:
+
+pre. googl expand http://goo.gl/1234 -a
+
+
+h3. Tips
+
+You can use the CLI alonsgide something like @pbcopy@ to make shortening URL's crazy fast:
+
+pre. googl shorten http://example.com | pbcopy
+
+Also use a bash function to simplify it further:
+
+pre. shorten (){
+	googl shorten $1 | pbcopy
+	echo "$1 shortened and copied to clipboard"
+}
+
+Which can be used as:
+
+pre. shorten http://example.com
+
+
+
 h2. Bugs
 
 If you have any problems with Google Url Shortener, please file an "issue":http://github.com/joshnesbitt/google_url_shortener/issues.

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-14 00:00:00 +00:00
+date: 2011-01-19 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,9 +48,24 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: trollop
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -61,12 +76,12 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to review the analytics of a short URL.
 email: 
 - josh@josh-nesbitt.net
-executables: []
-
+executables: 
+- googl
 extensions: []
 
 extra_rdoc_files: []
@@ -77,11 +92,14 @@ files:
 - Gemfile.lock
 - LICENSE
 - Rakefile
+- USAGE
+- bin/googl
 - google_url_shortener.gemspec
 - lib/google/url_shortener.rb
 - lib/google/url_shortener/analytics.rb
 - lib/google/url_shortener/analytics_group.rb
 - lib/google/url_shortener/base.rb
+- lib/google/url_shortener/cli.rb
 - lib/google/url_shortener/errors.rb
 - lib/google/url_shortener/request.rb
 - lib/google/url_shortener/url.rb