mudfly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89572b3458ff921f07a379fc668085b7059ef63c
+  data.tar.gz: a54118dd543323fc06fca86d2326dd0e58c0f337
+SHA512:
+  metadata.gz: 686cc60ceec62fc0739e2ee0655227655fb1c37c9497552c96c1bb80614ab0149bec33955a79d273c1523d2b74214702b96cfdd01d6732e13fb937b01c6591d4
+  data.tar.gz: da1dc934c36f113786b436c8af8d682c4005f21ed544a5010906d61119c56e252cb61540ff2e6ac4000df58ae06f7e2e4a9888613ea7b95563e9ae3c1011bb56

data/.gitignore

@@ -0,0 +1,4 @@
+build.sh
+spike.rb
+*.gem
+spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    mudfly (0.0.1)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.1)
+    faraday (0.8.6)
+      multipart-post (~> 1.1)
+    multipart-post (1.2.0)
+    rake (10.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  mudfly!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pablo Elices
+
+MIT License
+
+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,112 @@
+# Mudfly 0.0.1
+
+A Ruby wrapper for the PageSpeed Insights API
+
+## Requirements
+
+- Ruby >= 2.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mudfly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mudfly
+
+## Configuration
+    
+    require 'mudfly'
+    
+    # Defaults
+    
+    Mudfly.api_key    # => nil
+    Mudfly.user_agent # => "Mudfly Ruby Gem 0.0.1"
+    Mudfly.endpoint   # => "https://www.googleapis.com/pagespeedonline/v1/"
+    Mudfly.locale     # => "en_US"
+    
+    # Block Configuration
+    
+    Mudfly.configure do |config|
+      config.api_key    = 'Your API Key Here.'
+      config.user_agent = 'New User Agent'
+      config.endpoint   = 'Custom Endpoint'
+      config.locale     = 'Your Locale Here'
+    end
+    
+    # Single Configuration
+    
+    Mudfly.api_key    = 'Your API Key Here.'
+    Mudfly.user_agent = 'New User Agent'
+    Mudfly.endpoint   = 'Custom Endpoint'
+    Mudfly.locale     = 'Your Locale Here'
+
+See [this](https://developers.google.com/speed/docs/insights/languages) for a valid list of locales.
+
+## Usage
+
+    require 'mudfly'
+    
+    # Configure Mudfly Here
+    
+    Mudfly.analyze('https://github.com') # Desktop report for github.com
+    Mudfly.analyze('https://github.com', strategy: :desktop) # Same as above
+    Mudfly.analyze('https://github.com', strategy: :mobile) # Mobile report for github.com
+
+## Example
+
+    require 'mudfly'
+    
+    Mudfly.api_key = 'Your API Key Here' 
+    
+    report = Mudfly.analyze('http://pabloelic.es', strategy: :desktop)
+    
+    
+    # Report Info
+    
+    puts "Kind: #{report.kind}"
+    puts "ID: #{report.id}"
+    puts "Response Code: #{report.response_code}"
+    puts "Title: #{report.title}"
+    puts "Score: #{report.score}"
+    
+    
+    # Page Stats
+    
+    puts "Resources Number: #{report.stats.resources_number}"
+    puts "Hosts Number: #{report.stats.hosts_number}"
+    puts "Total Request Bytes: #{report.stats.total_request_bytes}"
+    puts "Static Resources Number: #{report.stats.static_resources_number}"
+    puts "HTML Response Bytes: #{report.stats.html_response_bytes}"
+    puts "CSS Response Bytes: #{report.stats.css_response_bytes}"
+    puts "JavaScript Response Bytes: #{report.stats.javascript_response_bytes}"
+    puts "Image Response Bytes: #{report.stats.image_response_bytes}"
+    puts "JavaScript Resources Number: #{report.stats.javascript_resources_number}"
+    puts "CSS Resources Number: #{report.stats.css_resources_number}"
+    
+    
+    # Rules
+    
+    report.rules.each do |rule|
+    
+      puts "Rule Name: #{rule.name}"
+      puts "Rule Score: #{rule.score}"
+      puts "Rule Impact: #{rule.impact}"
+    
+    end
+    
+    
+    # Report API Version
+    
+    puts "Report API Version: #{report.version.major}.#{report.version.minor}"
+
+
+## Copyright
+
+Copyright © 2013 Pablo Elices. See [license](https://github.com/pabloelices/mudfly/blob/master/LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task :default do
+
+  puts `rake -T`
+
+end

data/lib/mudfly.rb

@@ -0,0 +1,30 @@
+require 'mudfly/configuration'
+require 'mudfly/client'
+
+module Mudfly extend Configuration
+  
+  # Delegate to Mudfly::Client
+
+  def self.method_missing(symbol, *args)
+
+    if Client.respond_to?(symbol)
+
+      return Client.send(symbol, *args)
+
+    else
+
+      return super
+
+    end
+    
+  end
+
+  # Delegate to Mudfly::Client
+
+  def self.respond_to?(symbol, include_all = false)
+
+    return Client.respond_to?(symbol, include_all) || super(symbol, include_all)
+
+  end
+
+end # Mudfly

data/lib/mudfly/client.rb

@@ -0,0 +1,76 @@
+require 'json'
+
+require 'mudfly/request'
+
+module Mudfly
+
+  class Client
+
+    def self.analyze(url, strategy: :desktop)
+
+      unless [:desktop, :mobile].include?(strategy)
+
+        raise ArgumentError.new('Invalid strategy, only :desktop and :mobile are allowed.')
+
+      end
+
+      request_url = 'runPagespeed'
+
+      query_string = {
+
+        :url      => url,
+        :strategy => strategy
+
+      }
+
+      response_body = JSON.parse( Request.get(request_url, query_string) )
+
+      report = OpenStruct.new
+
+      report.response_code = response_body['responseCode']
+      report.title         = response_body['title']
+      report.score         = response_body['score']
+      report.kind          = response_body['kind']
+      report.id            = response_body['id']
+
+      report.stats = OpenStruct.new({
+
+        :resources_number            => response_body['pageStats']['numberResources'],
+        :hosts_number                => response_body['pageStats']['numberHosts'],
+        :total_request_bytes         => response_body['pageStats']['totalRequestBytes'],
+        :static_resources_number     => response_body['pageStats']['numberStaticResources'],
+        :html_response_bytes         => response_body['pageStats']['htmlResponseBytes'],
+        :css_response_bytes          => response_body['pageStats']['cssResponseBytes'],
+        :image_response_bytes        => response_body['pageStats']['imageResponseBytes'],
+        :javascript_response_bytes   => response_body['pageStats']['javascriptResponseBytes'],
+        :javascript_resources_number => response_body['pageStats']['numberJsResources'],
+        :css_resources_number        => response_body['pageStats']['numberCssResources']
+
+      })
+
+      report.rules = response_body['formattedResults']['ruleResults'].values.each.inject([]) do |rules, rule_temp|
+
+        rules << OpenStruct.new({
+
+          :name   => rule_temp['localizedRuleName'],
+          :score  => rule_temp['ruleScore'],
+          :impact => rule_temp['ruleImpact']
+
+        })
+
+      end
+
+      report.version = OpenStruct.new({
+
+        :major => response_body['version']['major'],
+        :minor => response_body['version']['minor']
+
+      })
+
+      return report
+
+    end
+
+  end
+
+end

data/lib/mudfly/configuration.rb

@@ -0,0 +1,36 @@
+require "mudfly/version"
+
+module Mudfly
+
+  module Configuration
+
+    VALID_CONFIGURATION_KEYS = [:api_key, :user_agent, :endpoint, :locale]
+
+    DEFAULT_API_KEY    = nil
+    DEFAULT_USER_AGENT = "Mudfly Ruby Gem #{Mudfly::VERSION}"
+    DEFAULT_ENDPOINT   = 'https://www.googleapis.com/pagespeedonline/v1/'
+    DEFAULT_LOCALE     = 'en_US'
+
+
+    attr_accessor *VALID_CONFIGURATION_KEYS
+
+    def self.extended(base)
+
+      base.api_key    = DEFAULT_API_KEY
+      base.user_agent = DEFAULT_USER_AGENT
+      base.endpoint   = DEFAULT_ENDPOINT
+      base.locale     = DEFAULT_LOCALE
+    
+    end
+
+    # Allow block configuration
+
+    def configure
+
+      yield self
+
+    end
+
+  end # Configuration
+
+end # Mudfly

data/lib/mudfly/error/bad_request.rb

@@ -0,0 +1,9 @@
+module Mudfly
+
+  module Error
+
+    class BadRequest < StandardError; end
+
+  end # Error
+
+end # Mudfly

data/lib/mudfly/error/forbidden.rb

@@ -0,0 +1,9 @@
+module Mudfly
+
+  module Error
+
+    class Forbidden < StandardError; end
+
+  end # Error
+
+end # Mudfly

data/lib/mudfly/error/internal_server_error.rb

@@ -0,0 +1,9 @@
+module Mudfly
+
+  module Error
+
+    class InternalServerError < StandardError; end
+
+  end # Error
+
+end # Mudfly

data/lib/mudfly/error/service_unavailable.rb

@@ -0,0 +1,9 @@
+module Mudfly
+
+  module Error
+
+    class ServiceUnavailable < StandardError; end
+
+  end # Error
+
+end # Mudfly

data/lib/mudfly/request.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+
+require 'mudfly/response/http_exception'
+
+module Mudfly
+
+  class Request
+
+    def self.get(url, query_string = {})
+
+      return perform(:get, url, query_string)   
+
+    end
+
+    def self.post(url, query_string = {})
+
+      return perform(:post, url, query_string)
+
+    end
+
+
+    private
+
+    def self.connection
+
+      connection = Faraday::Connection.new({
+
+        :url     => Mudfly.endpoint,
+        :headers => { 'User-Agent' => Mudfly.user_agent }
+
+      })
+
+      connection.use Mudfly::Response::HttpException
+
+      return connection
+
+    end
+
+    def self.perform(method, url, query_string = {})
+
+      query_string[:prettyprint] = false
+      query_string[:locale]      = Mudfly.locale
+      query_string[:key]         = Mudfly.api_key
+
+
+      response = connection.send(method) do |request|
+
+        case method
+        when :get
+          request.url(url, query_string)
+        when :post
+          request.path = url
+          request.body = query_string
+        end
+
+      end
+      
+      return response.body   
+
+    end
+
+  end # Request
+
+end # Mudfly

data/lib/mudfly/response/http_exception.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+
+require 'mudfly/error/bad_request'
+require 'mudfly/error/forbidden'
+require 'mudfly/error/service_unavailable'
+require 'mudfly/error/internal_server_error'
+
+module Mudfly
+
+  module Response
+
+    class HttpException < Faraday::Response::Middleware
+
+      def on_complete(response)
+
+        case response[:status].to_i
+
+          when 400; raise Mudfly::Error::BadRequest.new(response[:body])
+
+          when 403; raise Mudfly::Error::Forbidden.new(response[:body])
+
+          when 500; raise Mudfly::Error::InternalServerError.new('Something gone wrong')
+
+          when 503; raise Mudfly::Error::ServiceUnavailable.new('Impossible to handle the request')
+
+        end
+
+      end
+
+    end # HttpException
+
+  end # Response
+
+end # Mudfly

data/lib/mudfly/version.rb

@@ -0,0 +1,5 @@
+module Mudfly
+
+  VERSION = "0.0.1"
+
+end # Mudfly

data/mudfly.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'mudfly/version'
+
+Gem::Specification.new do |spec|
+  
+  spec.name          = 'mudfly'
+  spec.version       = Mudfly::VERSION
+  spec.author        = 'Pablo Elices'
+  spec.email         = 'contact@pabloelic.es'
+  spec.description   = 'Mudfly is a Ruby wrapper for the PageSpeed Insights API.'
+  spec.summary       = 'A Ruby wrapper for the PageSpeed Insights API.'
+  spec.homepage      = 'https://github.com/pabloelices/mudfly'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: mudfly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pablo Elices
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mudfly is a Ruby wrapper for the PageSpeed Insights API.
+email: contact@pabloelic.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mudfly.rb
+- lib/mudfly/client.rb
+- lib/mudfly/configuration.rb
+- lib/mudfly/error/bad_request.rb
+- lib/mudfly/error/forbidden.rb
+- lib/mudfly/error/internal_server_error.rb
+- lib/mudfly/error/service_unavailable.rb
+- lib/mudfly/request.rb
+- lib/mudfly/response/http_exception.rb
+- lib/mudfly/version.rb
+- mudfly.gemspec
+homepage: https://github.com/pabloelices/mudfly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the PageSpeed Insights API.
+test_files: []