page_speed 0.1.3 → 0.1.4

data/.rspec

@@ -0,0 +1 @@
+--colour

data/README.md

@@ -17,7 +17,11 @@ Simply install the gem:
 Usage
 -----
 
-Just execute it against any website you can imagine:
+You have to get your API key first through [here](http://code.google.com/intl/en-EN/apis/pagespeedonline/v1/getting_started.html), then set it to the gem:
+
+    page_speed -k YOUR_KEY
+
+After that, just execute page_speed against any website you can imagine:
 
     page_speed URL
 

data/bin/page_speed

@@ -4,9 +4,34 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'page_speed'
 
-unless ARGV.length == 1 && URL = ARGV[0]
-  puts "There has been an error. Please check your URL."
+if ARGV.length == 2
+  arg1, api_key = ARGV[0..1]
+  if arg1 == "-k"
+    PageSpeed::set_api_key(api_key)
+    puts "API key set."
+    exit
+  end
+end
+
+unless PageSpeed::api_key_exists?
+  puts "API key not set. Use the -k option to set the key."
+  puts ""
+  PageSpeed::help
   exit
 end
 
-PageSpeed::analyze(URL)
+case ARGV.length
+  when 1
+    arg1 = ARGV[0]
+    case arg1
+      when "-v", "--version"
+        PageSpeed::version
+      when "-h", "--help"
+        PageSpeed::help
+      else
+        PageSpeed::analyze(arg1)
+    end
+  else
+    puts "Please check your syntax.\n"
+    PageSpeed::help
+end

data/lib/page_speed/version.rb

@@ -1,3 +1,3 @@
 module PageSpeed
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/page_speed.rb

@@ -3,7 +3,6 @@ require "page_speed/version"
 require 'json'
 require 'open-uri'
 
-API_KEY = "AIzaSyB-WW7oKAfD0T9cLGMufjiWA1mtLwDd4hg"
 API_URL = "https://www.googleapis.com/pagespeedonline/v1/runPagespeed"
 
 module PageSpeed
@@ -18,8 +17,54 @@ module PageSpeed
 
         # Show results
         show_results(uri, desktop, mobile)
+
+      rescue URI::InvalidURIError
+        puts "Please check your URL and try again."
+
+      rescue OpenURI::HTTPError
+        puts "The API you used is not correct. Use the -k option to replace it."
+        puts ""
+        reset_api_key
+        help
+
+      rescue Exception => e
+        puts "There has been an unexpected error:"
+        puts e.message
+        puts e.backtrace.inspect
+      end
+    end
+
+    def help
+      version
+      usage
+    end
+
+    def version
+      puts "page_speed gem, version #{PageSpeed::VERSION}\n"
+    end
+
+    def usage
+      puts "usage: page_speed url | [ -k key | --key key ] | [ -v | --version ] | [ -h | --help ]"
+      puts "You can get your key at http://code.google.com/intl/en-EN/apis/pagespeedonline/v1/getting_started.html"
+    end
+
+    def set_api_key(key)
+      File.open(api_key_path, "w") {|f| f.write(key) }
+    end
+
+    def get_api_key
+      file = File.new(api_key_path, "r")
+      api_key = file.gets
+      file.close
+      api_key
+    end
+
+    def api_key_exists?
+      begin
+        get_api_key
+        true
       rescue Exception
-        puts "There has been an error. Please check your URL."
+        false
       end
     end
 
@@ -30,30 +75,30 @@ module PageSpeed
         url = "http://#{url}"
       end
       uri = URI.parse(url)
-      uri.open
+      uri.open # ping URL; will raise a URI::InvalidURIError when failing
       uri
     end
 
-    def scores_for(uri, opts = {})
-      desktop = score_for(uri, true)
-      mobile = score_for(uri, false)
+    def scores_for(uri)
+      desktop = score_for(uri, :desktop => true)
+      mobile = score_for(uri, :desktop => false)
       [desktop, mobile]
     end
 
-    def score_for(uri, is_desktop)
-      json = api_request(uri, is_desktop)
+    def score_for(uri, opts)
+      json = api_request(uri, opts)
       parse_score(json)
     end
 
-    def api_request(uri, is_desktop)
-      # Get options
-      strategy =
+    def api_request(uri, opts = {})
+      # Merge options
+      opts = {:desktop => true}.merge(opts)
 
       # Get URL for API
       params = {}
       params["url"] = uri
-      params["key"] = API_KEY
-      params["strategy"] = is_desktop ? "desktop" : "mobile"
+      params["key"] = get_api_key
+      params["strategy"] = opts[:desktop] ? "desktop" : "mobile"
       params_str = params.map{|k,v| "#{k}=#{v}" }.join("&")
 
       # Send request and return JSON
@@ -69,5 +114,18 @@ module PageSpeed
     def show_results(url, desktop, mobile)
       puts "Google Page Speed for #{url}: #{desktop} (Desktop) / #{mobile} (Mobile)"
     end
+
+    def reset_api_key
+      File.delete(api_key_path)
+    end
+
+    def api_key_path
+      dir = testing ? "/tmp" : File.expand_path("~")
+      dir + "/.page_speed"
+    end
+
+    def testing
+      ! defined?(ENV['page_speed_env']).nil? && ENV['page_speed_env'] == "test"
+    end
   end
 end

data/spec/integration/page_speed_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+ENV['page_speed_env'] = "test"
+API_KEY = "AIzaSyCT0PgAW-FjLF0Nfx81DqU6laCSiXkIHFs"
+
+describe PageSpeed do
+  before do
+    File.open("/tmp/.page_speed", 'w') {|f| f.write(API_KEY) } # Use a correct API KEY
+  end
+
+  it "should point to help when no parameter is provided" do
+    result = `bin/page_speed`
+    result.should include("Please check your syntax")
+    result.should include("usage: page_speed")
+  end
+
+  context "version" do
+    it "should be shown with -v" do
+      result = `bin/page_speed -v`
+      result.should include(PageSpeed::VERSION)
+    end
+
+    it "should be shown with --version" do
+      result = `bin/page_speed --version`
+      result.should include(PageSpeed::VERSION)
+    end
+  end
+
+  context "help" do
+    it "should be shown with -h" do
+      result = `bin/page_speed -h`
+      result.should include("usage: page_speed")
+    end
+
+    it "should be shown with --help" do
+      result = `bin/page_speed --help`
+      result.should include("usage: page_speed")
+    end
+  end
+
+  context "analyzer" do
+    it "should fail with a number as a parameter" do
+      result = `bin/page_speed 42`
+      result.should include("Please check your URL and try again")
+    end
+
+    it "should fail with a bad string as a parameter" do
+      result = `bin/page_speed do_the_cuca`
+      result.should include("Please check your URL and try again")
+    end
+
+    it "should success with a URL without www" do
+      result = `bin/page_speed google.com`
+      result.should include("Google Page Speed for http://google.com: 98 (Desktop) / 96 (Mobile)")
+    end
+
+    it "should success with a URL with www" do
+      result = `bin/page_speed www.facebook.com`
+      result.should include("Google Page Speed for http://www.facebook.com: 99 (Desktop) / 99 (Mobile)")
+    end
+  end
+
+  context "API key control" do
+    it "should prompt the API key when is not found" do
+      File.delete("/tmp/.page_speed")
+      result = `bin/page_speed google.com`
+      result.should include("PI key not set. Use the -k option to set the key.")
+    end
+
+    context "when API key is corrupted" do
+      before do
+        File.open("/tmp/.page_speed", 'w') {|f| f.write(API_KEY.chop) } # Use a corrupt API KEY
+        @result = `bin/page_speed google.com`
+      end
+
+      it "should prompt about it" do
+        @result.should include("The API you used is not correct.")
+      end
+
+      it "should have deleted the file where the API key is and ask for a new one" do
+        @result = `bin/page_speed google.com`
+        @result.should include("PI key not set. Use the -k option to set the key.")
+      end
+    end
+  end
+
+  context "key" do
+
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: page_speed
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Albert Bellonch
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-21 00:00:00 +02:00
+date: 2011-09-26 00:00:00 +02:00
 default_executable: page_speed
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
 - README.md
@@ -54,7 +55,7 @@ files:
 - lib/page_speed.rb
 - lib/page_speed/version.rb
 - page_speed.gemspec
-- spec/integration/pagespeed_spec.rb
+- spec/integration/page_speed_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://itnig.net
@@ -85,5 +86,5 @@ signing_key:
 specification_version: 3
 summary: A simple port for Google Page Speed's scores
 test_files: 
-- spec/integration/pagespeed_spec.rb
+- spec/integration/page_speed_spec.rb
 - spec/spec_helper.rb

data/spec/integration/pagespeed_spec.rb

@@ -1,4 +0,0 @@
-require 'spec_helper'
-
-describe PageSpeed do
-end