RubyGems - pingr - Versions diffs - 0.0.3 → 0.2.3 - Mend

pingr 0.0.3 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

checksums.yaml +7 -0
data/.gitignore +2 -1
data/.rspec +3 -0
data/.travis.yml +7 -0
data/.yardopts +7 -0
data/Gemfile +4 -0
data/LICENSE.txt +17 -18
data/README.md +14 -18
data/Rakefile +11 -0
data/bin/console +15 -0
data/bin/setup +8 -0
data/docs/Pingr/PingrError.html +134 -0
data/docs/Pingr/Request.html +232 -0
data/docs/Pingr/SearchEngines/Base.html +668 -0
data/docs/Pingr/SearchEngines/Bing.html +294 -0
data/docs/Pingr/SearchEngines/Google.html +294 -0
data/docs/Pingr/SearchEngines.html +117 -0
data/docs/Pingr.html +593 -0
data/docs/_config.yml +1 -0
data/docs/_index.html +181 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +496 -0
data/docs/file.README.html +146 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +146 -0
data/docs/index.md +37 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +179 -0
data/docs/top-level-namespace.html +110 -0
data/lib/pingr/request.rb +10 -64
data/lib/pingr/search_engines/base.rb +62 -0
data/lib/pingr/search_engines/bing.rb +22 -0
data/lib/pingr/search_engines/google.rb +21 -0
data/lib/pingr/version.rb +3 -1
data/lib/pingr.rb +27 -19
data/lib/tasks/pingr.rake +19 -0
data/pingr.gemspec +17 -13
data/spec/pingr_spec.rb +7 -0
data/spec/spec_helper.rb +16 -0
metadata +83 -28

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Pingr
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Pingr.html" title="Pingr (module)">Pingr</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Thu Aug 13 16:28:50 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.24 (ruby-2.6.6).
+</div>
+    </div>
+  </body>
+</html>

data/lib/pingr/request.rb CHANGED Viewed

@@ -1,73 +1,19 @@
+# frozen_string_literal: true
 module Pingr
   # Public: The object created to ping a search engine with a sitemap
   class Request
-    require 'logger'
-    require 'net/http'
-    require 'uri'
-    # Public: Gets/Sets the String url of the sitemap we're submitting
-    attr_accessor :sitemap_url
-    # Public: Gets/Sets the String or Symbol name of the search engine we're pinging
-    attr_accessor :search_engine
+    require 'pingr/search_engines/bing'
+    require 'pingr/search_engines/google'
     # Public: Initialize a new ping request
-    #
-    # search_engine - A String or Symbol name of the search engine we're pinging
+    #
     # sitemap_url - A String url of the sitemap we're submitting
-    #
+    #
     # Returns a Pingr::Request object
-    def initialize(search_engine, sitemap_url)
-      self.search_engine = search_engine.to_sym
-      self.sitemap_url = sitemap_url
-    end
-    # Public: The path to ping to submit sitemaps for this search_engine
-    #
-    # Returns a String with the correct path to submit sitemaps
-    #
-    # Raises: A PingrError if the search_engine attribute's value is not supported
-    def ping_path
-      case search_engine
-        # http://www.google.com/webmasters/tools/ping?sitemap=
-      when :google then "webmasters/tools/ping?sitemap=#{URI.escape(sitemap_url)}"
-        # http://www.bing.com/ping?sitemap=
-      when :bing then "ping?sitemap=#{URI.escape(sitemap_url)}"
-      else
-        raise PingrError, "Don't know how to ping search engine: #{search_engine}"
-      end
-    end
-    # Public: Perform the ping request (if in :live mode)
-    # Logs the success/failure of the ping in logger.
-    #
-    # Returns true if ping was a success
-    # Returns false if ping was not successful
-    def ping
-      return true unless Pingr.mode == :live
-      uri     = URI.parse("http://#{search_engine}.com/#{ping_path}")
-      http    = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new(uri.request_uri)
-      response = http.request(request)
-      if response.code.to_s =~ /200|301/
-        logger.info "Pinged #{search_engine} Successfully - #{Time.now}"
-        return true
-      else
-        logger.warn "Error pinging #{search_engine}! (response code: #{response.code})- #{Time.now}"
-        return false
-      end
-    end
-    private
-    # Private: A helper method to access Pingr::logger
-    #
-    # Returns A Logger instance
-    def logger
-      Pingr.logger
+    def initialize(sitemap_url)
+      Pingr::SearchEngines::Bing.new(sitemap_url).ping
+      Pingr::SearchEngines::Google.new(sitemap_url).ping
     end
   end
