holidays_from_google_calendar 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e141f7e77b5d28a0f6286c5ce57a9e3140459d8e
-  data.tar.gz: c49f47556e87dc460485d09689637dbbb3cc0413
+  metadata.gz: a59e69c462038c25af1aa0b4823cf9016b52b14e
+  data.tar.gz: dcd9fd8b0cfd5fa346183eb7870538df0bf3c188
 SHA512:
-  metadata.gz: 18ca26424001c47596268618ab2816980f76ab07a8d4d89f86806eda50453a0df748a1567e62f63d07f5b88969f9bef9a11b762c65381a39d00e1c79f620ace9
-  data.tar.gz: a2769dc98cf24f2f85072e06a5e88f7e5eef5f802c39414ec671d3d51822c8fb250c3b065d7b1a7d716e07e72455686b95bf60a15a0d62cd26c95bad4bac4dd0
+  metadata.gz: 5b7419bbaae8268b58db9fa448089c0e9283f6c3cdc689e546d372cecb0f81301a9b7f8975fbd90d5a3a2deab8a7de8fa4a5d0536d0de88eb7a669c73d2e16bd
+  data.tar.gz: 130fab39c62241f14dbb9f6678e11ea85c00425f50bcae587334bbb209a51576171276fdabf855406079f43252e200f1305f538c2785c6f5875128f6574760ed

data/.rubocop.yml

@@ -29,6 +29,10 @@ ClassAndModuleChildren:
 Style/SingleLineBlockParams:
   Enabled: false
 
+# Allow using `{...}` for anytime
+Style/BlockDelimiters:
+  Enabled: false
+
 # Prefer Kernel#sprintf
 FormatString:
   EnforcedStyle: sprintf

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.0
+  - 2.1
+  - 2.2
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -1,11 +1,7 @@
-# HolidaysFromGoogleCalendar
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/holidays_from_google_calendar`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# HolidaysFromGoogleCalendar [![Build Status](https://travis-ci.org/necojackarc/holidays_from_google_calendar.svg?branch=master)](https://travis-ci.org/necojackarc/holidays_from_google_calendar) [![Code Climate](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/gpa.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar) [![Test Coverage](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/coverage.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/coverage)
+Under construction.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -14,28 +10,85 @@ gem 'holidays_from_google_calendar'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install holidays_from_google_calendar
+```bash
+$ gem install holidays_from_google_calendar
+```
 
 ## Usage
 
-TODO: Write usage instructions here
 
-## Development
+### Sample code
+```ruby
+require "holidays_from_google_calendar"
+
+usa_holidays = HolidaysFromGoogleCalendar::Holidays.new do |config|
+  config.calendar = {
+    nation: "usa",
+    language: "en"
+  }
+
+  config.credential = {
+    api_key: "YOUR OWN GOOGLE API KEY"
+  }
+end
+
+usa_holidays.in_year(Date.parse("2016-02-06")) # Retrieve 2016's holidays
+=> [#<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42df748 @date=Fri, 01 Jan 2016, @name="New Year's Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42def28 @date=Mon, 18 Jan 2016, @name="Martin Luther King Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42de820 @date=Sun, 14 Feb 2016, @name="Valentine's Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42de0f0 @date=Mon, 15 Feb 2016, @name="Presidents' Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42dd808 @date=Sun, 13 Mar 2016, @name="Daylight Saving Time starts">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42dc8e0 @date=Sun, 27 Mar 2016, @name="Easter Sunday">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab3b40 @date=Wed, 13 Apr 2016, @name="Thomas Jefferson's Birthday">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab36b8 @date=Sun, 08 May 2016, @name="Mother's Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab3230 @date=Mon, 30 May 2016, @name="Memorial Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab2d08 @date=Sun, 19 Jun 2016, @name="Father's Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab26a0 @date=Mon, 04 Jul 2016, @name="Independence Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab21a0 @date=Mon, 05 Sep 2016, @name="Labor Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab1cc8 @date=Mon, 10 Oct 2016, @name="Columbus Day (regional holiday)">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab1610 @date=Mon, 31 Oct 2016, @name="Halloween">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab0f30 @date=Sun, 06 Nov 2016, @name="Daylight Saving Time ends">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab0a58 @date=Tue, 08 Nov 2016, @name="Election Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab0648 @date=Fri, 11 Nov 2016, @name="Veterans Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d4ab0238 @date=Thu, 24 Nov 2016, @name="Thanksgiving Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42d7f20 @date=Sat, 24 Dec 2016, @name="Christmas Eve">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42d7a70 @date=Sun, 25 Dec 2016, @name="Christmas Day">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42d7660 @date=Mon, 26 Dec 2016, @name="Christmas Day observed">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42d70e8 @date=Sat, 31 Dec 2016, @name="New Year's Eve">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42d62b0 @date=Sun, 01 Jan 2017, @name="New Year's Day">]
+
+usa_holidays.in_month(Date.parse("3rd March 2016")) # Retrieve holidays of March, 2016
+=> [#<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42dd808 @date=Sun, 13 Mar 2016, @name="Daylight Saving Time starts">,
+ #<HolidaysFromGoogleCalendar::Holiday:0x007ff7d42dc8e0 @date=Sun, 27 Mar 2016, @name="Easter Sunday">]
+
+usa_holidays.holiday?(Date.parse("Oct 31 2016")) # Halloween
+=> true
+
+usa_holidays.holiday?(Date.parse("April 16th 2016")) # Satruday
+=> true
+
+usa_holidays.holiday?(Date.parse("April 17th 2016")) # Sunday
+=> true
+
+usa_holidays.holiday?(Date.parse("Aug 2 2016")) # Weekday (Tuesday)
+=> false
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Development
+Need to set the following environment variable to run rspec.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+GOOGLE_API_KEY="YOUR OWN GOOGLE API KEY"
+```
 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/holidays_from_google_calendar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
-
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/holidays_from_google_calendar.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/holidays_from_google_calendar/configuration.rb

@@ -7,7 +7,7 @@ module HolidaysFromGoogleCalendar
     def initialize
       @calendar = {
         nation: "japanese",
-        language: "ja"
+        language: "en"
       }
 
       @cache = {

data/lib/holidays_from_google_calendar/version.rb

@@ -1,3 +1,3 @@
 module HolidaysFromGoogleCalendar
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays_from_google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - necojackarc
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: simplecov
+  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: codeclimate-test-reporter
+  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: Retriving national holidays from Google Calendar.
 email:
 - necojackarc@gmail.com