webinspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e032ae52ae21e3e3b5e6797e51e5f90c6682035e
+  data.tar.gz: 98407e3d9ef2b8f469a4c7886c86166e74e0fbf8
+SHA512:
+  metadata.gz: 4499172570068e8a4ea5b747093d5ea8a2cb49f87745af6bc2884a39d4658cbfc7d27e110a5a794e97514caf7474265ef6b7ab6e8d513619c9180c0947ee997c
+  data.tar.gz: 56de25e0dacd21ec19a59c513076980d56f1bbe02a4290b1959e0cb3dddd3ea09f0f286b15d9f11c0130c2a378fff859f512a37c35f26a290eba3667e5ca8e3d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Davide Santangelo
+
+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,64 @@
+# Webinspector
+
+Ruby gem to inspect completely a web page. It scrapes a given URL, and returns you its title, description, meta, links, images and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webinspector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webinspector
+
+## Usage
+
+Initialize a WebInspector instance for an URL, like this:
+
+```ruby
+page = WebInspector.new('http://davidesantangelo.com')
+```
+
+## Accessing response status and headers
+
+You can check the status and headers from the response like this:
+
+```ruby
+page.response.status  # 200
+page.response.headers # { "server"=>"apache", "content-type"=>"text/html; charset=utf-8", "cache-control"=>"must-revalidate, private, max-age=0", ... }
+```
+
+## Accessing inpsected data
+
+You can see the data like this:
+
+```ruby
+page.url                 # URL of the page
+page.scheme              # Scheme of the page (http, https)
+page.host                # Hostname of the page (like, davidesantangelo.com, without the scheme)
+page.port                # Port of the page
+page.title               # title of the page from the head section, as string
+page.description         # description of the page
+page.links               # every link found
+page.images              # every image found
+page.meta                # metatags of the page
+```
+
+## License
+The restcountry GEM is released under the MIT License.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/webinspector/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+>>>>>>> develop

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webinspector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/web_inspector.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'web_inspector/page'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'web_inspector/version'))
+
+module WebInspector
+  extend self
+
+  def new(url, options = {})
+    Page.new(url, options)
+  end
+end

data/lib/web_inspector/inspector.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'meta'))
+
+module WebInspector
+  class Inspector
+
+    def initialize(page)
+      @page = page
+      @meta = WebInspector::Meta.new(page).meta
+    end
+
+  	def title
+  		@page.css('title').inner_text.strip rescue nil
+  	end
+
+    def description
+      @meta['description'] || snippet
+    end
+
+    def meta
+      @meta
+    end
+
+    def links
+      links = []
+      @page.css("a").each do |a|
+        links.push((a[:href].to_s.start_with? @url.to_s) ? a[:href] : URI.join(@url, a[:href]).to_s) if (a and a[:href])
+      end
+      return links
+    end
+
+    def images
+      images = []
+      @page.css("img").each do |img|
+        images.push((img[:src].to_s.start_with? @url.to_s) ? img[:src] : URI.join(url, img[:src]).to_s) if (img and img[:src])
+      end
+      return images
+    end
+
+    private
+
+    def snippet
+      first_long_paragraph = @page.search('//p[string-length() >= 120]').first
+      first_long_paragraph ? first_long_paragraph.text : ''
+    end
+  end
+end

data/lib/web_inspector/meta.rb

@@ -0,0 +1,67 @@
+module WebInspector
+  class Meta
+  	def initialize(page)
+      @page = page
+    end
+
+  	def meta_tags
+      {
+        'name'        => meta_tags_by('name'),
+        'http-equiv'  => meta_tags_by('http-equiv'),
+        'property'    => meta_tags_by('property'),
+        'charset'     => [charset_from_meta_charset]
+      }
+    end
+
+    def meta_tag
+      convert_each_array_to_first_element_on meta_tags
+    end
+
+    def meta
+      meta_tag['name']
+          .merge(meta_tag['http-equiv'])
+          .merge(meta_tag['property'])
+          .merge('charset' => meta_tag['charset'])
+    end
+
+    def charset
+      @charset ||= (charset_from_meta_charset || charset_from_meta_content_type)
+    end
+
+    private
+
+    def charset_from_meta_charset
+      @page.css('meta[charset]')[0].attributes['charset'].value rescue nil
+    end
+
+    def charset_from_meta_content_type
+      @page.css("meta[http-equiv='Content-Type']")[0].attributes['content'].value.split(';')[1].split('=')[1] rescue nil
+    end
+
+   	def meta_tags_by(attribute)
+      hash = {}
+      @page.css("meta[@#{attribute}]").map do |tag|
+        name    = tag.attributes[attribute].value.downcase rescue nil
+        content = tag.attributes['content'].value rescue nil
+
+        if name && content
+          hash[name] ||= []
+          hash[name] << content
+        end
+      end
+      hash
+    end
+
+    def convert_each_array_to_first_element_on(hash)
+      hash.each_pair do |k, v|
+        hash[k] = if v.is_a?(Hash)
+                    convert_each_array_to_first_element_on(v)
+                  elsif v.is_a?(Array)
+                    v.first
+                  else
+                    v
+                  end
+      end
+    end
+  end
+end

