pagespeed 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7ab645c3e17ee15826119bd35b8d4fd47049b96
+  data.tar.gz: 5b7892fc13b1a78e24dcf3cd98643ed39fd1f9d4
+SHA512:
+  metadata.gz: 80eefaf2ff3eea612a6e7c11ad327ed1f5531b18e59a7aa769e50da78ac12575990f6f2a23bcfc091b27880349a19aae733971753fdef62e43e5e02c57a4d33c
+  data.tar.gz: bf5eec7059b177e0a297e378b1bc423ebbe79c95891fa2868691c71107a14a709afc971ef36ac7a7d0efc068125795342f61af14ef72f4c4a86d23f980bb74a2

data/.rspec

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

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in pagespeed.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+end

data/README.md

@@ -1,34 +1,39 @@
-a ruby wrapper around the google pagespeed api
+A Ruby library for the Google PageSpeed API.
 
 ## Usage
 
-	> pagespeed add-key YOUR_API_KEY
-	> pagespeed blahed.com
-	
-	 100 - Make landing page redirects cacheable
-	 100 - Put CSS in the document head
-	 100 - Avoid CSS @import
-	  95 - Specify a character set
-	 100 - Serve scaled images
-	  97 - Minify JavaScript
-	   0 - Leverage browser caching
-	 100 - Optimize the order of styles and scripts
-	  95 - Defer parsing of JavaScript
-	 100 - Prefer asynchronous resources
-	 100 - Minimize redirects
-	  48 - Minify CSS
-	 100 - Inline Small CSS
-	 100 - Combine images into CSS sprites
-	 100 - Specify a cache validator
-	  50 - Inline Small JavaScript
-	   0 - Specify a Vary: Accept-Encoding header
-	 100 - Serve resources from a consistent URL
-	 100 - Remove query strings from static resources
-	 100 - Specify image dimensions
-	 100 - Minimize request size
-	 100 - Avoid bad requests
-	 100 - Optimize images
-	  58 - Minify HTML
-
-	Total Score: 77
-	
+### Command Line
+
+```bash
+$ pagespeed add-key YOUR_API_KEY
+$ pagespeed -u blahed.com
+  - Avoid landing page redirects
+  - Enable compression
+  - Leverage browser caching
+  - Reduce server response time
+  - Minify CSS
+  - Minify HTML
+  - Minify JavaScript
+  - Eliminate render-blocking JavaScript and CSS in above-the-fold content
+  - Optimize images
+  - Prioritize visible content
+
+Total Score: 87/100 (desktop)
+```
+
+### Ruby API
+
+```ruby
+require 'pagespeed'
+
+request = PageSpeed::Request.new("google.com", 'YOUR_API_KEY', 'desktop')
+request.pagespeed
+```
+
+## Contributers
+
+- [blahed][1]
+- [danriti][2]
+
+[1]: https://github.com/blahed
+[2]: https://github.com/danriti

data/Rakefile

@@ -1 +1,10 @@
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts "rspec no available"
+end
+
+task :default => ['spec']

data/lib/pagespeed/cli.rb

@@ -2,27 +2,30 @@ require 'optparse'
 
 module PageSpeed
   class CLI
-    
+
     class << self
       KEY_PATH = File.join(ENV['HOME'], '.pagespeed_api_key')
-      BANNER = <<-USAGE
-      Usage:
-        pagespeed google.com
-
-      Description:
-        pagespeed pulls in results for a given website from the google pagespeed api
-              
-      USAGE
-      
+
       # parse and set the options
-      def set_options
+      def set_options(args)
+        # set default options
+        options = {}
+        options['strategy'] = 'desktop'
+
         @opts = OptionParser.new do |opts|
-          opts.banner = BANNER.gsub(/^\s{4}/, '')
+          opts.banner = "Usage: pagespeed [url] [options]"
 
           opts.separator ''
 
+          opts.on( '-s', '--strategy [STRATEGY]', 'The strategy to use when analyzing the page. Valid values are \'desktop\' and \'mobile\'.') do |s|
+            if s == nil
+              print_usage_and_exit!
+            end
+            options['strategy'] = s
+          end
+
           opts.on('-v', '--version', 'Show the pagespeed version and exit') do
-            puts "dsync v#{PageSpeed::VERSION}"
+            puts "pagespeed v#{PageSpeed::VERSION}"
             exit
           end
 
@@ -30,17 +33,19 @@ module PageSpeed
             puts opts
             exit
           end
+
         end
 
-        @opts.parse!
+        @opts.parse!(args)
+        options
       end
-    
+
       # print out the options banner and exit
       def print_usage_and_exit!
         puts @opts
         exit
       end
-      
+
       # get the api key from ~/.pagespeed_api_key
       # if we can't find it, show a user how to get one
       def get_api_key
@@ -58,28 +63,27 @@ module PageSpeed
           exit
         end
       end
-      
+
       # save the api key at ~/.pagespeed_api_key
       def save_api_key(key)
         File.open(KEY_PATH, 'w') { |f| f.write(key) }
       end
-      
+
       # parse the options and make the pagespeed request
       def run!(argv)
-        set_options
-        
+        opts = set_options(argv)
+
         if argv.size == 1
           api_key = get_api_key
