capistrano-calendar 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+.credentials.yml
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.8.7

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'json', '1.6.1'
+gem 'gdata', '1.1.2'
+gem 'daemons', '1.1.4'
+
+
+gem 'rspec', '2.6.0'

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    capistrano-calendar (0.0.1)
+      capistrano (>= 2.5.5)
+      gdata (>= 1.1.0)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (2.9.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    daemons (1.1.4)
+    diff-lcs (1.1.2)
+    gdata (1.1.2)
+    highline (1.6.2)
+    json (1.6.1)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.2.1)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-calendar!
+  daemons (= 1.1.4)
+  gdata (= 1.1.2)
+  json (= 1.6.1)
+  rspec (= 2.6.0)

data/README.md

@@ -0,0 +1,91 @@
+# Capistrano Calendar
+
+## Introduction
+
+capistrano-calendar is extension for capistrano that allows your create different deployment notification in calendar service. Currently supported services:
+
+* google calendar
+
+## Installation
+
+    gem install capistrano-calendar
+
+Add to your Capfile
+
+    require 'capistrano/calendar/recipes'
+
+## How it works
+
+This gem provides:
+
+* capistrano recipe *calendar:create_event* 
+* ruby binary script *capistrano-calendar*
+
+Capistrano recipe should be used in some :after hooks (e.g. after deploy). Recipe reads calendar configurations and run capistrano-calendar binary on some host specified in *capistrano_runner* option. So you **need to install** *capistrano-calendar* gem also on that calendar host. Also please ensure that you properly configured calendar_runner otherwise you may have **duplicated events** in calender.
+
+## Calendar configuration
+
+* *:calendar_service* (:google) - calendar service to use e.g. ':google'
+* **:calendar_username** (nil) - calendar service username e.g 'vasya.pupkin@gmail.com'
+* **:calendar_password** (nil) - calendar service password e.g 'qwery123456'
+* *:calendar_name* (default) - calendar name to use for events
+* *:calendar_summary* (nil) - calendar summary for new calendar
+* *:calendar_location* (nil) - calendar location for new calendar
+* *:calendar_timezone* ('UTC') - calendar timezone for new calendar
+* *:calendar_color* ('#A32929') - calendar color for new calendar
+* **:calendar_event_name** (nil) - calendar event name
+* *:calendar_event_summary* (nil) - calendar event summary
+* *:calendar_event_location* (nil) - calendar event location
+* *:calendar_event_time* (Time.now) - calendar event time
+* *:calendar_event_status* ('confirmed') - calendar event status
+
+Bold means required options. Value in brackets means default value.
+
+## Calendar runner configuration
+
+Calendar event creation will be executed by default on the one of application servers (specified in :app roles)
+You can change this behavior via *calendar_runner* option. Examples:
+
+    set(:calendar_runner, { :roles => :calendar_notifier, :once => true )
+    # or
+    set(:calendar_runner, { :hosts => 'notification.example.com' })
+
+Be sure to pass `:once => true` option if you use *:roles* !
+
+## Configuration example
+
+    set :calendar_service, :google
+    set :calendar_username, 'vasya.pupkin@my.company.com'
+    set :calendar_password, '123456'
+
+    set :calendar_name      { stage }
+    set :calendar_summary   { "" }
+    set :calendar_timezone, 'UTC'
+    set :calendar_color,    { stage == 'production' ? '#ff000' : '#00ff00' }
+
+    set :calendar_event_summary { "Bla" }
+    set :calendar_event_time { Time.now }
+
+    after 'deploy' do
+      set :calendar_event_title "[Deployed] #{application} #{branch}: #{real_revision}"
+      top.calendar.create_event
+    end
+
+    after 'deploy:rollback' do
+      set :calendar_event_title "[Rollback] #{application} #{branch}: #{real_revision}"
+      top.calendar.create_event
+    end
+
+    #
+    # Extra configurations if you are using capistrano-patch:
+    #
+    after 'patch:apply' do
+      set :calendar_event_title "[Pathed] #{application} #{branch}: #{patch_strategy.revision_to}"
+      calendar_client.create_event
+    end
+
+    after 'patch:revert' do
+      set :calendar_event_title "[Patch rollback] #{application} #{branch}: #{patch_strategy.revision_from}"
+      top.calendar.create_event
+    end
+

data/Rakefile

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

data/bin/capistrano-calendar

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'capistrano/calendar'
+
+Capistrano::Calendar::Runner.new(ARGV).run!

data/capistrano-calendar.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "capistrano/calendar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-calendar"
+  s.version     = Capistrano::Calendar::VERSION
+  s.authors     = ["Andriy Yanko"]
+  s.email       = ["andriy.yanko@gmail.com"]
+  s.homepage    = "https://github.com/railsware/capistrano-calendar/"
+  s.summary     = %q{Deployment event creation on (google) calendar service}
+
+  s.rubyforge_project = "capistrano-calendar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "capistrano", ">=2.5.5"
+  s.add_runtime_dependency "gdata",      ">=1.1.0"
+  s.add_runtime_dependency "json"
+end

data/lib/capistrano/calendar.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module Calendar
+    autoload :Client,         'capistrano/calendar/client'
+    autoload :Configuration,  'capistrano/calendar/configuration'
+    autoload :Runner,         'capistrano/calendar/runner'
+  end
+end

data/lib/capistrano/calendar/client.rb

@@ -0,0 +1,20 @@
+require 'capistrano/errors'
+
+module Capistrano
+  module Calendar
+    module Client
+      def self.new(config)
+        name = config[:calendar_service] || :google
+
+        require "capistrano/calendar/client/#{name}"
+
+        client_const = name.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+
+        const_get(client_const).new(config)
+
+      rescue LoadError
+        raise Capistrano::Error, "could not find any client named '#{name}'"
+      end
+    end
+  end
+end

data/lib/capistrano/calendar/client/base.rb

@@ -0,0 +1,31 @@
+module Capistrano
+  module Calendar
+    module Client
+      class Base
+        def initialize(config)
+          @configuration = config
+        end
+
+        attr_reader :configuration
+
+        def calendar_username
+          configuration.fetch(:calendar_username)
+        end
+
+        def calendar_password
+          configuration.fetch(:calendar_password)
+        end
+
+        def authenticate
+          raise NotImplementedError, "`authenticate' is not implemented by #{self.class.name}"
+        end
+
+        def create_event
+          raise NotImplementedError, "`create_event' is not implemented by #{self.class.name}"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/capistrano/calendar/client/google.rb

@@ -0,0 +1,105 @@
+require 'capistrano/calendar/client/base'
+
+require 'gdata'
+require 'json'
+require 'time'
+
+module Capistrano
+  module Calendar
+    module Client
+      class Google < Base
+
+        #
+        # http://code.google.com/apis/calendar/data/2.0/developers_guide_protocol.html
+        #
+
+        OWN_CALENDARS_URL   = "https://www.google.com/calendar/feeds/default/owncalendars/full"
+        CALENDAR_EVENTS_URL = "https://www.google.com/calendar/feeds/default/private/full"
+
+        def authenticate
+          client.clientlogin(calendar_username, calendar_password)
+        end
+
+        def create_event
+          response = client.post(events_url, json_event_entity)
+          JSON.parse(response.body)['data']
+        end
+
+        def events_url
+          if configuration[:calendar_name]
+            calendar = find_or_create_calendar(configuration[:calendar_name])
+            calendar['eventFeedLink']
+          else
+            CALENDAR_EVENTS_URL
+          end
+        end
+
+        def find_or_create_calendar(calendar_name)
+          find_calendar(calendar_name) || create_calendar(calendar_name)
+        end
+
+        def find_calendar(calendar_name)
+          response = client.get(OWN_CALENDARS_URL + '?alt=jsonc')
+          JSON.parse(response.body)['data']['items'].find { |item|
+            item['title'] == calendar_name
+          }
+        end
+
+        def create_calendar(calendar_name)
+          response = client.post(OWN_CALENDARS_URL, json_calendar_entity)
+          JSON.parse(response.body)['data']
+        end
+
+        def delete_calendar(calendar)
+          calendar.is_a?(Hash) or calendar = find_calendar(calendar)
+          calendar or raise Capistrano::Error, "Calendar #{calendar.inspect} not found"
+          client.delete(calendar['selfLink'])
+        end
+
+        protected
+
+        def client
+          @client ||= GData::Client::Calendar.new({
+            :headers => { 'Content-Type' => 'application/json' },
+            :source  => 'capistrano-calendar'
+          })
+        end
+
+        def json_calendar_entity
+          data = {
+            'title'    => configuration.fetch(:calendar_name),
+            'timeZone' => configuration.fetch(:calendar_timezone, 'UTC'),
+            'color'    => configuration.fetch(:calendar_color, '#A32929'),
+            'hidden'   => false
+          }
+
+          value = configuration[:calendar_summary]  and data['details'] = value
+          value = configuration[:calendar_location] and data['location'] = value
+          
+          { 'data' => data }.to_json
+        end
+
+        def json_event_entity
+          event_time = configuration.fetch(:calendar_event_time, Time.now).utc.xmlschema
+
+          data = {
+            'title'    => configuration.fetch(:calendar_event_name),
+            'status'   => configuration.fetch(:calendar_event_status, 'confirmed'),
+            'when'     => [
+              {
+                'start' => event_time,
+                'stop'  => event_time
+              }
+            ]
+          }
+
+          value = configuration[:calendar_event_summary]  and data['details'] = value
+          value = configuration[:calendar_event_location] and data['location'] = value
+
+          { 'data' => data }.to_json
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/calendar/configuration.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+require 'base64'
+
+module Capistrano
+  module Calendar
+    class Configuration
+
+      def self.collect(hash)
+        [
+          :calendar_service,
+          :calendar_username,
+          :calendar_password,
+
+          :calendar_name,
+          :calendar_summary,
+          :calendar_location,
+          :calendar_timezone,
+          :calendar_color,
+
+          :calendar_event_name,
+          :calendar_event_summary,
+          :calendar_event_location,
+          :calendar_event_time,
+          :calendar_event_status
+        ].inject({}) { |result, key|
+          result[key] = hash[key] if hash.exists?(key)
+          result
+        }
+      end
+
+      def self.encode(hash)
+        Base64.encode64(hash.to_yaml).gsub("\n", '')
+      end
+
+      def self.decode(string)
+        YAML.load(Base64.decode64(string))
+      end
+
+    end
+  end
+end

data/lib/capistrano/calendar/recipes.rb

@@ -0,0 +1,22 @@
+require 'capistrano/calendar'
+
+Capistrano::Configuration.instance.load do
+
+  set(:calendar_runner) do
+    {
+      :roles => :app,
+      :once  => true
+    }
+  end
+
+  namespace :calendar do
+    desc "Create calendar event"
+    task :create_event do
+      configuration = Capistrano::Calendar::Configuration.collect(self)
+      string = Capistrano::Calendar::Configuration.encode(configuration)
+
+      run("capistrano-calendar create_event #{string}", calendar_runner)
+    end
+
+  end
+end

data/lib/capistrano/calendar/runner.rb

@@ -0,0 +1,88 @@
+require 'optparse'
+
+module Capistrano
+  module Calendar
+    class Runner
+      def self.run(*args)
+        new(*args).run!
+      end
+
+      def initialize(argv)
+        @argv = argv
+      end
+
+      attr_reader :client
+
+      def run!
+        parser = OptionParser.new do |o|
+          o.banner = "Usage: capistrano-calendar [options] COMMAND [CONFIGURATION_DATA]"
+          o.separator ""
+          o.separator "Commands:"
+          o.separator ""
+          o.separator "  create_event - create calendar event"
+          o.separator ""
+          o.separator "CONFIGURATION_DATA is base64 encoded yaml data" 
+          o.separator ""
+          o.separator "Common options:"
+          o.on_tail("-h", "--help", "Show this message") { puts o; exit }
+          o.on_tail('-v', '--version', "Show version")   { puts Capistrano::Calendar::VERSION; exit }
+        end
+        
+        parser.parse!(@argv)
+
+        @command       = @argv.shift
+        @configuration = @argv.shift
+
+        case @command
+        when 'create_event'
+          @configuration or abort(parser.help)
+          @configuration = Capistrano::Calendar::Configuration.decode(@configuration)
+          @configuration.is_a?(Hash) or abort("Bad configuration given")
+
+          @client = Capistrano::Calendar::Client.new(@configuration)
+      
+          daemonize { create_event }
+        else
+          abort parser.help
+        end
+
+      end
+
+      protected
+
+      def create_event
+        client.authenticate
+        client.create_event
+      end
+
+      def daemonize
+        Process.fork do
+          # Detach the child process from the parent's session.
+          Process.setsid
+
+          # Re-fork. This is recommended for System V-based
+          # system as it guarantees that the daemon is not a
+          # session leader, which prevents it from aquiring
+          # a controlling terminal under the System V rules.
+          exit if fork
+
+          # Rename the process
+          $0 = "capistrano-calendar"
+
+          # Flush all buffers
+          $stdout.sync = $stderr.sync = true
+
+          # Set all standard files to `/dev/null/` in order
+          # to be sure that any output from the daemon will
+          # not appear in any terminals.
+          $stdin.reopen("/dev/null")
+          $stdout.reopen("/tmp/capistrano-calendar.stdout")
+          $stderr.reopen("/tmp/capistrano-calendar.stderr")
+
+          yield
+        end
+      end
+
+    end
+  end
+end

data/lib/capistrano/calendar/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Calendar
+    VERSION = "0.0.1"
+  end
+end

data/spec/google_calendar_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Capistrano::Calendar::Client, "#create_event for google calendar" do
+
+  let(:configuration) do
+    {
+      :calendar_service    => :google,
+      :calendar_username   => Helper.credentials[:google][:username],
+      :calendar_password   => Helper.credentials[:google][:password],
+      :calendar_name       => "Capistrano Calendar",
+      :calendar_event_name => 'Test Deploy!'
+    }
+  end
+
+  let(:client) {
+    client = Capistrano::Calendar::Client.new(configuration)
+    client.authenticate
+    client
+  }
+
+  before(:each) do
+    sleep(1)
+    configuration[:calendar_name] << " #{Time.now.to_f}"
+  end
+
+  it "should create calendar and event" do
+    event = client.create_event
+
+    event.should be_kind_of(Hash)
+    event['title'].should == configuration[:calendar_event_name]
+
+    calendar = client.find_calendar(configuration[:calendar_name])
+    calendar.should be_kind_of(Hash)
+    calendar['title'].should == configuration[:calendar_name]
+    calendar['timeZone'].should == 'UTC'
+  end
+
+  context "when calendar exists" do
+    before(:each) do
+      @calendar = client.create_calendar(configuration[:calendar_name])
+    end
+
+    it "should create event and does NOT create another calendar" do
+      event = client.create_event
+
+      event.should be_kind_of(Hash)
+      event['title'].should == configuration[:calendar_event_name]
+
+      calendar = client.find_calendar(configuration[:calendar_name])
+      calendar.should be_kind_of(Hash)
+      calendar['id'].should == @calendar['id']
+    end
+  end
+
+  context "when calendar_name is nil" do
+    before(:each) do
+      configuration.delete(:calendar_name)
+    end
+
+    it "should create event in default calendar" do
+      event = client.create_event
+
+      event.should be_kind_of(Hash)
+      event['title'].should == configuration[:calendar_event_name]
+      event['selfLink'].should include(Capistrano::Calendar::Client::Google::CALENDAR_EVENTS_URL)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'capistrano'
+require 'capistrano/calendar/client'
+
+require 'yaml'
+
+module Helper
+  def self.load_credentials!
+    @credentials = YAML.load_file('.credentials.yml')
+  rescue  Errno::ENOENT => e
+    puts "Put your credentials into '.credentials.yml'. Example:"
+    puts({ 
+      :google => {
+        :username => 'vasya.pukin@gmail.com',
+        :password => '123456'
+      }
+    }.to_yaml)
+
+    exit(1)
+  end
+
+  def self.credentials
+    @credentials
+  end
+end
+
+Helper.load_credentials!

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-calendar
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andriy Yanko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 5
+        - 5
+        version: 2.5.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gdata
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: 
+- andriy.yanko@gmail.com
+executables: 
+- capistrano-calendar
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/capistrano-calendar
+- capistrano-calendar.gemspec
+- lib/capistrano/calendar.rb
+- lib/capistrano/calendar/client.rb
+- lib/capistrano/calendar/client/base.rb
+- lib/capistrano/calendar/client/google.rb
+- lib/capistrano/calendar/configuration.rb
+- lib/capistrano/calendar/recipes.rb
+- lib/capistrano/calendar/runner.rb
+- lib/capistrano/calendar/version.rb
+- spec/google_calendar_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/railsware/capistrano-calendar/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: capistrano-calendar
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Deployment event creation on (google) calendar service
+test_files: 
+- spec/google_calendar_spec.rb
+- spec/spec_helper.rb