holidays_from_google_calendar 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59d4d036317d5ad1ff9807433d1a475b4643add2
-  data.tar.gz: 896ce2010c7329bd3efb95524a9b50f5129734f2
+SHA256:
+  metadata.gz: d580e1150fd1410a754c1704caf0a2bd8961b45c4e19eb14298fd8a0fd754de1
+  data.tar.gz: 0d924ba7e83d1b72db38e2ac1eb210edaa941511098eafd5a7bcb661917204a1
 SHA512:
-  metadata.gz: b54fe874772619a7ec877990aecd1a9d2d34002b38ad6c6299f800f51656fc849adc3ed6952ad6cc4094ae81cad8898a162cb7c7b0a74649f83e6a4c03579394
-  data.tar.gz: 496bfa2f3fb07d89940ebd86aa1305f57c64258cd1d0e71c787e8f2354b9ff3d0ba0267e934bea5549518dd911fe82c449ee783315aed325fc37e982f0782eff
+  metadata.gz: f5c0261d1d967e2178e52de58b8b3031eb5d8a7740b9044e9136ce0b21b20d46d244244d96b75a5ccc330b6cce8999ead598547afd9420bd4a64b00002440e57
+  data.tar.gz: bcdf1eafebd441cb953430e2d286a42b411a213aef1f4035188869cf10eefafd8fc67b1899a2b733d07f490cb2e496a8caf64a8cd767a0702367efbcb8421f2f

data/.travis.yml

@@ -1,6 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a5c4305696a06c12d5071d9c5bbda7d604be0495ad47c6199389f633fcbdaf86
 language: ruby
 rvm:
   - 2.0
   - 2.1
   - 2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3
+  - 2.4
+  - 2.5
+before_install:
+  - gem update --system --no-document
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email: false

data/README.md

@@ -1,5 +1,30 @@
-# 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.
+# 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)
+
+HolidaysFromGoogleCalendar can retrieve national holidays from Google Calendar with very simple interface.
+
+The results is going to be cached and you can preload holidays with your favorite range at initialization if you want.
+These features help you to reduce access times to Google Calendar API.
+
+I am sure that you only need to access the API a very few times if you preload holidays with proper range.
+
+Using Google Calendar, available nations are same as Google Calendar.
+
+Note that you can only retrieve holidays which Google Calendar has.
+Google Calendar appears not to have all holidays, so you cannot retrieve very old ones and far future's.
+
+## Features
+### Main
+* List holidays of a particular nation in a particular year
+* List holidays of a particular nation in a particular month
+* Check a date whether it is a holiday or not in a particular nation
+
+### Others
+* Cacheing results using LRU algorithm
+* Preload holidays at initialization
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,7 +46,54 @@ $ gem install holidays_from_google_calendar
 ```
 
 ## Usage
+### Configuration
+All parameters you can pass are below:
+
+```ruby
+usa_holidays = HolidaysFromGoogleCalendar::Holidays.new do |config|
+  config.credential = {
+    api_key: "YOUR OWN GOOGLE API KEY"
+  }
+
+  config.calendar = {
+    nation: "usa",
+    language: "en"
+  }
 
+  config.cache = {
+    enable: true,
+    max_size: 1000 # DEFAULT_CACHE_SIZE is 1000
+  }
+
+  config.preload = {
+    enable: true, # Require cache enabled
+    date_range: 1.year # Retrive holidays from "this day last year" to "this day next year"
+  }
+end
+```
+
+Default parameters of `cache` and `preload` are same as above.
+
+### List holidays of a particular nation in a particular year
+Returns a array of holidays in a particular year.
+
+```ruby
+usa_holidays.in_year(Date.current)
+```
+
+### List holidays of a particular nation in a particular month
+Returns a array of holidays in a particular month.
+
+```ruby
+usa_holidays.in_month(Date.current)
+```
+
+### Check a date whether it is a holiday or not in a particular nation
+Returns `true` when the day is holiday, Saturday or Sunday.
+
+```ruby
+usa_holidays.holiday?(Date.current)
+```
 
 ### Sample code
 ```ruby
@@ -69,7 +141,7 @@ usa_holidays.in_month(Date.parse("3rd March 2016")) # Retrieve holidays of March
 usa_holidays.holiday?(Date.parse("Oct 31 2016")) # Halloween
 => true
 
-usa_holidays.holiday?(Date.parse("April 16th 2016")) # Satruday
+usa_holidays.holiday?(Date.parse("April 16th 2016")) # Saturday
 => true
 
 usa_holidays.holiday?(Date.parse("April 17th 2016")) # Sunday

data/holidays_from_google_calendar.gemspec

@@ -28,5 +28,4 @@ Gem::Specification.new do |spec|
   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/client.rb

@@ -50,9 +50,11 @@ module HolidaysFromGoogleCalendar
 
     def pack_response_in_object(response, date_min, date_max)
       response.items.reduce([]) do |array, item|
+        date = item.start.date
+
         holiday = Holiday.new(
           name: item.summary,
-          date: Date.parse(item.start.date)
+          date: date.is_a?(Date) ? date : Date.parse(date)
         )
 
         if date_min <= holiday.date && holiday.date <= date_max

data/lib/holidays_from_google_calendar/version.rb

@@ -1,3 +1,3 @@
 module HolidaysFromGoogleCalendar
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: holidays_from_google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - necojackarc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !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
@@ -181,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Holidays from Google Calendar.