calendar-to-queue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6417d2361f6ed7a6269d446c346b5029e74954b6
+  data.tar.gz: cc274e815f1f78c952ae356c068e6ee448906407
+SHA512:
+  metadata.gz: 8a45a8dcf323c41ed08412861695ca5ed446bfc4535870fb3f1db7bf1cbd1ab47b3af81fd77c2054151f8e70315e94df19717ccc63efbf70842a848d1cd1a511
+  data.tar.gz: 7bc24954e52adf11f91a4ef4f7a73b486c0e5936dcb1d1fd168868368a72466307942a0b2c481a08fd2d6016f2143aaef36c3b6297f744241a06acdf73e53b04

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+= 0.0.1
+
+Initial Version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 John Naegle
+
+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.rdoc

@@ -0,0 +1,5 @@
+= CalendarToQueue
+
+Mountable endpoint for Calendar Push Notifications from Google Calenders that
+are placed into AWS Message Queues or a database for consumption.
+

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CalendarToQueue'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/calendar_to_queue/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/calendar_to_queue/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/calendar_to_queue/application_controller.rb

@@ -0,0 +1,9 @@
+module CalendarToQueue
+  class ApplicationController < ActionController::Base
+    # Authentication module must have `authenticate` method
+    include CalendarToQueue.config.admin_auth.to_s.constantize
+
+    # Authorization module must have `authorize` method
+    include CalendarToQueue.config.admin_authorization.to_s.constantize
+  end
+end

data/app/controllers/calendar_to_queue/google_calendar_push_controller.rb

@@ -0,0 +1,28 @@
+require_dependency "calendar_to_queue/application_controller"
+
+module CalendarToQueue
+
+  #
+  # Reciever for push notifications from watched resources in Google Calendar
+  #
+  class GoogleCalendarPushController < ApplicationController
+    def create
+      GoogleCalendarPush.new(create_params).process
+      head :ok
+    end
+
+    # https://developers.google.com/google-apps/calendar/v3/push#understanding-the-notification-message-format
+    def create_params
+      {
+        channel_id:     request.headers['X-Goog-Channel-ID'],
+        message_number: request.headers['X-Goog-Message-Number'],
+        resource_id:    request.headers['X-Goog-Resource-ID'],
+        state:          request.headers['X-Goog-Resource-State'],
+        resource_uri:   request.headers['X-Goog-Resource-URI'],
+        expiration:     request.headers['X-Goog-Channel-Expiration'],
+        token:          request.headers['X-Goog-Channel-Token']
+      }
+    end
+    private :create_params
+  end
+end

data/app/helpers/calendar_to_queue/application_helper.rb

@@ -0,0 +1,4 @@
+module CalendarToQueue
+  module ApplicationHelper
+  end
+end

data/app/models/calendar_to_queue/google_calendar_push.rb

@@ -0,0 +1,59 @@
+module CalendarToQueue
+  class GoogleCalendarPush < ActiveRecord::Base
+    def process
+      if self.token.blank?
+        log("No Token", :warn)
+      else
+        send_to_queue if queue?
+        save if persist?
+      end
+
+      unless queue?
+        log("Token: #{self.token}")
+      end
+    end
+
+    def payload
+      attributes.slice('channel_id', 'message_number', 'resource_id', 'state', 'resource_uri', 'expiration', 'token')
+    end
+
+    def send_to_queue
+      log("Sending to queue")
+      CalendarToQueue::Queue.deliver(self)
+    end
+    private :send_to_queue
+
+    # A-Z, a-z, 0-9, underscore(_), hyphen(-), and period (.). The
+    # name must not start or end with a period, and it should not
+    # have successive periods. The name is case sensitive and must
+    # be unique among all attribute names for the message. The name
+    # can be up to 256 characters long. The name cannot start with
+    # "AWS." or "Amazon." (or any variations in casing) because
+    # these prefixes are reserved for use by Amazon Web Services.
+    def queue_name
+      match_data = (token_hash['queue']||'').match(/^((?!(aws|amazon|\.))[a-z,0-9,_,\-,\.]{1,256})$/i)
+      match_data[0] if match_data
+    end
+
+    def queue?
+      queue_name.present?
+    end
+    private :queue?
+
+    def persist?
+      (token_hash['persist'] || '').match(/^(yes|true|1)$/i)
+    end
+    private :persist?
+
+    def token_hash
+      @token_hash ||= (token ||'').split('&').map {|x| x.split("=") }.to_h
+    end
+
+    def log(msg, level=:info)
+      CalendarToQueue.logger.send(level, "Google Calendar Push: ChannelId: #{self.channel_id}, MessageNumber: #{self.message_number}, ResourceId: #{self.resource_id}, State: #{self.state} - #{msg}")
+    end
+    private :log
+
+  end
+
+end

data/app/models/calendar_to_queue/queue.rb

@@ -0,0 +1,53 @@
+module CalendarToQueue
+  class Queue < ActiveRecord::Base
+
+    def self.deliver(push)
+      unless push.queue_name.blank?
+        queue = lookup(push.queue_name)
+        queue.deliver(push)
+      end
+    end
+
+    def deliver(push)
+      begin
+        CalendarToQueue::Queue.client.send_message({
+          queue_url: url,
+          message_body: JSON.generate(push.payload),
+        })
+      rescue Aws::SQS::Errors::ServiceError => e
+        CalendarToQueue.logger.error("Error sending to queue #{self.name}, push: #{}AWS QUEUE: #{e.context}: #{e.code}")
+      end
+    end
+
+    # Creates or finds
+    def self.lookup(name)
+      find_by_name(name) || create_queue(name)
+    end
+
+    def self.create_queue(name)
+      create(name: name)
+    end
+
+    after_create do
+      begin
+        response = client.create_queue(queue_name: name)
+        self.update_attributes(url: response.queue_url)
+      rescue Aws::SQS::Errors::ServiceError => e
+        CalendarToQueue.logger.error("Error creating AWS QUEUE: #{e.context}: #{e.code}")
+      end
+    end
+
+    def client
+      CalendarToQueue::Queue.client
+    end
+    private :client
+
+    def self.client
+      @@client ||= Aws::SQS::Client.new(
+        region: 'us-east-1',
+        access_key_id:     CalendarToQueue.config.aws_access_key_id,
+        secret_access_key: CalendarToQueue.config.aws_secret_access_key
+      )
+    end
+  end
+end

