hertools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20f15df456f2d19d57142b6e67310c78cf4d7a80a08d4f3e17ca07764e7bb38f
+  data.tar.gz: 0e0ac2aff27cc5303d8a3ed93e44c075c6bad37cba541f00565eeb00f4f3cb85
+SHA512:
+  metadata.gz: 14a9a96095ad1a146abb92cb5c230366639cb2a4e490822ca8bedd9e6311c9ded6932d500c6b8b6025916d9c874dcef7fb2330c6b3b615cdd122c50990c83b0f
+  data.tar.gz: ab279755ab77ff157d39a9d6ae5317837906c8bf81ecd3d95ee7d92580fe1cafec49f96198ba28f4728082ac76f9526854a0c838a9cf0f47e3e33a29ea526034

data/.gitignore

@@ -0,0 +1,20 @@
+Gemfile.lock
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status
+
+*.swp
+.rvmrc
+.ruby-version
+*.gem
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hertools.gemspec
+gemspec
+
+gem "rake"
+gem "rspec", "~> 3.0"
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 WuDi
+
+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,48 @@
+# Hertools
+
+A tool box made for her. Provides more and more tools, like the WebsiteParser and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hertools'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hertools
+
+## Usage
+
+### Hertools::WebsiteParser
+
+```ruby
+require 'hertools'
+
+wp = Hertools::WebsiteParser.new
+
+res = wp.crawl_title_and_favicon_file("https://www.baidu.com/")
+res = wp.crawl_title_and_favicon_file("https://www.baidu.com/", root_path: "/Users/test/study/", html_parser: "httparty")
+res = wp.crawl_title_and_favicon_file("https://www.baidu.com", root_path: "/Users/test/study/", html_parser: "nokogiri")
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Amberwudi/hertools.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hertools"
+
+# 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(__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/hertools.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/hertools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hertools"
+  spec.version       = Hertools::VERSION
+  spec.authors       = ["WuDi"]
+  spec.email         = ["wudlvq@qq.com"]
+
+  spec.summary       = %q{A tool box made for her.}
+  spec.description   = %q{A tool box made for her. Provides more and more tools, like the WebsiteParser and so on.}
+  spec.homepage      = "https://github.com/Amberwudi/hertools"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_dependency 'httparty', '~> 0.18', '>= 0.18.1'
+  spec.add_dependency 'nokogiri', '~> 1.10', '>= 1.10.10'
+  spec.add_dependency 'htmlentities', '~> 4.3', '>= 4.3.4'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Amberwudi/hertools"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/hertools.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'hertools/version'
+
+module Hertools
+  class Error < StandardError; end
+
+  autoload :WebsiteParser, 'hertools/website_parser'
+end

data/lib/hertools/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hertools
+  VERSION = '0.1.0'
+end

data/lib/hertools/website_parser.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'open-uri'
+require 'httparty'
+require 'htmlentities'
+require 'nokogiri'
+
+module Hertools
+  # Summary: help to get the website info by a url.
+  class WebsiteParser
+    # Summary: get the title and favicon file by the url of one webpage.
+    # Arguments
+    # url: the url of a webpage
+    # options:
+    #   html_parser: %w[httparty nokogiri]
+    #   root_path: existing file directory
+    def crawl_title_and_favicon_file(url, options = {})
+      puts '>>> Parsing the arguments <<<'
+      unless parse_url(url)
+        puts 'Failed because the bad url!'
+        return false
+      end
+      unless parse_options(options)
+        puts 'Failed because the bad options!'
+        return false
+      end
+
+      puts '>>> Analysing the http response <<<'
+      if httparty?
+        response = HTTParty.get(@url)
+        res = response.body
+      else
+        response = HTTParty.head(@url)
+        res = begin
+                Nokogiri::HTML(URI.open(url), nil, 'UTF-8')
+              rescue StandardError => e
+                puts e
+                nil
+              end
+      end
+      puts "HttpCode: #{response.code}"
+
+      if res.nil? || res.to_s.empty?
+        puts 'No content!'
+        @title = @domain_name
+        @favicon_url = "#{@index_url}/favicon.ico"
+        puts "Use the default favicon url: #{@favicon_url}."
+      else
+        @title = if httparty?
+                   res[%r{<title>\n*(.*)\n*</title>}, 1].to_s
+                 else
+                   res.xpath('//head/title')[0]&.content.to_s
+                 end
+        if @title.empty?
+          puts 'Not found the title!'
+          puts 'Use the domain name as the title.'
+          @title = @domain_name
+        end
+        if httparty?
+          coder = HTMLEntities.new
+          @title = coder.decode(@title)
+        end
+        puts "Title: #{@title}"
+
+        @favicon_url = if httparty?
+                         res[/<link rel="icon".*href="([^"]+)/, 1].to_s
+                       else
+                         favicon_links = res.xpath('//head/link[@rel="icon"]')
+                         favicon_links.empty? ? '' : favicon_links[0][:href].to_s
+                       end
+        if @favicon_url.empty?
+          puts 'Not found the favicon url!'
+          @favicon_url = "#{@index_url}/favicon.ico"
+          puts "Use the default favicon url: #{@favicon_url}."
+        else
+          puts "FaviconUrl: #{@favicon_url}"
+          unless @favicon_url.include?('http')
+            if @favicon_url.include?('//')
+              @favicon_url = "#{@protocol}:#{@favicon_url}"
+              puts "Fixed favicon url: #{@favicon_url}"
+            elsif @favicon_url.include?('/')
+              @favicon_url = "#{@index_url}#{@favicon_url}"
+              puts "Fixed favicon url: #{@favicon_url}"
+            else
+              @favicon_url = "#{@index_url}/favicon.ico"
+              puts "Use the default favicon url: #{@favicon_url}."
+            end
+          end
+        end
+      end
+
+      if @title.empty? && @favicon_url.empty?
+        puts 'Failed because not found the title and favicon url!'
+        return false
+      end
+
+      identifier = Digest::MD5.hexdigest(@url)
+      file_directory_path = "#{@root_path}/#{@domain_name}_#{identifier}"
+      puts "FileDirectory: #{file_directory_path}"
+      Dir.mkdir(file_directory_path) unless File.directory?(file_directory_path)
+      if File.directory?(file_directory_path)
+        unless @title.empty?
+          info_file_path = "#{file_directory_path}/website_info.txt"
+          puts "InfoFilePath: #{info_file_path}"
+          open(info_file_path, 'wb') { |f| f << "Title: #{@title}" }
+        end
+
+        unless @favicon_url.empty?
+          favicon_file_suffix = @favicon_url.split('.').last
+          favicon_file_name = Digest::MD5.hexdigest(@favicon_url) + '.' + favicon_file_suffix
+          favicon_file_path = "#{file_directory_path}/#{favicon_file_name}"
+          puts "FaviconFilePath: #{favicon_file_path}"
+          open(favicon_file_path, 'wb') { |f| f << URI.open(@favicon_url).read }
+        end
+        puts 'Finished!'
+        true
+      else
+        puts 'Failed to create the directory!'
+        false
+      end
+    rescue StandardError => e
+      puts e
+      puts 'Failed because the unexpected exception!'
+      false
+    end
+
+    private
+
+    def parse_url(url)
+      @url = String(url)
+      puts "Url: #{@url}"
+      @url_match = @url.match(%r{(https?)://([^/]+)})
+      return false if @url.empty? || @url_match.nil?
+
+      @index_url = @url_match[0]
+      puts "IndexUrl: #{@index_url}"
+      @protocol = @url_match[1]
+      puts "Protocol: #{@protocol}"
+      @domain_name = @url_match[2]
+      puts "DomainName: #{@domain_name}"
+      true
+    rescue StandardError => e
+      puts e
+      false
+    end
+
+    def parse_options(options)
+      options = Hash(options)
+      html_parser = options.fetch(:html_parser) { 'httparty' }
+      @old_html_parser = @html_parser
+      @html_parser = %w[httparty nokogiri].include?(html_parser) ? html_parser : 'httparty'
+      reset_httparty_judge_result if @old_html_parser != @html_parser
+      puts "HtmlParser: #{@html_parser}"
+      root_path = options.fetch(:root_path) { Dir.pwd }
+      @root_path = (File.directory?(root_path) ? root_path : Dir.pwd).chomp('/')
+      puts "RootPath: #{@root_path}"
+      true
+    rescue StandardError => e
+      puts e
+      false
+    end
+
+    def httparty?
+      @httparty_judge_result ||= @html_parser == 'httparty'
+    end
+
+    def reset_httparty_judge_result
+      @httparty_judge_result = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: hertools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WuDi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+description: A tool box made for her. Provides more and more tools, like the WebsiteParser
+  and so on.
+email:
+- wudlvq@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hertools.gemspec
+- lib/hertools.rb
+- lib/hertools/version.rb
+- lib/hertools/website_parser.rb
+homepage: https://github.com/Amberwudi/hertools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Amberwudi/hertools
+  source_code_uri: https://github.com/Amberwudi/hertools
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A tool box made for her.
+test_files: []