Ruby Pagespeed Insights

A Ruby wrapper for Google PageSpeed Insights API.

Installation

Add this line to your application's Gemfile:

gem 'ruby_pagespeed_insights'

And then execute:

 bundle

Or install it yourself as:

 gem install ruby_pagespeed_insights

Usage

Once installed, you have to get your API key in the Google Developers Console and then you can start to using the library.

API Version 5

require 'pagespeed_insights'

request = PagespeedInsights::V5.new(
  url: 'http://site.com',
  key: 'your api key',
  strategy: 'desktop',
  categories: ['seo', 'pwa']
)

response = request.results
response.status   # response code status
response.headers  # response headers
response.body     # response body content

param	default value	allowed values	optional?
url	none		false
key	none		false
strategy	none	desktop, mobile	true
categories	none	accessibility, best-practices, performance, pwa, seo	true

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kevyder/ruby_pagespeed_insights. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ruby Pagespeed Insights project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.