bank_holiday 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14ac3023c2436c0fe22f8bf457a15141239f8897
-  data.tar.gz: bc44a421a9e7fb3d856cc80543a64d6e68f1d177
+  metadata.gz: f245723987a458fd500cd99489e01b095aaf3feb
+  data.tar.gz: c561996d16660e1b8a66e618762f0ad50fe8d4a2
 SHA512:
-  metadata.gz: bc6114cdcbf20e347e606aafd9d8b98eada00db39e5693f6a8e9bb7ca88a306bc518d4e33ab06e9fa23b5efc213d3e1cfec0b702f1bda9dc76af384d4ccb7858
-  data.tar.gz: e08e42a645b763213aa7b0fbf209780f24d07a0e5a76f46e0c6b35c3e89c0707394a55a78c1532a6f477370d9fd757db8ab3ea629b653a3ff6d83882ba4606ef
+  metadata.gz: 12726d60eb0112188afb6607e26d1956fddf4fa1ebece7a83159e6743edc2a529092f7a337b84ec6728a82501656b4d914dd103158dcce63b3519a159de7034d
+  data.tar.gz: a1834b836cb5f6b034cbf29fa1d95a0130cb826d34f93b424a38836dbb65adfb516edd847507788ad33d054de02dad4b0ffc9579989c949f3b71f54404603030

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,87 @@
+# Bank Holiday
+
+Retrieve UK bank holidays in a nice format and includes handy Rails helpers for dates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "bank_holiday"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bank_holiday
+
+## Usage
+
+### Helpers
+
+If you want to see if a date is a bank holiday then simply use;
+
+    date = Date.today
+    => Thu, 17 Jul 2014
+    
+    date.bank_holiday?
+    => false
+    
+    date = Date.parse("25/08/2014")
+    => Mon, 25 Aug 2014
+    
+    date.bank_holiday?
+    => true
+    
+### Accessing Holidays
+
+To return all bank holidays
+
+    bank_holidays = BankHoliday.all
+
+This uses the Dish gem to allow easy access to the objects;
+
+    bank_holidays.first.title
+    => "New Year’s Day"
+     
+    bank_holiday.first.date
+    => "2012-01-02"
+      
+    bank_holiday.first.notes
+    => "Substitute day"
+    
+    bank_holiday.first.bunting
+    => true
+    
+There is also some other helpful methods;
+
+    after_date = BankHoliday.after(Date.today)
+    => [#<Dish::Plate:0x007f831e886c80 @_original_hash={"title"=>"Summer bank holiday", "date"=>"2014-08-25", "notes"=>"", "bunting"=>true}>, #<Dish::Plate:0x007f831e886aa0 @_original_hash={"title"=>"Christmas Day", "date"=>"2014-12-25", "notes"=>"", "bunting"=>true}>, #<Dish::Plate:0x007f831e8868c0 @_original_hash={"title"=>"Boxing Day", "date"=>"2014-12-26", "notes"=>"", "bunting"=>true}>...]
+    
+    before_date = BankHoliday.before(1.month.ago)
+    => [#<Dish::Plate:0x007f831e855630 @_original_hash={"title"=>"New Year’s Day", "date"=>"2012-01-02", "notes"=>"Substitute day", "bunting"=>true}>, #<Dish::Plate:0x007f831e855450 @_original_hash={"title"=>"Good Friday", "date"=>"2012-04-06", "notes"=>"", "bunting"=>false}>, #<Dish::Plate:0x007f831e855270 @_original_hash={"title"=>"Easter Monday", "date"=>"2012-04-09", "notes"=>"", "bunting"=>true}>...]
+    
+    next = BankHoliday.next
+    => #<Dish::Plate:0x007f831e886c80 @_original_hash={"title"=>"Summer bank holiday", "date"=>"2014-08-25", "notes"=>"", "bunting"=>true}>
+    
+    last = BankHoliday.last
+    => #<Dish::Plate:0x007f831e886e60 @_original_hash={"title"=>"Spring bank holiday", "date"=>"2014-05-26", "notes"=>"", "bunting"=>true}>
+    
+    future = BankHoliday.future
+    => [#<Dish::Plate:0x007f831e886c80 @_original_hash={"title"=>"Summer bank holiday", "date"=>"2014-08-25", "notes"=>"", "bunting"=>true}>, #<Dish::Plate:0x007f831e886aa0 @_original_hash={"title"=>"Christmas Day", "date"=>"2014-12-25", "notes"=>"", "bunting"=>true}>, #<Dish::Plate:0x007f831e8868c0 @_original_hash={"title"=>"Boxing Day", "date"=>"2014-12-26", "notes"=>"", "bunting"=>true}>...]
+    
+    past = BankHoliday.past
+    => [#<Dish::Plate:0x007f831e855630 @_original_hash={"title"=>"New Year’s Day", "date"=>"2012-01-02", "notes"=>"Substitute day", "bunting"=>true}>, #<Dish::Plate:0x007f831e855450 @_original_hash={"title"=>"Good Friday", "date"=>"2012-04-06", "notes"=>"", "bunting"=>false}>, #<Dish::Plate:0x007f831e855270 @_original_hash={"title"=>"Easter Monday", "date"=>"2012-04-09", "notes"=>"", "bunting"=>true}>...]
+    
+## Future
+
+I would like to add other options/features to this and would welcome any improvements or changes.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bank_holiday.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bank_holiday/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'bank_holiday'
+  s.version     = BankHoliday::VERSION
+  s.date        = '2014-07-25'
+  s.summary     = "Finding bank holidays including helpers for dates."
+  s.description = "Finding bank holidays including helpers for dates."
+  s.authors     = ["Craig Sheen"]
+  s.email       = 'craig_sheen@hotmail.com'
+  s.files       = ["lib/bank_holiday.rb"]
+  s.homepage    = 'https://github.com/craigsheen/bank_holiday'
+  s.license     = 'MIT'
+  
+  s.add_dependency 'dish'
+  s.require_paths = ["lib", "lib/bank_holiday"]
+  s.files         = `git ls-files`.split($/)
+end

data/lib/bank_holiday/bank_holiday.rb

@@ -0,0 +1,54 @@
+require 'dish/ext'
+
+module BankHoliday
+
+  URL = "https://www.gov.uk/bank-holidays.json"
+
+  def self.all
+    uri = URI.parse(URL)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new(uri.request_uri)
+    response = http.request(request)
+    bank_holidays = response.body
+    return Dish(JSON.parse(bank_holidays)["england-and-wales"]["events"])
+  end
+  
+  def self.after(date)
+    @bank_holidays||=all
+    @bank_holidays.reject{ |h| Date.parse(h.date) <= date }
+  end
+  
+  def self.before(date)
+    @bank_holidays||=all
+    @bank_holidays.reject{ |h| Date.parse(h.date) >= date }
+  end
+  
+  def self.next
+    future.first
+  end
+  
+  def self.last
+    past.last
+  end
+  
+  def self.future
+    @bank_holidays||=all
+    @bank_holidays.reject{ |h| Date.parse(h.date) <= Date.today }
+  end
+  
+  def self.past
+    @bank_holidays||=all
+    @bank_holidays.reject{ |h| Date.parse(h.date) >= Date.today }
+  end
+
+  def self.bank_holiday?(date)
+    @bank_holidays||=all
+    if @bank_holidays.collect {|holiday| holiday.date}.include?(date.strftime("%Y-%m-%d"))
+      return true
+    else
+      return false
+    end
+  end
+
+end

data/lib/bank_holiday/date.rb

@@ -0,0 +1,8 @@
+require 'bank_holiday'
+class Date
+    
+  def bank_holiday?
+    BankHoliday.bank_holiday?(self)
+  end
+    
+end

data/lib/bank_holiday/version.rb

@@ -0,0 +1,3 @@
+module BankHoliday
+  VERSION = "0.0.3"
+end

data/lib/bank_holiday.rb

@@ -1,4 +1,8 @@
 require 'net/http'
-require "dish/ext"
+require 'dish/ext'
 require 'bank_holiday/date'
-require 'bank_holiday/bank_holiday'
+require 'bank_holiday/bank_holiday'
+
+module BankHoliday
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bank_holiday
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Craig Sheen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dish
@@ -30,8 +30,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- bank_holiday.gemspec
 - lib/bank_holiday.rb
-homepage: ''
+- lib/bank_holiday/bank_holiday.rb
+- lib/bank_holiday/date.rb
+- lib/bank_holiday/version.rb
+homepage: https://github.com/craigsheen/bank_holiday
 licenses:
 - MIT
 metadata: {}
@@ -39,6 +45,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/bank_holiday
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='