holiday_list 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4897c6155de7143716fe7b0d4d6745fe3c8aef5
+  data.tar.gz: e4664e1f521f868dda8ad81a9b5bf319a8c4e649
+SHA512:
+  metadata.gz: 11209b133401cb0ec369a83500ea0cb44bca517f307082bf8092afcbb93dcf9ca71b98127f0a8117a14d036f1999d5366100a7e8b0e2e0175b709031391ee361
+  data.tar.gz: b7f35acc8298d84e5d57043f48d66d0028361a7f273902de7ba18ee7fcb0d2d2f77c8cb4cbc60becc78d4b522531806da9e1251f0164e3aeda00bd54cca7392c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-head
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Hicks
+
+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,46 @@
+# Holiday::List
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'holiday_list'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install holiday_list
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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
+
+## Todo
+
+- initializer
+- Travis ci build
+- Code complete
+- Test coverage
+- rename?
+- clean up readme
+- ~~replace httparty with faraday~~
+
+### Its nice to want things
+
+- connect to more google public calendars
+- connect to private google calendars
+- connect to non google calendars
+- store data in redis

data/Rakefile

@@ -0,0 +1,47 @@
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "dotenv"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test    => :spec
+
+desc 'Launch irb with holiday_list required'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'holiday_list'
+  ARGV.clear
+  IRB.start
+end
+
+namespace :spec do
+  desc 'Run RSpec, re-recording VCR cassettes'
+  task :rerecord do
+    Dotenv.load
+
+    ENV['RERECORD'] = 'true'
+    Rake::Task['spec'].execute
+    Rake::Task['spec:scrub'].execute
+  end
+
+  desc 'Scrub access key tokens'
+  task :scrub do
+    Dotenv.load
+
+    FileList.new('spec/vcr/cassettes/*.yml').each do |file|
+      next unless key = ENV['GOOGLE_ACCESS_KEY']
+
+      modified_file = File.open(file).read.gsub(/#{key}/, 'A_GOOD_KEY')
+
+      File.open(file, 'w') do |out|
+        out << modified_file
+      end
+    end
+  end
+end
+
+# TODO: add git pre-commit hook to prevent users from checking in
+# GOOGLE_ACCESS_KEY in VCR cassettes

data/holiday_list.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'holiday_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "holiday_list"
+  spec.version       = HolidayList::VERSION
+  spec.authors       = ["Ben Hicks"]
+  spec.email         = ["benkhicks@gmail.com"]
+  spec.description   = %q{HolidayList}
+  spec.summary       = %q{Connects to google calendar and retrieves holidays}
+  spec.homepage      = ""
+  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_runtime_dependency "faraday"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", "~> 1.15.0"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry"
+end

data/lib/holiday_list.rb

@@ -0,0 +1,61 @@
+require 'holiday_list/version'
+require 'holiday_list/configuration'
+require 'holiday_list/google_calendar_request_string'
+require 'holiday_list/request_exception'
+require 'faraday'
+require 'json'
+
+# MyList:
+# Used to generate a list of upcoming holidays
+class HolidayList
+  include RequestException
+
+  def self.list
+    new.to_a
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def initialize
+    @request_string = GoogleCalendarRequestString.new self.class.configuration
+  end
+
+  def to_a
+    argument_error! if invalid_request?
+
+    json_response['items'].map do |item|
+      {
+        summary:    item['summary'],
+        start_date: Date.parse(item['start']['date']),
+        etag:       item['etag']
+      }
+    end
+  end
+
+  private
+
+  # TODO: methods below are only used in #to_a, and are prime candidates for an extract class refactoring
+  def invalid_request?
+    return false unless response_error
+    response_error['code'] == 400
+  end
+
+  def response
+    conn = Faraday.new url: GoogleCalendarRequestString.url_base
+    conn.get @request_string.to_s
+  end
+
+  def json_response
+    @json_response ||= JSON.parse(response.body)
+  end
+
+  def response_error
+    json_response['error']
+  end
+end

data/lib/holiday_list/configuration.rb

@@ -0,0 +1,11 @@
+class HolidayList
+  # Configuration:
+  # Used to persist access token configurations
+  class Configuration
+    attr_accessor :id, :key
+
+    def configured?
+      !id.nil? && !key.nil?
+    end
+  end
+end

data/lib/holiday_list/google_calendar_request_string.rb

@@ -0,0 +1,39 @@
+require 'holiday_list/params'
+require 'holiday_list/request_exception'
+
+class HolidayList
+  # GoogleCalendarRequestString:
+  # Generates the google calendar api request string
+  class GoogleCalendarRequestString
+    include RequestException
+
+    # TODO: address these items:
+    # - make class more extensible
+    # - rename class, redundat String, and is it really a 'Request'?
+    # - don't think 'to_str' is working. should work like:
+    #     gcrs = GoogleCalendarRequestString.new(configuration)
+    #     conn.get gcrs # '/calendar/v3/calendars/12345/events?time_min=yesterday'
+    def self.url_base
+      'https://www.googleapis.com'
+    end
+
+    def url_path
+      '/calendar/v3/calendars'
+    end
+
+    attr_reader :id, :params
+
+    def initialize(configuration)
+      argument_error! unless configuration.configured?
+
+      key = configuration.key
+      @id = configuration.id
+
+      @params = Params.new(key)
+    end
+
+    def to_s
+      "#{url_path}/#{id}/events?#{params}"
+    end
+  end
+end

data/lib/holiday_list/params.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/date_time/calculations'
+
+class HolidayList
+  # Params:
+  # Munges google calendar api request parameters
+  class Params
+    attr_reader :key
+
+    def initialize(key, time_options = {})
+      @key     = key
+      @options = time_options
+
+      validate_options!
+    end
+
+    def to_s
+      params_hash.to_query
+    end
+
+    def params_hash
+      {
+        key:          key,
+        orderBy:      order_by,
+        singleEvents: single_events,
+        timeMin:      time_min,
+        timeMax:      time_max
+      }
+    end
+
+    private
+
+    def time_min
+      @time_min ||= @options.fetch('start') { DateTime.now.new_offset(0) }
+    end
+
+    def time_max
+      @time_max ||= @options.fetch('stop') { DateTime.now.next_year.new_offset(0) }
+    end
+
+    def order_by
+      'startTime'
+    end
+
+    def single_events
+      true
+    end
+
+    def validate_options!
+      message = 'Start and end dates must be valid DateTime objects that'\
+                ' occur sequentially'
+
+      fail ArgumentError, message if [time_min, time_max].any? do |time|
+        time.class != DateTime
+      end
+
+      fail ArgumentError, message if time_min > time_max
+    end
+  end
+end

data/lib/holiday_list/request_exception.rb

@@ -0,0 +1,12 @@
+class HolidayList
+  # RequestException
+  # Provides convenience methods for common exceptions
+  module RequestException
+    private
+
+    def argument_error!(message = nil)
+      message ||= 'A valid google access key is required'
+      fail ArgumentError, message
+    end
+  end
+end

data/lib/holiday_list/version.rb

@@ -0,0 +1,3 @@
+class HolidayList # rubocop:disable Documentation
+  VERSION = '0.0.1'
+end

data/spec/holiday_list/configuration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe HolidayList::Configuration do
+  subject { HolidayList::Configuration.new }
+
+  describe '#configured?' do
+    shared_examples 'failing configuration' do
+      it 'is false' do
+        expect(subject.configured?).to be false
+      end
+    end
+
+    context 'without a key' do
+      before { subject.id = 'id' }
+
+      it_behaves_like 'failing configuration'
+    end
+
+    context 'without an id' do
+      before { subject.key = 'key' }
+
+      it_behaves_like 'failing configuration'
+    end
+
+    context 'without a key or id' do
+      it_behaves_like 'failing configuration'
+    end
+
+    context 'with a key and id' do
+      before do
+        subject.key = 'key'
+        subject.id  = 'id'
+      end
+
+      it 'is true' do
+        expect(subject.configured?).to be true
+      end
+    end
+  end
+end

data/spec/holiday_list/google_calendar_request_string_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe HolidayList::GoogleCalendarRequestString do
+  let(:configuration) do
+    double('Configuration', configured?: true).as_null_object
+  end
+
+  subject { HolidayList::GoogleCalendarRequestString.new(configuration) }
+
+  describe '#new' do
+    context 'configured' do
+      before do
+        HolidayList::GoogleCalendarRequestString
+          .any_instance.should_not_receive(:argument_error!)
+      end
+
+      it 'creates a new object' do
+        subject
+      end
+    end
+
+    context 'not configured' do
+      before do
+        configuration.stub(:configured?).and_return(false)
+        HolidayList::GoogleCalendarRequestString
+          .any_instance.should_receive(:argument_error!)
+      end
+
+      it 'calls argument_error!' do
+        subject
+      end
+    end
+  end
+
+  describe '#to_s' do
+    let(:params) { double('Params') }
+
+    before do
+      HolidayList::Params.stub(:new).and_return(params)
+    end
+
+    it 'uses Params' do
+      params.should_receive(:to_s)
+      subject.to_s
+    end
+  end
+end