rss_watcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffe62440dbb07c9f6dc0a8f3e92063d8830cb3beffb5c71e0db425d7acf599ec
+  data.tar.gz: fcb086bbf67e619ef0aca722a9804e5306e1917e71b892ad707c7d80f94e4d09
+SHA512:
+  metadata.gz: 7711af450ab72ab3409e8738099841722961f1303e87d38739c828ebba104f3f2f2d93b5927aa924e9198c4240f61ef9df7608e377afa247eb7da6ef9616520f
+  data.tar.gz: ffe570172578bfc3e391c8e1af82de1554d7df7adf23fff593d34090e9cacbda25d55becdf7c76abeb5bbab40f3de99000ef73f42a62d49cb15fe7745f291eca

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rss_watcher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    rss_watcher (0.1.0)
+      rss (~> 0.2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (10.5.0)
+    rss (0.2.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rss_watcher!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,35 @@
+# RssWatcher
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rss_watcher`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rss_watcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rss_watcher
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/owaiswiz/rss_watcher.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rss_watcher"
+
+# 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/rss_watcher.rb

@@ -0,0 +1,23 @@
+require "rss"
+require "open-uri"
+require "rss_watcher/version"
+require "rss_watcher/feed_manager"
+
+module RssWatcher
+  class Error < StandardError; end
+  # Your code goes here...
+  def self.watch url:, update_interval: 10, cache_file: "rss_watcher.cache"
+    #url - RSS feed url
+    #updated_interval - Seconds to wait for between checking for updates to the RSS feed
+    #cache_file - Path to a file that this gem uses internally for remembering the last seen item
+    while true
+      open(url) do |rss|
+        feed = RSS::Parser.parse(rss)
+        RssWatcher::FeedManager.new(cache_file).get_new_feed_items(feed.items).each do |item|
+          yield item if block_given?
+        end
+      end
+      sleep update_interval
+    end
+  end
+end

data/lib/rss_watcher/feed_manager.rb

@@ -0,0 +1,58 @@
+module RssWatcher
+  class FeedManager
+    def initialize cache_file_path
+      @cache_file_path = cache_file_path
+    end
+
+    def get_new_feed_items feed_items
+      load_cache
+
+      new_feed_items = []
+      feed_items = feed_items.sort_by(&:pubDate).reverse
+
+      feed_items.each do |item|
+        break if old_item? item
+        new_feed_items << item if new_item? item
+      end
+
+      update_cache feed_items
+      dump_cache
+
+      return new_feed_items.reverse
+    end
+
+    private
+    def new_item? item
+      item.pubDate.to_i > @cache[:time] || (!old_item?(item) && !item_in_cache?(item))
+    end
+
+    def old_item? item
+      item.pubDate.to_i < @cache[:time]
+    end
+
+    def item_in_cache? item
+      @cache[:items_title].include? item.title
+    end
+
+    def load_cache
+      if File.exists? @cache_file_path
+        @cache = Marshal.load File.read(@cache_file_path)
+      else
+        @cache = {time: Time.now.to_i, items_title: []}
+      end
+    end
+
+    def update_cache feed_items
+      return if feed_items.length == 0
+      most_recent_items = feed_items.group_by(&:pubDate)[feed_items.first.pubDate]
+      @cache[:time] = most_recent_items.first.pubDate.to_i
+      @cache[:items_title] = most_recent_items.collect &:title
+    end
+
+    def dump_cache
+      File.open(@cache_file_path, 'w') do |file|
+        file.write Marshal.dump(@cache)
+      end
+    end
+  end
+end

data/lib/rss_watcher/version.rb

@@ -0,0 +1,3 @@
+module RssWatcher
+  VERSION = "0.1.0"
+end

data/rss_watcher.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rss_watcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rss_watcher"
+  spec.version       = RssWatcher::VERSION
+  spec.authors       = ["Owais"]
+  spec.email         = ["owaiswiz@gmail.com"]
+
+  spec.summary       = %q{A Ruby Gem For Watching RSS Feeds}
+  spec.homepage      = "https://github.com/owaiswiz/rss_watcher"
+
+  # 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"]
+
+  spec.add_dependency "rss", "~> 0.2.8"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rss_watcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rss_watcher.rb
+- lib/rss_watcher/feed_manager.rb
+- lib/rss_watcher/version.rb
+- rss_watcher.gemspec
+homepage: https://github.com/owaiswiz/rss_watcher
+licenses: []
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem For Watching RSS Feeds
+test_files: []