-end
+end

data/lib/pingr/search_engines/base.rb ADDED Viewed

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module Pingr
+  module SearchEngines
+    # Public: The object created to ping a search engine with a sitemap
+    class Base
+      require 'net/http'
+      require 'uri'
+      # Public: Gets/Sets the String url of the sitemap we're submitting
+      attr_reader :sitemap_url
+      # Public: Initialize a new ping request
+      #
+      # sitemap_url - A String url of the sitemap we're submitting
+      #
+      # Returns a Pingr::Request object
+      def initialize(sitemap_url)
+        @sitemap_url = sitemap_url
+      end
+      # Public: Perform the ping request (if in :live mode)
+      # Logs the success/failure of the ping in logger.
+      #
+      # Returns true if ping was a success
+      # Returns false if ping was not successful
+      def ping
+        return true unless Pingr.mode == :live
+        ssl = ping_url.scheme == 'https'
+        Net::HTTP.start(ping_url.host, ping_url.port, use_ssl: ssl) do |http|
+          request = Net::HTTP::Get.new(ping_url)
+          response = http.request(request)
+          if response.code.to_s =~ /200|301/
+            logger.info "Pinged #{search_engine} Successfully - #{Time.now}"
+            return true
+          else
+            logger.warn "Error pinging #{search_engine}! (response code: #{response.code})- #{Time.now}"
+            return false
+          end
+        end
+      end
+      private
+      def ping_url
+        raise NotImplementedError, "Define ping_url in #{self.class}"
+      end
+      def search_engine
+        raise NotImplementedError, "Define search_engine in #{self.class}"
+      end
+      # Private: A helper method to access Pingr::logger
+      #
+      # Returns A Logger instance
+      def logger
+        Pingr.logger
+      end
+    end
+  end
+end

data/lib/pingr/search_engines/bing.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Pingr
+  module SearchEngines
+    require 'pingr/search_engines/base'
+    class Bing < Base
+      private
+      def search_engine
+        :bing
+      end
+      # Private: The path to ping to submit sitemaps for this search_engine
+      #
+      # Returns URI
+      def ping_url
+        URI("https://www.bing.com/ping?sitemap=#{URI.escape(sitemap_url)}")
+      end
+    end
+  end
+end

data/lib/pingr/search_engines/google.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Pingr
+  module SearchEngines
+    require 'pingr/search_engines/base'
+    class Google < Base
+      private
+      def search_engine
+        :google
+      end
+      # Private: The path to ping to submit sitemaps for this search_engine
+      #
+      # Returns URI
+      def ping_url
+        URI("https://www.google.com/webmasters/tools/ping?sitemap=#{URI.escape(sitemap_url)}")
+      end
+    end
+  end
+end

data/lib/pingr/version.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 module Pingr
-  VERSION = "0.0.3"
+  VERSION = '0.2.3'
 end

data/lib/pingr.rb CHANGED Viewed

@@ -1,26 +1,31 @@
-require "pingr/version"
-require "pingr/request"
+# frozen_string_literal: true
+require 'pingr/version'
+require 'pingr/request'
 module Pingr
+  require 'logger'
   # Exceptions raised from within Pingr are of this class
   class PingrError < StandardError; end
-  # Currently supported search engines
-  SUPPORTED_SEARCH_ENGINES = [:google, :bing]
   # Public: Set the mode Pingr is running in
-  #
+  #
   # mode_name - A Symbol or String value for the mode. Must be one of :test or :live
-  #
+  #
   # Raises PingrError if an invalid value is passed
   def self.mode=(mode_name)
-    raise PingrError, "Unknown mode: #{mode_name}" unless mode_name.to_s =~ /test|live/
+    unless mode_name.to_s =~ /test|live/
+      raise PingrError, "Unknown mode: #{mode_name}"
+    end
     @mode = mode_name.to_sym
   end
   # Public: The mode Pingr is running in
-  #
+  #
   # Returns a Symbol either :test or :live
   def self.mode
     @mode ||= begin
