rivendell-import 0.7 → 0.8

data/Gemfile

@@ -5,7 +5,17 @@ gemspec
 # gem "rivendell-db", :path => "~/Projects/RivendellDb"
 # gem "rivendell-api", :path => "~/Projects/RivendellApi"
 
+# To test mysql DB instead of sqlite
+#
+# $ mysqladmin create import
+# $ mysql mysql
+# mysql> GRANT ALL PRIVILEGES ON import.* TO 'import'@'localhost' IDENTIFIED BY 'import';
+#
+# and this gem :
+# gem "mysql"
+
 gem 'capistrano'
+gem 'simplecov-rcov'
 
 if RUBY_PLATFORM =~ /linux/
   gem 'libnotify'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rivendell-import (0.7)
+    rivendell-import (0.8)
       SyslogLogger (~> 2.0)
       activerecord (~> 3.2.8)
       activesupport (~> 3.2.8)
@@ -21,32 +21,33 @@ GEM
   remote: https://rubygems.org/
   specs:
     SyslogLogger (2.0)
-    activemodel (3.2.16)
-      activesupport (= 3.2.16)
+    activemodel (3.2.17)
+      activesupport (= 3.2.17)
       builder (~> 3.0.0)
-    activerecord (3.2.16)
-      activemodel (= 3.2.16)
-      activesupport (= 3.2.16)
+    activerecord (3.2.17)
+      activemodel (= 3.2.17)
+      activesupport (= 3.2.17)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.16)
+    activesupport (3.2.17)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     addressable (2.3.5)
     arel (3.0.3)
     bcrypt-ruby (3.1.2)
-    builder (3.0.3)
+    builder (3.0.4)
     capistrano (2.14.2)
       highline
       net-scp (>= 1.0.0)
       net-sftp (>= 2.0.0)
       net-ssh (>= 2.0.14)
       net-ssh-gateway (>= 1.1.0)
-    cucumber (1.2.1)
+    cucumber (1.3.10)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
     daemons (1.1.9)
     data_objects (0.10.13)
       addressable (~> 2.1)
@@ -80,8 +81,8 @@ GEM
       data_objects (= 0.10.13)
     fastercsv (1.5.5)
     ffi (1.9.3)
-    gherkin (2.11.2)
-      json (>= 1.4.6)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
     guard (1.4.0)
       listen (>= 0.4.2)
       thor (>= 0.14.6)
@@ -112,6 +113,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     multi_json (1.8.2)
+    multi_test (0.0.3)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     net-scp (1.1.0)
@@ -122,7 +124,7 @@ GEM
     net-ssh-gateway (1.2.0)
       net-ssh (>= 2.6.5)
     null_logger (0.0.1)
-    polyglot (0.3.3)
+    polyglot (0.3.4)
     rack (1.5.2)
     rack-protection (1.5.1)
       rack
@@ -156,11 +158,13 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
     sinatra (1.4.4)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
-    sqlite3 (1.3.8)
+    sqlite3 (1.3.9)
     stringex (1.5.1)
     thor (0.16.0)
     tilt (1.4.1)
@@ -168,7 +172,7 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     trollop (2.0)
-    tzinfo (0.3.38)
+    tzinfo (0.3.39)
     uuidtools (2.1.4)
     will_paginate (3.0.5)
 
@@ -188,3 +192,4 @@ DEPENDENCIES
   rivendell-import!
   rspec
   simplecov
+  simplecov-rcov

data/README.md

@@ -1,29 +1,18 @@
 # Rivendell::Import
 
-TODO: Write a gem description
+Next-Generation import interface for Rivendell
 
-## Installation
+## Run examples
 
-Add this line to your application's Gemfile:
+    bundle exec ./bin/rivendell-import --config examples/config.rb --listen examples --debug
 
-    gem 'rivendell-import'
+## Initialize a dedicated MySQL database
 
-And then execute:
+    $ mysqladmin create import
+    $ mysql mysql
+    mysql> GRANT ALL PRIVILEGES ON import.* TO 'import'@'localhost' IDENTIFIED BY 'import';
+    $ mysqladmin flush-privileges
 
-    $ bundle
+Then use :
 
-Or install it yourself as:
-
-    $ gem install rivendell-import
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+    rivendell-import [...] --database 'mysql://import:import@localhost/import' [...]

data/examples/.gitignore

@@ -1,2 +1,4 @@
 music/
 pad/
+*.wav
+*.mp3

data/examples/config.rb

