RubyGems - rss_notifier - Versions diffs - 0.1.5 → 0.2.0 - Mend

rss_notifier 0.1.5 → 0.2.0

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 (15) hide show

checksums.yaml +4 -4
data/README.md +11 -0
data/lib/rss_notifier/adapter/email.html.erb +2 -2
data/lib/rss_notifier/adapter/email.rb +44 -10
data/lib/rss_notifier/adapter/pushbullet.rb +1 -1
data/lib/rss_notifier/app.rb +32 -23
data/lib/rss_notifier/config.rb +4 -4
data/lib/rss_notifier/db.rb +40 -8
data/lib/rss_notifier/models.rb +9 -0
data/lib/rss_notifier/models/feed.rb +65 -0
data/lib/rss_notifier/models/item.rb +61 -0
data/lib/rss_notifier/version.rb +1 -1
data/rss_notifier.gemspec +3 -0
metadata +47 -3
data/lib/rss_notifier/item.rb +0 -60

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab295187f2099b9dd59cac181cbc86299d93fa43
-  data.tar.gz: 8293bf6ac91fd26a831ba495bc7515710cf4d3cc
+  metadata.gz: 19880610ce9f65b63fb64bb674fea707c709f720
+  data.tar.gz: 70e5677949a56fb3baf1fabf7b1245101d883716
 SHA512:
-  metadata.gz: 6f5cf66c18989cf7b32aa290f662094faf23fc14b51b20ae4f3802bfef59cbaff7154b296bb6585ed2d15cfced9be8c966ed8b56f97af044fd518ed72b12353c
-  data.tar.gz: 7cd8955e87cd8e51f867f110da13d39f1811c916057341593cd1b3fd5f733f8fe14dd3979b515024229d0c16e9d02551b36ce5f0b9580c00bc0933b0bdd971cb
+  metadata.gz: fcd67b4add33589b3695441d5e5c225680e57848b266f53100f9d9fb47842ac4ae7f9df69978686c204a4d78a500aeb2aca01c176136bd16a44204fe949309cc
+  data.tar.gz: 32419a690ee70c8cc94be2b5877bf4250e4f806a9ee04b2b4b762de847a798decb74e399922a2248b11596af84d236d790949e6a8dbff94263384ba70d1341cf

data/README.md CHANGED