@@ -31,33 +36,36 @@ module Pingr
       end
     end
   end
   # Public: A custom logger to keep track of the Pings
-  #
+  #
   # Returns a Logger object. By default, the log clears itself every week
   def self.logger
-    @logger ||= Logger.new(logger_name, shift_age = 'weekly')
+    @logger ||= if defined?(Rails)
+      Rails.logger
+    else
+      Logger.new(logger_name, shift_age = 'weekly')
+    end
   end
   # Public: Sets the logger to be used.
   # If the developer would like to use their own custom logger, let 'em.
   def self.logger=(_logger)
     @logger = _logger
   end
   private
   # Private: The name of the Logger used by Pingr.
   # If we've detected a Rails app, sets up a log file in the log directory.
   # Otherwise, use STDOUT
-  #
+  #
   # Returns a String with the logger name or an IO object
   def self.logger_name
     if defined?(Rails)
-      Rails.root.join('log', "pingr.#{Rails.env}.log")
+      Rails.root.join('log', "#{Rails.env}.log").to_s
     else
       STDOUT
     end
   end
 end

data/lib/tasks/pingr.rake ADDED Viewed

@@ -0,0 +1,19 @@
+require "dotenv/tasks"
+namespace :pingr do
+  require "pingr"
+  desc "Request search engines crawl the sitemap again"
+  task :ping => :dotenv do |t, args|
+    sitemap_url = ENV.fetch('SITEMAP_URL')
+    if sitemap_url.nil?
+      warn("Please provide SITEMAP_URL")
+      exit(1)
+    else
+      puts("Pinging search engines...")
+      Pingr::Request.new(sitemap_url)
+      puts("Done!")
+    end
+  end
+end

data/pingr.gemspec CHANGED Viewed

@@ -1,21 +1,25 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pingr/version'
 Gem::Specification.new do |gem|
-  gem.name          = "pingr"
+  gem.name          = 'pingr'
   gem.version       = Pingr::VERSION
-  gem.authors       = ["Bodacious"]
-  gem.email         = ["bodacious@katanacode.com"]
-  gem.description   = %q{A simple gem for pinging search engines with your XML sitemap}
-  gem.summary       = %q{Ping search engines with your XML Sitemap}
-  gem.homepage      = "https://github.com/KatanaCode/pingr"
+  gem.authors       = ['Bodacious']
+  gem.email         = ['gavin@gavinmorrice.com']
+  gem.description   = 'A simple gem for pinging search engines with your XML sitemap'
+  gem.summary       = 'Ping search engines with your XML Sitemap'
+  gem.homepage      = 'https://github.com/Bodacious/pingr'
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.add_development_dependency "rake"
+  gem.require_paths = ['lib']
+  gem.add_runtime_dependency 'dotenv'
+  gem.add_runtime_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end

data/spec/pingr_spec.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+RSpec.describe Pingr do
+  it 'has a version number' do
+    expect(Pingr::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'bundler/setup'
+require 'pingr'
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata CHANGED Viewed

@@ -1,76 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: pingr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease:
+  version: 0.2.3
 platform: ruby
 authors:
 - Bodacious
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple gem for pinging search engines with your XML sitemap
 email:
-- bodacious@katanacode.com
-executables: []
+- gavin@gavinmorrice.com
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
+- docs/Pingr.html
+- docs/Pingr/PingrError.html
+- docs/Pingr/Request.html
+- docs/Pingr/SearchEngines.html
+- docs/Pingr/SearchEngines/Base.html
+- docs/Pingr/SearchEngines/Bing.html
+- docs/Pingr/SearchEngines/Google.html
+- docs/_config.yml
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/index.md
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
 - lib/pingr.rb
 - lib/pingr/request.rb
+- lib/pingr/search_engines/base.rb
+- lib/pingr/search_engines/bing.rb
+- lib/pingr/search_engines/google.rb
 - lib/pingr/version.rb
+- lib/tasks/pingr.rake
 - pingr.gemspec
-homepage: https://github.com/KatanaCode/pingr
+- spec/pingr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Bodacious/pingr
 licenses: []
-post_install_message:
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4232574977062910475
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4232574977062910475
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
 summary: Ping search engines with your XML Sitemap
-test_files: []
+test_files:
+- spec/pingr_spec.rb
+- spec/spec_helper.rb