google_mobile_friendly 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b6336b135771aed6ff80ba94b710cc61b82430b
+  data.tar.gz: 2a9325d8cc1b681bae8edbd7c35bd4ea955d65b1
+SHA512:
+  metadata.gz: 9e828030b269b26aa5b1ee1c4a8575bb5cb47c4b15735925f08631a22be8d14d7e1f8d307d43f83699f24affde31cf2c69ab8bc8fab0083582e5be764b2cca41
+  data.tar.gz: d8c2db05f769219cef60c7bcac0697a4aac6f4c634eaf25c57cc5b65c715ba6fd17f4313e3a50891313627f6986e4d150a6c8693acc3bd09e479aaa17c2a0f83

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - ruby-head
+before_install: gem install bundler
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_mobile_friendly.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pavel Kozlov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# GoogleMobileFriendly
+
+[![Build Status](https://travis-ci.org/loadkpi/google_mobile_friendly.svg?branch=master)](https://travis-ci.org/loadkpi/google_mobile_friendly) [![Code Climate](https://codeclimate.com/github/loadkpi/google_mobile_friendly/badges/gpa.svg)](https://codeclimate.com/github/loadkpi/google_mobile_friendly)
+
+Ruby Wrapper for Mobile-Friendly Test from Google Search Console URL Testing Tools API
+
+See Google documentation for more information - https://developers.google.com/webmaster-tools/search-console-api/reference/rest/    
+
+## Requirements
+
+* Ruby >= 2.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_mobile_friendly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_mobile_friendly
+
+
+## Usage
+
+    page_one = GoogleMobileFriendly.run_test 'http://google.com', 'YOUR_API_KEY'
+    page_one.is_mobile_friendly?
+    # => true
+    page_one.list_of_mobile_issues
+    # => nil
+    page_one.list_of_blocked_resources
+    # => ["https://www.gstatic.com/og/_/ss/k=og.mob.o3hu3mtmammu.L.W.O/m=md/excm=mih,mab,meb/d=1/ed=1/rs=AA2YrTsgcHY9rgal7Q_4KtT2B4QI4nDAcA", "https://www.gstatic.com/og/_/js/k=og.mob.en_US.09TQbv5ZB3k.O/rt=j/m=md/exm=mih,mab,meb/d=1/ed=1/rs=AA2YrTtYyrscNOyD60o4h8_Tc0H3-gaXUQ", "https://www.google.com/xjs/_/js/k=xjs.qs.en_US.JLMJY8f85DU.O/m=sx,c,sb_mob,bct,cdos,elog,hsm,jsa,mbsf,qim,r,qsm,d,csi/am=gCNop3GCBgwAWHU0S-wLCAEoBA/rt=j/d=1/t=zcms/rs=ACT90oHfJ0gcIaPuA4F8guH-oefRznVKvw"]
+
+    page_two = GoogleMobileFriendly.run_test 'http://edition.cnn.com/EVENTS/1996/year.in.review/', 'YOUR_API_KEY'
+    page_two.is_mobile_friendly?
+    # => false
+    page_two.list_of_mobile_issues
+    # => ["Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close).", "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).", "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size)."]
+
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_mobile_friendly"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google_mobile_friendly.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_mobile_friendly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_mobile_friendly"
+  spec.version       = GoogleMobileFriendly::VERSION
+  spec.authors       = ["Pavel Kozlov"]
+  spec.email         = ["loadkpi@gmail.com"]
+
+  spec.summary       = "Google Mobile-Friendly Test API wrapper for Ruby"
+  spec.description   = "Ruby Wrapper for Mobile-Friendly Test from Google Search Console URL Testing Tools API"
+  spec.homepage      = "https://github.com/loadkpi/google_mobile_friendly"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", '~> 1.7'
+  spec.add_development_dependency "rake", '>= 10.0'
+  spec.add_development_dependency "rspec", '~> 3.1'
+  spec.add_development_dependency "webmock", '~> 2.0'
+  spec.add_development_dependency "simplecov", '~> 0.10'
+end

data/lib/google_mobile_friendly.rb

@@ -0,0 +1,15 @@
+require 'google_mobile_friendly/request'
+require 'google_mobile_friendly/test_page'
+require 'google_mobile_friendly/response_data/mobile_friendly_issue'
+require 'google_mobile_friendly/response_data/resource_issue'
+require 'google_mobile_friendly/response_data/run_mobile_friendly_test_response'
+require 'google_mobile_friendly/response_data/test_status'
+require 'google_mobile_friendly/version'
+
+
+module GoogleMobileFriendly
+  def self.run_test url, api_key
+    request = GoogleMobileFriendly::Request.new url, api_key
+    request.execute
+  end
+end

data/lib/google_mobile_friendly/request.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require 'json'
+
+module GoogleMobileFriendly
+  class Request
+    #see https://searchconsole.googleapis.com/$discovery/rest?version=v1 for more info
+    GOOGLE_TEST_REQUEST_URI = 'https://searchconsole.googleapis.com/v1/urlTestingTools/mobileFriendlyTest:run'
+
+    def initialize url, api_key
+      @url = url
+      @api_key = api_key
+    end
+
+    def execute
+      uri = URI(GOOGLE_TEST_REQUEST_URI)
+      params = {:key => @api_key}
+      uri.query = URI.encode_www_form(params)
+      http_result = Net::HTTP.post_form(uri, 'url' => @url)
+      response = JSON.parse(http_result.body, symbolize_names: true)
+      GoogleMobileFriendly::TestPage.new response
+    end
+  end
+end

data/lib/google_mobile_friendly/response_data/mobile_friendly_issue.rb

@@ -0,0 +1,19 @@
+module GoogleMobileFriendly
+  module ResponseData
+    class MobileFriendlyIssue
+      MOBILE_FRIENDLY_RULE_UNSPECIFIED = "Unknown rule. Sorry, we don't have any description for the rule that was\nbroken."
+      USES_INCOMPATIBLE_PLUGINS = "Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage)."
+      CONFIGURE_VIEWPORT = "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured)."
+      FIXED_WIDTH_VIEWPORT = "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport)."
+      SIZE_CONTENT_TO_VIEWPORT = "Content not sized to viewport. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport)."
+      USE_LEGIBLE_FONT_SIZES = "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size)."
+      TAP_TARGETS_TOO_CLOSE = "Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)."
+
+      def self.get_user_friendly_issues response
+        response[:mobileFriendlyIssues].map do |issue|
+          self.const_get issue[:rule]
+        end unless response[:mobileFriendlyIssues].nil?
+      end
+    end
+  end
+end

data/lib/google_mobile_friendly/response_data/resource_issue.rb

@@ -0,0 +1,11 @@
+module GoogleMobileFriendly
+  module ResponseData
+    class ResourceIssue
+      def self.get_blocked_resources_issues_urls response
+        response[:resourceIssues].map do |issue|
+          issue[:blockedResource][:url]
+        end unless response[:resourceIssues].nil?
+      end
+    end
+  end
+end

data/lib/google_mobile_friendly/response_data/run_mobile_friendly_test_response.rb

@@ -0,0 +1,13 @@
+module GoogleMobileFriendly
+  module ResponseData
+    class RunMobileFriendlyTestResponse
+      MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED = 'Internal error when running this test. Please try running the test again.'
+      MOBILE_FRIENDLY = 'The page is mobile friendly.'
+      NOT_MOBILE_FRIENDLY = 'The page is not mobile friendly.'
+
+      def self.mobile_friendly
+        'MOBILE_FRIENDLY'
+      end
+    end
+  end
+end

data/lib/google_mobile_friendly/response_data/test_status.rb

@@ -0,0 +1,18 @@
+module GoogleMobileFriendly
+  module ResponseData
+    class TestStatus
+      TEST_STATUS_UNSPECIFIED = "Internal error when running this test. Please try running the test again."
+      COMPLETE = "Inspection has completed without errors."
+      INTERNAL_ERROR = "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later."
+      PAGE_UNREACHABLE = "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
+
+      def self.raise_if_response_is_bad response
+        return if response[:testStatus][:status] == "COMPLETE"
+        raise MobileFriendlyAPIError.new(self.const_get response[:testStatus][:status])
+      end
+    end
+
+    class MobileFriendlyAPIError < StandardError
+    end
+  end
+end

data/lib/google_mobile_friendly/test_page.rb

@@ -0,0 +1,23 @@
+module GoogleMobileFriendly
+  class TestPage
+    attr_reader :response
+
+    def initialize api_response
+      @response = api_response
+      raise @response[:error][:message] unless @response[:error].nil?
+      GoogleMobileFriendly::ResponseData::TestStatus.raise_if_response_is_bad @response
+    end
+
+    def is_mobile_friendly?
+      @response[:mobileFriendliness] == GoogleMobileFriendly::ResponseData::RunMobileFriendlyTestResponse.mobile_friendly
+    end
+
+    def list_of_mobile_issues
+      GoogleMobileFriendly::ResponseData::MobileFriendlyIssue.get_user_friendly_issues @response
+    end
+
+    def list_of_blocked_resources
+      GoogleMobileFriendly::ResponseData::ResourceIssue.get_blocked_resources_issues_urls @response
+    end
+  end
+end

data/lib/google_mobile_friendly/version.rb

@@ -0,0 +1,3 @@
+module GoogleMobileFriendly
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: google_mobile_friendly
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pavel Kozlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ruby Wrapper for Mobile-Friendly Test from Google Search Console URL
+  Testing Tools API
+email:
+- loadkpi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_mobile_friendly.gemspec
+- lib/google_mobile_friendly.rb
+- lib/google_mobile_friendly/request.rb
+- lib/google_mobile_friendly/response_data/mobile_friendly_issue.rb
+- lib/google_mobile_friendly/response_data/resource_issue.rb
+- lib/google_mobile_friendly/response_data/run_mobile_friendly_test_response.rb
+- lib/google_mobile_friendly/response_data/test_status.rb
+- lib/google_mobile_friendly/test_page.rb
+- lib/google_mobile_friendly/version.rb
+homepage: https://github.com/loadkpi/google_mobile_friendly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Google Mobile-Friendly Test API wrapper for Ruby
+test_files: []