web_update_checker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a1ad7ce5402c738c3085ff43a47f4a9a832d198
+  data.tar.gz: 12939a88848de01cdf26aaa863d7530a323ad804
+SHA512:
+  metadata.gz: f0a8c4fa6b72967bdf1cbd145549688b0a910e493abe74b18540f62dab3b446edbc5295e67a61f5597aaf7caf2ae1919444b474e92e6078c0e9b334c03ed51fc
+  data.tar.gz: a9c3b7be79ab0a9a32125a46563befb61bdb076aa12db9465bb1dcc6e6df7b8a6b68e60de175b2b380259dfd74c6cf280d0577aa4f2a03cd876d53f20b790912

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

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

data/Checker.rb

@@ -0,0 +1,24 @@
+
+url = 'http://hot-buzz.o-ta-su-ke.net/'
+
+regex = /<h1>(.*)<\/h1>/
+
+mail = Mail.new do
+  from    'matsubokkuri@gmail.com'
+  to      'matsubokkuri@gmail.com'
+  subject 'Web site is updated!'
+  body     url
+end
+
+mail.delivery_method :smtp, {
+  address:   'smtp.gmail.com',
+  port:      587,
+  user_name: 'matsubokkuri',
+  password:'hogehoge1',
+  authentication: 'plain',
+  enable_starttls_auto: true
+}
+
+Checker.new(url, regex, mail).execute
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Matsukura
+
+MIT License
+
+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,59 @@
+# WebUpdateChecker
+
+This library polls an URL and notifies if the contents is changed.
+This is useful if you want to be notified as soon as a web site contents is changed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'web_update_checker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install web_update_checker
+
+## Usage
+
+
+main.rb
+```
+url = 'http://matsu.teraren.com/blog/'
+
+regex = /<h1>(.*)<\/h1>/
+
+mail = Mail.new do
+from    'TODO@example.com'
+to      'TODO@example.com'
+subject 'Web site is updated!'
+body     @url
+end
+
+mail.delivery_method :smtp, {
+address:   'localhost',
+             port:      25,
+}
+
+
+url = 'http://example.com/'
+WebUpdateChecker::Checker.new(url, regex, mail).execute
+```
+
+
+Execute like a following CLI
+```
+% while [ true ]; do; ruby main.rb; sleep 30; done
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/web_update_checker/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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/web_update_checker/version.rb

@@ -0,0 +1,3 @@
+module WebUpdateChecker
+  VERSION = "0.0.1"
+end

data/lib/web_update_checker.rb

@@ -0,0 +1,95 @@
+require "web_update_checker/version"
+
+# ruby standard
+require "net/http"
+require "uri"
+require 'fileutils'
+
+# gem
+require 'mail'
+
+module WebUpdateChecker
+
+  class Checker
+
+    #
+    # @param [String] url to Checker
+    # @param [Regex] Regex of to match comparing text
+    # @param [Mail] instance of Mail
+    #
+    def initialize(url, regex = nil, mail = nil)
+      @url  = url
+      @regex = regex
+      @mail = mail
+      @tmp_file_last    = '/tmp/site_last.txt'
+      @tmp_file_current = '/tmp/site_current.txt'
+    end
+
+
+    #
+    # @param [Bool] true if changed, false if no change, nil if first time.
+    #
+    def execute
+
+      uri = URI.parse(@url)
+
+
+      uri = URI(@url)
+      req = Net::HTTP::Get.new(uri.path)
+
+      response = Net::HTTP.start(
+        uri.host, uri.port, 
+        :use_ssl => uri.scheme == 'https', 
+        :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |https|
+          https.request(req)
+        end
+
+
+
+        matched_body = nil
+        if @regex
+          match = @regex.match(response.body)
+          if match.nil?
+            raise "Regex does not match"
+          end
+          matched_body = match[1]
+        else
+          matched_body = response.body
+        end
+
+
+        unless File.exist?(@tmp_file_last)
+          # first time
+          File.write(@tmp_file_last,    matched_body)
+          File.write(@tmp_file_current, matched_body)
+          return nil
+        else
+          # 2nd time
+          File.write(@tmp_file_current, matched_body)
+        end
+
+
+        result = nil
+        unless FileUtils.compare_file(@tmp_file_last, @tmp_file_current)
+          @mail.deliver! if @mail
+          result = true
+        else
+          result = false
+        end
+
+        File.write(@tmp_file_last,    matched_body)
+
+        return result
+
+    end
+
+
+  def cleanup
+    File.unlink(@tmp_file_last)    if File.exists?(@tmp_file_last)
+    File.unlink(@tmp_file_current) if File.exists?(@tmp_file_current)
+  end
+
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'web_update_checker'

data/spec/web_update_checker_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe WebUpdateChecker do
+
+  before(:all) do
+    @url = 'http://example.com/'
+    WebUpdateChecker::Checker.new(@url).cleanup
+  end
+
+  before(:each) do
+
+    @regex = /<h1>(.*)<\/h1>/
+
+    @mail = Mail.new do
+      from    'TODO@example.com'
+      to      'TODO@example.com'
+      subject 'Web site is updated!'
+      body     @url
+    end
+
+    @mail.delivery_method :smtp, {
+      address:   'localhost',
+      port:      25,
+
+#      address:   'smtp.gmail.com',
+#      port:      587,
+#      user_name: '<TODO>',
+#      password:  '<TODO>',
+#      authentication: 'plain',
+#      enable_starttls_auto: true
+    }
+
+
+
+  end
+
+  it 'should have a version number' do
+    WebUpdateChecker::VERSION.should_not be_nil
+  end
+
+  it 'should initialize temporary file' do
+
+    WebUpdateChecker::Checker.new(@url).execute.should be_nil
+
+  end
+
+
+  it 'should be return as same contents' do
+
+    WebUpdateChecker::Checker.new(@url).execute.should be_false
+
+  end
+
+
+  it 'should be return as different contents' do
+
+    url = 'http://www.yahoo.co.jp/'
+    WebUpdateChecker::Checker.new(url).execute.should be_true
+
+  end
+
+
+  it 'should be send a notification mail' do
+
+    WebUpdateChecker::Checker.new(@url, @regex, @mail).execute.should be_true
+
+  end
+
+
+  after(:all) do
+  end
+
+end

data/web_update_checker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'web_update_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "web_update_checker"
+  spec.version       = WebUpdateChecker::VERSION
+  spec.authors       = ["Yuki Matsukura"]
+  spec.email         = ["matsubokkuri@gmail.com"]
+  spec.summary       = %q{Check the web page is changed comparing to the previous time.}
+  spec.description   = %q{First time of execution, this library get the specifified URL and preserve the result. After the 2nd time, compare the current page contents and previous contents. }
+  spec.homepage      = "http://github.com/matsubo/web_update_checker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0.9"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "mail", "~> 2.3"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: web_update_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuki Matsukura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 'First time of execution, this library get the specifified URL and preserve
+  the result. After the 2nd time, compare the current page contents and previous contents. '
+email:
+- matsubokkuri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Checker.rb
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/web_update_checker.rb
+- lib/web_update_checker/version.rb
+- spec/spec_helper.rb
+- spec/web_update_checker_spec.rb
+- web_update_checker.gemspec
+homepage: http://github.com/matsubo/web_update_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Check the web page is changed comparing to the previous time.
+test_files:
+- spec/spec_helper.rb
+- spec/web_update_checker_spec.rb
+has_rdoc: