pingr 0.0.3 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1da583e92b4854f6711ef65023bfa6063d8438e87ed5ab3010153f610fa97213
+  data.tar.gz: ab8fb62ec2b20063c6b06229103301bb9247abf6134760d9e424248df0c30648
+SHA512:
+  metadata.gz: c6125d0330a643114584c6f6a78b5e36c681f6111d157e8d84452c1d9ee016533c97d1d1c0db5dbd40cc8ca88114617ada2cf23cb519ed4d6d5c66a211595712
+  data.tar.gz: 441d0e64fb314ae818db406a537df8c5e922a2a451dd65539720f0883231f390dd51a3d3e16a04a40dd55e6d27071ffc69c4aca249fd9434eda45fa6e3f9c0e3

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc
@@ -15,3 +14,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/.yardopts

@@ -0,0 +1,7 @@
+--plugin tomdoc
+--private
+--hide-void-return
+--title "Pingr"
+--output-dir=docs
+--markup=markdown
+--markup-provider=redcarpet

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

@@ -22,7 +22,7 @@ From within your app (most likely a controller):
 
 ``` ruby
 def ping_sitemaps
-  Pingr::Request.new(:google, my_sitemap_url).ping
+  Pingr::Request.new(my_sitemap_url) # This will ping Google and Bing
 end
 ```
 
@@ -32,30 +32,21 @@ A good way to do this would be using Rails's after filters:
 class PostsController < ActionController::Base
 
   after_filter :ping_sitemaps, only: [:create, :update, :destroy]
-  
-  # ... 
-  
+
+  # ...
+
   private
-  
+
   def ping_sitemaps
-    Pingr::Request.new(:google, my_sitemap_url).ping
-    Pingr::Request.new(:bing, my_sitemap_url).ping
+    Pingr::Request.new(my_sitemap_url)
   end
-  
-end
-```
-
-You can ping all [supported search engines](https://github.com/KatanaCode/pingr/blob/master/lib/pingr.rb#L9) by doing:
 
-``` ruby
-def ping_sitemaps
-  for search_engine in Pingr::SUPPORTED_SEARCH_ENGINES
-    Pingr::Request.new(search_engine, my_sitemap_url).ping
-  end
 end
 ```
 
-... not the most elegant solution but we'll improve that in future versions.
+You can view the [supported search engines](https://github.com/KatanaCode/pingr/tree/master/lib/pingr/search_engines) and add your own by viewing the code in this directory:
+
+https://github.com/KatanaCode/pingr/tree/master/lib/pingr/search_engines
 
 ## Modes
 
@@ -77,3 +68,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
+
+Katana are [web and mobile app 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/docs/Pingr/PingrError.html

@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: Pingr::PingrError
+  
+    &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 = "Pingr::PingrError";
+  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 (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Pingr.html" title="Pingr (module)">Pingr</a></span></span>
+     &raquo; 
+    <span class="title">PingrError</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>Exception: Pingr::PingrError
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">StandardError</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next">Pingr::PingrError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/pingr.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Exceptions raised from within Pingr are of this class</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+  
+
+</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/docs/Pingr/Request.html

@@ -0,0 +1,232 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Pingr::Request
+  
+    &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 = "Pingr::Request";
+  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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Pingr.html" title="Pingr (module)">Pingr</a></span></span>
+     &raquo; 
+    <span class="title">Request</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>Class: Pingr::Request
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Pingr::Request</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/pingr/request.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The object created to ping a search engine with a sitemap</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(sitemap_url)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Initialize a new ping request.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(sitemap_url)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Initialize a new ping request</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>sitemap_url</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>A String url of the sitemap we&#39;re submitting</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+14
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pingr/request.rb', line 14</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sitemap_url'>sitemap_url</span><span class='rparen'>)</span>
+  <span class='const'><span class='object_link'><a href="../Pingr.html" title="Pingr (module)">Pingr</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SearchEngines.html" title="Pingr::SearchEngines (module)">SearchEngines</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SearchEngines/Bing.html" title="Pingr::SearchEngines::Bing (class)">Bing</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SearchEngines/Base.html#initialize-instance_method" title="Pingr::SearchEngines::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sitemap_url'>sitemap_url</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_ping'>ping</span>
+  <span class='const'><span class='object_link'><a href="../Pingr.html" title="Pingr (module)">Pingr</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SearchEngines.html" title="Pingr::SearchEngines (module)">SearchEngines</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SearchEngines/Google.html" title="Pingr::SearchEngines::Google (class)">Google</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SearchEngines/Base.html#initialize-instance_method" title="Pingr::SearchEngines::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sitemap_url'>sitemap_url</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_ping'>ping</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+</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>