ruby_pagespeed_insights 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f9bd12f73b3037fa196bfddbb42357d573009e43496c1e5bef4901dd0f89066
-  data.tar.gz: 4baac14f76f0943ebaa04fbec06c7683f1d3665e411abec380ad81cd5fd63049
+  metadata.gz: a3da48681214b327943fa772cc587c416d4bc5a2256be1efab1a4e30440ee249
+  data.tar.gz: 8a6b6d5f3618a9dc96365a1a39aee4c586e5360b4fe9b5397983f3beda1c96c1
 SHA512:
-  metadata.gz: 8c417b0a572a682615a36a84514c673fe6828fc9d589a4c1a13f01789c67dd1f905e0066c77d2dae4a579fdd9249e0e782ccb2371b4726b54dadea0634fda755
-  data.tar.gz: '01495f527c4749b54fed753093b59a7a49ce5c45df205093223cddd3fff7c3236f6af905af1c6b1099e3a2d905ebacd4f32157d835c4b6cb87928aa019441102'
+  metadata.gz: 8bd8205104ea915d087529949f3fc1e2c3081c4bd6606a57af4caf7b7ebf2b44f84c5d1de518d710bd3018ed6185a4fa219700fed70f11ab55a051f720ed9718
+  data.tar.gz: 65e4d8d7e1af4e553171febcfde6153e5cdb78fad971f716640e30a85a10ba77dd69003ac4f51168d16fe613b102afa081f09f539e228e2ae794d6b72b0533a9

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: ${COVERALLS_REPO_TOKEN}

data/.mdl_style.rb

@@ -0,0 +1 @@
+exclude_rule 'MD013'

data/.mdlrc

@@ -0,0 +1 @@
+style '.mdl_style.rb'

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.7.1
   - 2.6.3
   - 2.5.5
+  - 2.4.10
 before_install:
   - gem i rubygems-update -v '3.1.2' && update_rubygems
   - gem i bundler -v '1.17.3'

data/Gemfile

@@ -4,3 +4,11 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ruby-pagespeed-insights.gemspec
 gemspec
+
+group :development, :test do
+  gem 'simplecov', '~> 0.16.1'
+  gem 'pre-commit', '~> 0.39.0'
+  gem 'rubocop', require: false
+  gem 'dotenv', '~> 2.7', '>= 2.7.6'
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_pagespeed_insights (1.0.0)
+    ruby_pagespeed_insights (1.0.1)
       faraday (~> 1.0, >= 1.0.1)
       json (~> 2.3, >= 2.3.0)
 
@@ -9,6 +9,12 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
     dotenv (2.7.6)
@@ -50,13 +56,18 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.3.0)
       parser (>= 2.7.1.4)
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
-    simplecov (0.19.0)
+    simplecov (0.16.1)
       docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -64,14 +75,14 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17, >= 1.17.3)
+  coveralls
   dotenv (~> 2.7, >= 2.7.6)
   pre-commit (~> 0.39.0)
   rake (~> 12.3, >= 12.3.3)
   rspec (~> 3.0)
-  rubocop (~> 0.90.0)
-  rubocop-rspec (~> 1.43, >= 1.43.2)
+  rubocop
   ruby_pagespeed_insights!
-  simplecov (~> 0.19.0)
+  simplecov (~> 0.16.1)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,28 +1,55 @@
 # Ruby Pagespeed Insights
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pagespeed_insights`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/ruby_pagespeed_insights.svg)](https://rubygems.org/gems/ruby_pagespeed_insights) [![Build Status](https://travis-ci.org/kevyder/ruby_pagespeed_insights.svg?branch=master)](https://travis-ci.org/kevyder/ruby_pagespeed_insights) [![Coverage Status](https://coveralls.io/repos/github/kevyder/ruby_pagespeed_insights/badge.svg?branch=master)](https://coveralls.io/github/kevyder/ruby_pagespeed_insights?branch=master) [![Gem](https://img.shields.io/gem/dt/ruby_pagespeed_insights)](https://rubygems.org/gems/ruby_pagespeed_insights) ![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/kevyder/ruby_pagespeed_insights)
 
-TODO: Delete this and the text above, and describe your gem
+A Ruby wrapper for Google PageSpeed Insights API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-pagespeed-insights'
+gem 'ruby_pagespeed_insights'
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ruby-pagespeed-insights
+```bash
+ gem install ruby_pagespeed_insights
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Once installed, you have to get your `API key` in the [Google Developers Console](https://developers.google.com/speed/docs/insights/v5/get-started) and then you can start to using the library.
+
+### [API Version 5](https://developers.google.com/speed/docs/insights/v5/reference/pagespeedapi/runpagespeed)
+
+```ruby
+request = PagespeedInsights::V5.new(
+  url: 'http://site.com',
+  key: 'your api key',
+  strategy: 'desktop',
+  categories: 'seo'
+)
+
+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
 
@@ -32,7 +59,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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](http://contributor-covenant.org) code of conduct.
+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](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +67,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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](https://github.com/kevyder/ruby-pagespeed-insights/blob/master/CODE_OF_CONDUCT.md).
+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](https://github.com/kevyder/ruby_pagespeed_insights/blob/master/CODE_OF_CONDUCT.md).

data/lib/pagespeed_insights/version.rb

@@ -1,3 +1,3 @@
 module PagespeedInsights
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/ruby-pagespeed-insights.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Kevin Rodriguez']
   spec.email         = ['kyrodriguez97@gmail.com']
 
-  spec.summary       = 'A Ruby wrapper for the PageSpeed Insights API.'
+  spec.summary       = 'A Ruby wrapper for Google PageSpeed Insights API.'
   spec.description   = 'A Ruby wrapper for Google PageSpeed Insights API.'
   spec.homepage      = 'https://github.com/kevyder/ruby_pagespeed_insights'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.4'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -38,9 +38,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.17', '>= 1.17.3'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.19.0'
-  spec.add_development_dependency 'pre-commit', '~> 0.39.0'
-  spec.add_development_dependency 'rubocop', '~> 0.90.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.43', '>= 1.43.2'
-  spec.add_development_dependency 'dotenv', '~> 2.7', '>= 2.7.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_pagespeed_insights
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-12 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,88 +104,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-- !ruby/object:Gem::Dependency
-  name: pre-commit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.39.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.39.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.90.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.90.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.43'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.43.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.43'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.43.2
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
 description: A Ruby wrapper for Google PageSpeed Insights API.
 email:
 - kyrodriguez97@gmail.com
@@ -193,7 +111,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".mdl_style.rb"
+- ".mdlrc"
 - ".pre-commit-config.yaml"
 - ".rspec"
 - ".rubocop.yml"
@@ -224,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -234,5 +155,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for the PageSpeed Insights API.
+summary: A Ruby wrapper for Google PageSpeed Insights API.
 test_files: []