@@ -24,6 +24,8 @@ Rivendell::Import.config do |config|
   config.rivendell.db_url = 'mysql://rduser:letmein@localhost/Rivendell'
 
   config.to_prepare do |file|
+    # task.cancel!
+
     cart.default_title = file.basename
 
     file.in("music") do

data/lib/rivendell/import/cart.rb

@@ -51,16 +51,44 @@ module Rivendell::Import
     end
 
     def update
-      update_attributes = attributes.dup
+      begin
+        update_by_api
+      rescue => e
+        Rivendell::Import.logger.debug "Update by API failed : #{e}"
+        update_by_db if Database.enabled?
+      end
+    end
 
-      if default_title
-        current_cart = xport.list_cart(number)
-        unless current_cart.has_title?
-          update_attributes[:title] = default_title
-        end
+    def empty_title?(title)
+      not [ nil, "", "[new cart]" ].include? title
+    end
+
+    def update_by_api
+      update_attributes = {}
+
+      if title
+        update_attributes[:title] = title
+      else
+        update_attributes[:title] = default_title if default_title && empty_title?(xport.list_cart(number).title)
       end
 
-      xport.edit_cart number, update_attributes
+      unless update_attributes.empty?
+        Rivendell::Import.logger.debug "Update Cart by API : #{update_attributes}"
+        xport.edit_cart number, update_attributes
+      end
+    end
+
+    def update_by_db
+      Database.init
+
+      Rivendell::Import.logger.debug "Update Cart by DB"
+      current_cart = Rivendell::DB::Cart.get(number)
+      if title
+        current_cart.title = title
+      else
+        current_cart.title = default_title if default_title && empty_title?(current_cart.title)
+      end
+      current_cart.save
     end
 
     def cut

data/lib/rivendell/import/cut.rb

@@ -16,7 +16,11 @@ module Rivendell::Import
     end
 
     def as_json(options = {})
-      super options.merge(:root => false)
+      super(options.merge(:root => false)).tap do |as_json|
+        as_json.each do |k,v|
+          as_json[k] = [v.begin, v.end] if v.is_a?(Range)
+        end
+      end
     end
 
     def attributes
@@ -70,5 +74,16 @@ module Rivendell::Import
       end
     end
 
+    def datetime=(datetime)
+      datetime = (datetime.first)..(datetime.last) if Array === datetime
+      datetime = Time.parse(datetime.begin)..Time.parse(datetime.end) if String === datetime.first
+      @datetime = datetime
+    end
+
+    def daypart=(daypart)
+      daypart = (daypart.first)..(daypart.last) if Array === daypart
+      @daypart = daypart
+    end
+
   end
 end

data/lib/rivendell/import/task.rb

@@ -20,8 +20,10 @@ module Rivendell::Import
       self.pending.select(&:ready?)
     end
 
+    RAN_STATUSES = %w{completed failed canceled}.freeze
+
     def self.ran
-      where :status => %w{completed failed}
+      where :status => RAN_STATUSES
     end
 
     def self.search(text)
@@ -29,7 +31,7 @@ module Rivendell::Import
     end
 
     def ran?
-      status.completed? or status.failed?
+      status.in? RAN_STATUSES
     end
 
     @@default_xport_options = {}
@@ -99,7 +101,16 @@ module Rivendell::Import
       file.destroy! if delete_file?
     end
 
+    def cancel!
+      self.status = "canceled"
+    end
+
     def run
+      if status.canceled?
+        logger.debug "Don't run canceled task : #{self.inspect}"
+        return
+      end
+
       logger.debug "Run #{self.inspect}"
       change_status! :running
 
@@ -117,7 +128,7 @@ module Rivendell::Import
       logger.error "Task failed : #{e}"
       logger.debug e.backtrace.join("\n")
     ensure
-      unless status.completed?
+      unless ran?
         change_status! :failed
       end
       save!

data/lib/rivendell/import/version.rb

@@ -1,5 +1,5 @@
 module Rivendell
   module Import
-    VERSION = "0.7"
+    VERSION = "0.8"
   end
 end

data/lib/rivendell/import.rb

@@ -19,8 +19,15 @@ module Rivendell
     @@logger = NullLogger.instance
     mattr_accessor :logger
 
-    def self.establish_connection(file = "db.sqlite3")
-      ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => file
+    def self.establish_connection(file_or_uri = "db.sqlite3")
+      database_spec =
+        if URI.parse(file_or_uri).scheme.in? [nil, "file"]
+          { :adapter => "sqlite3", :database => file_or_uri }
+        else
+          file_or_uri
+        end
+
+      ActiveRecord::Base.establish_connection database_spec
       ActiveRecord::Migrator.migrate(::File.expand_path("../../../db/migrate/", __FILE__), nil)
     end
 

