miyuki 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfa81dd6b05e2361be6fdd3062edf78a85308fef
-  data.tar.gz: 9c151825a73470dc07d53229209215d1a5997b48
+  metadata.gz: 0e1f6766c6de32f19ca19a15b0d50c4aac6462cd
+  data.tar.gz: 71406609632d18bcded6d20be2ffb1f3d1d9f867
 SHA512:
-  metadata.gz: 566a45cae0d029cbe3bafb3d3db98fa816a50e6f3b42916d32a0f0b821c4358ecc3fdf39b79643f5f88fa546d7fdd8bd2d25d9d9d06299feb596e85085d9b6d2
-  data.tar.gz: d1da7e3a0a15709edaf5b1658eccb0b206da5c1adee17baff7af8c933183f2cbea9c1de632fdaf47a4cbcd7db4e48640e9706ee162d71c765e94741d1faaf802
+  metadata.gz: 4251deb61c0d65ce5a88fc2667a8904a64ce665c1817b5a87e0437e478e0ebeea1d5b7070e2a0ec054d29c2af230630b995db0d98c29a45dcdc686fc7372b442
+  data.tar.gz: 2d5ce0c653fd560c64f2d7ad13ec5382dcf89c1064727696748818db7c73a453cddde89bac4e51bab8bb020066eda6853ff6c28a8835189387dc63dfedbf85b6

data/.gitignore

@@ -1,2 +1,5 @@
 *.gem
-TODO
+*.pid
+*.log
+bin/tmp/
+features/support/testWatchDir/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+
+notifications:
+  irc: 'irc.rizon.net#aggvistnurummor'

data/Gemfile

@@ -1,7 +1,14 @@
 source 'https://rubygems.org'
 
+gem 'rake'
 gem 'rufus-scheduler'
-gem 'yamazaki', '>= 0.3'
+gem 'yamazaki', '>= 0.3.1'
 gem 'foreverb'
 gem 'terminal-notifier'
 gem 'libnotify'
+gem 'rb-notifu'
+gem 'filewatcher'
+gem 'ruby_deep_clone'
+
+gem 'cucumber'
+gem 'rspec'

data/Gemfile.lock

@@ -1,26 +1,70 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    builder (3.2.2)
     color (1.7.1)
     colorb (0.0.9)
       color
+    cucumber (1.3.17)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.6)
+    ffi (1.9.6-x86-mingw32)
+    filewatcher (0.3.5)
+      trollop (~> 2.0)
     foreverb (0.3.2)
       thor (>= 0.15.0)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    gherkin (2.12.2-x86-mingw32)
