Sha256: 8ab6dbe548f35d7fc67f53787f6959ea6b96fce476324e008f2ae714206d7a00

Contents?: true

Size: 1.67 KB

Versions: 10

Compression:

Stored size: 1.67 KB

Contents

# Ical Importer

Easily import your iCal feeds.

[![TravisCI](https://secure.travis-ci.org/tstmedia/ical_importer.png "TravisCI")](http://travis-ci.org/tstmedia/ical_importer "Travis-CI IcalImporter")

[RubyGems](http://rubygems.org/gems/ical_importer)

# Usage

Add

```ruby
gem 'ical_importer'
```

to your Gemfile

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
  event.description
  event.location
  event.start_date_time
  event.end_date_time
  event.utc
  event.date_exclusions
  event.recur_end_date
  event.recur_month_repeat_by
  event.recur_interval
  event.recur_interval_value
  event.recurrence_id
  event.all_day_event
  event.recurrence
  event.utc?
  event.all_day_event?
  event.recurrence?
  event.recur_week_sunday
  event.recur_week_monday
  event.recur_week_tuesday
  event.recur_week_wednesday
  event.recur_week_thursday
  event.recur_week_friday
  event.recur_week_saturday
end

parser = IcalImporter::Parser.new(a_url)
parser.parse do |e|
  # block stuffs
end

# Each of these also accepts blocks and returns a list
# MUST parse before using these
parser.all_events
parser.recurrence_events
parser.single_events
```

# Notes

* Recurrence events are not the same as recurring events

# TODO

* Current implementation based on an extraction from another app
  - some of the recurring/recurrence/single logic is fragmented
  - Re-implement to be more similarly classifiable across these different scenarios
* Document Methods

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
ical_importer-0.2.0 README.md
ical_importer-0.1.3 README.md
ical_importer-0.1.2 README.md
ical_importer-0.1.1 README.md
ical_importer-0.1.0 README.md
ical_importer-0.0.19 README.md
ical_importer-0.0.18 README.md
ical_importer-0.0.17 README.md
ical_importer-0.0.16 README.md
ical_importer-0.0.15 README.md