business_calendar 0.0.17 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 482e0f0674387288534d373978b3c93cad967259af5f631e1cb5c91957d83be2
-  data.tar.gz: 3b07e79f60daea35982c9d1ddeb14ea85bad885527aabe7cd5be23f5d92918ff
+  metadata.gz: a487e3b1b6a6706731bd57ec4f0939f99fcab79c47de9003d4ca903dd72195c4
+  data.tar.gz: 30c4916820d736996003a54a98c43024c7142e9686ce0cb3529c03b41bbce809
 SHA512:
-  metadata.gz: 816ac828fd2e6625c3ec587627060872d068e909eeaf8d21468e25057237da40b58461165b6acfbbd131093aa0349291516e8a233bff5e303203081bd2ee0637
-  data.tar.gz: 507a5bbc258ba6f92bc63a6b454da9a8f6aaa0c7fea2b778e6f71160aa93e0dd45fc3e52971b4f83f2c1b487364e29afc4f816c4ef32e11287168efd3b69b126
+  metadata.gz: a8b3050c7234025e3c2ecde281590b7f0e161f3199b17abb74baac6a8b0894204a34f8b9debcb5ae6746ef943875da881f98ffc36a0c419e0047009345833a7a
+  data.tar.gz: '05690246237c04b98e40d8f5cf24a368644bd555310903a605de6c50013c534c7e61db7cc405c3b2ccbb190c26e1e761139800322dd43be06667fc0377d38ebd'

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      matrix:
+        ruby-version: [2.3.1, 2.7.0]
+        experimental: [false]
+        include:
+          - ruby-version: head
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/gem-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# business_calendar changes by version
+
+2.0.0
+---------
+
+- Remove UK weekend holidays, replace with the actual observed holiday dates [#26]
+
+1.1.0
+---------
+
+- Cache parsed responses from API endpoints for TTL (Time to Live) duration.
+- Increase default TTL duration from 5 minutes to 1 day.
+  Holidays are not expected to frequently change.
+- Allow disabling cache clearing by setting `ttl` to `false`.
+- Set hard limit to size of memoized holidays cache,
+  since large quantities of user supplied dates could consume excessive memory / cause DoS.
+
+1.0.0
+---------
+
+- Initial version 1 release
+- Add option to fetch holidays from a URL [#19]
+- Install new dependencies while preserving support for ruby 1.8.7 [#20] and [#22]
+- Add option to treat weekends as business days [#21]

data/Gemfile

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

data/README.md

@@ -1,8 +1,6 @@
 # BusinessCalendar
 
 [![Gem Version](https://badge.fury.io/rb/business_calendar.svg)](https://rubygems.org/gems/business_calendar)
-[![Build Status](https://travis-ci.org/enova/business_calendar.svg)](https://travis-ci.org/enova/business_calendar)
-[![Coverage Status](https://coveralls.io/repos/github/enova/business_calendar/badge.svg?branch=master)](https://coveralls.io/github/enova/business_calendar?branch=master)
 [![Dependency Status](https://gemnasium.com/enova/business_calendar.svg)](https://gemnasium.com/enova/business_calendar)
 
 Need to know what days you can actually debit a customer on in excruciating detail? Fed up with singleton-based gems 
@@ -32,7 +30,7 @@ Instantiate a calendar object with:
 bc = BusinessCalendar.for(:US)
 ```
 
-This will automatically load holidays based on the US banking holiday schedule, as configured in `data/holidays.yml`. 
+This will automatically load holidays based on the US banking holiday schedule, as configured in `data/US.yml`.
 Currently, this gem supports `:GB` and `:US` regions.
 
 Now, you can use it:
@@ -61,6 +59,35 @@ holiday_tester = Proc.new { |date| MY_HOLIDAY_DATES.include? date }
 bc = BusinessCalendar::Calendar.new(holiday_tester)
 ```
 
+You can also create an API that returns a list of holidays, and point BusinessCalendar to the API.
+
+The API needs to respond to an `HTTP GET` with status `200` and a JSON response with field `holidays` containing a list of ISO 8601 string dates:
+
+```json
+{
+  "holidays": [
+    "2018-10-08",
+    "2018-11-12",
+    "2018-11-22"
+  ]
+}
+```
+
+With this option, holiday dates are *temporarily* cached (with a default ttl of 300s). This is so that changes to the data being returned by the API will not necessitate restarting every application/process that uses BusinessCalendar with that API.
+
+Usage:
+
+```ruby
+# additions = URI to hit for dates to be added to holiday list. Set to nil if none
+# removals  = URI to hit for dates to be removed from holiday list. Set to nil if none
+#
+# opts      = Set same config options (regions, holiday_names, additions_only)
+#             as the YAML files, with the additional option "ttl" to set ttl on
+#             cached dates. Defaults to 300s.
+
+bc = BusinessCalendar.for_endpoint('https://some.test/calendars/2018', 'https://some.test/calendars/2018_removals')
+```
+
 ## Contributing
 
 1. Fork it

data/business_calendar.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rnubel@enova.com"]
   spec.description   = %q{Helper gem for dealing with business days and date adjustment in multiple countries.}
   spec.summary       = %q{Country-aware business-date logic and handling.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/enova/business_calendar"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "holidays", "~> 1.0"
+  spec.add_dependency "faraday"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry"
 end

data/data/GB.yml

@@ -26,12 +26,12 @@ GB:
   - '2015-12-26'
   - '2016-12-25'
   - '2017-01-01'
-  - '2020-12-26'
-  - '2021-12-25'
-  - '2021-12-26'
-  - '2022-01-01'
-  - '2022-12-25'
-  - '2023-01-01'
+  - '2020-12-28'
+  - '2021-12-27'
+  - '2021-12-28'
+  - '2022-01-03'
+  - '2022-12-27'
+  - '2023-01-02'
   removals:
   - '2002-05-28'
   - '2007-04-08'
@@ -44,9 +44,9 @@ GB:
   - '2013-03-31'
   - '2014-04-20'
   - '2015-12-28'
-  - '2020-12-28'
-  - '2021-12-27'
-  - '2021-12-28'
-  - '2022-01-03'
-  - '2022-12-27'
-  - '2023-01-02'
+  - '2020-12-26'
+  - '2021-12-25'
+  - '2021-12-26'
+  - '2022-01-01'
+  - '2022-12-25'
+  - '2023-01-01'

data/gemfiles/ree.gemfile

@@ -1,7 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'rake', '< 11'
-gem 'json', '< 2'
-gem 'pry', '< 0.10'
+gem 'addressable', '< 2.4.0'
+gem 'json',        '< 2'
+gem 'faraday',     '< 0.10'
+gem 'hashdiff',    '0.3.0'
+gem 'pry',         '< 0.10'
 
+# Specify your gem's dependencies in business_calendar.gemspec
 gemspec :path => '../'

data/gemfiles/ruby_1.9.3.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'json', '< 2.3.0'
+
+# Specify your gem's dependencies in business_calendar.gemspec
+gemspec :path => '../'

data/lib/business_calendar.rb

@@ -1,13 +1,23 @@
+require 'faraday'
+
 module BusinessCalendar
   CountryNotSupported = Class.new(StandardError)
   OrganizationNotSupported = Class.new(StandardError)
   class << self
-    def for(country)
-      Calendar.new(holiday_determiner(country))
+    def for(country, options = {})
+      if options["use_cached_calendar"]
+        calendar_cache[country] ||= Calendar.new(holiday_determiner(country))
+      else
+        Calendar.new(holiday_determiner(country), options)
+      end
+    end
+
+    def for_organization(org, options = {})
+      Calendar.new(holiday_determiner_for_organization(org), options)
     end
 
-    def for_organization(org)
-      Calendar.new(holiday_determiner_for_organization(org))
+    def for_endpoint(additions, removals, options = {})
+      Calendar.new(holiday_determiner_for_endpoint(additions, removals, options), options)
     end
 
     private
@@ -34,6 +44,38 @@ module BusinessCalendar
          :additions_only  => cfg['additions_only'] )
     end
 
+    def holiday_dates_for_endpoint(client, endpoint)
+      Proc.new { JSON.parse(client.get(endpoint).body).fetch('holidays').map { |s| Date.parse s } }
+    end
+
+    def holiday_determiner_for_endpoint(additions_endpoint, removals_endpoint, opts)
+      client = Faraday.new do |conn|
+        conn.response :raise_error
+        conn.adapter :net_http
+      end
+
+      additions = if additions_endpoint
+                    holiday_dates_for_endpoint(client, additions_endpoint)
+                  end
+
+      removals = if removals_endpoint
+                   holiday_dates_for_endpoint(client, removals_endpoint)
+                 end
+
+      HolidayDeterminer.new(
+        opts["regions"] || [],
+        opts["holiday_names"] || [],
+        :additions       => additions,
+        :removals        => removals,
+        :additions_only  => opts["additions_only"] || [],
+        :ttl => opts['ttl']
+      )
+    end
+
+    def calendar_cache
+      @calendar_cache ||= {}
+    end
+
     def config(country)
       @config ||= load_config
       @config[country.to_s]

data/lib/business_calendar/calendar.rb

@@ -1,9 +1,14 @@
 class BusinessCalendar::Calendar
+  DEFAULT_TIME_TO_LIVE = 24 * 60 * 60
   attr_reader :holiday_determiner
 
   # @param [Proc[Date -> Boolean]] a proc which returns whether or not a date is a
   #                                holiday.
-  def initialize(holiday_determiner)
+  def initialize(holiday_determiner, options = {})
+    ttl = options['ttl']
+    @time_to_live = ttl.nil? ? DEFAULT_TIME_TO_LIVE : ttl
+    @options = options
+    @holiday_cache = {}
     @holiday_determiner = holiday_determiner
   end
 
@@ -11,13 +16,16 @@ class BusinessCalendar::Calendar
   # @return [Boolean] Whether or not this calendar's list of holidays includes <date>.
   def is_holiday?(date)
     date = date.send(:to_date) if date.respond_to?(:to_date, true)
-    holiday_determiner.call(date)
+
+    clear_cache if should_clear_cache?
+
+    @holiday_cache[date] ||= holiday_determiner.call(date)
   end
 
   # @param [Date]     date
   # @return [Boolean] Whether or not banking can be done on <date>.
   def is_business_day?(date)
-    return false if date.saturday? || date.sunday?
+    return false if !@options['business_weekends'] && (date.saturday? || date.sunday?)
     return false if is_holiday?(date)
     true
   end
@@ -36,8 +44,9 @@ class BusinessCalendar::Calendar
     return subtract_business_days(date_or_dates, -num) if num < 0
 
     with_one_or_many(date_or_dates) do |date|
-      start = nearest_business_day(date, initial_direction)
-      num.times.reduce(start) { |d, _| following_business_day(d) }
+      d = nearest_business_day(date, initial_direction)
+      num.times { d = following_business_day(d) }
+      d
     end
   end
   alias :add_business_day :add_business_days
@@ -51,7 +60,8 @@ class BusinessCalendar::Calendar
     return add_business_days(date_or_dates, -num) if num < 0
 
     with_one_or_many(date_or_dates) do |date|
-      num.times.reduce(date) { |d, _| preceding_business_day(d) }
+      num.times { date = preceding_business_day(date) }
+      date
     end
   end
   alias :subtract_business_day :subtract_business_days
@@ -101,14 +111,26 @@ class BusinessCalendar::Calendar
   end
 
   private
-  def with_one_or_many(thing_or_things)
-    is_array = thing_or_things.is_a? Enumerable
-    things = is_array ? thing_or_things : [thing_or_things]
 
-    results = things.collect do |thing|
-      yield thing
-    end
+  def should_clear_cache?
+    return false unless @time_to_live
+
+    # limit size using a heuristic, to prevent cache growing arbitrarily large
+    !@last_cleared || (Time.now - @last_cleared) >= @time_to_live || @holiday_cache.size > 365 * 3
+  end
+
+  def clear_cache
+    @last_cleared = Time.now
+    @holiday_cache = {}
+  end
 
-    return is_array ? results : results.first
+  def with_one_or_many(thing_or_things)
+    if thing_or_things.is_a? Enumerable
+      thing_or_things.collect do |thing|
+        yield thing
+      end
+    else
+      yield thing_or_things
+    end
   end
 end

data/lib/business_calendar/holiday_determiner.rb

@@ -1,9 +1,12 @@
 require 'holidays'
 
 class BusinessCalendar::HolidayDeterminer
+  DEFAULT_TIME_TO_LIVE = 24 * 60 * 60
   attr_reader :regions, :holiday_names, :additions, :removals, :additions_only
 
   def initialize(regions, holiday_names, opts = {})
+    ttl = opts[:ttl]
+    @time_to_live = ttl.nil? ? DEFAULT_TIME_TO_LIVE : ttl
     @regions        = regions
     @holiday_names  = holiday_names
     @additions      = opts[:additions]      || []
@@ -12,13 +15,37 @@ class BusinessCalendar::HolidayDeterminer
   end
 
   def call(date)
+    clear_cache if should_clear_cache?
+
     if additions.include? date
       true
     elsif removals.include? date
       false
     elsif !additions_only
       Holidays.between(date, date, @regions, :observed).
-              any? { |h| @holiday_names.include? h[:name] }
+        any? { |h| @holiday_names.include? h[:name] }
     end
   end
+
+  private
+
+  def should_clear_cache?
+    return false unless @time_to_live
+
+    !@last_cleared || (Time.now - @last_cleared) >= @time_to_live
+  end
+
+  def clear_cache
+    @last_cleared = Time.now
+    @additions_cache = nil
+    @removals_cache = nil
+  end
+
+  def additions
+    @additions_cache ||= @additions.is_a?(Proc) ? @additions.call : @additions
+  end
+
+  def removals
+    @removals_cache ||= @removals.is_a?(Proc) ? @removals.call : @removals
+  end
 end

data/lib/business_calendar/version.rb

@@ -1,3 +1,3 @@
 module BusinessCalendar
-  VERSION = "0.0.17"
+  VERSION = "2.0.1"
 end

data/spec/acceptance_gb_spec.rb

@@ -20,12 +20,12 @@ describe "GB bank holidays" do
       2015-12-26
       2016-12-25
       2017-01-01
-      2020-12-26
-      2021-12-25
-      2021-12-26
-      2022-01-01
-      2022-12-25
-      2023-01-01
+      2020-12-28
+      2021-12-27
+      2021-12-28
+      2022-01-03
+      2022-12-27
+      2023-01-02
     ).map { |x| Date.parse x }.each do |expected_holiday|
     it "treats #{expected_holiday} as a holiday" do
       expect(BusinessCalendar.for(:GB).is_holiday?(expected_holiday)).to be true
@@ -35,12 +35,12 @@ describe "GB bank holidays" do
   %w(
       2012-05-28
       2015-12-28
-      2020-12-28
-      2021-12-27
-      2021-12-28
-      2022-01-03
-      2022-12-27
-      2023-01-02
+      2020-12-26
+      2021-12-25
+      2021-12-26
+      2022-01-01
+      2022-12-25
+      2023-01-01
     ).map { |x| Date.parse x }.each do |date|
     it "treats #{date} as not a holiday" do
       expect(BusinessCalendar.for(:GB).is_holiday?(date)).to be false

data/spec/business_calendar/holiday_determiner_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe BusinessCalendar::HolidayDeterminer do
   let(:regions) { [ :us ] }
-  let(:opts)    {{}}
+  let(:opts)    { {} }
   subject { BusinessCalendar::HolidayDeterminer.new(regions, ["Independence Day"], opts) }
 
   it "initializes with list of regions and a list of accepted holidays" do

data/spec/business_calendar_spec.rb

@@ -75,11 +75,59 @@ describe BusinessCalendar do
     end
   end
 
+  shared_examples_for "weekends as business days" do
+    specify "a weekend is a business day" do
+      expect(subject.is_business_day?('2014-03-09'.to_date)).to be true
+    end
+
+    specify "a normal weekday is a business day" do
+      expect(subject.is_business_day?('2014-03-10'.to_date)).to be true
+    end
+
+    specify 'the nearest business day to a saturday in any direction is saturday' do
+      expect(subject.nearest_business_day('2014-03-08'.to_date)).to eq '2014-03-08'.to_date
+      expect(subject.nearest_business_day('2014-03-08'.to_date, :forward)).to eq '2014-03-08'.to_date
+      expect(subject.nearest_business_day('2014-03-08'.to_date, :backward)).to eq '2014-03-08'.to_date
+    end
+
+    specify 'one business day added to a friday is saturday' do
+      expect(subject.add_business_day('2014-03-07'.to_date)).to eq '2014-03-08'.to_date
+    end
+
+    specify 'one business day added to a weekend is the next day' do
+      expect(subject.add_business_day('2014-03-08'.to_date)).to eq '2014-03-09'.to_date
+      expect(subject.add_business_day('2014-03-09'.to_date)).to eq '2014-03-10'.to_date
+    end
+
+    specify 'the following business day of a saturday is sunday' do
+      expect(subject.following_business_day('2014-03-08'.to_date)).to eq '2014-03-09'.to_date
+    end
+
+    specify 'a saturday plus zero business days is still saturday' do
+      expect(subject.add_business_days('2014-03-08'.to_date, 0)).to eq '2014-03-08'.to_date
+      expect(subject.add_business_days('2014-03-08'.to_date, 0, :backward)).to eq '2014-03-08'.to_date
+    end
+
+    specify 'the preceding business day of a monday is sunday' do
+      expect(subject.preceding_business_day('2014-03-10'.to_date)).to eq '2014-03-09'.to_date
+    end
+
+    specify 'a monday less three business days is the previous friday' do
+      expect(subject.add_business_days('2014-03-10'.to_date, -3)).to eq '2014-03-07'.to_date
+    end
+  end
+
   context "in the US" do
     let(:country) { :US }
 
     it_behaves_like "standard business time"
 
+    context "with weekends as business days" do
+      subject { BusinessCalendar.for(country, {"business_weekends" => true}) }
+
+      it_behaves_like "weekends as business days"
+    end
+
     specify "American Independence Day is not a business day" do
       expect(subject.is_business_day?('2014-07-04'.to_date)).to be false
     end
@@ -94,6 +142,12 @@ describe BusinessCalendar do
 
     it_behaves_like "standard business time"
 
+    context "with weekends as business days" do
+      subject { BusinessCalendar.for(country, {"business_weekends" => true}) }
+
+      it_behaves_like "weekends as business days"
+    end
+
     specify "American Independence Day is a business day" do
       expect(subject.is_business_day?('2014-07-04'.to_date)).to be true
     end
@@ -110,4 +164,218 @@ describe BusinessCalendar do
       expect { subject }.to raise_error BusinessCalendar::CountryNotSupported
     end
   end
+
+  context "with an API endpoint" do
+    let(:additions) { 'http://fakeendpoint.test/additions' }
+    let(:removals) { 'http://fakeendpoint.test/removals' }
+
+    subject { BusinessCalendar.for_endpoint(additions, removals) }
+
+    before do
+      stub_request(:get, additions).to_return(
+        :status => 200,
+        :body => {'holidays' => ['2014-07-04', '2014-07-05']}.to_json
+      )
+
+      stub_request(:get, removals).to_return(
+        :status => 200,
+        :body => {'holidays' => ['2014-12-24', '2014-12-25']}.to_json
+      )
+    end
+
+    it_behaves_like "standard business time"
+
+    context "with weekends as business days" do
+      subject { BusinessCalendar.for_endpoint(additions, removals, {"business_weekends" => true}) }
+
+      it_behaves_like "weekends as business days"
+    end
+
+    it 'hits the configured endpoint and then reuses the cached result' do
+      subject.is_business_day?('2014-07-03'.to_date)
+      subject.is_business_day?('2014-07-03'.to_date)
+      subject.is_business_day?('2014-07-04'.to_date)
+      subject.is_holiday?('2014-07-06'.to_date)
+      subject.is_holiday?('2014-07-06'.to_date)
+      subject.is_holiday?('2014-12-24'.to_date)
+
+      expect(a_request(:get, additions)).to have_been_made.times(1)
+      expect(a_request(:get, removals)).to have_been_made.times(1)
+    end
+
+    context 'after 24 hours without specifying a Time to Live override' do
+      subject { BusinessCalendar.for_endpoint(additions, removals) }
+      let!(:start) { Time.now }
+      let!(:one_day) { 86400 }
+
+      it 'expires the holidays cache' do
+        allow(Time).to receive(:now) { start }
+
+        subject.is_business_day?('2014-01-01'.to_date)
+
+        # initial request was made
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+
+        # cache from initial request was still used
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        # 24 hours + 1 second have passed
+        # cache should be cleared and fresh API request made
+        allow(Time).to receive(:now) { start + one_day + 1 }
+
+        subject.is_business_day?('2014-01-01'.to_date)
+
+        # 2nd request was made
+        expect(a_request(:get, additions)).to have_been_made.times(2)
+
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+
+        # 2nd request is now cached, so no new request should have been issued
+        expect(a_request(:get, additions)).to have_been_made.times(2)
+      end
+    end
+
+    context 'turning off Time to Live functionality' do
+      subject { BusinessCalendar.for_endpoint(additions, removals, {'ttl' => false}) }
+      let!(:start) { Time.now }
+      let!(:one_day) { 86400 }
+
+      it 'will never clear the cache' do
+        allow(Time).to receive(:now) { start }
+
+        subject.is_business_day?('2014-01-01'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        allow(Time).to receive(:now) { start + 301 }
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        allow(Time).to receive(:now) { start + one_day + 1 }
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+      end
+    end
+
+    context 'setting Time to Live override to zero' do
+      subject { BusinessCalendar.for_endpoint(additions, removals, {'ttl' => 0}) }
+      let!(:start) { Time.now }
+
+      it 'will always clear the cache' do
+        allow(Time).to receive(:now) { start }
+
+        subject.is_holiday?('2014-01-01'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        allow(Time).to receive(:now) { start + 301 }
+
+        subject.is_holiday?('2014-01-01'.to_date)
+        subject.is_holiday?('2014-07-04'.to_date)
+        subject.is_holiday?('2014-07-04'.to_date)
+        subject.is_holiday?('2014-11-28'.to_date)
+
+        expect(a_request(:get, additions)).to have_been_made.times(5)
+
+        subject.is_holiday?('2014-01-01'.to_date)
+        subject.is_holiday?('2014-01-01'.to_date)
+        subject.is_holiday?('2014-07-04'.to_date)
+        subject.is_holiday?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(9)
+      end
+    end
+
+    context 'using a 5 minute Time to Live override' do
+      subject { BusinessCalendar.for_endpoint(additions, removals, {'ttl' => 300}) }
+      let!(:start) { Time.now }
+
+      it 'expires the holidays cache after the specified time has elapsed' do
+        allow(Time).to receive(:now) { start }
+
+        # initial request made and cached
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        # 120 seconds pass, cache should still be used
+        allow(Time).to receive(:now) { start + 120 }
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        # 301 seconds pass, cache is expired and 2nd request made
+        allow(Time).to receive(:now) { start + 301 }
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(2)
+
+        # 2nd request is now cached, so no new request should have been issued
+        subject.is_business_day?('2014-01-01'.to_date)
+        subject.is_business_day?('2014-07-04'.to_date)
+        subject.is_business_day?('2014-11-28'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(2)
+      end
+    end
+
+    context 'with a few years in dates filling the cache' do
+      let!(:start) { Time.now }
+
+      # NOTE: this test cheats a bit to test class internals / implementation
+      it 'will clear out the holiday cache but keep the cached API result' do
+        allow(Time).to receive(:now) { start }
+        subject.is_business_day?('2014-07-04'.to_date)
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+        (2014..2017).each do |year|
+          (1..12).each do |month|
+            (1..28).each do |day|
+              subject.is_business_day?("#{year}-#{month}-#{day}".to_date)
+            end
+          end
+        end
+
+        # about to reach cache size threshold
+        expect(subject.instance_variable_get('@holiday_cache').size).to be(960)
+
+        (1..7).each do |month|
+          (1..28).each do |day|
+            subject.is_business_day?("#2018-#{month}-#{day}".to_date)
+          end
+        end
+
+        # now holiday cache will have been cleared and should be small again
+        expect(subject.instance_variable_get('@holiday_cache').size).to be(4)
+
+        # and cached API response was still used
+        expect(a_request(:get, additions)).to have_been_made.times(1)
+      end
+    end
+
+    context 'http request fails' do
+      before { stub_request(:get, additions).to_return(:status => 500) }
+
+      it 'raises an error' do
+        expect { subject.is_business_day?('2014-07-04'.to_date) }.to raise_error Faraday::Error
+      end
+    end
+
+    specify "date included in endpoint's holiday list is not a business day" do
+      expect(subject.is_business_day?('2014-07-05'.to_date)).to be false
+    end
+
+    specify 'a time is converted to a date' do
+      expect(subject.is_holiday?(Time.parse('2014-07-04'))).to be true
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,11 @@
 require 'bundler/setup'
 Bundler.setup
 
-require 'simplecov'
-
 require 'business_calendar'
 require 'date'
+require 'webmock/rspec'
 require 'pry'
 
-
 # I'm not depending on ActiveSupport just for this.
 class String
   def to_date
@@ -20,3 +18,9 @@ class Date
     "#<Date #{strftime("%Y-%m-%d")}>"
   end
 end
+
+RSpec.configure do |config|
+  config.before do
+    WebMock.disable_net_connect!
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 2.0.1
 platform: ruby
 authors:
 - Robert Nubel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holidays
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,10 +102,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,6 +118,7 @@ files:
 - data/US.yml
 - data/org/captalys.yml
 - gemfiles/ree.gemfile
+- gemfiles/ruby_1.9.3.gemfile
 - lib/business_calendar.rb
 - lib/business_calendar/calendar.rb
 - lib/business_calendar/holiday_determiner.rb
@@ -130,7 +132,7 @@ files:
 - spec/business_calendar/holiday_determiner_spec.rb
 - spec/business_calendar_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/enova/business_calendar
 licenses:
 - MIT
 metadata: {}
@@ -149,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Country-aware business-date logic and handling.

data/.simplecov

@@ -1,8 +0,0 @@
-unless RUBY_VERSION == "1.8.7"
-  require 'coveralls'
-
-  Coveralls.wear! do
-    add_filter "version.rb"
-    add_filter "spec/"
-  end
-end

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.1
-
-script: bundle exec rspec
-
-env:
-  global:
-    secure: klQ3BQNdKkGIq3Zfv8Sr6oZqaMg9GHx+LGhynQ5xt7A6SGvxbMuoXJlE9wW4me6u+B9S2D+q+pdKgGPE/+fHsVt/d0zDXRnrjVyo1eexT220AMfpjiFDAtya8sAcuuAICLhw8AmzTjns8yAWInv5U5vC6oejkLA71FXtHU//210=
-
-matrix:
-  include:
-    - rvm: ree
-      gemfile: gemfiles/ree.gemfile
-      env: TEST_SUITE=spec
-
-deploy:
-  provider: rubygems
-  api_key:
-    secure: "c9QcNX+nk0Yzl22ZVknZtv+/G4fUeLph0TH9PS6hQ92zywM61wtXTJExZdBHulvKAaQbKaq20LcFjLw41qwJc6tvIEYXpOinfOaiemTKaGmKscDrIi3wUAxfjmTacXZAaTdEORQVqTOmppqsuKnP7cqmSNxTSI901Sz5Cy6Jpl0="
-  on:
-    tags: true
-    repo: enova/business_calendar