learnable-notifier 0.0.1

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.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ gem 'i18n'
2
+ gem 'prowler', '~> 1.2'
3
+ gem 'feedzirra'
4
+ gem 'clamp'
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Myles Eftos
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,30 @@
1
+ = learnable-notifier
2
+
3
+ A little executable that will monitor a Learnable.com forum RSS feed, and send new messages to Prowl (http://www.prowlapp.com), allowing
4
+ you to receive them on you iOS compatible phone.
5
+
6
+ == Install
7
+
8
+ gem install learnable-notifier
9
+
10
+ == Usage
11
+
12
+ learnable-notifier --lesson [URL to lesson] --api-key [Prowl API key]
13
+
14
+ DON'T include the ?type=rss at the end of the URL - it is added explicitly
15
+
16
+ Throw it in a crontab.
17
+
18
+ == Note on Patches/Pull Requests
19
+
20
+ * Fork the project.
21
+ * Make your feature addition or bug fix.
22
+ * Add tests for it. This is important so I don't break it in a
23
+ future version unintentionally.
24
+ * Commit, do not mess with rakefile, version, or history.
25
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
26
+ * Send me a pull request. Bonus points for topic branches.
27
+
28
+ == Copyright
29
+
30
+ Copyright (c) 2011 Myles Eftos. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,53 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "learnable-notifier"
8
+ gem.summary = %Q{A little application that check the Learnable RSS feed and posts new messages to prowl}
9
+ gem.description = %Q{A little application that check the Learnable RSS feed and posts new messages to prowl. Use it in a cronjob - tested on OSX and Linux.}
10
+ gem.email = "myles@madpilot.com.au"
11
+ gem.homepage = "http://github.com/madpilot/learnable-notifier"
12
+ gem.authors = ["Myles Eftos"]
13
+ gem.add_dependency "bundler", ">= 0"
14
+ gem.executables = "learnable-notify"
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ require 'rake/testtask'
22
+ Rake::TestTask.new(:test) do |test|
23
+ test.libs << 'lib' << 'test'
24
+ test.pattern = 'test/**/test_*.rb'
25
+ test.verbose = true
26
+ end
27
+
28
+ begin
29
+ require 'rcov/rcovtask'
30
+ Rcov::RcovTask.new do |test|
31
+ test.libs << 'test'
32
+ test.pattern = 'test/**/test_*.rb'
33
+ test.verbose = true
34
+ end
35
+ rescue LoadError
36
+ task :rcov do
37
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
38
+ end
39
+ end
40
+
41
+ task :test => :check_dependencies
42
+
43
+ task :default => :test
44
+
45
+ require 'rake/rdoctask'
46
+ Rake::RDocTask.new do |rdoc|
47
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
48
+
49
+ rdoc.rdoc_dir = 'rdoc'
50
+ rdoc.title = "learnable-notifier #{version}"
51
+ rdoc.rdoc_files.include('README*')
52
+ rdoc.rdoc_files.include('lib/**/*.rb')
53
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,6 @@
1
+ #!/bin/env ruby
2
+ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
3
+ require 'learnable-notifier'
4
+ require 'command_line'
5
+
6
+ CommandLine.run
@@ -0,0 +1,59 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{learnable-notifier}
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Myles Eftos"]
12
+ s.date = %q{2011-03-29}
13
+ s.default_executable = %q{learnable-notify}
14
+ s.description = %q{A little application that check the Learnable RSS feed and posts new messages to prowl. Use it in a cronjob - tested on OSX and Linux.}
15
+ s.email = %q{myles@madpilot.com.au}
16
+ s.executables = ["learnable-notify"]
17
+ s.extra_rdoc_files = [
18
+ "LICENSE",
19
+ "README.rdoc"
20
+ ]
21
+ s.files = [
22
+ ".document",
23
+ ".gitignore",
24
+ "Gemfile",
25
+ "LICENSE",
26
+ "README.rdoc",
27
+ "Rakefile",
28
+ "VERSION",
29
+ "bin/learnable-notify",
30
+ "learnable-notifier.gemspec",
31
+ "lib/command_line.rb",
32
+ "lib/learnable-notifier.rb",
33
+ "test/helper.rb",
34
+ "test/test_learnable-notifier.rb"
35
+ ]
36
+ s.homepage = %q{http://github.com/madpilot/learnable-notifier}
37
+ s.rdoc_options = ["--charset=UTF-8"]
38
+ s.require_paths = ["lib"]
39
+ s.rubygems_version = %q{1.3.7}
40
+ s.summary = %q{A little application that check the Learnable RSS feed and posts new messages to prowl}
41
+ s.test_files = [
42
+ "test/helper.rb",
43
+ "test/test_learnable-notifier.rb"
44
+ ]
45
+
46
+ if s.respond_to? :specification_version then
47
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
48
+ s.specification_version = 3
49
+
50
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
51
+ s.add_runtime_dependency(%q<bundler>, [">= 0"])
52
+ else
53
+ s.add_dependency(%q<bundler>, [">= 0"])
54
+ end
55
+ else
56
+ s.add_dependency(%q<bundler>, [">= 0"])
57
+ end
58
+ end
59
+
@@ -0,0 +1,9 @@
1
+ class CommandLine < Clamp::Command
2
+ option [ "-l", "--lesson" ], "LESSON", "URL of the Learnable lesson you are monitoring"
3
+ option [ "-k", "--api-key" ], "API_KEY", "Your Prowl API Key"
4
+
5
+ def execute
6
+ @notifier = LearnableNotifier.new(lesson, api_key)
7
+ @notifier.find_next_message
8
+ end
9
+ end
@@ -0,0 +1,46 @@
1
+ require "rubygems"
2
+ require "bundler/setup"
3
+ require "prowler"
4
+ require "feedzirra"
5
+ require "clamp"
6
+
7
+ class LearnableNotifier
8
+ attr_accessor :rss_path, :api_key, :sent, :options
9
+
10
+ def initialize(rss_path, api_key, options = {})
11
+ self.rss_path = rss_path
12
+ self.options = {
13
+ :application => 'Learnable forum',
14
+ :storage => File.join(ENV['HOME'], '.learnable-notifier')
15
+ }.merge(options)
16
+
17
+ Prowler.configure do |config|
18
+ config.api_key = api_key
19
+ config.application = self.options[:application]
20
+ end
21
+
22
+ self.sent = { self.rss_path => [] }
23
+ if (File.exists?(self.options[:storage]) && yaml = YAML.load_file(self.options[:storage]))
24
+ self.sent = yaml
25
+ end
26
+ end
27
+
28
+ def find_next_message
29
+ next_guid = nil
30
+ feed = Feedzirra::Feed.fetch_and_parse("#{rss_path}?type=rss")
31
+ feed.entries.each do |entry|
32
+ unless self.sent[self.rss_path].include?(entry.entry_id)
33
+ send_message("Message from Learnable", entry.title)
34
+ self.sent[self.rss_path].push(entry.entry_id)
35
+ end
36
+ end
37
+
38
+ File.open(self.options[:storage], 'w') do |fh|
39
+ YAML.dump(self.sent, fh)
40
+ end
41
+ end
42
+
43
+ def send_message(title, message)
44
+ Prowler.notify title, message
45
+ end
46
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+ require 'shoulda'
4
+
5
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
6
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
7
+ require 'learnable-notifier'
8
+
9
+ class Test::Unit::TestCase
10
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestLearnableNotifier < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,94 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: learnable-notifier
3
+ version: !ruby/object:Gem::Version
4
+ hash: 29
5
+ prerelease: false
6
+ segments:
7
+ - 0
8
+ - 0
9
+ - 1
10
+ version: 0.0.1
11
+ platform: ruby
12
+ authors:
13
+ - Myles Eftos
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2011-03-29 00:00:00 +08:00
19
+ default_executable: learnable-notify
20
+ dependencies:
21
+ - !ruby/object:Gem::Dependency
22
+ name: bundler
23
+ prerelease: false
24
+ requirement: &id001 !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ hash: 3
30
+ segments:
31
+ - 0
32
+ version: "0"
33
+ type: :runtime
34
+ version_requirements: *id001
35
+ description: A little application that check the Learnable RSS feed and posts new messages to prowl. Use it in a cronjob - tested on OSX and Linux.
36
+ email: myles@madpilot.com.au
37
+ executables:
38
+ - learnable-notify
39
+ extensions: []
40
+
41
+ extra_rdoc_files:
42
+ - LICENSE
43
+ - README.rdoc
44
+ files:
45
+ - .document
46
+ - .gitignore
47
+ - Gemfile
48
+ - LICENSE
49
+ - README.rdoc
50
+ - Rakefile
51
+ - VERSION
52
+ - bin/learnable-notify
53
+ - learnable-notifier.gemspec
54
+ - lib/command_line.rb
55
+ - lib/learnable-notifier.rb
56
+ - test/helper.rb
57
+ - test/test_learnable-notifier.rb
58
+ has_rdoc: true
59
+ homepage: http://github.com/madpilot/learnable-notifier
60
+ licenses: []
61
+
62
+ post_install_message:
63
+ rdoc_options:
64
+ - --charset=UTF-8
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ none: false
69
+ requirements:
70
+ - - ">="
71
+ - !ruby/object:Gem::Version
72
+ hash: 3
73
+ segments:
74
+ - 0
75
+ version: "0"
76
+ required_rubygems_version: !ruby/object:Gem::Requirement
77
+ none: false
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ hash: 3
82
+ segments:
83
+ - 0
84
+ version: "0"
85
+ requirements: []
86
+
87
+ rubyforge_project:
88
+ rubygems_version: 1.3.7
89
+ signing_key:
90
+ specification_version: 3
91
+ summary: A little application that check the Learnable RSS feed and posts new messages to prowl
92
+ test_files:
93
+ - test/helper.rb
94
+ - test/test_learnable-notifier.rb