data/rivendell-import.gemspec

@@ -44,6 +44,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rdoc"
   gem.add_development_dependency "cucumber"
   gem.add_development_dependency "database_cleaner"
-  # gem.add_development_dependency "remarkable_activerecord"
 
+  # gem.add_development_dependency "remarkable_activerecord"
 end

data/spec/rivendell/import/base_spec.rb

@@ -46,12 +46,11 @@ describe Rivendell::Import::Base do
     let(:file) { Rivendell::Import::File.new("dummy.wav") }
 
     it "should create a File with given path and base_directory" do
-      Rivendell::Import::File.should_receive(:new).with(File.expand_path("path", "base_directory"), :base_directory => "base_directory")
-      subject.file "path", "base_directory"
+      subject.file("path", "base_directory").file_path.should == File.expand_path("path", "base_directory")
     end
 
     it "should create a File with given path and base_directory" do
-      Rivendell::Import::File.stub :new=> file
+      Rivendell::Import::File.stub :new => file
       subject.should_receive(:create_task).with(file)
       subject.file "path", "base_directory"
     end

data/spec/rivendell/import/cut_spec.rb

@@ -14,6 +14,26 @@ describe Rivendell::Import::Cut do
 
   end
 
+  describe "#to_json" do
+
+    let(:json_clone) do
+      Rivendell::Import::Cut.new(cart).tap do |clone|
+        clone.from_json subject.to_json, false
+      end
+    end
+
+    it "should support datetime (Time range)" do
+      subject.datetime =  Time.parse("2014-03-20 00:00")..Time.parse("2014-03-21 23:59:59")
+      json_clone.datetime.should == subject.datetime
+    end
+
+    it "should support datepart (String range)" do
+      subject.daypart = "08:00:00".."12:00:00"
+      json_clone.daypart.should == subject.daypart
+    end
+
+  end
+
   describe "#create" do
 
     before(:each) do
@@ -39,6 +59,7 @@ describe Rivendell::Import::Cut do
 
     before do
       subject.number = 1
+      subject.cart.number = 1
     end
 
     context "when DB attributes are defined" do

data/spec/rivendell/import/task_spec.rb

@@ -6,7 +6,7 @@ describe Rivendell::Import::Task do
   subject { Rivendell::Import::Task.new :file => file }
 
   describe "#file" do
-   
+
     it "should return a file with specified path" do
       Rivendell::Import::Task.new(:file => file).file.should == file
     end
@@ -14,7 +14,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#cart" do
-    
+
     it "should return a Cart associated to the task" do
       subject.cart.task.should == subject
     end
@@ -22,7 +22,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#xport" do
-    
+
     it "should return a instance of Rivendell::API::Xport" do
       subject.xport.should be_instance_of(Rivendell::API::Xport)
     end
@@ -35,14 +35,14 @@ describe Rivendell::Import::Task do
   end
 
   describe "#xport_options" do
-    
+
     it "should use #default_xport_options" do
-      subject.stub :default_xport_options => { :host => "dummy" }  
+      subject.stub :default_xport_options => { :host => "dummy" }
       subject.xport_options.should == { :host => "dummy" }
     end
 
     it "should not modified #default_xport_options" do
-      subject.stub :default_xport_options => { :host => "dummy" }  
+      subject.stub :default_xport_options => { :host => "dummy" }
       subject.xport_options[:host] = "other"
       subject.default_xport_options.should == { :host => "dummy" }
     end
@@ -50,14 +50,14 @@ describe Rivendell::Import::Task do
   end
 
   describe "#prepare" do
-    
+
     it "should return the Task" do
       subject.prepare { |file| } .should == subject
     end
 
     it "should invoke the specified block with Task file" do
       given_file = nil
-      subject.prepare do |file| 
+      subject.prepare do |file|
         given_file = file
       end
       given_file.should == subject.file
@@ -71,7 +71,23 @@ describe Rivendell::Import::Task do
       subject.stub :destination => "test"
       subject.stub :cart => mock(:create => true, :import => true, :update => true, :number => 123, :to_json => '')
     end
-    
+
+    context "when task is canceled" do
+      before do
+        subject.status = "canceled"
+      end
+
+      it "should not create cart" do
+        subject.cart.should_not_receive(:create)
+        subject.run
+      end
+
+      it "keeps its canceled status" do
+        subject.run
+        expect(subject.status).to be_canceled
+      end
+    end
+
     it "should create Cart" do
       subject.cart.should_receive(:create)
       subject.run
