feedbook 0.9.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDkwNWM3OWZlM2RkOTliMzFmYjk5OTJmZTU4OGYwNTQzY2YzY2NkMA==
+  data.tar.gz: !binary |-
+    MWNiMmE5Njk1MDE1MDI1ZGJlNTBkMDRhM2M4NzM3Y2ZlMzZiOWU2OA==
+SHA512:
+  metadata.gz: !binary |-
+    OTFjODk5MGIwNzhmZDlmM2RiMmIxMmYxNmZiZmVmNTViNTE0MjZhNDk0ZDkx
+    MDY2OWQ2YWY3N2UzODE0ZWYyNGExZWNiOWI1YzliNTNiNzc1ODE3MmVmNzA1
+    ZTk3OTlhMGRjYzE4MjQ2MmE2ODM2NTFmYjNkZmIwNGM5YjRjNDE=
+  data.tar.gz: !binary |-
+    NjJhZmU1YTMyOGVmZDQ1ZTUyY2U5Y2U0YzdhN2JkMTYwMGFhMWM1M2Q1MjM2
+    MDllNTdjMjViOWQ5MTUwNjdhZmQ2MDY4YTUzYzBlNjU5MDc1Zjg5OTQ1MDBi
+    OGIwYTBlZmUwMmYzMzkxMGQyZWFlMzY5ZWI0NzVmZDJlZDAyMjc=

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maciej Paruszewski
+
+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,129 @@
+# Feedbook [![Build Status](https://travis-ci.org/pinoss/feedbook.svg?branch=master)](https://travis-ci.org/pinoss/feedbook) [![Code Climate](https://codeclimate.com/github/pinoss/feedbook.png)](https://codeclimate.com/github/pinoss/feedbook) [![Coverage Status](https://coveralls.io/repos/pinoss/feedbook/badge.png)](https://coveralls.io/r/pinoss/feedbook) 
+
+Feedbook is a simple console application that allows to notify on IRC, mail and social media (like Twitter and Facebook) about RSS/Atom updates.
+ 
+## Why?
+
+> Automation isn’t about being lazy, it’s about being efficient. 
+> ~ Addy Osmani
+
+* If you do something every day, why not to automate it? 
+* If you have a blog and want to notify your users on Twitter on Facebook that there is a new post, you can do it without opening your browser.
+
+## Main Features
+
+* Parse feeds and notifies about new posts.
+* Easy to configure.
+* Fire and forget - once you have valid configuration you do not need to think about feedbook again, everything will work automatically.
+
+## Installation
+
+Install gem with:
+
+    $ gem install feedbook
+
+## Usage
+
+Install gem into your system:
+
+    $ gem install feedbook
+
+Create your configuration file or take a default file and modify it:
+
+    $ feedbook init
+    => Created default feedbook configuration file: feedbook.yml
+
+After you create or modify your configuration file, you need to start listening for RSS changes: 
+
+    $ feedbook start
+    Loading configuration from file feedbook.yml... completed.
+    Loading notifiers... 
+    Configuration loaded for TwitterNotifier
+    Configuration loaded for FacebookNotifier
+    completed.
+    Fetching feeds for the first use... completed.
+    Listener started...
+    Fetching feeds...
+
+And Feedbook now will work and listen for changes.
+
+## Configuration
+
+
+```yaml
+feeds:
+  - url: https://github.com/pinoss.atom # collection of urls (separated by space)
+    variables:                          # you can use variables defined here in your templates 
+      default_header: Check out our new post
+    notifications:                      # notifications configuration, you need to specify type and template for each notification
+      - type: facebook
+        template: "{{ default_header }} {{ title }} by {{ author }}: {{ url }}"
+      - type: twitter
+        template: "{{ default_header }} on our blog {{ feed_url }}: {{ title }}/{{ url }}"
+
+configuration:
+  interval: 5m
+  facebook: # Facebook OAuth token
+    token: SECRET_FACEBOOK_TOKEN
+  twitter:  # Twitter token collection
+    consumer_key: SECRET_CONSUMER_KEY
+    consumer_secret: SECRET_TWITTER_CONSUMER_SECRET
+    access_token: SECRET_TWITTER_ACCESS_TOKEN
+    access_token_secret: SECRET_TWITTER_ACCESS_TOKEN_SECRET
+  irc:      # IRC configuration 
+    url: irc.freenode.net
+    port: 8001
+    ssl_enabled: true/false
+    channel: #channel
+    nick: feedbook_bot
+  mail:     # Mail configuration
+    address: mparuszewski@feedbook.lo
+    port: 5870
+    domain: smtp.feedbook.lo
+    username: mparuszewski
+    password: your_password
+    authentication: plain
+    enable_starttls_auto: true/false
+    
+```
+
+### Facebook
+
+You need to generate your access token to use Facebook notifier, you can do that on [Graph API Explorer](https://developers.facebook.com/tools/explorer) page (click *Get access token* and select __user_status__).
+
+### Twitter
+
+You need to generate your keys here, you will need 4 keys, first two you will get on [Create an application](https://apps.twitter.com/app/new) page, after you create it, go to __API Keys__ tab and click __Create my access token__ at the bottom.
+
+### Mail
+
+Mail configuration is really simple, you need to specify few parameters and you will get mail notifications.
+
+### IRC
+
+IRC configuration is also very simple, I think it does not require any explanations.
+
+## Templates
+
+Feedbook uses Liquid for generating output. If you know Mustache it will not be a problem for you to write your template, it uses same syntax, but provides more features (like tags and helpers) - you can read about Liquid on [Liquid for Designers](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers).
+
+## Todo
+
+Because Feedbook is still in development there is many to do:
+
+* add Google+ Notifier
+   Unfortunately Google+ does not provides API with ability to push messages to streams. Because of that I need to find a tool that will provide that feature without use of Google+.
+* add links shortener (bit.ly or goo.gl) as a Liquid tag/filter
+   Twitter limits Tweet length to 140 characters, why not to shorten links and rescue too long message.
+* add ability to add own Notifier without forking Feedbook project
+   I would like to give ability to users to create own Notifier plugins without any special development to Feedbook.
+* add more tests
+   I would like to add integration tests to make sure that all features work.
+
+## Contributing
+
+1. Fork it ( https://github.com/pinoss/feedbook/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 a new Pull Request

data/Rakefile

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

data/bin/feedbook

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'gli'
+require 'box'
+require 'feedbook'
+require 'fileutils'
+
+include GLI::App
+
+program_desc 'Feedbook is a simple gem and application that notifies about new posts and Atom/RSS updates on your social media sites (like Facebook and Twitter), e-mail or IRC.'
+
+flag [:c,:config], default_value: 'feedbook.yml', desc: 'Feedbook configuration file location'
+
+desc 'Parses feedbook.yml file for feeds and configuration and listen for changes in RSS/Atom feeds to notify about updates on social media sites'
+command :start do |c|
+
+  c.action do |global_options, _, _|
+    Feedbook::Listener.start(global_options[:config])
+  end
+end
+
+desc 'Creates basic feedbook config file'
+command :init do |c|
+  c.action do |global_options, _, _|
+    abort 'There is already a feedbook configuration file' if File.exist?(global_options[:config])
+    File.open(global_options[:config], 'w') { |f| f.write(Box::FILES['feedbook']) }
+    puts "=> Created default feedbook configuration file: #{global_options[:config]}"
+  end
+end
+
+desc 'Outputs feedbook gem version'
+command :version do |c|
+  c.action do |global_options, _, _|
+    puts "feedbook version: #{Feedbook::VERSION}"
+  end
+end
+
+on_error do |exception|
+  case exception
+  when SystemExit
+  else
+    STDERR.puts "Error: #{exception} (#{exception.class})"
+    STDERR.puts exception.backtrace.join("\n")
+  end
+  false
+end
+
+exit run(ARGV)
+
+__END__
+@@  feedbook
+## Feedbook default config file, modify it!
+
+feeds:
+  - url: https://github.com/pinoss.atom
+    variables:
+      default_header: Check out our new post
+    notifications:
+      - type: facebook
+        template: "{{ default_header }} {{ title }} by {{ author }}: {{ url }}"
+      - type: twitter
+        template: "{{ default_header }} on our blog {{ feed_url }}: {{ title }}/{{ url }}"
+
+configuration:
+  interval: 5m
+  facebook:
+    token: SECRET_FACEBOOK_TOKEN
+  twitter:
+    consumer_key: SECRET_CONSUMER_KEY
+    consumer_secret: SECRET_TWITTER_CONSUMER_SECRET
+    access_token: SECRET_TWITTER_ACCESS_TOKEN
+    access_token_secret: SECRET_TWITTER_ACCESS_TOKEN_SECRET

data/feedbook.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feedbook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'feedbook'
+  spec.version       = Feedbook::VERSION
+  spec.authors       = ['Maciej Paruszewski']
+  spec.email         = ['maciek.paruszewski@gmail.com']
+  spec.summary       = %q{Feedbook}
+  spec.homepage      = "https://github.com/pinoss/feedbook"
+  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_runtime_dependency 'feedjira', '~> 1.3'
+  spec.add_runtime_dependency 'gli',      '~> 2.1'
+  spec.add_runtime_dependency 'liquid',   '~> 2.6'
+  spec.add_runtime_dependency 'timeloop', '~> 1.0'
+  spec.add_runtime_dependency 'koala',    '~> 1.9'
+  spec.add_runtime_dependency 'box',      '~> 0.1'
+  spec.add_runtime_dependency 'twitter',  '~> 5.1'
+  spec.add_runtime_dependency 'mail',     '~> 2.6'
+  spec.add_runtime_dependency 'irc-notify'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake',    '~> 10.3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry-debugger'
+end

data/lib/feedbook.rb

@@ -0,0 +1,6 @@
+require 'feedbook/listener'
+require 'feedbook/errors'
+require 'feedbook/version'
+
+module Feedbook
+end

data/lib/feedbook/comparers/posts_comparer.rb

@@ -0,0 +1,15 @@
+module Feedbook
+  module Comparers
+    module PostsComparer
+
+      # Returns only posts from new posts list that does not exists in old posts list. 
+      # @param old_posts [Array] list of old posts
+      # @param new_posts [Array] list of new posts
+      # 
+      # @return [type] [description]
+      def self.get_new_posts(old_posts, new_posts)
+        new_posts.select { |post| old_posts.all? { |opost| opost.url != post.url } }
+      end
+    end
+  end
+end

data/lib/feedbook/configuration.rb

@@ -0,0 +1,47 @@
+require 'feedbook/notifiers'
+require 'feedbook/helpers/time_interval_parser'
+
+module Feedbook
+  class Configuration
+    attr_reader :interval
+
+    INTERVAL_FORMAT = /\A(\d+)(s|m|h|d)\z/
+
+    # Initializes new Configuration object with configuration for program instance
+    # @param opts = {} [Hash] Hash with configuration of interval and suppliers
+    # 
+    # @return [NilClass] nil
+    def initialize(opts = {})
+      @interval    = Helpers::TimeIntervalParser.parse(opts.fetch(:interval, ''))
+      @twitter     = opts.fetch(:twitter,  nil)
+      @facebook    = opts.fetch(:facebook, nil)
+      @irc         = opts.fetch(:irc, nil)
+      @mail        = opts.fetch(:mail, nil)
+    end
+
+    # Load notifiers configuration
+    # 
+    # @return [NilClass] nil
+    def load_notifiers
+      unless twitter.nil?
+        Notifiers::TwitterNotifier.instance.load_configuration(twitter)
+      end
+      
+      unless facebook.nil?
+        Notifiers::FacebookNotifier.instance.load_configuration(facebook)
+      end
+
+      unless irc.nil?
+        Notifiers::IRCNotifier.instance.load_configuration(irc)
+      end
+
+      unless mail.nil?
+        Notifiers::MailNotifier.instance.load_configuration(mail)
+      end
+    end
+
+    private
+    attr_reader :twitter, :facebook, :irc, :mail
+
+  end
+end

data/lib/feedbook/errors.rb

@@ -0,0 +1,10 @@
+require 'feedbook/errors/invalid_feed_url_error'
+require 'feedbook/errors/invalid_interval_format_error'
+require 'feedbook/errors/invalid_variables_format_error'
+require 'feedbook/errors/no_configuration_file_error'
+require 'feedbook/errors/parse_feed_error'
+require 'feedbook/errors/no_configuration_file_error'
+require 'feedbook/errors/template_syntax_error'
+require 'feedbook/errors/unsupported_notifier_error'
+require 'feedbook/errors/notifier_configuration_error'
+require 'feedbook/errors/notifier_notify_error'

data/lib/feedbook/errors/invalid_feed_url_error.rb

@@ -0,0 +1,6 @@
+module Feedbook
+  module Errors
+    class InvalidFeedUrlError < StandardError
+    end
+  end
+end

data/lib/feedbook/errors/invalid_interval_format_error.rb

@@ -0,0 +1,6 @@
+module Feedbook
+  module Errors
+    class InvalidIntervalFormatError < StandardError
+    end
+  end
+end

data/lib/feedbook/errors/invalid_variables_format_error.rb

@@ -0,0 +1,6 @@
+module Feedbook
+  module Errors
+    class InvalidVariablesFormatError < StandardError
+    end
+  end
+end

data/lib/feedbook/errors/no_configuration_file_error.rb

@@ -0,0 +1,6 @@
+module Feedbook
+  module Errors
+    class NoConfigurationFileError < StandardError
+    end
+  end
+end