rivendell-api 0.0.2 → 0.0.3

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rivendell-api.gemspec
 gemspec
+
+if RUBY_PLATFORM =~ /linux/
+  gem 'libnotify' 
+  gem 'rb-inotify', '~> 0.8.8'
+end

data/lib/rivendell/api.rb

@@ -2,6 +2,7 @@ require "rivendell/api/version"
 
 require "null_logger"
 require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/class/attribute_accessors"
 
 module Rivendell
   module API

data/lib/rivendell/api/cart.rb

@@ -12,10 +12,10 @@ module Rivendell::API
     def number=(number)
       @number = (number ? number.to_i : nil)
     end
-
+    
     alias_method :group, :group_name
     alias_method :group=, :group_name=
-
+      
     def cut_list=(cuts)
       
     end
@@ -24,10 +24,10 @@ module Rivendell::API
       
     end
 
-    def method_missing(name, arguments)
+    def method_missing(name, *arguments)
       underscored_name = name.to_s.underscore
       if respond_to?(underscored_name)
-        send underscored_name, arguments
+        send underscored_name, *arguments
       else
         super
       end

data/lib/rivendell/api/cut.rb

@@ -16,10 +16,10 @@ module Rivendell::API
     alias_method :cut_name=, :name=
     alias_method :cut_number=, :number=
 
-    def method_missing(name, arguments)
+    def method_missing(name, *arguments)
       underscored_name = name.to_s.underscore
       if respond_to?(underscored_name)
-        send underscored_name, arguments
+        send underscored_name, *arguments
       else
         super
       end

data/lib/rivendell/api/version.rb

@@ -1,5 +1,5 @@
 module Rivendell
   module Api
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/rivendell/api/xport.rb

@@ -1,7 +1,7 @@
 module Rivendell::API
   class Xport
     include HTTMultiParty
-    base_uri 'http://localhost/rd-bin/rdxport.cgi'
+
     # debug_output $stderr
     format :xml
 
@@ -26,11 +26,33 @@ module Rivendell::API
       Rivendell::API.logger
     end
 
+    def initialize(options = {})
+      options.each { |k,v| send "#{k}=", v }
+    end
+
+    attr_accessor :login_name, :password, :host
+
+    def host
+      @host ||= "localhost"
+    end
+
+    def login_name
+      @login_name ||= "user"
+    end
+    
+    def password 
+      @password ||= ""
+    end
+
+    def rdxport_uri
+      "http://#{host}/rd-bin/rdxport.cgi"
+    end
+
     def query(command, attributes = {})
       attributes = { 
         :command => command, 
-        :login_name => "user", 
-        :password => "" 
+        :login_name => login_name, 
+        :password => password 
       }.merge(attributes)
 
       attributes.inject({}) do |map, (key, value)|
@@ -41,7 +63,7 @@ module Rivendell::API
 
     def post(command, attributes = {}, options = {})
       logger.debug "Post #{command} #{attributes.inspect}"
-      self.class.post '', :query => query(command, attributes)
+      self.class.post rdxport_uri, :query => query(command, attributes)
     end
 
     def list_groups
@@ -70,6 +92,31 @@ module Rivendell::API
       post COMMAND_REMOVECART, :cart_number => cart_number
     end
 
+    def list_cuts(cart_number)
+      response = post COMMAND_LISTCUTS, :cart_number => cart_number
+      case cuts_xml = response["cutList"]["cut"]
+      when Array
+        cuts_xml.collect do |cut_xml|
+          Rivendell::API::Cut.new(cut_xml)
+        end
+      when nil
+        []
+      else
+        [ Rivendell::API::Cut.new(cuts_xml) ]
+      end
+    end
+
+    def remove_cut(cart_number, cut_number)
+      post COMMAND_REMOVECUT, :cart_number => cart_number, :cut_number => cut_number
+    end
+
+    # Extension
+    def clear_cuts(cart_number)
+      list_cuts(cart_number).map(&:number).each do |cut_number|
+        remove_cut cart_number, cut_number
+      end
+    end
+
     def import(cart_number, cut_number, file, options = {})
       arguments = { 
         :channels => 2, 
@@ -91,4 +138,5 @@ module Rivendell::API
     end
 
   end
+
 end

data/spec/fixtures/rdxport_list_cuts.xml

@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<cutList>
+<cut>
+  <cutName>045004_001</cutName>
+  <cartNumber>45004</cartNumber>
+  <cutNumber>1</cutNumber>
+  <evergreen>false</evergreen>
+  <description>Rivendell 1</description>
+  <outcue></outcue>
+  <isrc></isrc>
+  <isci></isci>
+  <length>7862</length>
+  <originDatetime>Wed, 22 Apr 2009 21:23:22 GMT</originDatetime>
+  <startDatetime></startDatetime>
+  <endDatetime></endDatetime>
+  <sun>true</sun>
+  <mon>true</mon>
+  <tue>true</tue>
+  <wed>true</wed>
+  <thu>true</thu>
+  <fri>true</fri>
+  <sat>true</sat>
+  <startDaypart></startDaypart>
+  <endDaypart></endDaypart>
+  <originName>hyppo</originName>
+  <weight>1</weight>
+  <lastPlayDatetime>Thu, 13 Sep 2012 07:05:35 GMT</lastPlayDatetime>
+  <playCounter>34</playCounter>
+  <localCounter>22</localCounter>
+  <validity>2</validity>
+  <codingFormat>0</codingFormat>
+  <sampleRate>44100</sampleRate>
+  <bitRate>0</bitRate>
+  <channels>2</channels>
+  <playGain>0</playGain>
+  <startPoint>52</startPoint>
+  <endPoint>7914</endPoint>
+  <fadeupPoint>-1</fadeupPoint>
+  <fadedownPoint>-1</fadedownPoint>
+  <segueStartPoint>6008</segueStartPoint>
+  <segueEndPoint>7888</segueEndPoint>
+  <segueGain>-3000</segueGain>
+  <hookStartPoint>-1</hookStartPoint>
+  <hookEndPoint>-1</hookEndPoint>
+  <talkStartPoint>-1</talkStartPoint>
+  <talkEndPoint>0</talkEndPoint>
+</cut>
+<cut>
+  <cutName>045004_002</cutName>
+  <cartNumber>45004</cartNumber>
+  <cutNumber>2</cutNumber>
+  <evergreen>false</evergreen>
+  <description>Rivendell 2</description>
+  <outcue></outcue>
+  <isrc></isrc>
+  <isci></isci>
+  <length>9064</length>
+  <originDatetime>Wed, 22 Apr 2009 21:25:00 GMT</originDatetime>
+  <startDatetime></startDatetime>
+  <endDatetime></endDatetime>
+  <sun>true</sun>
+  <mon>true</mon>
+  <tue>true</tue>
+  <wed>true</wed>
+  <thu>true</thu>
+  <fri>true</fri>
+  <sat>true</sat>
+  <startDaypart></startDaypart>
+  <endDaypart></endDaypart>
+  <originName>hyppo</originName>
+  <weight>1</weight>
+  <lastPlayDatetime>Thu, 13 Sep 2012 07:05:48 GMT</lastPlayDatetime>
+  <playCounter>34</playCounter>
+  <localCounter>22</localCounter>
+  <validity>2</validity>
+  <codingFormat>0</codingFormat>
+  <sampleRate>44100</sampleRate>
+  <bitRate>0</bitRate>
+  <channels>2</channels>
+  <playGain>0</playGain>
+  <startPoint>78</startPoint>
+  <endPoint>9142</endPoint>
+  <fadeupPoint>-1</fadeupPoint>
+  <fadedownPoint>-1</fadedownPoint>
+  <segueStartPoint>8280</segueStartPoint>
+  <segueEndPoint>9116</segueEndPoint>
+  <segueGain>-3000</segueGain>
+  <hookStartPoint>-1</hookStartPoint>
+  <hookEndPoint>-1</hookEndPoint>
+  <talkStartPoint>-1</talkStartPoint>
+  <talkEndPoint>0</talkEndPoint>
+</cut>
+<cut>
+  <cutName>045004_003</cutName>
+  <cartNumber>45004</cartNumber>
+  <cutNumber>3</cutNumber>
+  <evergreen>false</evergreen>
+  <description>Rivendell 3</description>
+  <outcue></outcue>
+  <isrc></isrc>
+  <isci></isci>
+  <length>8307</length>
+  <originDatetime>Wed, 22 Apr 2009 21:25:38 GMT</originDatetime>
+  <startDatetime></startDatetime>
+  <endDatetime></endDatetime>
+  <sun>true</sun>
+  <mon>true</mon>
+  <tue>true</tue>
+  <wed>true</wed>
+  <thu>true</thu>
+  <fri>true</fri>
+  <sat>true</sat>
+  <startDaypart></startDaypart>
+  <endDaypart></endDaypart>
+  <originName>hyppo</originName>
+  <weight>1</weight>
+  <lastPlayDatetime>Thu, 13 Sep 2012 07:05:22 GMT</lastPlayDatetime>
+  <playCounter>33</playCounter>
+  <localCounter>21</localCounter>
+  <validity>2</validity>
+  <codingFormat>0</codingFormat>
+  <sampleRate>44100</sampleRate>
+  <bitRate>0</bitRate>
+  <channels>2</channels>
+  <playGain>0</playGain>
+  <startPoint>130</startPoint>
+  <endPoint>8437</endPoint>
+  <fadeupPoint>-1</fadeupPoint>
+  <fadedownPoint>-1</fadedownPoint>
+  <segueStartPoint>-1</segueStartPoint>
+  <segueEndPoint>-1</segueEndPoint>
+  <segueGain>-3000</segueGain>
+  <hookStartPoint>-1</hookStartPoint>
+  <hookEndPoint>-1</hookEndPoint>
+  <talkStartPoint>-1</talkStartPoint>
+  <talkEndPoint>0</talkEndPoint>
+</cut>
+</cutList>

data/spec/rivendell/api/xport_spec.rb

@@ -14,6 +14,88 @@ describe Rivendell::API::Xport do
     File.read fixture_file(file)
   end
 
+  describe "initialization" do
+    
+    it "should use specified attributes" do
+      Rivendell::API::Xport.new(:login_name => "dummy").login_name.should == "dummy"
+    end
+
+    
+
+  end
+
+  describe "#login_name" do
+
+    before do
+      FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_list_groups.xml"))
+
+      def subject.make_request
+        list_groups
+      end
+    end
+
+    it "should be 'user' by default" do
+      subject.login_name.should == 'user'
+    end
+
+    it "should be used in queries" do
+      subject.login_name = "dummy"
+      subject.make_request
+      FakeWeb.last_request.form_data["LOGIN_NAME"].should == "dummy"
+    end
+
+  end
+
+  describe "#password" do
+
+    before do
+      FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_list_groups.xml"))
+
+      def subject.make_request
+        list_groups
+      end
+    end
+    
+    it "should be '' by default" do
+      subject.password.should == ''
+    end
+
+    it "should be used in queries" do
+      subject.password = "dummy"
+      subject.make_request
+      FakeWeb.last_request.form_data["PASSWORD"].should == "dummy"
+    end
+
+  end
+
+  describe "host" do
+
+    let(:host) { "example.com" }
+
+    subject { Rivendell::API::Xport.new :host => host }
+
+    before do
+      FakeWeb.register_uri(:post, "http://#{host}/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_list_groups.xml"))
+      def subject.make_request
+        list_groups
+      end
+    end
+    
+    it "should used host specified in constructor" do
+      subject.make_request
+    end
+
+  end
+
+  describe ".rdxport_uri" do
+
+    it "should use host" do
+      subject.host = "dummy"
+      subject.rdxport_uri.should == "http://dummy/rd-bin/rdxport.cgi"
+    end
+    
+  end
+
   describe "#list_groups" do
 
     before(:each) do