data/lib/web_inspector/page.rb

@@ -0,0 +1,120 @@
+require 'nokogiri'
+require 'uri'
+require 'addressable/uri'
+require 'open-uri'
+require 'open_uri_redirections'
+require 'faraday'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'inspector'))
+
+module WebInspector
+  class Page
+  	attr_reader :url, :scheme, :host, :port, :title, :description, :meta, :links, :images, :size, :response
+
+    def initialize(url, options = {})
+      @url = url
+      @options = options
+      @inspector = WebInspector::Inspector.new(page)
+    end
+
+    def title
+      @inspector.title
+    end
+
+    def description
+      @inspector.description
+    end
+
+    def links
+      @inspector.links
+    end
+
+    def images
+      @inspector.images
+    end
+
+    def meta
+      @inspector.meta
+    end
+
+    def url
+      normalized_uri
+    end
+
+    def host
+      uri.host
+    end
+
+    def scheme
+      uri.scheme
+    end
+
+    def port
+      URI(normalized_uri).port
+    end
+
+    def to_hash
+      {
+        'url'           => url,
+        'scheme'        => scheme,
+        'host'          => host,
+        'port'          => port,
+        'title'         => title,
+        'description'  	=> description,
+        'meta'  				=> meta,
+        'links'					=> links,
+        'images'				=> images,
+        'response'      => { 'status'  => response.status,
+                             'headers' => response.headers }
+      }
+    end
+
+    def response
+      @response ||= fetch
+    rescue Faraday::TimeoutError, Faraday::Error::ConnectionFailed, RuntimeError, URI::InvalidURIError => e
+      @exception_log << e
+      nil
+    end
+
+    private
+    
+    def fetch
+      session = Faraday.new(:url => url) do |faraday|
+        faraday.request :retry, max: @retries
+
+        if @allow_redirections
+          faraday.use FaradayMiddleware::FollowRedirects, limit: 10
+          faraday.use :cookie_jar
+        end
+
+        faraday.headers.merge!(@headers || {})
+        faraday.adapter :net_http
+      end
+
+      response = session.get do |req|
+        req.options.timeout      = @connection_timeout
+        req.options.open_timeout = @read_timeout
+      end
+
+      @url.url = response.env.url.to_s
+
+      response
+    end
+
+    def uri
+      Addressable::URI.parse(@url)
+    end
+
+    def normalized_uri
+      uri.normalize.to_s
+    end
+
+    def default_user_agent
+      "WebInspector/#{WebInspector::VERSION} (+https://github.com/davidesantangelo/webinspector)"
+    end
+
+    def page
+      Nokogiri::HTML(open(normalized_uri, :allow_redirections => :safe))
+    end
+  end
+end

data/lib/web_inspector/version.rb

@@ -0,0 +1,3 @@
+module WebInspector
+  VERSION = "0.1.0"
+end

data/lib/webinspector.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), './web_inspector'))

data/webinspector.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/web_inspector/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "webinspector"
+  spec.version       = WebInspector::VERSION
+  spec.authors       = ["Davide Santangelo"]
+  spec.email         = ["davide.santangelo@gmail.com"]
+
+  spec.summary       = %q{Ruby gem to inspect completely a web page.}
+  spec.description   = %q{Ruby gem to inspect completely a web page. It scrapes a given URL, and returns you its meta, links, images and more.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "typhoeus"
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+  spec.add_dependency "addressable"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "open_uri_redirections"
+  spec.add_dependency "openurl"
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: webinspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Davide Santangelo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: typhoeus
+  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: 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: json
+  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: addressable
+  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: nokogiri
+  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: open_uri_redirections
+  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: openurl
+  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'
+description: Ruby gem to inspect completely a web page. It scrapes a given URL, and
+  returns you its meta, links, images and more.
+email:
+- davide.santangelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/web_inspector.rb
+- lib/web_inspector/inspector.rb
+- lib/web_inspector/meta.rb
+- lib/web_inspector/page.rb
+- lib/web_inspector/version.rb
+- lib/webinspector.rb
+- webinspector.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby gem to inspect completely a web page.
+test_files: []