@@ -3,6 +3,17 @@
 It checks given rss urls every given period and notifies you using [Pushbullet](https://www.pushbullet.com).
+## Getting notifications
+### Email
+Create an account on https://sendgrid.com and generate API Key.
+### Pushbullet
+Create an account on https://www.pushbullet.com and generate Access Token.
 ## Usage
 Install the gem

data/lib/rss_notifier/adapter/email.html.erb CHANGED

@@ -42,11 +42,11 @@
     </style>
   </head>
   <body>
-    <h1><a href="<%= item.link %>"><%= item.title %></a></h1>
+    <h1><a href="<%= item.link %>"><%= item.feed.name %> | <%= item.title %></a></h1>
     <hr>
     <div class="row">
       <div class="mini-info">
-        <b>RSS URL:</b> <span style="word-wrap: break-word;"><%= item.rss_url %></span> <br><br>
+        <b>RSS URL:</b> <span style="word-wrap: break-word;"><%= item.feed.url %></span> <br><br>
         <b>Date:</b> <%= item.date.strftime('%Y-%m-%d %H:%M:%S') %> <br>
       </div>
       <div class="clearfix"></div>

data/lib/rss_notifier/adapter/email.rb CHANGED

@@ -1,5 +1,6 @@
 require 'http'
 require 'erb'
+require 'sendgrid-ruby'
 module RssNotifier
   module Adapter
@@ -9,30 +10,63 @@ module RssNotifier
       HTML_TEMPLATE = File.expand_path('../email.html.erb', __FILE__)
-      # curl -s --user 'api:YOUR_API_KEY' \
-      #     https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages \
-      #     -F from='Excited User <mailgun@YOUR_DOMAIN_NAME>' \
-      #     -F to=YOU@YOUR_DOMAIN_NAME \
-      #     -F to=bar@example.com \
-      #     -F subject='Hello' \
-      #     -F text='Testing some Mailgun awesomness!'
-      def initialize(email)
+      # @param email [String]
+      # @param config [RssNotifier::Config]
+      def initialize(email, config)
+        @config = config
         @email = email
         @template = ERB.new(File.read(HTML_TEMPLATE))
+        @config[:adapters][:email][:from] or
+          raise 'config[:adapters][:email][:from] is not configured.'
+        @config[:adapters][:email][:sendgrid_api_key] or
+          raise 'config[:adapters][:email][:sendgrid_api_key] is not configured.'
       end
       def notify(item)
         b = binding
         b.local_variable_set(:item, item)
         html = @template.result(b)
-        puts "-------"
+        RssNotifier.logger.debug("Adapter::Email #{email}, #{html}")
+        mail = SendGrid::Mail.new do |m|
+          m.to = email
+          m.from = @config[:adapters][:email][:from]
+          m.subject = "#{item.feed.name} | #{item.title}"
+          m.text = html
+        end
+        client = RssNotifier::Adapter::Email.client(@config[:adapters][:email][:sendgrid_api_key])
+        begin
+          res = client.send(mail)
+          if res.code == 200
+            RssNotifier.logger.warn("Could not notify #{self}. Code=#{res.code}")
+            p res.body
+          else
+            RssNotifier.logger.debug("#{self} notified")
+            return false
+          end
+        rescue => e
+          puts e.to_s
+          puts e.backtrace
+          return false
+        end
+        true
       end
       def to_s
         "<Adapter::Email email=#{email}>"
       end
+      def self.client(api_key)
+        @clients ||= {}
+        @clients[api_key] ||= SendGrid::Client.new(api_key: api_key)
+      end
     end
   end
 end

data/lib/rss_notifier/adapter/pushbullet.rb CHANGED

@@ -16,7 +16,7 @@ module RssNotifier
       def notify(item)
         body = JSON.dump({
           'type' => 'link',
-          'title' => "#{item.rss_title}",
+          'title' => "#{item.feed.name}",
           'body' => item.title,
           'url' => item.link
         })

data/lib/rss_notifier/app.rb CHANGED

@@ -1,7 +1,7 @@
 require 'rss_notifier/adapter'
 require 'rss_notifier/config'
 require 'rss_notifier/db'
-require 'rss_notifier/item'
+require 'rss_notifier/models'
 require 'pathname'
 require 'rss'
@@ -50,7 +50,7 @@ module RssNotifier
       notify.each do |d|
         next unless d[:enabled]
         if d[:adapter] == 'email'
-          @notify << Adapter::Email.new(d[:email])
+          @notify << Adapter::Email.new(d[:email], @config)
         elsif d[:adapter] == 'pushbullet'
           @notify << Adapter::Pushbullet.new(d[:name], d[:access_token])
         else
@@ -67,40 +67,47 @@ module RssNotifier
       end
     end
+    # @return [Array] of tuples (url, name)
+    def rss_urls_from_config
+      @rss_urls_from_config ||= @config.rss_urls.map do |o|
+        [ o[:url].to_s.strip, o[:name].to_s.strip ]
+      end.to_h
+    end
     def check_rss!
-      @config.rss_urls.each do |url_object|
-        title, url = url_object[:title], url_object[:url]
+      changed_items = []
+      rss_urls_from_config.each do |url, name|
+        RssNotifier.logger.info "Checking #{name} | #{url}"
-        RssNotifier.logger.info "Checking #{title} | #{url}"
+        feed = @db.get_feed(url: url, name: name)
-        raw = HTTP.get(url).to_s
-        feed = nil
+        rss_raw = nil
+        response = nil
         begin
-          raw = raw.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-          feed = RSS::Parser.parse(raw)
+          response = HTTP.get(url)
+          # require 'pry'; binding.pry
+          raw_encoded = response.to_s.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+          rss_raw = RSS::Parser.parse(raw_encoded)
         rescue => e
           RssNotifier.logger.warn "Cannot parse RSS: #{e}"
           puts e.backtrace
           next
         end
-        items = []
-        feed.items.each do |item|
-          items << Item.new({
-            rss_url: url,
-            rss_title: title,
-            link: item.link,
-            title: item.title,
-            description: item.description,
-            date: item.date
+        rss_raw.items.each do |raw_item|
+          item = feed.find_or_create_item(link: raw_item.link)
+          item.update({
+            title: raw_item.title,
+            description: raw_item.description,
+            date: raw_item.date
           })
+          changed_items << item if item.changed?
         end
-        @db.update(items)
+        feed.save
       end
-      changed_items = @db.changed_items
-      is_changed = @db.changed?
-      @db.save
-      unless is_changed
+      if changed_items.empty?
         RssNotifier.logger.info 'No changes'
         return
       end
@@ -111,6 +118,8 @@ module RssNotifier
         changed_items.each do |item|
           notify!(item)
         end
+      else
+        RssNotifier.logger.info "#{changed_items.size} items changed"
       end
     end

data/lib/rss_notifier/config.rb CHANGED

@@ -7,16 +7,16 @@ module RssNotifier
     DEFAULTS = {
       adapters: {
         email: {
-          mailgun_api: 'something',
-          from: 'Excited User <mailgun@YOUR_DOMAIN_NAME>'
+          sendgrid_api_key: '<Get it from sendgrid.com>',
+          from: 'RSS Notifier <rss-notifier@joma.pw>',
         }
       },
       notify: [
         { email: 'me@example.com', adapter: 'email', enabled: false },
-        { name: 'mini me', access_token: '<get from pushbullet.com/#settings>', adapter: 'pushbullet', enabled: false },
+        { name: 'mini me', access_token: '<Get it from pushbullet.com>', adapter: 'pushbullet', enabled: false },
       ],
       rss_urls: [
-        { title: 'Some News', url: 'http://some-site.com/rss' }
+        { name: 'Some News', url: 'http://some-site.com/rss' }
       ],
       period_in_minutes: 20
     }

data/lib/rss_notifier/db.rb CHANGED

@@ -1,15 +1,18 @@
 require 'yaml/store'
+require 'rss_notifier/models'
+require 'pry'
 module RssNotifier
   class Db
     attr_reader :store
-    attr_accessor :items
+    attr_accessor :feeds
     def initialize(store)
-      # { item_url => Item, ... }
-      @items = {}
+      @feeds = {}
       @store = store
     end
@@ -56,13 +59,42 @@ module RssNotifier
       true
     end
-    def self.load(filename)
-      store = YAML::Store.new(filename)
-      db = RssNotifier::Db.new(store)
+    # @return [RssNotifier::Models::Feed] creates new Feed if not found
+    def get_feed(url:, name:)
+      @feeds[url] ||= RssNotifier::Models::Feed.new(url: url.to_s.strip, name: name)
+    end
+    # @return [RssNotifier::Models::Feed]
+    def find_feed(url:)
+      @feeds[url.to_s.strip]
+    end
+    def load
+      @feeds = {}
       store.transaction do
-        db.items = store['items'] || {}
+        feeds_raw = store['feeds'] || {}
+        feeds_raw.each do |url, feed_raw|
+          feed = RssNotifier::Models::Feed.new(feed_raw)
+          @feeds[feed.url] = feed
+        end
       end
-      db
+      self
+    end
+    # @return [RssNotifier::Db]
+    def self.default
+      @default or raise "Not initialized"
+    end
+    def self.default=(default)
+      @default = default
+    end
+    def self.load(filename)
+      store = YAML::Store.new(filename)
+      RssNotifier::Db.default = RssNotifier::Db.new(store)
+      RssNotifier::Db.default.load
+      RssNotifier::Db.default
     end
   end

data/lib/rss_notifier/models.rb ADDED

@@ -0,0 +1,9 @@
+require 'rss_notifier/models/item'
+require 'rss_notifier/models/feed'
+Virtus.finalize
+module RssNotifier
+  module Models
+  end
+end

data/lib/rss_notifier/models/feed.rb ADDED

@@ -0,0 +1,65 @@
+require 'virtus'
+require 'inflecto'
+require 'json'
+# {
+#   rss_url => {
+#     'Last-Modified' => 'blah',
+#     'items' => { item_url => Item, ... },
+#   }
+# }
+module RssNotifier
+  module Models
+    class Feed
+      include Virtus.model(:finalize => false)
+      attribute :url, String
+      attribute :name, String
+      attribute :items, Array['RssNotifier::Models::Item']
+      # updated_at in DB
+      attribute :updated_at, Time
+      # @return [RssNotifier::Models::Item]
+      def find_or_create_item(link:)
+        item = items.detect { |i| i.link.to_s.strip == link.to_s.strip }
+        unless item
+          item = RssNotifier::Models::Item.new(feed_url: self.url, link: link)
+          self.items << item
+        end
+        item
+      end
+      def store
+        @store ||= RssNotifier::Db.default.store
+      end
+      def changed?
+        !updated_at || items.any?(&:changed?)
+      end
+      def save
+        items.each do |item|
+          item.updated_at = Time.now
+        end
+        self.updated_at = Time.now
+        store.transaction do
+          store["feeds"] ||= {}
+          store["feeds"][url] = self.to_db_object
+        end
+      end
+      def to_db_object
+        {
+          'url' => url,
+          'name' => name,
+          'updated_at' => updated_at,
+          'items' => items.map(&:to_db_object),
+        }
+      end
+    end
+  end
+end

data/lib/rss_notifier/models/item.rb ADDED

@@ -0,0 +1,61 @@
+require 'virtus'
+module RssNotifier
+  module Models
+    class Item
+      include Virtus.model
+      attribute :link, String
+      attribute :title, String
+      attribute :description, String
+      attribute :date, Time
+      # updated_at in DB
+      attribute :updated_at, Time
+      attribute :feed_url, String
+      def feed
+        @feed ||= RssNotifier::Db.default.find_feed(url: feed_url)
+      end
+      def update(attributes)
+        __title = self.title
+        self.attributes = attributes
+        @__changed = __title != self.title
+      end
+      def changed?
+        new_record? || @__changed
+      end
+      def new_record?
+        !self.updated_at
+      end
+      def to_h
+        {
+          feed_url: feed.url,
+          feed_name: feed.name,
+          link: link,
+          title: title,
+          description: description,
+          date: date,
+        }
+      end
+      def to_db_object
+        {
+          'link' => link,
+          'title' => title,
+          'description' => description,
+          'date' => date,
+          'updated_at' => updated_at,
+          'feed_url' => feed_url,
+        }
+      end
+    end
+  end
+end

data/lib/rss_notifier/version.rb CHANGED

@@ -1,3 +1,3 @@
 module RssNotifier
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/rss_notifier.gemspec CHANGED

@@ -21,6 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http', '~> 1.0'
   spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'inflecto', '~> 0.0'
+  spec.add_dependency 'sendgrid-ruby', '~> 1.1'
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rss_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Zhomart Mukhamejanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +161,9 @@ files:
 - lib/rss_notifier/cli.rb
 - lib/rss_notifier/config.rb
 - lib/rss_notifier/db.rb
-- lib/rss_notifier/item.rb
+- lib/rss_notifier/models.rb
+- lib/rss_notifier/models/feed.rb
+- lib/rss_notifier/models/item.rb
 - lib/rss_notifier/version.rb
 - rss_notifier.gemspec
 homepage: https://github.com/Zhomart/rss_notifier

data/lib/rss_notifier/item.rb DELETED

@@ -1,60 +0,0 @@
-module RssNotifier
-  class Item
-    DONT_SAVE = [ '@is_changed' ]
-    attr_accessor :rss_url
-    attr_accessor :rss_title
-    attr_accessor :link
-    attr_accessor :title
-    attr_accessor :description
-    attr_accessor :date
-    attr_accessor :saved_at
-    attr_accessor :is_changed
-    def initialize(params = nil)
-      params and params.each do |k, v|
-        self.send("#{k}=", v)
-      end
-      self.is_changed = false
-    end
-    def update(params)
-      old_title = self.title
-      params.each do |k, v|
-        send("#{k}=", v)
-      end
-      self.is_changed = old_title != self.title
-    end
-    def changed?
-      self.is_changed
-    end
-    def new_record?
-      !self.saved_at
-    end
-    def to_h
-      {
-        rss_url: rss_url,
-        rss_title: rss_title,
-        link: link,
-        title: title,
-        description: description,
-        date: date,
-      }
-    end
-    def encode_with(coder)
-      vars = instance_variables.map { |x| x.to_s } - DONT_SAVE
-      vars.each do |var|
-        var_val = eval(var)
-        coder[var.gsub('@', '')] = var_val
-      end
-    end
-  end
-end