@@ -50,7 +132,7 @@ describe Rivendell::API::Xport do
 
   end
 
-  describe "add_cart" do
+  describe "#add_cart" do
     
     before(:each) do
       FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_add_cart.xml"))
@@ -77,7 +159,7 @@ describe Rivendell::API::Xport do
 
   end
 
-  describe "add_cut" do
+  describe "#add_cut" do
     
     before(:each) do
       FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_add_cut.xml"))
@@ -94,7 +176,7 @@ describe Rivendell::API::Xport do
 
   end
 
-  describe "list_carts" do
+  describe "#list_carts" do
     
     before(:each) do
       FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_list_carts.xml"))
@@ -116,4 +198,71 @@ describe Rivendell::API::Xport do
 
   end
 
+  describe "#list_cuts" do
+    
+    before(:each) do
+      FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => fixture_content("rdxport_list_cuts.xml"))
+    end
+
+    it "should use COMMAND 9" do
+      subject.list_cuts(123)
+      FakeWeb.last_request["COMMAND"] == "9"
+    end
+
+    it "should return Cuts" do
+      subject.list_cuts(123).map(&:description).should include("Rivendell 1", "Rivendell 2", "Rivendell 3")
+    end
+
+  end
+
+  describe "#clear_cuts" do
+
+    let(:number) { 123 }
+
+    def cut(cut_number)
+      Rivendell::API::Cut.new :number => cut_number
+    end
+
+    let(:cuts) { [ cut(1), cut(2) ]}
+    
+    it "should load specified Cart" do
+      subject.should_receive(:list_cuts).with(number).and_return(cuts)
+      subject.clear_cuts number
+    end
+
+    it "should remove Cart's Cuts" do
+      subject.stub :list_cuts => cuts
+      subject.should_receive(:remove_cut).with(number, 1)
+      subject.should_receive(:remove_cut).with(number, 2)
+      subject.clear_cuts number
+    end
+
+  end
+
+  describe "#remove_cut" do
+    
+    before(:each) do
+      FakeWeb.register_uri(:post, "http://localhost/rd-bin/rdxport.cgi", :body => xml_response)
+    end
+
+    let(:cart_number) { 123 }
+    let(:cut_number) { 1 }
+
+    it "should use COMMAND 11" do
+      subject.remove_cut cart_number, cut_number
+      FakeWeb.last_request["COMMAND"] == "11"
+    end
+
+    it "should specify cart_number" do
+      subject.remove_cut 123, cut_number
+      FakeWeb.last_request["CART_NUMBER"] == "123"
+    end
+
+    it "should specify cut_number" do
+      subject.remove_cut cart_number, 1
+      FakeWeb.last_request["CUT_NUMBER"] == 1
+    end
+
+  end
+
 end

