business_calendar 0.0.18 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82cbe11f46934df2bcc820bd3725e10601f7e2942ef46285e191e96af392faee
-  data.tar.gz: 1bc29d426eb24de502a7b62c26300e841b914c74f66c6ab99193e2b862031103
+  metadata.gz: f7e437b2a3580ac2cac07f883e3acc42dfa39e0bd3506e95e1e46a1441d14f7d
+  data.tar.gz: 13769d2f539ae93f3579c1b46378c5da5708b039b63f186e910d9f528e4b5041
 SHA512:
-  metadata.gz: 8aeaca2443bb3a4cfdf40dd6a016803b3e16bbf714104efb725ca417efcb9aecd76a5dd9cc7b334c6a2c79e66a882db31254b72cf834892a00a00b90be3da5f6
-  data.tar.gz: 76cc84dc341780de4f5c90899f101d0cc3215fc3b930602f982be66bf2f74b876503ad067abfa56d28be10fd5acee278db90a49e95740fe66c5e7a1f7e098de2
+  metadata.gz: 625699922d3aa15522193ab57de09fa8ac5c0d13623afd47bfdbda65b2e2b2798d623ea316c0db5570b3e0c4c69de18cb4a47793167bcacf458642c516a2e0af
+  data.tar.gz: de9860000e204fc1fb05a853c437277bda370033046cc2ff43d954af432b715d39bba09f8a9d085621876f2cf508e6434063ad8ea238e01cde8eea955b7b1f42

data/.travis.yml

@@ -1,21 +1,21 @@
 sudo: false
 language: ruby
 cache: bundler
-rvm:
-  - 2.3.1
 
-script: bundle exec rspec
+matrix:
+  include:
+    - rmv: ree
+      gemfile: gemfiles/ree.gemfile
+      script: bundle exec rspec
+    - rvm: 1.9.3
+      script: bundle exec rspec
+    - 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:

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# business_calendar changes by version
+
+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/README.md

@@ -61,6 +61,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

@@ -18,11 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+
   spec.add_dependency "holidays", "~> 1.0"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-conductivity"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "pry"
 end

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/lib/business_calendar.rb

@@ -1,3 +1,6 @@
+require 'faraday'
+require 'faraday/conductivity'
+
 module BusinessCalendar
   CountryNotSupported = Class.new(StandardError)
   OrganizationNotSupported = Class.new(StandardError)
@@ -6,12 +9,17 @@ module BusinessCalendar
       if options["use_cached_calendar"]
         calendar_cache[country] ||= Calendar.new(holiday_determiner(country))
       else
-        Calendar.new(holiday_determiner(country))
+        Calendar.new(holiday_determiner(country), options)
       end
     end
 
-    def for_organization(org)
-      Calendar.new(holiday_determiner_for_organization(org))
+    def for_organization(org, options = {})
+      Calendar.new(holiday_determiner_for_organization(org), options)
+    end
+
+    def for_endpoint(additions, removals, options = {})
+      ttl = options["ttl"] || 300
+      Calendar.new(holiday_determiner_for_endpoint(additions, removals, options), options.merge({"ttl" => ttl}))
     end
 
     private
@@ -38,6 +46,29 @@ module BusinessCalendar
          :additions_only  => cfg['additions_only'] )
     end
 
+    def holiday_determiner_for_endpoint(additions_endpoint, removals_endpoint, opts)
+      client = Faraday.new do |conn|
+        conn.response :selective_errors
+        conn.adapter :net_http
+      end
+
+      additions = if additions_endpoint
+                    Proc.new { JSON.parse(client.get(additions_endpoint).body).fetch('holidays').map { |s| Date.parse s } }
+                  end
+
+      removals = if removals_endpoint
+                   Proc.new { JSON.parse(client.get(removals_endpoint).body).fetch('holidays').map { |s| Date.parse s } }
+                 end
+
+      HolidayDeterminer.new(
+        opts["regions"] || [],
+        opts["holiday_names"] || [],
+        :additions       => additions,
+        :removals        => removals,
+        :additions_only  => opts["additions_only"] || []
+      )
+    end
+
     def calendar_cache
       @calendar_cache ||= {}
     end

data/lib/business_calendar/calendar.rb

@@ -3,8 +3,9 @@ class BusinessCalendar::Calendar
 
   # @param [Proc[Date -> Boolean]] a proc which returns whether or not a date is a
   #                                holiday.
-  def initialize(holiday_determiner)
-    @is_holiday = {}
+  def initialize(holiday_determiner, options = {})
+    @options = options
+    @holiday_cache = {}
     @holiday_determiner = holiday_determiner
   end
 
@@ -12,14 +13,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)
-    return @is_holiday[date] unless @is_holiday[date].nil?
-    @is_holiday[date] = holiday_determiner.call(date)
+
+    clear_cache if @options["ttl"]
+
+    @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
@@ -114,4 +117,11 @@ class BusinessCalendar::Calendar
       yield thing_or_things
     end
   end
+
+  def clear_cache
+    if !@issued_at || (Time.now - @issued_at) >= @options["ttl"]
+      @issued_at = Time.now
+      @holiday_cache = {}
+    end
+  end
 end

data/lib/business_calendar/holiday_determiner.rb

@@ -18,7 +18,16 @@ class BusinessCalendar::HolidayDeterminer
       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 additions
+    @additions.is_a?(Proc) ? @additions.call : @additions
+  end
+
+  def removals
+    @removals.is_a?(Proc) ? @removals.call : @removals
+  end
 end

data/lib/business_calendar/version.rb

@@ -1,3 +1,3 @@
 module BusinessCalendar
-  VERSION = "0.0.18"
+  VERSION = "1.0.0"
 end

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,74 @@ 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 for each call to an addition or removal' do
+      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-12-24'.to_date)
+
+      expect(a_request(:get, additions)).to have_been_made.times(4)
+      expect(a_request(:get, removals)).to have_been_made.times(3)
+    end
+
+    it 'caches holidays for 5 min' do
+      start = Time.now
+
+      allow(Time).to receive(:now) { start }
+
+      subject.is_business_day?('2014-07-04'.to_date)
+      subject.is_business_day?('2014-07-04'.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-07-04'.to_date)
+
+      expect(a_request(:get, additions)).to have_been_made.times(2)
+    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::ClientError
+      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

@@ -5,9 +5,9 @@ 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 +20,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.18
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Nubel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holidays
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-conductivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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
@@ -106,6 +148,7 @@ files:
 - ".rspec"
 - ".simplecov"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -150,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Country-aware business-date logic and handling.