waffle_cal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b0aa1260e460020871a469f486a060baeab4b96
+  data.tar.gz: f83962872b6672154a89848de9431dba068bfc2d
+SHA512:
+  metadata.gz: cad59ec0b4d1c93486e63637c4872dcdc1336dadd242e2c59f144c67cbf8d2050758a88ea652c809c4d262a1253ebaefcf0acd652f54ab88ed30e64bf2d76587
+  data.tar.gz: 36111d91437b54d987346a5fcaceebfb7c6eb2fba2eeadd89d459c503d3ec09192c9baf90a865b823ab88682bf5601019d30b9d17eceee4dc58d7e0b46c4044e

data/.gitignore

@@ -0,0 +1 @@
+./bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    waffle_cal (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  rake (~> 10)
+  rspec (~> 3.2)
+  waffle_cal!

data/README.md

@@ -0,0 +1,29 @@
+# WaffleCal
+A simple iCal/vCal generator.
+
+## Usage
+Once the gem has been added to your Gemfile and you’ve updated your bundle, you can create calendars like this:
+
+	calendar_id = WaffleCal::ProdId.create(‘my_entity’, ‘my_product’, ‘en’)
+	calendar = WaffleCal::Calendar.new(calendar_id)
+	
+Create events like this:
+
+	event = WaffleCal::Event.new(params)
+
+where `params` is a `Hash` with these keys:
+
+* uid: A unique identifier (mandatory)
+* start_time: An instance of `Time` representing when the event starts (mandatory)
+* end_time: An instace of `Time` representing when the event ends (mandatory)
+* summary: The title/headline of the event (mandatory)
+* description: A longer textual description (optional)
+* location: Where the event is held. Can either be text or coordinates (optional).
+
+Add the event to your calendar like this:
+
+	calendar << event
+
+In the end, serialize the calendar to a `String` with `to_s`:
+
+	puts calendar.to_s

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/waffle_cal.rb

@@ -0,0 +1,4 @@
+require 'waffle_cal/calendar'
+require 'waffle_cal/event'
+require 'waffle_cal/prod_id'
+require 'waffle_cal/errors'

data/lib/waffle_cal/calendar.rb

@@ -0,0 +1,49 @@
+module WaffleCal
+
+	class Calendar
+
+		attr_accessor :prod_id, :events
+
+		def initialize(prod_id=nil)
+			@prod_id = prod_id
+		end
+
+		def <<(event)
+			add_event(event)
+		end
+
+		def add_event(event)
+			@events ||= []
+			@events << event
+		end
+
+		def events
+			@events || []
+		end
+
+		def to_s
+			output = []
+
+			output += start_calendar
+			output += events.collect { |evt| evt.to_s }
+			output += end_calendar
+			
+			output.join("\r\n")
+		end
+
+		protected
+
+		def start_calendar
+			output = []
+			output << "BEGIN:VCALENDAR"
+			output << "VERSION:2.0"
+		    output << "METHOD:PUBLISH"
+			output << "PRODID:-#{@prod_id.to_s}"
+			output
+		end
+
+		def end_calendar
+			["END:VCALENDAR"]
+		end
+	end
+end

data/lib/waffle_cal/errors.rb

@@ -0,0 +1,10 @@
+module WaffleCal
+
+	module Errors
+
+		class IncompleteEventError < StandardError; end
+		class IllegalEventError < StandardError; end
+
+	end
+
+end

data/lib/waffle_cal/event.rb

@@ -0,0 +1,72 @@
+module WaffleCal
+
+	class Event
+
+		attr_accessor :uid, :start_time, :end_time, :summary, :description, :location
+
+		@@time_format = "%Y%m%dT%H%M00"
+
+		def initialize(attrs={})
+			attrs.each { |key, val| self.send("#{key}=", val) }
+		end
+
+		def to_s
+			valid?
+
+			output = []
+			output << start_event
+      		output << date_start_str
+      		output << date_end_str
+      		output << uid_str
+			output << summary_str if summary
+			output << location_str if location
+			output << description_str if description
+			output << end_event
+			output.join("\r\n")
+		end
+
+		protected
+
+		def valid?
+			raise Errors::IncompleteEventError.new('Missing uid')  if uid.nil?
+			raise Errors::IncompleteEventError.new('Missing start time') if start_time.nil?
+			raise Errors::IncompleteEventError.new('Missing end time') if end_time.nil?
+			raise Errors::IncompleteEventError.new('Missing summary') if summary.nil?
+			raise Errors::IncompleteEventError.new('Start time is not an instance of Time') unless start_time.instance_of?(Time)
+			raise Errors::IncompleteEventError.new('End time is not an instance of Time') unless end_time.instance_of?(Time)
+			raise Errors::IllegalEventError.new('End time is before start time') if start_time > end_time
+		end
+
+		def date_start_str
+			"DTSTART:#{start_time.strftime(@@time_format)}"
+		end
+
+		def date_end_str
+			"DTEND:#{end_time.strftime(@@time_format)}"
+		end
+
+		def uid_str
+			"UID:#{uid}"
+		end
+
+		def summary_str
+			"SUMMARY:#{summary}"
+		end
+
+		def location_str
+			"LOCATION:#{location}"
+		end
+
+		def description_str
+			"DESCRIPTION:#{description}"
+		end
+
+		def start_event
+			"BEGIN:VEVENT"
+		end
+
+		def end_event
+			"END:VEVENT"
+		end
+	end
+end

data/lib/waffle_cal/prod_id.rb

@@ -0,0 +1,34 @@
+module WaffleCal
+
+	class ProdId
+		attr_accessor :entity_name, :product_name, :language
+
+		def initialize(attrs={})
+			@entity_name = attrs[:entity_name]
+			@product_name = attrs[:product_name]
+			@language = attrs[:language].upcase if attrs.has_key?(:language)
+		end
+
+		def self.create(entity_name, product_name, language)
+			ProdId.new({entity_name: entity_name, product_name: product_name, language: language})
+		end
+
+		def to_s
+			if complete?
+				"//#{@entity_name}//#{@product_name}//#{@language}"
+			else
+				default_prod_id.to_s
+			end
+		end
+
+		private
+
+		def complete?
+			@entity_name && @product_name && @language
+		end
+
+		def default_prod_id
+			ProdId.new({entity_name: 'fiskeben.dk', product_name: 'waffle_cal', language: 'EN'})
+		end
+	end
+end

data/lib/waffle_cal/version.rb

@@ -0,0 +1,3 @@
+module WaffleCal
+	VERSION = '0.0.1'
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe WaffleCal::Calendar do
+	subject { WaffleCal::Calendar.new }
+
+	describe '#to_s' do
+		it 'returns a vcalendar string' do
+			expect(subject.to_s).to be_a(String)
+		end
+	end
+
+	describe '<<' do
+		it 'adds an event' do
+			subject << WaffleCal::Event.new
+			expect(subject.events.length).to eq(1)
+		end
+	end
+
+	describe 'add_event' do
+		it 'adds an event' do
+			subject.add_event(WaffleCal::Event.new)
+			expect(subject.events.length).to eq(1)
+		end
+	end
+
+	describe 'events' do
+		it 'returns a list of events' do
+			expect(subject.events).to be_an(Array)
+		end
+
+		it 'returns all events' do
+			subject << WaffleCal::Event.new
+			expect(subject.events.first).to be_an(WaffleCal::Event)
+		end
+	end
+
+
+end

data/spec/event_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe WaffleCal::Event do
+
+	it 'serializes to string' do
+		event = WaffleCal::Event.new({uid: 'my-uid', start_time: Time.now - 100, end_time: Time.now + 100, summary: 'Some event', description: 'Very event', location: 'Moon'})
+		expect(event.to_s).to be_a(String)
+	end
+
+	context 'validation' do
+
+		it 'raises error if uid is missing' do
+			event = WaffleCal::Event.new({start_time: Time.now, end_time: Time.now + 100, summary: 'Some event', description: 'Very event', location: 'Moon'})
+			expect { event.to_s }.to raise_error(WaffleCal::Errors::IncompleteEventError)
+		end
+
+		it 'raises error if start_time is missing' do
+			event = WaffleCal::Event.new({uid: 'my-uid', end_time: Time.now + 100, summary: 'Some event', description: 'Very event', location: 'Moon'})
+			expect { event.to_s }.to raise_error(WaffleCal::Errors::IncompleteEventError)
+		end
+
+		it 'raises error if end_time is missing' do
+			event = WaffleCal::Event.new({uid: 'my-uid', start_time: Time.now, summary: 'Some event', description: 'Very event', location: 'Moon'})
+			expect { event.to_s }.to raise_error(WaffleCal::Errors::IncompleteEventError)
+		end
+
+		it 'raises error if summary is missing' do
+			event = WaffleCal::Event.new({uid: 'my-uid', start_time: Time.now, end_time: Time.now + 100, description: 'Very event', location: 'Moon'})
+			expect { event.to_s }.to raise_error(WaffleCal::Errors::IncompleteEventError)
+		end
+
+
+		it 'raises error if end time is before start time' do
+			event = WaffleCal::Event.new({uid: 'my-uid', start_time: Time.now, end_time: Time.now - 100, summary: 'Some event', description: 'Very event', location: 'Moon'})
+			expect { event.to_s }.to raise_error(WaffleCal::Errors::IllegalEventError)
+		end
+
+	end	
+	
+end

data/spec/prod_id_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe WaffleCal::ProdId do
+
+	context 'validation' do
+
+		let (:valid_id) { id = WaffleCal::ProdId.new({entity_name: 'foo', product_name: 'bar', language: 'en'}) }
+
+		it 'returns an ID string if complete' do
+			expect(valid_id.to_s).to eq('//foo//bar//EN')
+		end
+
+		it 'uppercases language' do
+			expect(valid_id.language).to eq('EN')
+		end
+
+		it 'returns default ID string if not complete' do
+			expect(WaffleCal::ProdId.new.to_s).to eq('//fiskeben.dk//waffle_cal//EN')
+		end
+	end
+	
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'waffle_cal'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/waffle_cal.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'waffle_cal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "waffle_cal"
+  spec.version       = WaffleCal::VERSION
+  spec.authors       = ["Ricco Førgaard"]
+  spec.email         = ["ricco@fiskeben.dk"]
+  spec.summary       = "Vcal/ical creator"
+  spec.description   = "Creates ical/vcal files."
+  spec.homepage      = "http://fiskeben.dk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: waffle_cal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricco Førgaard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !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: Creates ical/vcal files.
+email:
+- ricco@fiskeben.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/waffle_cal.rb
+- lib/waffle_cal/calendar.rb
+- lib/waffle_cal/errors.rb
+- lib/waffle_cal/event.rb
+- lib/waffle_cal/prod_id.rb
+- lib/waffle_cal/version.rb
+- spec/calendar_spec.rb
+- spec/event_spec.rb
+- spec/prod_id_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- waffle_cal.gemspec
+homepage: http://fiskeben.dk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Vcal/ical creator
+test_files:
+- spec/calendar_spec.rb
+- spec/event_spec.rb
+- spec/prod_id_spec.rb
+- spec/spec_helper.rb