@@ -101,7 +117,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#destination" do
-    
+
     it "should return 'Cart in group :group' if cart#group is defined" do
       subject.cart.group = 'dummy'
       subject.destination.should == "Cart in group dummy"
@@ -115,7 +131,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#tags" do
-    
+
     it "should be empty by default" do
       subject.tags.should be_empty
     end
@@ -123,12 +139,12 @@ describe Rivendell::Import::Task do
   end
 
   describe "#tag" do
-    
+
     it "should add the given tag" do
       subject.tag "dummy"
       subject.tags.should == %w{dummy}
     end
-    
+
   end
 
   describe "storage" do
@@ -163,14 +179,14 @@ describe Rivendell::Import::Task do
       subject.xport_options[:host] = "dummy"
       reloaded_task.xport_options[:host].should == "dummy"
     end
-    
+
   end
 
   describe "#status" do
-    
+
     it "should be include in pending, completed, failed" do
       pending
-      # subject.should validate_inclusion_of(:status, :in => %w{pending running completed failed})
+      # subject.should validate_inclusion_of(:status, :in => %w{pending running completed failed canceled})
     end
 
     it "should be pending by default" do
@@ -180,7 +196,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#notifications" do
-    
+
     before(:each) do
       subject.save!
     end
@@ -198,7 +214,7 @@ describe Rivendell::Import::Task do
     end
 
     let(:notifier) { Rivendell::Import::Notifier::Test.create! }
-    
+
     it "should create a Notification when a Notifier is added" do
       subject.notifiers << notifier
       subject.notifications.first.notifier.should == notifier
@@ -207,7 +223,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#notify!" do
-    
+
     before(:each) do
       subject.status = "completed"
       subject.save!
@@ -215,7 +231,7 @@ describe Rivendell::Import::Task do
     end
 
     let(:notifier) { Rivendell::Import::Notifier::Test.create! }
-    
+
     it "should notify task with all associated notifiers" do
       subject.notify!
       notifier.notified_tasks.should == [ subject ]
@@ -229,7 +245,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#change_status!" do
-    
+
     it "should update_attribute :status" do
       subject.should_receive(:update_attribute).with(:status, "completed")
       subject.change_status! :completed
@@ -248,7 +264,7 @@ describe Rivendell::Import::Task do
   end
 
   describe "#delete_file!" do
-    
+
     it "should set flag delete_file" do
       subject.delete_file!
       subject.delete_file.should be_true
@@ -259,14 +275,14 @@ describe Rivendell::Import::Task do
       before do
         subject.stub :cart => mock.as_null_object
       end
-      
+
 
       it "should destroy! file when task is completed" do
         subject.delete_file!
         subject.file.should_receive(:destroy!)
         subject.run
       end
-                  
+
     end
 
     context "not defined" do
@@ -275,13 +291,13 @@ describe Rivendell::Import::Task do
         subject.file.should_not_receive(:destroy!)
         subject.run
       end
-                  
+
     end
 
   end
 
   describe ".purge!" do
-    
+
     it "should remove tasks older than 24 hours" do
       old_task = Rivendell::Import::Task.create! :file => file, :created_at => 25.hours.ago
       Rivendell::Import::Task.purge!
@@ -301,4 +317,51 @@ describe Rivendell::Import::Task do
 
   end
 
+  describe "#ran?" do
+
+    it "should be true when status is completed" do
+      subject.status = "completed"
+      expect(subject).to be_ran
+    end
+
+    it "should be true when status is failed" do
+      subject.status = "failed"
+      expect(subject).to be_ran
+    end
+
+    it "should be true when status is canceled" do
+      subject.status = "canceled"
+      expect(subject).to be_ran
+    end
+
+  end
+
+  describe ".ran" do
+
+    it "should return completed tasks" do
+      subject.change_status! "completed"
+      expect(Rivendell::Import::Task.ran).to include(subject)
+    end
+
+    it "should return failed tasks" do
+      subject.change_status! "failed"
+      expect(Rivendell::Import::Task.ran).to include(subject)
+    end
+
+    it "should return canceled tasks" do
+      subject.change_status! "canceled"
+      expect(Rivendell::Import::Task.ran).to include(subject)
+    end
+
+  end
+
+  describe "#cancel!" do
+
+    it "should change task status to canceled" do
+      subject.cancel!
+      expect(subject.status).to be_canceled
+    end
+
+  end
+
 end