+      multi_json (~> 1.3)
+    libnotify (0.8.4)
+      ffi (>= 1.0.11)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    rake (10.4.2)
+    rb-notifu (0.0.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    ruby_deep_clone (0.6.0)
     rufus-scheduler (3.0.9)
       tzinfo
     terminal-notifier (1.6.2)
     thor (0.19.1)
     thread_safe (0.3.4)
+    trollop (2.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    yamazaki (0.3)
+    yamazaki (0.3.1)
       colorb (~> 0)
 
 PLATFORMS
   ruby
+  x86-mingw32
 
 DEPENDENCIES
+  cucumber
+  filewatcher
   foreverb
+  libnotify
+  rake
+  rb-notifu
+  rspec
+  ruby_deep_clone
   rufus-scheduler
   terminal-notifier
-  yamazaki (>= 0.3)
+  yamazaki (>= 0.3.1)

data/README.md

@@ -1,13 +1,13 @@
 Miyuki – Non ti lascia mai solo
 ===============================
-After having configured the `example/miyuki.conf` configuration file, Miyuki lets you to have always the latest episodes of anime you're watching, downloading the episodes whenever they're available on Nyaa.
+After having configured the `example/miyuki.conf` configuration file, Miyuki lets you to have always the latest episodes of anime you're watching, downloading the episodes whenever they're available on [nyaa](http://nyaa.se).
 
-Of course, set the watch directory inside the configuration file to the one you've set in your torrent client.
+Of course, remember set the watch directory inside the configuration file (`example/miyuki.conf`) to the one you've set in your torrent client.
 
 Features
 --------
-- After having launched the daemon, the changes to the configuration file will be always syncronized without having restart Miyuki
-- Whenever Miyuki finds out a new episode to download, you'll be notified with an alert (compatible with OSX natively and with Linux installing `libnotify`)
+- After having launched the daemon, the changes to the configuration file will be always syncronized without having to restart Miyuki
+- Whenever Miyuki finds out a new episode to download, you'll be notified with a system alert (compatible with OSX and Windows natively and with Linux installing `libnotify`)
 - Miyuki gives you a powerful way to search anime series through patterns
 
 How to use
@@ -18,11 +18,6 @@ How to use
 
 `$ miyuki stop` (or `$ miyuki kill`)
 
-Known bugs
-----------
-- Nisekoi BDs in `example/miyuki.conf` are downloaded both in 720p and 1080p
-
 Contributors
 ------------
-- [alfateam123](https://github.com/alfateam123) — notifications
-
+- [alfateam123](https://github.com/alfateam123) — libnotify

data/Rakefile

@@ -1,7 +1,9 @@
 #! /usr/bin/env ruby
 require 'rake'
+require 'cucumber'
+require 'cucumber/rake/task'
 
-task default: [ :build, :install ]
+task default: [ :build, :install, :test ]
 
 task :build do
    sh 'gem build *.gemspec'
@@ -10,3 +12,7 @@ end
 task :install do
   sh 'gem install *.gem'
 end
+
+Cucumber::Rake::Task.new(:test) do |t|
+  t.cucumber_opts = %w{--format pretty}
+end

data/example/miyuki.conf

@@ -4,7 +4,7 @@ notifications:
   enabled: true
 
 series:
-  - name:   Nisekoi
+  - name:   Mekakucity
     fansub: Commie
 
   - name:    Nisekoi

data/features/load_config.feature

@@ -0,0 +1,18 @@
+Feature: Load configuration file
+  In order to load a custom configuration inside Miyuki
+  As a user who wants to run her
+  I give her the path to the configuration file
+
+  Scenario: The file exists and is valid
+    When I set the configuration file path to "features/support/miyuki.conf"
+    Then I expect no exception raised
+
+  Scenario: The file does not exist
+    When I set the configuration file path to "features/support/nopls.conf"
+    Then I expect an exception raised
+
+  Scenario: The configuration is refreshed as soon as the file is modified
+    When I set the configuration file path to "features/support/miyuki.conf"
+    And  I modify something in "features/support/miyuki.conf"
+    Then Miyuki reloads her configuration
+    And  I get a notification about the reloading

data/features/step_definitions/load_config_step.rb

@@ -0,0 +1,25 @@
+When(/I set the configuration file path to "(.*)"/) do |path|
+  @path = path
+  begin
+    Miyuki.config = @path
+  rescue
+  end
+end
+
+Then(/I expect an exception raised/) do
+  expect { Miyuki.config = @path }.to raise_error
+end
+
+Then(/I expect no exception raised/) do
+  expect { Miyuki.config = @path }.to_not raise_error
+end
+
+And(/^I modify something in "(.*?)"/) do |file|
+  @previous_config = Miyuki.config
+
+  FileUtils.touch(file)
+end
+
+Then(/^Miyuki reloads her configuration/) do
+  expect(Miyuki.config).to_not be equal(@previous_config)
+end

data/features/step_definitions/track_step.rb

@@ -0,0 +1,17 @@
+When(/I invoke "(.*)"/) do |command|
+  Miyuki.send(command.to_sym)
+end
+
+And(/watch folder is created if it does not exists/) do
+  watch_dir = Miyuki.config['watchDir']
+  FileUtils.rm_r(watch_dir) if Dir.exists?(watch_dir)
+
+  expect { Miyuki.track! }.to change { Dir.exists?(watch_dir) }.from(false).to(true)
+end
+
+And(/watch folder is not created if it exists already/) do
+  watch_dir = Miyuki.config['watchDir']
+  Dir.mkdir(watch_dir) unless Dir.exists?(watch_dir)
+
+  expect { Miyuki.track! }.to_not change { Dir.exists?(watch_dir) }
+end

data/features/step_definitions/tracker_step.rb

@@ -0,0 +1,43 @@
+And(/I wait (\d+) seconds?/) do |seconds|
+  sleep seconds.to_f
+end
+
+Then(/I have almost (\d+) torrent files? containing "(.*?)"/) do |count, string|
+  watch_dir = Miyuki.config['watchDir']
+  torrent_files = Dir["#{watch_dir}/*.torrent"].select { |f| f.include?(string) }
+
+  expect(torrent_files.count).to be >= count.to_i
+end
+
+And(/I have almost (\d+) torrent files? that do not contain "(.*?)"/) do |count, string|
+  watch_dir = Miyuki.config['watchDir']
+  torrent_files = Dir["#{watch_dir}/*.torrent"].reject { |f| f.include?(string) }
+
+  expect(torrent_files.count).to be >= count.to_i
+end
+
+And(/there are (\d+) torrent files? containing "(.*?)"/) do |count, string|
+  watch_dir = Miyuki.config['watchDir']
+  torrent_files = Dir["#{watch_dir}/*.torrent"].select { |f| f.include?(string) }
+
+  expect(torrent_files.count).to be count.to_i
+end
+
+And(/there are (\d+) torrent files? that do not contain "(.*?)"/) do |count, string|
+  watch_dir = Miyuki.config['watchDir']
+  torrent_files = Dir["#{watch_dir}/*.torrent"].reject { |f| f.include?(string) }
+
+  expect(torrent_files.count).to be count.to_i
+end
+
+And(/I consider the currently downloaded torrent files/) do
+  watch_dir = Miyuki.config['watchDir']
+  @previous_torrent_files_ctime = Dir["#{watch_dir}/*.torrent"].map { |f| File.ctime(f) }
+end
+
+Then(/I expect (\d+) torrent files? (have|has) been overwritten/) do |count, plural|
+  watch_dir = Miyuki.config['watchDir']
+  torrent_files_ctime = Dir["#{watch_dir}/*.torrent"].map { |f| File.ctime(f) }
+
+  expect(@previous_torrent_files_ctime).to match_array(torrent_files_ctime)
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require 'miyuki'
+require 'rspec'
+require 'fileutils'
+
+Miyuki.join_scheduler = false
+
+After do |s|
+  watch_dir = 'features/support/testWatchDir'
+  FileUtils.rm_r(watch_dir) if Dir.exists?(watch_dir)
+
+  Cucumber.wants_to_quit = true if s.failed?
+end

data/features/support/miyuki.conf

@@ -0,0 +1,13 @@
+watchDir:      "features/support/testWatchDir"
+refreshEvery:  6s
+notifications:
+  enabled: true
+
+series:
+  - name:   Mekakucity
+    fansub: Commie
+
+  - name:    Nisekoi
+    fansub:  Commie
+    res:     1080p
+    pattern: "[$fansub] $name - Volume [BD $res AAC]"

data/features/track.feature

@@ -0,0 +1,11 @@
+Feature: Start the tracking of anime series
+  In order to keep track of new episodes of the anime series I'm watching
+  As user who wants to actually start Miyuki
+  I call Miyuki::track!
+
+  Scenario: The tracking starts without launching exceptions
+    When I set the configuration file path to "features/support/miyuki.conf"
+    And  I invoke "track!"
+    Then I expect no exception raised
+    And watch folder is created if it does not exists
+    And watch folder is not created if it exists already

data/features/tracker.feature

@@ -0,0 +1,27 @@
+Feature: Download new episodes
+  In order to download the new episodes of the anime series I'm watching
+  As user who wants to have the torrent files downloaded automatically as soon as they're available
+  I expect the episodes are tracked and the torrent files are downloaded
+
+  Scenario: The episodes are downloaded according to the configuration file
+    When I set the configuration file path to "features/support/miyuki.conf"
+    And  I invoke "track!"
+    And  I wait 5 seconds to let Miyuki to find and download the episodes
+    Then I have almost 2 torrent files containing "BD"
+    And  I have almost 12 torrent file that do not contain "BD"
+    And  there are 0 torrent files containing "BD 720p"
+    And  there are 0 torrent files that do not contain "[Commie]"
+
+  Scenario: Episodes already downloaded are ignored
+    When I set the configuration file path to "features/support/miyuki.conf"
+    And  I invoke "track!"
+    And  I wait 5 seconds to let Miyuki to find and download the episodes
+    And  I consider the currently downloaded torrent files
+    And  I wait 6 seconds in order to have a new check of the new anime episodes
+    And  I wait 5 seconds in case this scenario would fail
+    Then I expect 0 torrent files have been overwritten by their duplicates
+
+  Scenario: There is a notification for every episode downloaded if enabled
+    When I set the configuration file path to "features/support/miyuki.conf"
+    And  I invoke "track!"
+    Then I get a notification for every torrent file downloaded

data/lib/miyuki/miyuki.rb

@@ -14,26 +14,32 @@
 
 module Miyuki
   class << self
+    attr_reader :config, :config_file
+    attr_accessor :join_scheduler
+
     def config=(config_file)
       @notifier = Notifier.new
 
       @config_file = config_file
       @config = load_config
 
-      # TODO: Implement file watcher
-      Rufus::Scheduler.singleton.every('1m') { refresh_config }
+      Thread.new do
+        FileWatcher.new([config_file]).watch { refresh_config }
+      end
     end
 
     def track!
+      raise Exception, 'You have to provide a proper configuration file to start the tracking.' unless @config
+
       watch_dir = File.expand_path(@config['watchDir'])
-      FileUtils.mkdir_p(watch_dir) unless File.directory?(watch_dir)
+      FileUtils.mkdir_p(watch_dir) unless Dir.exists?(watch_dir)
 
-      # TODO: #deep_dup instead of using Marshal
-      @tracker = Tracker.new(watch_dir, Marshal.load(Marshal.dump(@config))['series']) do |torrent|
+      config = DeepClone.clone(@config)
+      @tracker = Tracker.new(watch_dir, config['series']) do |torrent|
         notify_torrents(torrent)
       end
 
-      run_scheduler
+      run_scheduler!
     end
 
   private
@@ -45,7 +51,6 @@ module Miyuki
         notify_configuration
 
         @config = new_config
-        @scheduler.pause if defined?(@scheduler)
         track!
       end
     end
@@ -54,19 +59,22 @@ module Miyuki
       old_torrents = @tracker.torrents
 
       @tracker.refresh
+      @tracker.remove_duplicates(old_torrents)
 
-      new_torrents = @tracker.remove_duplicates(old_torrents)
-      new_torrents.each { |torrent| notify_torrents(new_torrents) }
+      new_torrents = @tracker.torrents
+      new_torrents.each { |new_torrent| notify_torrents(new_torrent) }
     end
 
     def load_config
       YAML.load(File.read(@config_file))
     end
 
-    def run_scheduler
-      @scheduler = Rufus::Scheduler.new
-      @scheduler.every @config['refreshEvery'] { refresh_torrents }
-      @scheduler.join
+    def run_scheduler!
+      @scheduled_job.kill if @scheduled_job
+
+      scheduler = Rufus::Scheduler.new
+      @scheduled_job = scheduler.schedule_every @config['refreshEvery'] { refresh_torrents }
+      scheduler.join if @join_scheduler != false
     end
 
     def notify_torrents(torrent)

data/lib/miyuki/notifier.rb

@@ -19,7 +19,11 @@ module Miyuki
     end
 
     def notify(title, message)
-      @notifier.notify(title, message)
+      @notifier.notify(title, message) if has_notifier?
+    end
+
+    def has_notifier?
+      !!@notifier
     end
 
   private
@@ -28,6 +32,7 @@ module Miyuki
       case RUBY_PLATFORM
         when /darwin/ then Miyuki::TerminalNotifier.new
         when /linux/  then Miyuki::Libnotify.new
+        when  /mswin|msys|mingw|cygwin/ then Miyuki::Notifu.new
       end
     end
   end

data/lib/miyuki/notifiers/notifu.rb

@@ -0,0 +1,22 @@
+##
+#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#                    Version 2, December 2004
+#
+# Everyone is permitted to copy and distribute verbatim or modified
+# copies of this license document, and changing it is allowed as long
+# as the name is changed.
+#
+#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+#
+#  0. You just DO WHAT THE FUCK YOU WANT TO.
+##
+require 'rb-notifu'
+
+module Miyuki
+  class Notifu
+    def notify(title, message)
+      ::Notifu.show(title: message, message: title, type: :info, time: 1)
+    end
+  end
+end

data/lib/miyuki/tracker.rb

@@ -28,22 +28,26 @@ module Miyuki
       refresh
     end
 
+    def for_every_torrent(&callback)
+      if block_given?
+        @callback = callback
+      else
+        yield
+      end
+    end
+
     def refresh
       @torrents = []
 
       fetch_torrents
 
       @torrents.each do |torrent|
-        existed = File.exists?("#{Yamazaki::WATCH_DIR}/#{torrent.title}.torrent")
-        Yamazaki.download_torrent(torrent.title, torrent.link)
-        downloaded = !existed && File.exists?("#{Yamazaki::WATCH_DIR}/#{torrent.title}.torrent")
+        downloaded = Yamazaki.download_torrent(torrent.title, torrent.link)
 
-        # TODO: `downloaded` should be returned by Yamazaki natively
         @callback.call(torrent) if downloaded && @callback
       end
     end
 
-    # TODO: Refactor
     def remove_duplicates(other_torrents)
       @torrents.delete_if do |torrent|
         other_torrents.each do |other_torrent|

data/lib/miyuki/version.rb

@@ -13,5 +13,5 @@
 ##
 
 module Miyuki
-  VERSION = '0.3'
+  VERSION = '0.4'
 end

data/lib/miyuki.rb

@@ -16,6 +16,8 @@ require 'fileutils'
 require 'yaml'
 require 'rufus-scheduler'
 require 'yamazaki'
+require 'filewatcher'
+require 'deep_clone'
 
 require 'miyuki/notifier'
 require 'miyuki/tracker'
@@ -25,4 +27,5 @@ require 'miyuki/version'
 case RUBY_PLATFORM
   when /darwin/ then require 'miyuki/notifiers/terminal-notifier.rb'
   when /linux/  then require 'miyuki/notifiers/libnotify.rb'
+  when /mswin|msys|mingw|cygwin/ then require 'miyuki/notifiers/notifu.rb'
 end

data/miyuki.gemspec

@@ -17,9 +17,15 @@ Gem::Specification.new do |s|
   s.add_dependency 'yamazaki',        '~> 0.3'
   s.add_dependency 'rufus-scheduler', '~> 3.0'
   s.add_dependency 'foreverb',        '~> 0.3'
+  s.add_dependency 'filewatcher',     '~> 0.3'
+  s.add_dependency 'ruby_deep_clone', '~> 0.6'
 
   case RUBY_PLATFORM
     when /darwin/ then s.add_dependency 'terminal-notifier', '~> 1.6'
     when /linux/  then s.add_dependency 'libnotify',         '~> 0.8'
+    when /mswin|msys|mingw|cygwin/ then s.add_dependency 'libnotify', '~> 0.0'
   end
+
+  s.add_development_dependency 'cucumber', '~> 1.3'
+  s.add_development_dependency 'rspec', '~> 3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miyuki
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Roxas Shadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yamazaki
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: ruby_deep_clone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: terminal-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Miyuki downloads automatically every episode of anime you're watching
 email: webmaster@giovannicapuano.net
 executables:
@@ -74,16 +130,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/miyuki
 - example/miyuki.conf
+- features/load_config.feature
+- features/step_definitions/load_config_step.rb
+- features/step_definitions/track_step.rb
+- features/step_definitions/tracker_step.rb
+- features/support/env.rb
+- features/support/miyuki.conf
+- features/track.feature
+- features/tracker.feature
 - lib/miyuki.rb
 - lib/miyuki/miyuki.rb
 - lib/miyuki/notifier.rb
 - lib/miyuki/notifiers/libnotify.rb
+- lib/miyuki/notifiers/notifu.rb
 - lib/miyuki/notifiers/terminal-notifier.rb
 - lib/miyuki/tracker.rb
 - lib/miyuki/version.rb