holidays_from_google_calendar 0.4.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59d4d036317d5ad1ff9807433d1a475b4643add2
-  data.tar.gz: 896ce2010c7329bd3efb95524a9b50f5129734f2
+SHA256:
+  metadata.gz: 98ffb5d178e22fa195401b11f470d050452618e08b54d777c65a61c7f07c3ead
+  data.tar.gz: 8b1f8f362ecc9951248fe3f3ca5111591555db63c85f1777713e836abf2df6c0
 SHA512:
-  metadata.gz: b54fe874772619a7ec877990aecd1a9d2d34002b38ad6c6299f800f51656fc849adc3ed6952ad6cc4094ae81cad8898a162cb7c7b0a74649f83e6a4c03579394
-  data.tar.gz: 496bfa2f3fb07d89940ebd86aa1305f57c64258cd1d0e71c787e8f2354b9ff3d0ba0267e934bea5549518dd911fe82c449ee783315aed325fc37e982f0782eff
+  metadata.gz: 92dbb171814dce93210969fe7bea8d0eafbc2cd9ec554bd7a87e706ae6f864d21a0b57edcc6aba25a8948151462a3f4c2bcd630e19ca3d1f3d72480c5f90adec
+  data.tar.gz: 1cb498335614a96d26d6752d1f30e38b2e694208acda0c91afc1bc1474c9cc6423b8b6478434a70deac69d3c92f17c64c037385643d9225cb231698435c905e3

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request_target:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
+
+    - name: Send test coverage report to Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   Exclude:
     - 'bin/*'
     - 'Gemfile'
+  NewCops: enable
 
 # Accept single-line methods with no body
 SingleLineMethods:

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 
+
+[![CI](https://github.com/necojackarc/holidays_from_google_calendar/actions/workflows/ci.yml/badge.svg)](https://github.com/necojackarc/holidays_from_google_calendar/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/necojackarc/holidays_from_google_calendar/badge.svg?branch=master)](https://coveralls.io/github/necojackarc/holidays_from_google_calendar?branch=master)
+[![Code Climate](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/gpa.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar)
+
+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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/holidays_from_google_calendar.gemspec

@@ -19,14 +19,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "google-api-client", "~> 0.9"
   spec.add_dependency "activesupport"
+  spec.add_dependency "google-apis-calendar_v3"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "simplecov-lcov"
 end

data/lib/holidays_from_google_calendar/client.rb

@@ -4,7 +4,7 @@ module HolidaysFromGoogleCalendar
       @nation = configuration.calendar[:nation]
       @language = configuration.calendar[:language]
       @api_key = configuration.credential[:api_key]
-      @cache = Cache.new(configuration.cache)
+      @cache = Cache.new(**configuration.cache)
 
       return unless configuration.preload[:enable]
       preload(configuration.preload[:date_range])
@@ -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 = "1.0.0"
 end

data/lib/holidays_from_google_calendar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support"
 require "active_support/core_ext"
 require "google/apis/calendar_v3"
@@ -33,6 +35,7 @@ module HolidaysFromGoogleCalendar
 
     def holiday?(date)
       return true if date.wday.in?([0, 6]) # If Sunday or Saturday
+
       @client.retrieve(date_min: date, date_max: date).size > 0
     end
   end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: holidays_from_google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 1.0.0
 platform: ruby
 authors:
 - necojackarc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-api-client
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: google-apis-calendar_v3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,32 +42,32 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,10 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -181,8 +181,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.3.22
 signing_key: 
 specification_version: 4
 summary: Holidays from Google Calendar.

data/.travis.yml

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