pingr 0.0.3 → 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4489ba3b7b8c39ee1e18bbd9e80d366d13020aa790b8bf6b0f332cac8376018
+  data.tar.gz: 60ef57d71a99b5ca892c45cf419eb8af039f4a1a94eed3bd50b30f57b00344f4
+SHA512:
+  metadata.gz: 9cb214d121f3f557641963bccf2ae67cfbb9fbf190c7f1f2e57a4dc6735d381fa3aa27fed29decba46c6b3b3708254489d38d1dcaf28e581106adddd5b2dcba6
+  data.tar.gz: 2c452f2ccf7e495de33d63f1ec38140c156ebe32f28cb4b914fb5038fc6336adeb38fb146e8ca5f22a215b4019c526b34c23de8272a0e55f4cdf7a721493aa4f

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
 # Specify your gem's dependencies in pingr.gemspec
 gemspec

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 Bodacious
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2020 Bodacious
 
-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:
+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 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.
+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

@@ -77,3 +77,8 @@ Pingr.mode = :live if Rails.env =~ /staging|production/
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## About Katana Code
+
+Katana Code are [iPhone app and Ruby on Rails Developers in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").

data/Rakefile

@@ -1 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+import "./lib/tasks/pingr.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+Bundler::GemHelper.install_tasks

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pingr'
+
+# 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/lib/pingr.rb

@@ -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/pingr/request.rb

@@ -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

@@ -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

@@ -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

@@ -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

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

data/lib/tasks/pingr.rake

@@ -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

@@ -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         = ['bodacious@katanacode.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/KatanaCode/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.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'dotenv'
+  gem.add_runtime_dependency 'rake'
   
-  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'rspec'
 end

data/spec/pingr_spec.rb

@@ -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

@@ -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

@@ -1,76 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: pingr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Bodacious
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2020-06-18 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: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - 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
+- spec/pingr_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/KatanaCode/pingr
 licenses: []
+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
+rubygems_version: 3.1.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ping search engines with your XML Sitemap
-test_files: []
+test_files:
+- spec/pingr_spec.rb
+- spec/spec_helper.rb