billing_cycle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de1567f4fc4e2813c2e8a24d7c38d4972de4dd92
+  data.tar.gz: e433e801af93c75c6d5dc056d9af3d34c236a0b3
+SHA512:
+  metadata.gz: 0cb00109a6b6d23b477aa8c5b6b4c3304f8c39441bf42939f17624ab3e47300cb076727d7996dc44083f4596ae6487863016f2b0f3f5581dbd904d511c2b1878
+  data.tar.gz: 7cf9c934466b6d9c4092f87f8f3af6aa60b18817786529f86599371b749991ccaf36717ebf68474f28ffafed8eb12f112d4a46e2e5173e6a4afc0415e364972b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Brian Pattison
+
+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,71 @@
+# Billing Cycle
+
+[![Build Status](https://travis-ci.org/simplymadeapps/billing_cycle.svg?branch=master)](https://travis-ci.org/simplymadeapps/billing_cycle)
+[![Code Climate](https://codeclimate.com/github/simplymadeapps/billing_cycle/badges/gpa.svg)](https://codeclimate.com/github/simplymadeapps/billing_cycle)
+[![Test Coverage](https://codeclimate.com/github/simplymadeapps/billing_cycle/badges/coverage.svg)](https://codeclimate.com/github/simplymadeapps/billing_cycle/coverage)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/simplymadeapps/billing_cycle/)
+
+Billing Cycle is a gem used to calculate the next billing date for a recurring subscription.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "billing_cycle"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+```ruby
+original_billing_date = Time.zone.parse("2018-01-31 00:00:00")
+billing_interval = 1.month
+billing_cycle = BillingCycle::BillingCycle.new(original_billing_date, billing_interval)
+
+Time.zone.now
+# => Tue, 26 Jun 2018 00:00:00 CDT -05:00
+
+billing_cycle.next_due_at
+# => Sat, 30 Jun 2018 00:00:00 CDT -05:00
+
+billing_cycle.next_due_at(Time.zone.parse("2020-02-01 00:00:00")
+# => Sat, 29 Feb 2020 00:00:00 CST -06:00
+
+billing_cycle.previous_due_at
+# => Thu, 31 May 2018 00:00:00 CDT -05:00
+
+billing_cycle.previous_due_at(Time.zone.parse("2020-02-01 00:00:00")
+# => Fri, 31 Jan 2020 00:00:00 CST -06:00
+```
+
+If the original billing date is in the future, the `next_due_at` will always be the
+original billing date, and the `previous_due_at` will be `nil`.
+
+```ruby
+original_billing_date = Time.zone.parse("9999-12-31 00:00:00")
+billing_interval = 1.month
+billing_cycle = BillingCycle::BillingCycle.new(original_billing_date, billing_interval)
+
+billing_cycle.next_due_at
+# => Fri, 31 Dec 9999 00:00:00 CST -06:00
+
+billing_cycle.previous_due_at
+# => nil
+```
+
+## 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
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts "Could not load Rspec Rake task"
+end

data/lib/billing_cycle.rb

@@ -0,0 +1,5 @@
+require "active_support"
+require "active_support/core_ext/integer"
+require "active_support/time_with_zone"
+require_relative "./billing_cycle/billing_cycle"
+require_relative "./billing_cycle/version"

data/lib/billing_cycle/billing_cycle.rb

@@ -0,0 +1,94 @@
+require "active_support"
+require "active_support/core_ext/integer"
+require "active_support/time_with_zone"
+
+module BillingCycle
+  # Utility class for calculating the next billing date for a subscription.
+  class BillingCycle
+    attr_accessor :created_at, :interval
+
+    # Initialize a billing cycle.
+    # @param created_at [Time] The date/time the subscription was created
+    # @param interval [ActiveSupport::Duration] The interval the subscription is paid
+    def initialize(created_at, interval)
+      @created_at = created_at
+      @interval = interval
+    end
+
+    # Returns the next billing date based on the subscription
+    # @param now [Time] The current time
+    # @return [Time] The next billing date/time
+    def next_due_at(now = Time.zone.now)
+      # The next billing date is always the original date if "now" is earlier than the original date
+      return created_at if now <= created_at
+
+      number_of_cycles = number_of_cycles_since_created(now)
+      next_due_at = calculate_due_at(number_of_cycles)
+
+      # The number of cycles since the billing cycle was created only gets us to "now"
+      # so we need probably need to add another cycle to get the next billing date.
+      while next_due_at < now
+        number_of_cycles += interval_value
+        next_due_at = calculate_due_at(number_of_cycles)
+      end
+
+      next_due_at
+    end
+
+    # Returns the previous billing date based on the subscription
+    # @param now [Time] The current time
+    # @return [Time] The previous billing date/time
+    def previous_due_at(now = Time.zone.now)
+      # There was no previous billing date before the original billing date
+      return nil if now <= created_at
+
+      number_of_cycles = number_of_cycles_since_created(now) + interval_value
+      previous_due_at = calculate_due_at(number_of_cycles)
+
+      # The number of cycles since the billing cycle was created gets us to "now",
+      # and if now matches a billing date exactly, we want the previous billing date.
+      while previous_due_at >= now
+        number_of_cycles -= interval_value
+        previous_due_at = calculate_due_at(number_of_cycles)
+      end
+
+      previous_due_at
+    end
+
+    private
+
+    # Calculate the due date based on number of billing cycles since
+    # or before the date/time the subscription was created.
+    # @param number_of_cycles [Integer]
+    # @return [Time]
+    def calculate_due_at(number_of_cycles)
+      number_of_cycles.send(interval_units).from_now(created_at)
+    end
+
+    # Returns the number from the interval's duration.
+    # @return [Integer] `6` for a duration of `6.months`
+    def interval_value
+      if interval.parts.is_a? Array
+        interval.parts[0][1]
+      else
+        interval.parts.values[0]
+      end
+    end
+
+    # Returns the interval type from the interval's duration.
+    # @return [Symbol] `:month` for a duration of `1.month`
+    def interval_units
+      if interval.parts.is_a? Array
+        interval.parts[0][0]
+      else
+        interval.parts.keys[0]
+      end
+    end
+
+    # Returns the number billing cycles that have occurred between the created date and "now".
+    # @return [Integer]
+    def number_of_cycles_since_created(now)
+      (interval_value * ((now - created_at).to_i / interval)).to_i
+    end
+  end
+end

data/lib/billing_cycle/version.rb

@@ -0,0 +1,3 @@
+module BillingCycle
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: billing_cycle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Pattison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: codeclimate-test-reporter
+  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: rainbow
+  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: rspec-rails
+  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: rubocop
+  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
+    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-rcov
+  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'
+description: Billing Cycle is a gem used to calculate the next billing date for a
+  recurring subscription.
+email:
+- brian@brianpattison.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/billing_cycle.rb
+- lib/billing_cycle/billing_cycle.rb
+- lib/billing_cycle/version.rb
+homepage: https://github.com/simplymadeapps/billing_cycle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Utility for calculating the next billing date for a recurring subscription.
+test_files: []