in_business 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tim Rogers
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# in_business
+
+Working with business opening times is pretty hard, or at least, a lot of effort
+to write for each application. 
+
+We have awesome gems like
+[business_time](https://github.com/bokmann/business_time) which help, but there's
+a gap in the market for something that knows your hours, and can quickly tell
+you whether a particular time is open or closed concretely. As fun as crazy
+time calculations are!
+
+I've been doing quite a lot of work recently building [Twilio](http://www.twilio.com)
+apps such as my startup employer [GoCardless](https://gocardless.com)'s
+[Nodephone](https://gocardless.com/blog/data-driven-support/) where you need
+to work out if an incoming call is during office hours or not.
+
+This gem allows you to do that kind of thing with simple `.open?` and `.closed?`
+methods, and even supports holidays!
+
+*in_business* depends on Rails's [ActiveSupport](https://github.com/rails/rails/tree/master/activesupport)
+and is awesome combined with the [holidays](https://github.com/alexdunae/holidays)
+gem.
+
+## Usage
+
+```ruby
+InBusiness.open? DateTime.now # => nil (since we've not set any hours yet!)
+
+# We want to be open 9am til 6pm on a Monday
+InBusiness.hours.monday = "09:00".."18:00"
+InBusiness.open? DateTime.parse('10am Monday') # => true
+InBusiness.closed? DateTime.parse('9pm Monday') # => true
+
+# In our imaginary land, 8th July 2013 is a Monday but a public holiday, so let's add it...
+InBusiness.holidays << Date.parse('8th July 2013')
+InBusiness.hours.monday # => "09:00".."18:00"
+InBusiness.open? DateTime.parse("8th July 2013 12:00") # => false
+InBusiness.is_holiday? DateTime.parse("8th July 2013 12:00") # => true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'in_business'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install in_business`
+
+### Using with Rails
+
+Make sure that the gem is in your Gemfile and that you've `bundle install` -ed,
+then create an initializer, for example `config/initializers/in_business.rb`.
+
+In there, you'll want to set your daily hours and any holidays:
+
+```ruby
+InBusiness.hours = {
+  monday: "09:00".."18:00",
+  tuesday: "10:00".."19:00",
+  # ...
+  saturday: "09:00".."12:00"
+}
+
+InBusiness.holidays << Date.parse("25th December 2013")
+```
+
+### Using with the [holidays](https://github.com/alexdunae/holidays) gem
+
+Just do something like this, perhaps in your Rails initializer:
+
+```ruby
+Holidays.between(Date.civil(2013, 1, 1), 2.years.from_now, :gb).
+  map{|holiday| InBusiness.holidays << holiday[:date]}
+```
+
+This little technique is inspired by [business_time]([business_time](https://github.com/bokmann/business_time))'s readme!
+
+## Running specs
+
+```
+$ bundle
+$ rspec spec
+```
+
+## 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/in_business.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'in_business/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "in_business"
+  spec.version       = InBusiness::VERSION
+  spec.summary       = %Q{A gem for checking whether a given DateTime, Date or Time is within a predefined set of opening hours}
+  spec.authors       = ["Tim Rogers"]
+  spec.email         = ["tim@gocardless.com"]
+  spec.description   = %q{A gem for checking whether a given DateTime, Date or Time is within a predefined set of opening hours}
+  spec.homepage      = "https://github.com/timrogers/in_business"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", '~> 2.14.0'
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "activesupport", '~> 4.0.0'
+end

data/lib/in_business/version.rb

@@ -0,0 +1,3 @@
+module InBusiness
+  VERSION = '0.0.1'
+end

data/lib/in_business.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+require 'active_support/core_ext'
+
+module InBusiness
+
+  @holidays = []
+  @hours = OpenStruct.new
+  
+  def self.holidays
+    @holidays
+  end
+
+  def self.holidays=(array)
+    @holidays = array
+  end
+
+  def self.hours
+    @hours
+  end
+
+  def self.hours=(hash)
+    @hours = OpenStruct.new(hash)
+  end
+
+  def self.reset
+    # Used for clearing the state of InBusiness between specs
+    @holidays = []
+    @hours = OpenStruct.new
+    true
+  end
+
+  def self.open?(datetime)
+    
+    # If this is included in the list of holidays, return false
+    return false if is_holiday? datetime
+
+    # If we don't know the opening hours for datetime's day, assume we're closed
+    return false unless hours.send(days[datetime.wday.to_s].to_sym)
+
+    # We have opening hours, so check if the current time is within them
+    if !hours.send(days[datetime.wday.to_s].to_sym).include? datetime.strftime("%H:%M")
+      return false
+    end
+
+    true # It's not not open, so it must be open ;)
+  end
+
+  def self.closed?(datetime)
+    !open?(datetime)
+  end
+
+  def self.is_holiday?(date)
+    @holidays.include? date.to_date
+  end
+
+  # Maps values of [DateTime/Date/Time]#wday to English days
+  def self.days
+    {
+      "0" => "sunday",
+      "1" => "monday",
+      "2" => "tuesday",
+      "3" => "wednesday",
+      "4" => "thursday",
+      "5" => "friday",
+      "6" => "saturday"
+    }
+  end
+
+end

data/spec/in_business_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+def parse_datetime_in_london(string)
+  ActiveSupport::TimeZone["London"].parse(string)
+end
+
+describe InBusiness do
+    
+  after(:each) do
+    InBusiness.reset # Clear the settings so they can be set for this example
+  end
+
+  describe ".hours" do
+
+    it "returns an OpenStruct by default" do
+      InBusiness.hours.should be_a OpenStruct
+    end
+
+    it "can be updated from the method" do
+      InBusiness.hours.monday.should be_nil
+      InBusiness.hours.monday = "09:00".."18:00"
+      InBusiness.hours.monday.should eq "09:00".."18:00"
+    end
+
+  end
+
+  describe ".hours=" do
+    let(:monday_hours) { "09:00".."18:00" }
+    let(:options) { { monday: monday_hours } }
+
+    it "instantiates an OpenStruct with the contents of the passed hash" do
+      InBusiness.hours = options
+      InBusiness.hours.monday.should eq monday_hours
+    end
+
+  end
+
+  describe ".holidays" do
+
+    it "returns an empty array by default" do
+      InBusiness.holidays.should be_a Array
+      InBusiness.holidays.length.should eq 0
+    end
+
+    it "can be updated from the method" do
+      expect{InBusiness.holidays << Date.parse('1st January 2014')}.to change(InBusiness.holidays, :length).from(0).to(1)
+    end
+
+  end
+
+  describe ".holidays=" do
+    let(:holidays) do
+      [Date.parse('1st January 2014'), Date.parse('1st February 2014')]
+    end
+
+    it "sets the holidays array to the passed array" do
+      InBusiness.holidays = holidays
+      InBusiness.holidays.should eq holidays
+    end
+
+  end
+
+  describe ".days" do
+    it "returns a hash" do
+      InBusiness.days.should be_a Hash
+    end
+
+    it "contains mappings of weekday numbers to their English representation" do
+      InBusiness.days.fetch("1").should eq "monday"
+    end
+  end
+
+  describe ".reset" do
+
+    before do
+      InBusiness.holidays << Date.parse("1st January 2014")
+      InBusiness.hours.monday = "09:00".."23:00"
+      InBusiness.reset
+    end
+
+    it "resets .holidays to a blank array" do
+      InBusiness.holidays.should be_a Array
+      InBusiness.holidays.length.should eq 0
+    end
+
+    it "resets .hours to an empty OpenStruct" do
+      InBusiness.hours.should be_a OpenStruct
+      InBusiness.hours.marshall_dump.should be_nil
+    end
+
+  end
+
+  describe ".is_holiday?" do
+    let(:first_jan_2014) { Date.parse("1st January 2014") }
+    before { InBusiness.holidays << first_jan_2014 }
+
+    it "returns true if the provided date is a defined holiday" do
+      InBusiness.is_holiday?(first_jan_2014).should be_true
+    end
+
+    it "returns false if the provided date is not a defined holiday" do
+      InBusiness.is_holiday?(first_jan_2014 + 1.day).should be_false
+    end
+
+  end
+
+  context "with no hours set" do
+
+    describe ".open?" do
+
+      it "returns false" do
+        Timecop.freeze(DateTime.now) do
+          InBusiness.open?(DateTime.now).should be_false
+        end
+      end
+
+    end
+
+    describe ".closed?" do
+
+      it "returns true" do
+        Timecop.freeze(DateTime.now) do
+          InBusiness.closed?(DateTime.now).should be_true
+        end
+      end
+
+    end
+  end
+
+  context "with hours set" do
+    before do 
+      InBusiness.hours.monday = "09:00".."20:00"
+    end
+
+    describe ".open?" do
+
+      it "returns true for a time within the hours" do
+        Timecop.freeze(parse_datetime_in_london("8th July 2013 12:00")) do
+          InBusiness.open?(DateTime.now).should be_true
+        end
+      end
+
+      it "returns false for a time outside of the hours" do
+        Timecop.freeze(parse_datetime_in_london("8th July 2013 20:01")) do
+          InBusiness.open?(DateTime.now).should be_false
+        end
+      end
+
+      it "returns false for a day that hasn't had hours set" do
+        Timecop.freeze(parse_datetime_in_london("9th July 2013 10:00")) do
+          InBusiness.open?(DateTime.now).should be_false
+        end
+      end
+
+    end
+
+    describe ".closed?" do
+
+      it "returns false for a time within the hours" do
+        Timecop.freeze(parse_datetime_in_london("8th July 2013 19:59")) do
+          InBusiness.closed?(DateTime.now).should be_false
+        end
+      end
+
+      it "returns true for a time outside of the hours" do
+        Timecop.freeze(parse_datetime_in_london("8th July 2013 20:01")) do
+          InBusiness.closed?(DateTime.now).should be_true
+        end
+      end
+
+      it "returns true for a day that hasn't had hours set" do
+        Timecop.freeze(parse_datetime_in_london("9th July 2013 10:00")) do
+          InBusiness.closed?(DateTime.now).should be_true
+        end
+      end
+
+    end
+
+  end
+
+  context "with holidays set" do
+
+    before do
+      InBusiness.holidays << Date.parse("8th July 2013")
+      InBusiness.holidays << Date.parse("1st January 2014")
+      InBusiness.hours.tuesday = "09:00".."11:00"
+    end
+
+    describe ".open?" do
+
+      it "returns false if the passed date is one of the holidays" do
+        Timecop.freeze(parse_datetime_in_london("8th July 2013 12:00")) do
+          InBusiness.open?(DateTime.now).should be_false
+        end
+      end
+
+      it "returns true if the passed date is not one of the holidays" do
+        Timecop.freeze(parse_datetime_in_london("9th July 2013 10:01")) do
+          InBusiness.open?(DateTime.now).should be_true
+        end
+      end
+
+    end
+
+    describe ".closed?" do
+
+      it "returns true if the passed date is one of the holidays" do
+        Timecop.freeze(parse_datetime_in_london("1st January 2014 00:00")) do
+          InBusiness.closed?(DateTime.now).should be_true
+        end
+      end
+
+      it "returns false if the passed date is not one of the holidays" do
+        Timecop.freeze(parse_datetime_in_london("9th July 2013 10:01")) do
+          InBusiness.closed?(DateTime.now).should be_false
+        end
+      end
+
+    end
+
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+require 'timecop'
+require 'in_business'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: in_business
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: A gem for checking whether a given DateTime, Date or Time is within a
+  predefined set of opening hours
+email:
+- tim@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- in_business.gemspec
+- lib/in_business.rb
+- lib/in_business/version.rb
+- spec/in_business_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/timrogers/in_business
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A gem for checking whether a given DateTime, Date or Time is within a predefined
+  set of opening hours
+test_files:
+- spec/in_business_spec.rb
+- spec/spec_helper.rb