-          request = PageSpeed::Request.new(argv[0], api_key)
+          request = PageSpeed::Request.new(argv[0], api_key, opts['strategy'])
           request.pagespeed
         elsif argv.size == 2 && argv[0] == 'add-key'
           save_api_key(argv[1])
         else
           print_usage_and_exit!
         end
-        
       end
-      
-    end 
+
+    end
   end
 end

data/lib/pagespeed/parser.rb

@@ -3,38 +3,39 @@ require 'json'
 module PageSpeed
   class Parser
     class << self
-      
+
       # parse the response and print it real pretty
       def parse(result)
         result = JSON.parse(result)
         code   = result['responseCode']
         total_score = result['score']
-        
+        strategy = result['request']['strategy']
+
         fail(code, result['title']) unless code == 200
-        
+
         result['formattedResults']['ruleResults'].each do |name, rule|
           score = rule['ruleScore']
           colorize(score)
           puts " #{pad_score(score)} - #{rule['localizedRuleName']}"
         end
-        
+
         colorize(total_score)
-        puts " \nTotal Score: #{total_score}"
+        puts " \nTotal Score: #{total_score}/100 (#{strategy})"
         decolorize
       end
-      
+
       private
-      
+
       # fail with the appropriate code/message
       def fail(code, title)
         puts "\033[31m#{title}\033[0m"
         exit
       end
-      
+
       # pad the score to make it extra readable
       def pad_score(score)
         score = score.to_s
-        
+
         case score.length
         when 3
           score
@@ -44,7 +45,7 @@ module PageSpeed
           '  ' + score
         end
       end
-      
+
       # colorize the good the bad and the ugly
       def colorize(score)
         case score.to_i
@@ -56,12 +57,12 @@ module PageSpeed
           print "\033[31m"
         end
       end
-      
+
       # reset colors
       def decolorize
         print "\033[0m"
       end
-      
+
     end
   end
-end
+end

data/lib/pagespeed/request.rb

@@ -4,48 +4,49 @@ require 'uri'
 module PageSpeed
   class Request
     PAGESPEED_API_URL = 'https://www.googleapis.com/pagespeedonline/v1/runPagespeed'
-    
+
     attr_accessor :url, :api_key
-    
-    def initialize(url, api_key)
+
+    def initialize(url, api_key, strategy)
       @url = url =~ /^https?:\/\// ? url : ('http://' + url )
       @api_key = api_key
+      @strategy = strategy
       @uri = build_request_uri
     end
-    
+
     def pagespeed
       http = Net::HTTP.new(@uri.host, @uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      
+
       request = Net::HTTP::Get.new(@uri.request_uri)
       response = http.request(request)
-      
+
       if response.code.to_i == 200
         PageSpeed::Parser.parse(response.body)
       else
         status_error(response)
       end
-      
+
     rescue Exception => e
       puts e.message
       puts e.backtrace.join("\n")
       puts "\033[31mUh oh, didn't work. Maybe the host is down or the url is wrong... or perhaps google is down :("
       exit
     end
-    
+
     def status_error(response)
       puts "#{response.code}"
       exit
     end
-    
+
     private
-    
+
     def build_request_uri
       uri = URI.parse(PAGESPEED_API_URL)
-      uri.query = "url=#{@url}&key=#{@api_key}"
+      uri.query = "url=#{@url}&strategy=#{@strategy}&key=#{@api_key}"
       uri
     end
-      
+
   end
-end
+end

data/lib/pagespeed/version.rb

@@ -1,3 +1,3 @@
 module PageSpeed
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/spec/pagespeed/cli_spec.rb

@@ -0,0 +1,37 @@
+require 'pagespeed'
+
+describe PageSpeed::CLI do
+  subject(:cli) { described_class }
+
+  before do
+    IO.any_instance.stub(:puts) # globally
+  end
+
+  it "has no parameters" do
+    actual = cli.set_options([])
+    expect(actual).to eq({"strategy" => "desktop"})
+  end
+
+  it "has help parameter" do
+    lambda { cli.set_options(["-h"]) }.should raise_error SystemExit
+  end
+
+  it "has version parameter" do
+    lambda { cli.set_options(["-v"]) }.should raise_error SystemExit
+  end
+
+  it "has incomplete strategy parameter" do
+    lambda { cli.set_options(["-s"]) }.should raise_error SystemExit
+  end
+
+  it "has complete strategy parameter" do
+    actual = cli.set_options(["-s", "mobile"])
+    expect(actual).to eq({"strategy" => "mobile"})
+  end
+
+  it "has positional url argument" do
+    actual = cli.set_options(["google.com"])
+    expect(actual).to eq({"strategy" => "desktop"})
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,35 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pagespeed
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - blahed
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-28 00:00:00 -04:00
-default_executable: 
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies: []
-
-description: ""
-email: 
+description: ''
+email:
 - tdunn13@gmail.com
-executables: 
+executables:
 - pagespeed
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -41,39 +31,31 @@ files:
 - lib/pagespeed/request.rb
 - lib/pagespeed/version.rb
 - pagespeed.gemspec
-has_rdoc: true
-homepage: ""
+- spec/pagespeed/cli_spec.rb
+- spec/spec_helper.rb
+homepage: ''
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: pagespeed
-rubygems_version: 1.6.2
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pulls google pagespeed results for a given site
-test_files: []
-
+test_files:
+- spec/pagespeed/cli_spec.rb
+- spec/spec_helper.rb