data/app/views/layouts/calendar_to_queue/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CalendarToQueue</title>
+  <%= stylesheet_link_tag    "calendar_to_queue/application", media: "all" %>
+  <%= javascript_include_tag "calendar_to_queue/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+CalendarToQueue::Engine.routes.draw do
+  resources :google_calendar_push, only: [:create]
+end

data/db/migrate/20160229221448_create_calendar_to_queue_google_calendar_pushes.rb

@@ -0,0 +1,15 @@
+class CreateCalendarToQueueGoogleCalendarPushes < ActiveRecord::Migration
+  def change
+    create_table :calendar_to_queue_google_calendar_pushes do |t|
+      t.string :channel_id
+      t.integer :message_number
+      t.string :resource_id
+      t.string :state
+      t.string :resource_uri
+      t.timestamp :expiration
+      t.string :token
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160229224219_create_calendar_to_queue_queues.rb

@@ -0,0 +1,9 @@
+class CreateCalendarToQueueQueues < ActiveRecord::Migration
+  def change
+    create_table :calendar_to_queue_queues do |t|
+      t.string :name
+      t.string :url
+      t.timestamps null: false
+    end
+  end
+end

data/lib/calendar_to_queue.rb

@@ -0,0 +1,32 @@
+require "calendar_to_queue/engine"
+require_relative 'calendar_to_queue/configuration'
+require_relative 'calendar_to_queue/access_control/admin_authentication'
+require_relative 'calendar_to_queue/access_control/admin_authorization'
+
+module CalendarToQueue
+  class << self
+
+    # Modify CalendarToQueue configuration
+    # Example:
+    #   CalendarToQueue.configure do |config|
+    #   end
+    def configure
+      yield configuration
+    end
+
+    # Accessor for ComfortableMexicanSofa::Configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias :config :configuration
+
+    def logger=(new_logger)
+      @logger = new_logger
+    end
+
+    def logger
+      @logger ||= Rails.logger
+    end
+
+  end
+end

data/lib/calendar_to_queue/access_control/admin_authentication.rb

@@ -0,0 +1,20 @@
+module CalendarToQueue::AccessControl
+  module AdminAuthentication
+    # Set username and password in config/initializers/calendar_2_queue.rb
+    # Like this:
+    #   CalendarToQueue::AccessControl::AdminAuthentication = 'myname'
+    #   CalendarToQueue::AccessControl::AdminAuthentication = 'mypassword'
+
+    mattr_accessor  :username,
+                    :password
+
+    # Simple http_auth. When implementing some other form of authentication
+    # this method should return +true+ if everything is great, or redirect user
+    # to some other page, thus denying access to cms admin section.
+    def authenticate
+      authenticate_or_request_with_http_basic do |username, password|
+        self.username == username && self.password == password
+      end
+    end
+  end
+end

data/lib/calendar_to_queue/access_control/admin_authorization.rb

@@ -0,0 +1,8 @@
+module CalendarToQueue::AccessControl
+  module AdminAuthorization
+    # By default there's no authorization of any kind
+    def authorize
+      true
+    end
+  end
+end

data/lib/calendar_to_queue/configuration.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+class CalendarToQueue::Configuration
+
+  # Module that will handle authentication to access queue-admin area
+  attr_accessor :admin_auth
+
+  # Module that will handle authorization against admin queue resources
+  attr_accessor :admin_authorization
+
+  # AWS access_key for sending pushes to AWS SQS
+  # defaults to ENV['AWS_ACCESS_KEY_ID']
+  attr_accessor :aws_access_key_id
+
+  # AWS secret access key for sending pushes to AWS SQS
+  # defaults to ENV['AWS_SECRET_ACCESS_KEY']
+  attr_accessor :aws_secret_access_key
+
+  # AWS Region
+  #
+  # Note: if you create an Amazon EC2 instance or an Amazon SQS queue in one region, the instance
+  # or queue is independent from instances or queues in another region.
+  #
+  # https://docs.aws.amazon.com/general/latest/gr/rande.html
+  #
+  # defaults to us-east-1
+  attr_accessor :aws_region
+
+  # Configuration defaults
+  def initialize
+    @admin_auth            = 'CalendarToQueue::AccessControl::AdminAuthentication'
+    @admin_authorization   = 'CalendarToQueue::AccessControl::AdminAuthorization'
+    @aws_access_key_id     = ENV['AWS_ACCESS_KEY_ID']
+    @aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    @aws_region            = 'us-east-1'
+  end
+
+end

data/lib/calendar_to_queue/engine.rb

@@ -0,0 +1,5 @@
+module CalendarToQueue
+  class Engine < ::Rails::Engine
+    isolate_namespace CalendarToQueue
+  end
+end

data/lib/calendar_to_queue/version.rb

@@ -0,0 +1,3 @@
+module CalendarToQueue
+  VERSION = "0.0.1"
+end

data/lib/tasks/calendar_to_queue_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :calendar_to_queue do
+#   # Task goes here
+# end

data/test/calendar_to_queue_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CalendarToQueueTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, CalendarToQueue
+  end
+end