data/spec/support/fakeweb.rb

@@ -1,2 +1,11 @@
 require 'fakeweb'
 FakeWeb.allow_net_connect = false
+
+class Net::HTTPGenericRequest
+
+  def form_data
+    @form_data ||= Hash[CGI.unescape(body).scan(/([^=]+)=([^&]*)&?/)]
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rivendell-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -182,6 +182,7 @@ files:
 - spec/fixtures/rdxport_add_cut.xml
 - spec/fixtures/rdxport_import.xml
 - spec/fixtures/rdxport_list_carts.xml
+- spec/fixtures/rdxport_list_cuts.xml
 - spec/fixtures/rdxport_list_groups.xml
 - spec/rivendell/api/xport_spec.rb
 - spec/spec_helper.rb
@@ -202,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4338672299131379254
+      hash: 3217387288640019372
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4338672299131379254
+      hash: 3217387288640019372
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -224,6 +225,7 @@ test_files:
 - spec/fixtures/rdxport_add_cut.xml
 - spec/fixtures/rdxport_import.xml
 - spec/fixtures/rdxport_list_carts.xml
+- spec/fixtures/rdxport_list_cuts.xml
 - spec/fixtures/rdxport_list_groups.xml
 - spec/rivendell/api/xport_spec.rb
 - spec/spec_helper.rb