add_to_google_cal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 974e4024ca9a078dc6c7d24f223fb5d6a0d323a9
+  data.tar.gz: 02c37e7e1f828a1f1b805c2f6433b7271defc479
+SHA512:
+  metadata.gz: c8fed9839c9f837d72a9e7c20089f3fb513796d37140527677f7e1ccd24f94dab1a41a2d07c05320f871917ec2b2fe9712337b6dac6b74cf639dd87afa33c237
+  data.tar.gz: b50b98a6b89fa8793e3e5978d932ef9123c8988110c52368ed0e1ff999be4350da25a654139ebd433320791e3a9570e01de91ed9b90af2bc4813405419850f61

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.sqlite3
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color --profile
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-2.0.0-p247@add-to-google-cal

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in add_to_google_cal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Charles Bergeron
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# AddToGoogleCal
+
+A view layer helper which takes an object (such as an ActiveRecord instance from your database) and generates an "Add To Google Calendar" URL based on it's attributes.
+
+This follows the ISO RFC-2445 calendar standard of using `dtstart`, `dtend`, `summary`, etc. You can customize these fields to match your implementation (ie. `start_date`, `end_date`, `event_name`, etc). Details on this below.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'add_to_google_cal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install add_to_google_cal
+
+## Usage
+
+### ActiveRecord:
+
+    class Wedding < AR::Base
+
+      has_google_cal
+
+    end
+
+    Wedding.first.to_google_cal
+
+    # TODO: Support custom column names, ie:
+    has_google_cal {
+      :dtstart_attribute => 'crazy_date_start_column_name'
+    }
+
+### Generic Object:
+
+    require 'ostruct'
+    object = OpenStruct.new({
+      :summary => "Super awesome event coming up in 2009, y'all!",
+      :dtstart => '2019-03-07'
+    })
+
+    AddToGoogleCal::Builder.new(object).call
+    => "https://www.google.com/calendar/render?action=TEMPLATE&dates=20190726T000000Z/20190726T000000Z& ..." (or something like this)
+
+### Ruby Hash:
+
+    attributes = {
+      {
+        dtstart: Time.utc(2013, 01, 03, 12, 00),
+        dtend:   Time.utc(2013, 01, 03, 14, 00),
+        summary: 'This is the Title of the Event'
+      }
+    }
+
+    AddToGoogleCal::Builder.new(attributes).call
+    => 'https://www.google.com/calendar/render?action=TEMPLATE&dates=20130103T120000Z/20130103T140000Z&text=This+is+the+Title+of+the+Event'
+
+
+### erb might look like:
+
+    <%= link_to("Add To Google Calendar", AddToGoogleCal.new(object).call) %>
+
+
+## TODO:
+
+* Handle converting various types of date/time objects
+  * Finish the argument validation for required fields
+* Support objects / structs
+
+* Finish implementing the ActiveRecord hook
+* Support custom column names in has_google_cal AR mixin
+
+
+## Thanks To
+
+@pcreux and everyone else who has colloborated / paired on this project.
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+
+## Why?
+
+I was working on [Handcrafted Video Wedding Invites](http://www.craftedtoyou.com/) and this project was born out of a need to allow wedding guests quickly adding a wedding event to their Google Calendar.
+
+http://www.craftedtoyou.com/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/add_to_google_cal.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'add_to_google_cal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "add_to_google_cal"
+  spec.version       = AddToGoogleCal::VERSION
+  spec.authors       = ["Charles Bergeron"]
+  spec.email         = ["hello@charlesbergeron.ca"]
+  spec.description   = %q{A view layer helper which takes an object (such as an ActiveRecord instance from your database) and generates an "Add To Google Calendar" URL based on it's attributes.}
+  spec.summary       = %q{Google Calendar anchor href link url helper presenter.}
+  spec.homepage      = "https://github.com/chuckbergeron/add_to_google_cal"
+  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_dependency 'activerecord', '>= 3.0'
+  spec.add_development_dependency 'bundler', '>= 1.3'
+  # spec.add_development_dependency 'pry-debugger'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.0'
+  spec.add_development_dependency 'sqlite3'
+end
+

data/lib/add_to_google_cal.rb

@@ -0,0 +1,59 @@
+require_relative 'add_to_google_cal/builder'
+require_relative 'add_to_google_cal/version'
+
+require 'active_record'
+require 'cgi'
+# require 'pry-debugger'
+
+# TODO: DRY this up!
+module AddToGoogleCal
+
+  module ClassMethods
+
+    # Options Example (in your model):
+    #   has_google_cal { summary_field: 'event_name' }
+    #
+    def has_google_cal(options = {})
+      cattr_accessor :summary_field, :dtstart_field, :dtend_field
+      self.dtstart_field = (options[:dtstart_field] || :dtstart).to_s
+      self.dtend_field   = (options[:dtend_field]   || :dtend).to_s
+      self.summary_field = (options[:summary_field] || :summary).to_s
+
+      include AddToGoogleCal::InstanceMethods
+    end
+
+  end
+
+  module InstanceMethods
+
+    def to_gcal
+      dtstart_field = self.class.dtstart_field
+      dtend_field   = self.class.dtend_field
+      summary_field = self.class.summary_field
+
+      unless self.respond_to?(dtstart_field)
+        raise ArgumentError, "#{self} does not have a #{dtstart_field}"
+      end
+
+      unless self.respond_to?(dtend_field)
+        raise ArgumentError, "#{self} does not have a #{dtend_field}"
+      end
+
+      unless self.respond_to?(summary_field)
+        raise ArgumentError, "#{self} does not have a #{summary_field}"
+      end
+
+      hash = {
+        dtstart: self.send(dtstart_field),
+        dtend:   self.send(dtend_field),
+        summary: self.send(summary_field)
+      }
+
+      AddToGoogleCal::Builder.new(hash).call
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.send :extend, AddToGoogleCal::ClassMethods

data/lib/add_to_google_cal/builder.rb

@@ -0,0 +1,55 @@
+module AddToGoogleCal
+
+  class Builder
+
+    attr_accessor :hash
+
+    def initialize(object_or_hash)
+      self.hash = object_or_hash
+      validate!
+    end
+
+    # Output Examples:
+    #
+    # https://www.google.com/calendar/render?action=TEMPLATE&dates=20190726T000000Z/20190726T000000Z&sprop=website:http://john-and-marie.craftedtoyou.com&text=John+Dylan+%26+Marie+Skye&location=New+York+City+%40+12%3A00+am&sprop=name:John+Dylan+%26+Marie+Skye&details=Any+notes%2C+descriptions%2C+links%2C+or+reminders+can+be+written+here%21Accomodations%3A+Sudden+Valley+Golf+Resort+%26+Casino%0D%0A%0D%0AGroup+Name%3A+John+Dylan+%26+Marie+Skye+Wedding%0D%0A%0D%0AGroup+Reservation+%23%3A+149602%0D%0A%0D%0ARates%3A+%24149+-+%24179%0D%0A%0D%0ACut-off+date%3A+July+30%2C+2014%0D%0A%0D%0AReservations+line%3A+1.866.555.5555%0D%0A"
+    # https://www.google.com/calendar/render?action=TEMPLATE&dates=20131119T180000/20131119T210000&text=%23VANRUBY+Hack+Night&location=Launch+Academy+(%23300+-+128+West+Hastings+Street,+Vancouver,+BC,+Canada)&details=Vancouver+Ruby+Meetup+Group%0ATuesday,+November+19+at+6:00+PM%0A%0A%23VANRUBY+hack+nights++Every+2+weeks+on+Tuesday+we+get+together+to+hack+on+cool+stuff.+Bring+a+your+laptop+and+hack+away+on+your+favourite+open+source+...%0A%0ADetails:+http://www.meetup.com/vancouver-ruby/events/149547312/&add=chuck.bergeron@gmail.com&ctok=Y2h1Y2suYmVyZ2Vyb25AZ21haWwuY29t&sf=true&output=xml
+    def call
+      attributes = {
+        dates: "#{format_time(@hash[:dtstart])}/#{format_time(@hash[:dtend])}",
+        text:  encode_string(@hash[:summary])
+      }
+
+      attributes.merge!(details:  encode_string(@hash[:description])) unless @hash[:description].blank?
+      attributes.merge!(location: encode_string(@hash[:location]))    unless @hash[:location].blank?
+
+      url = "https://www.google.com/calendar/render?action=TEMPLATE"
+
+      attributes.each do |key, value|
+        url << "&#{key}=#{value}"
+      end
+
+      url
+    end
+
+    private
+
+      def validate!
+        msg =  "- Object must be a Date, DateTime or Time object."
+        raise(ArgumentError, ":dtstart #{msg} #{hash[:dtstart].class} given") unless hash[:dtstart].kind_of? Time
+        raise(ArgumentError, ":dtend #{msg} #{hash[:dtend].class} given") unless hash[:dtend].kind_of? Time
+
+        raise(ArgumentError, ":summary must be a string") unless hash[:summary].kind_of? String
+        raise(ArgumentError, ":summary must not be blank") if hash[:summary].blank?
+      end
+
+      def encode_string(str)
+        CGI.escape(str)
+      end
+
+      def format_time(time)
+        time.utc.strftime('%Y%m%dT%H%M%SZ')
+      end
+
+  end
+
+end

data/lib/add_to_google_cal/version.rb

@@ -0,0 +1,5 @@
+module AddToGoogleCal
+
+  VERSION = "1.0.0"
+
+end

data/spec/lib/add_to_google_cal_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe AddToGoogleCal::Builder do
+
+  let(:default_attributes) {
+    {
+      dtstart: Time.utc(2013, 01, 03, 12, 00),
+      dtend:   Time.utc(2013, 01, 03, 14, 00),
+      summary: 'This is the Title of the Event'
+    }
+  }
+
+  subject { AddToGoogleCal::Builder.new(default_attributes) }
+
+  it "generates the dates" do
+    expect(subject.call).to include("&dates=20130103T120000Z/20130103T140000Z")
+  end
+
+  it 'maps summary to text' do
+    expect(subject.call).to include("&text=This+is+the")
+  end
+
+  it 'supports a location' do
+    subject.hash.merge!(location: "Vancouver, BC")
+
+    subject.call.should include("&location=Vancouver%2C+BC")
+  end
+
+  it 'maps description to details' do
+    subject.hash.merge!(description: "Hey: How@are.you & there!")
+
+    subject.call.should include("&details=Hey%3A+How%40are.you+%26+there%21")
+  end
+
+  it "should raise ArgumentError for a dtstart that is not a date/time" do
+    subject.hash[:dtstart] = ''
+    expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+  end
+
+  it "should raise ArgumentError for a dtend that is not a date/time" do
+    subject.hash[:dtend] = ''
+    expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+  end
+
+  it "should raise ArgumentError for a summary that is not stringify'able or is blank" do
+    subject.hash[:summary] = ''
+    expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+  end
+
+  # AR Implementation
+  describe "has_google_cal" do
+
+    it "builds the add to google cal link" do
+      wedding = Wedding.create(default_attributes)
+      expect(wedding.to_gcal).to include("&dates=20130103T120000Z/20130103T140000Z")
+    end
+
+    it "accepts options" do
+      event = EventNonStandardColumns.create({
+        start_time: Time.utc(2013, 01, 03, 12, 00),
+        end_time:   Time.utc(2013, 01, 03, 14, 00),
+        event_name: 'This is the Title of the Event'
+      })
+      expect(event.to_gcal).to include("&dates=20130103T120000Z/20130103T140000Z")
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'add_to_google_cal'
+
+sqlite_file = File.dirname(__FILE__) + "/support/add_to_google_cal.sqlite3"
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => sqlite_file)
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'
+
+RSpec.configure do |config|
+
+end

data/spec/support/models.rb

@@ -0,0 +1,13 @@
+class Wedding < ActiveRecord::Base
+
+  has_google_cal
+
+end
+
+class EventNonStandardColumns < ActiveRecord::Base
+
+  has_google_cal :summary_field => :event_name,
+                 :dtstart_field => :start_time,
+                 :dtend_field   => :end_time
+
+end

data/spec/support/schema.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Schema.define do
+
+  self.verbose = false
+
+  create_table :weddings, :force => true do |t|
+    t.string :summary
+    t.datetime :dtstart
+    t.datetime :dtend
+
+    t.timestamps
+  end
+
+  create_table :event_non_standard_columns, :force => true do |t|
+    t.string :event_name
+    t.datetime :start_time
+    t.datetime :end_time
+
+    t.timestamps
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: add_to_google_cal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charles Bergeron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A view layer helper which takes an object (such as an ActiveRecord instance
+  from your database) and generates an "Add To Google Calendar" URL based on it's
+  attributes.
+email:
+- hello@charlesbergeron.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- add_to_google_cal.gemspec
+- lib/.DS_Store
+- lib/add_to_google_cal.rb
+- lib/add_to_google_cal/.DS_Store
+- lib/add_to_google_cal/builder.rb
+- lib/add_to_google_cal/version.rb
+- spec/lib/add_to_google_cal_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/chuckbergeron/add_to_google_cal
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Google Calendar anchor href link url helper presenter.
+test_files:
+- spec/lib/add_to_google_cal_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb