ical_importer 0.0.14 → 0.0.15

data/CHANGELOG

@@ -0,0 +1,5 @@
+#### 2012-10-10 **Version 0.15**
+
+* Adjustable request timeout on ical feed retrieval
+
+  > @NickLaMuro: https://github.com/tstmedia/ical_importer/pull/2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ical_importer (0.0.14)
+    ical_importer (0.0.15)
       activesupport (~> 3.0.15)
       i18n
       ri_cal

data/README.md

@@ -21,6 +21,9 @@ Then you can do:
 ```ruby
 IcalImporter::Parser.new(a_url).parse # To get just an array of events
 
+# To get just an array of events, with a longer timeout [default is 8 sec]
+IcalImporter::Parser.new(a_url, :timeout => 40).parse
+
 IcalImporter::Parser.new(a_url).parse do |event|
   event.uid
   event.title

data/lib/ical_importer/parser.rb

@@ -1,10 +1,19 @@
 module IcalImporter
   class Parser
     attr_reader :feed, :bare_feed, :url
+    attr_accessor :timeout
 
-    def initialize(url)
+    DEFAULT_TIMEOUT = 8
+
+    # Get a new Parser object
+    #
+    # url     - URL where we download the ical feed
+    # options - Options hash
+    #         :timeout  - Custom timeout for downloading ical feed [Default: 8]
+    def initialize(url, options={})
       @url = url
       @bare_feed = open_ical
+      @timeout = options[:timeout] || DEFAULT_TIMEOUT
       if should_parse?
         @bare_feed.pos = 0
         begin
@@ -57,7 +66,7 @@ module IcalImporter
     def open_ical(protocol = 'http')
       raise ArgumentError, "Must be http or https" unless %w[http https].include? protocol
       begin
-        ::Timeout::timeout(8) do
+        ::Timeout::timeout(@timeout) do
           open prepped_uri(protocol)
         end
       rescue

data/lib/ical_importer/version.rb

@@ -1,3 +1,3 @@
 module IcalImporter
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/spec/ical_importer/parser_spec.rb

@@ -16,6 +16,23 @@ module IcalImporter
         RiCal.should_receive(:parse).with bare_stuff
         Parser.new(url)
       end
+
+      it "defaults a timeout to the DEFAULT_TIMEOUT" do
+        Parser.any_instance.stub(:open_ical).and_return bare_stuff
+        parser = Parser.new(url)
+        parser.timeout.should == Parser::DEFAULT_TIMEOUT
+      end
+
+      context "when a user defines a timeout" do
+        it "sets the timeout" do
+          Parser.any_instance.stub(:open_ical).and_return bare_stuff
+          parser = Parser.new(url, :timeout => 11)
+          parser.timeout.should == 11
+
+          parser.timeout = 10
+          parser.timeout.should == 10
+        end
+      end
     end
 
     describe "#should_parse?" do
@@ -90,6 +107,21 @@ module IcalImporter
       it "fails with an invalid protocol" do
         expect { subject.send(:open_ical, 'wrong_proto') }.to raise_error(ArgumentError, "Must be http or https")
       end
+
+      it "will wait up to #{Parser::DEFAULT_TIMEOUT} secs" do
+        Timeout.should_receive(:timeout).with(Parser::DEFAULT_TIMEOUT)
+        subject.send(:open_ical, 'http')
+      end
+
+      context "when timeout is defined" do
+
+        it "will wait up to the defined time" do
+          subject.timeout = 9
+        Timeout.should_receive(:timeout).with(9)
+        subject.send(:open_ical, 'http')
+        end
+
+      end
     end
 
     describe "#prepped_uri" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ical_importer
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,6 +118,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -158,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3814022261725594651
+      hash: 3561992931881412650
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3814022261725594651
+      hash: 3561992931881412650
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24