almanack 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ee646213641a7f73f5cd5d2164c92930875b58d
+  data.tar.gz: 474257e5d3e93edd1a5c4b5b4125129c7c645ba2
+SHA512:
+  metadata.gz: caf49861afbd6bd62c5147da62425ed06b822a65ed4e5d543062b2a27e9ae67d9f53e4a88a8235ae590a4554c98475016b83ab9cc8237ac2194c03063d859bc5
+  data.tar.gz: 6d5458aa700b1c152caa5a31f2294a766e0a6ca6ab3eeb673bf4be9213aa806c9982663bc3c8088999130d08d637fccd8690abc7b445a7d8893ce6d1b68fb327

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.1.1
+addons:
+  code_climate:
+    repo_token:
+      secure: "VmXcnoFkthPYiEdyMTgqopGNUirpoZ3/wRych2xm+k8g9yW3IVbnEsK0lLg7InlyUhM3r7IxC4NBTRa33MhkpuCtvQGFpUjt56lhDvLcb0OBLOnpReKpo8VWW/cy0okpiW8LNt488M67WH+Wnlx//Fpkop9/HNM1vTLjysISk/Q="

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Nicholls
+
+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,37 @@
+# Almanack
+
+[![Build Status](https://travis-ci.org/Aupajo/sinatra-gcal.svg)](https://travis-ci.org/Aupajo/sinatra-gcal)
+[![Code Climate](https://codeclimate.com/github/Aupajo/sinatra-gcal.png)](https://codeclimate.com/github/Aupajo/sinatra-gcal)
+[![Code Climate](https://codeclimate.com/github/Aupajo/sinatra-gcal/coverage.png)](https://codeclimate.com/github/Aupajo/sinatra-gcal)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'almanack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install almanack
+
+## Usage
+
+TODO: Write usage instructions here
+
+### Meetup.com
+
+You'll need your [Meetup.com API key](https://secure.meetup.com/meetup_api/key).
+
+## Contributing
+
+1. Fork it ( http://github.com/Aupajo/sinatra-gcal/fork )
+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

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc 'Run a dummy server'
+task :server do
+  require "almanack"
+
+  today = DateTime.now
+
+  Almanack.config.add_events [
+    { title: "Hogswatch", start_date: today },
+    { title: "Soul Cake Tuesday", start_date: today + 10 },
+    { title: "Eve of Small Gods", start_date: today + 30 },
+  ]
+
+  Rack::Handler::WEBrick.run(Almanack::Server)
+end

data/almanac.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'almanack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "almanack"
+  spec.version       = Almanack::VERSION
+  spec.authors       = ["Pete Nicholls"]
+  spec.email         = ["pete@metanation.com"]
+  spec.summary       = %q{Combined events calendar for Google Calendar, iCal, Meetup.com and friends.}
+  spec.homepage      = "https://github.com/Aupajo/sinatra-gcal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "sinatra"
+  spec.add_dependency "ri_cal"
+  spec.add_dependency "addressable"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/almanack/calendar.rb

@@ -0,0 +1,21 @@
+module Almanack
+  class Calendar
+    def initialize(config)
+      @config = config
+    end
+
+    def event_sources
+      @config.event_sources
+    end
+
+    def events  
+      days_lookahead = 30
+      from_date = DateTime.now
+      to_date = DateTime.now + days_lookahead
+      
+      event_sources.map do |event_source|
+        event_source.events_between(from_date..to_date)
+      end.flatten.sort_by(&:start_date)
+    end
+  end
+end

data/lib/almanack/configuration.rb

@@ -0,0 +1,29 @@
+require 'net/http'
+require 'uri'
+require 'ri_cal'
+
+module Almanack
+  class Configuration
+    attr_reader :event_sources
+
+    def initialize
+      reset!
+    end
+
+    def reset!
+      @event_sources = []
+    end
+
+    def add_ical_feed(url)
+      @event_sources << IcalFeed.new(url)
+    end
+
+    def add_events(events)
+      @event_sources << SimpleEventCollection.new(events)
+    end
+
+    def add_meetup_group(options)
+      @event_sources << MeetupGroup.new(options)
+    end
+  end
+end

data/lib/almanack/event.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module Almanack
+  class Event < OpenStruct
+  end
+end

data/lib/almanack/ical_feed.rb

@@ -0,0 +1,60 @@
+require 'net/http'
+require 'uri'
+require 'ri_cal'
+
+module Almanack
+  class IcalFeed
+    def initialize(url)
+      @url = url
+    end
+
+    def events_between(date_range)
+      occurrences_between(date_range).map do |occurrence|
+        event_from(occurrence)
+      end
+    end
+
+    private
+
+    def each_ical_event(&block)
+      entities.each do |entity|
+        entity.events.each(&block) if entity.respond_to?(:events)
+      end
+    end
+
+    def occurrences_between(date_range)
+      to_date = date_range.max
+      from_date = date_range.min
+
+      occurrences = []
+
+      each_ical_event do |ical_event|
+        ical_event.occurrences(starting: from_date, before: to_date).each do |occurrence|
+          occurrences << occurrence
+        end
+      end
+
+      occurrences
+    end
+
+    def event_from(occurrence)
+      Event.new(
+        title: occurrence.summary,
+        start_date: occurrence.dtstart,
+        end_date: occurrence.dtend,
+        description: occurrence.description,
+        location: occurrence.location
+      )
+    end
+
+    def entities
+      RiCal.parse_string(body)
+    end
+
+    def body
+      uri = URI(@url)
+      Net::HTTP.get(uri)
+    end
+
+  end
+end

data/lib/almanack/meetup_group.rb

@@ -0,0 +1,96 @@
+require 'net/http'
+require 'json'
+require 'addressable/uri'
+
+module Almanack
+  class MeetupGroup
+    def initialize(options = {})
+      @request_options = options
+    end
+
+    def events_between(date_range)
+      events.select do |event|
+        event.start_date >= date_range.min && event.start_date <= date_range.max
+      end
+    end
+
+    private
+
+    def events
+      request = MeetupAPIRequest.new(@request_options)
+      request.results.map { |result| event_from(result) }
+    end
+
+    def event_from(result)
+      # 3 hours, as recommended by Meetup.com if duration isn't present
+      default_duration_in_ms = 3 * 60 * 60 * 1000
+      
+      event_name = [result['group']['name'], result['name']].compact.join(': ')
+      start_time = Time.at(result['time'] / 1000)
+      duration_in_secs = (result['duration'] || default_duration_in_ms) / 1000
+      end_time = start_time + duration_in_secs
+      
+      Event.new(
+        title: event_name,
+        start_date: start_time.to_datetime,
+        end_date: end_time.to_datetime,
+        description: result['description'],
+        location: location_from_venue(result['venue']),
+        url: result['event_url']
+      )
+    end
+
+    def location_from_venue(venue)
+      %w{ name address_1 address_2 address_3 city state country }.map do |attr|
+        venue[attr]
+      end.compact.join(', ')
+    end
+  end
+
+  class MeetupAPIError < StandardError
+  end
+
+  class MeetupAPIException < Exception
+  end
+
+  class MeetupAPIRequest
+    REQUIRED_OPTIONS = [:group_domain, :group_urlname, :group_id]
+
+    attr_accessor :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def results
+      response['results']
+    end
+
+    def uri
+      if !options.has_key?(:key)
+        raise MeetupAPIException, 'Cannot form valid URI, missing :key option'
+      end
+
+      if (options.keys & REQUIRED_OPTIONS).empty?
+        raise MeetupAPIException, "Cannot form valid URI, missing one of: #{REQUIRED_OPTIONS}"
+      end
+
+      endpoint = "https://api.meetup.com/2/events"
+
+      Addressable::URI.parse(endpoint).tap do |uri|
+        uri.query_values = options
+      end
+    end
+
+    def response
+      json = Net::HTTP.get(uri)
+      data = JSON.parse(json)
+      
+      if data['problem']
+        raise MeetupAPIError, data['problem']
+      end
+
+      data
+    end
+  end
+end

data/lib/almanack/server.rb

@@ -0,0 +1,13 @@
+require "sinatra"
+
+module Almanack
+  class Server < Sinatra::Base
+    set :theme, 'origami'
+    set :root, Pathname(settings.root).join('themes', settings.theme)
+
+    get "/" do
+      @calendar = Almanack.calendar
+      erb :events
+    end
+  end
+end

data/lib/almanack/simple_event_collection.rb

@@ -0,0 +1,11 @@
+module Almanack
+  class SimpleEventCollection
+    def initialize(events)
+      @events = events
+    end
+
+    def events_between(date_range)
+      @events.map { |attrs| Event.new(attrs) }
+    end
+  end
+end

data/lib/almanack/themes/origami/public/stylesheets/origami.css

@@ -0,0 +1,4 @@
+body {
+  font: 14pt/1.6em "Helvetica Neue", sans-serif;
+  font-weight: 300;
+}

data/lib/almanack/themes/origami/views/events.erb

@@ -0,0 +1,8 @@
+<div class="events">
+  <% @calendar.events.each do |event| %>
+    <div class="event">
+      <h2 class="title"><%= event.title %></h2>
+      (<%= event.start_date %>)
+    </div>
+  <% end %>
+</div>

data/lib/almanack/themes/origami/views/layout.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Upcoming events</title>
+    <link rel="stylesheet" type="text/css" href="/stylesheets/origami.css">
+  </head>
+  <body>
+
+    <%= yield %>
+
+  </body>
+</html>

data/lib/almanack/version.rb

@@ -0,0 +1,3 @@
+module Almanack
+  VERSION = "0.0.1.alpha1"
+end

data/lib/almanack.rb

@@ -0,0 +1,23 @@
+require "pathname"
+require "almanack/version"
+require "almanack/server"
+require "almanack/configuration"
+require "almanack/calendar"
+require "almanack/simple_event_collection"
+require "almanack/meetup_group"
+require "almanack/ical_feed"
+require "almanack/event"
+
+module Almanack
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.calendar
+    @calendar ||= Calendar.new(config)
+  end
+
+  def self.reset!
+    config.reset!
+  end
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Almanack
+  describe Calendar do
+    
+    describe "#events" do
+      describe "with simple events" do
+        it "returns the events" do
+          config = Configuration.new
+          config.add_events [
+            { title: "Hogswatch" }
+          ]
+
+          calendar = Calendar.new(config)
+
+          expect(calendar.events.size).to eq(1)
+          expect(calendar.events.first.title).to eq('Hogswatch')
+        end
+      end
+
+      describe "with an iCal feed" do
+        it "returns the event occurrences" do
+          config = Configuration.new
+          config.add_ical_feed "https://www.google.com/calendar/ical/61s2re9bfk01abmla4d17tojuo%40group.calendar.google.com/public/basic.ics"
+
+          calendar = Calendar.new(config)
+
+          events = nil
+
+          Timecop.freeze(2014, 4, 3) do
+            VCR.use_cassette('google_calendar') do
+              events = calendar.events
+            end
+          end
+
+          expect(events.size).to eq(15)
+          expect(events).to all_have_properties(:title, :start_date)
+          expect(events).to be_in_order
+        end
+      end
+    end
+
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module Almanack
+  describe Configuration do
+
+    describe "#add_events" do
+      it "adds a simple event collection event source" do
+        config = Configuration.new
+        expect(config.event_sources.size).to eq(0)
+
+        config.add_events [
+          { title: "Hogswatch" }
+        ]
+
+        expect(config.event_sources.size).to eq(1)
+        expect(config.event_sources.first).to be_an_instance_of(SimpleEventCollection)
+      end
+    end
+
+    describe "#ical_feed" do
+      it "adds an iCal feed event source" do
+        config = Configuration.new
+        expect(config.event_sources.size).to eq(0)
+
+        config.add_ical_feed "https://www.google.com/calendar/ical/61s2re9bfk01abmla4d17tojuo%40group.calendar.google.com/public/basic.ics"
+        
+        expect(config.event_sources.size).to eq(1)
+        expect(config.event_sources.first).to be_an_instance_of(IcalFeed)
+      end
+    end
+
+    describe "#meetup_group" do
+      it "adds a Meetup group event source" do
+        config = Configuration.new
+        expect(config.event_sources.size).to eq(0)
+
+        config.add_meetup_group(group_urlname: "CHC-JS", key: "secrettoken")
+        
+        expect(config.event_sources.size).to eq(1)
+        expect(config.event_sources.first).to be_an_instance_of(MeetupGroup)
+      end
+    end
+
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Almanack
+  describe Event do
+
+    it "has a title" do
+      event = Event.new(title: "Music with rocks in")
+      expect(event.title).to eq("Music with rocks in")
+    end
+
+    it "has a start date" do
+      event = Event.new(start_date: DateTime.new(2014, 01, 01))
+      expect(event.start_date).to eq(DateTime.new(2014, 01, 01))
+    end
+
+    it "has a end date" do
+      event = Event.new(end_date: DateTime.new(2014, 01, 02))
+      expect(event.end_date).to eq(DateTime.new(2014, 01, 02))
+    end
+
+    it "has a location" do
+      event = Event.new(location: "Street of Cunning Artificers")
+      expect(event.location).to eq("Street of Cunning Artificers")
+    end
+
+    it "has a description" do
+      event = Event.new(description: "Be there or be a rectangular thynge.")
+      expect(event.description).to eq("Be there or be a rectangular thynge.")
+    end
+
+  end
+end

data/spec/features/calendar_feature_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "Viewing a calendar", :feature do
+  before { Almanack.reset! }
+
+  it "displays all upcoming events" do
+    Almanack.config.add_events [
+      { title: "Hogswatch" },
+      { title: "Soul Cake Tuesday" },
+      { title: "Eve of Small Gods" },
+    ]
+
+    get "/"
+
+    expect(last_response).to have_event_on_page("Hogswatch")
+    expect(last_response).to have_event_on_page("Soul Cake Tuesday")
+    expect(last_response).to have_event_on_page("Eve of Small Gods")
+  end
+
+  it "displays events from an iCal feed" do
+    Almanack.config.add_ical_feed "https://www.google.com/calendar/ical/61s2re9bfk01abmla4d17tojuo%40group.calendar.google.com/public/basic.ics"
+    
+    Timecop.freeze(2014, 4, 3) do
+      VCR.use_cassette('google_calendar') do
+        get "/"
+      end
+    end
+
+    expect(last_response).to have_event_on_page("Ruby Meetup @catalyst - Tanks! Guns!")
+    expect(last_response).to have_event_on_page("The Foundation")
+    expect(last_response).to have_event_on_page("WikiHouse/NZ weekly meet-up")
+    expect(last_response).to have_event_on_page("Christchurch Python Meetup")
+    expect(last_response).to have_event_on_page("Coffee & Jam")
+  end
+end