relish-billing 0.0.3

data/lib/relish/billing/testing_helper.rb

@@ -0,0 +1,27 @@
+require 'securerandom'
+module Relish
+  module Billing
+    module TestingHelper
+
+      # We need this because it isn't easy to reset test data when integrating with billing service providers
+      def unique_profile_id
+        "test-user-#{SecureRandom.urlsafe_base64}"
+      end
+
+      def create_user_profile(attributes = {})
+        default_attributes = {
+          email: "test@email.com", 
+          id: unique_profile_id,
+          plan: "pro",
+          trial_end_date: Date.today + 3,
+        }
+        UserProfile.new(default_attributes.merge(attributes))
+      end
+
+      def fixture(key)
+        driver.fixtures.fetch key
+      end
+
+    end
+  end
+end

data/lib/relish/billing/version.rb

@@ -0,0 +1,5 @@
+module Relish
+  module Billing
+    VERSION = "0.0.3"
+  end
+end

data/relish-billing.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "relish/billing/version"
+
+Gem::Specification.new do |s|
+  s.name        = "relish-billing"
+  s.version     = Relish::Billing::VERSION
+  s.authors     = ["Matt Wynne"]
+  s.email       = ["matt@mattwynne.net"]
+  s.homepage    = ""
+  s.summary     = %q{Billing service for Relish}
+  s.description = %q{Handles billing}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.test_files    << 'Guardfile'
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "guard-cucumber"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-fsevent", "~> 0.9.1"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "capybara-webkit"
+  s.add_development_dependency "headless"
+  s.add_dependency "recurly", "~> 2.11.3"
+  # s.add_runtime_dependency "rest-client"
+end

data/script/ci

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+echo
+echo '##'
+echo '## Setting up Ruby environment'
+echo '##'
+
+source ~/.rvm/scripts/rvm
+source .rvmrc
+bundle check || bundle install
+
+echo
+echo '##'
+echo '## Running tests' 
+echo '##'
+bundle exec rake
+HEADLESS=1 HIT_THE_WEB=1 bundle exec rake
+

data/spec/relish/billing/fake_driver_spec.rb

@@ -0,0 +1,15 @@
+require_relative "../../../lib/relish/billing/fake_driver"
+require_relative "../../../lib/relish/billing/testing_helper"
+require "support/driver_examples"
+
+module Relish
+  module Billing
+    describe FakeDriver do
+      include TestingHelper
+
+      it_should_behave_like "a driver"
+      let(:driver)  { FakeDriver.new }
+      let(:profile) { create_user_profile }
+    end
+  end
+end

data/spec/relish/billing/recurly_api_driver_spec.rb

@@ -0,0 +1,66 @@
+require_relative "../../../lib/relish/billing/recurly_api_driver"
+require_relative "../../../lib/relish/billing/testing_helper"
+require "support/driver_examples"
+require "date"
+
+Relish::Billing::RecurlyApiDriver.configure do |config|
+  config.environment = :test
+end
+
+module Relish
+  module Billing
+    describe RecurlyApiDriver do
+      include TestingHelper
+
+      it_should_behave_like "a driver"
+      let(:driver)  { RecurlyApiDriver.new }
+      let(:profile) { create_user_profile  }
+
+      before do
+        pending("set HIT_THE_WEB=1 to run this spec") unless ENV['HIT_THE_WEB']
+      end
+
+      let(:card)    { driver.fixtures.fetch :valid_credit_card }
+
+      describe "#account_status" do
+        context "an account with a subscription" do
+          before do
+            driver.save_card profile, card
+          end
+
+          let(:account_status) { driver.account_status profile }
+
+          it "returns the next billing date" do
+            account_status.next_billing_date.should == profile.trial_end_date
+          end
+
+          context "when the subscription has been cancelled" do
+            before do
+              driver.cancel_subscription profile
+            end
+
+            it "should be non renewing" do
+              account_status.should be_non_renewing
+            end
+          end
+        end
+      end
+
+      describe "#set_plan" do
+        context "an account with a subscription" do
+          before do
+            driver.save_card profile, card
+          end
+
+          context "when the plan code is invalid" do
+            it "raises an error" do
+              new_profile = profile.with_plan('so such plan')
+              expect { driver.set_plan new_profile }.to raise_error(InvalidPlanError)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/relish/billing/user_profile_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../../../lib/relish/billing/entities'
+
+module Relish
+  module Billing
+    describe UserProfile do
+      describe "calculating a realistic trial end date" do
+        let(:profile) { UserProfile.new(email: '', id: '', plan: '', trial_end_date: trial_end_date) }
+
+        context "with a trial end date that has passed" do
+          let(:trial_end_date) { Date.today - 45 }
+
+          it "returns today's date" do
+            profile.trial_end_date.should == Date.today
+          end
+        end
+
+        context "with a trial end date tomorrow" do
+          let(:trial_end_date) { Date.today + 1 }
+
+          it "returns today's date" do
+            profile.trial_end_date.should == trial_end_date
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/support/driver_examples.rb

@@ -0,0 +1,169 @@
+module Relish
+  module Billing
+
+    shared_examples_for "a driver" do
+      def status
+        driver.account_status(profile)
+      end
+
+      it "clears test data" do
+        driver.set_plan profile
+        driver.save_card profile, fixture(:valid_credit_card)
+        driver.account_status(profile).should be_active
+        driver.clear_test_data
+        driver.account_status(profile).should_not be_active
+      end
+
+      describe "#fixtures" do
+        expected_keys = [:valid_credit_card, :invalid_credit_card, :other_valid_credit_card]
+        it "returns a hash containing the keys #{expected_keys}" do
+          driver.fixtures.keys.should =~ expected_keys 
+        end
+      end
+
+      describe "setting a plan" do
+
+        context "when there is no account" do
+          it "just ignores you" do
+            expect { driver.set_plan(profile) }.not_to raise_error
+          end
+        end
+
+        context "when the plan has already been set" do
+          let(:new_plan) { 'free' }
+
+          before do
+            driver.save_card(profile, fixture(:valid_credit_card))
+            new_plan.should_not == profile.plan
+          end
+
+          it "changes the plan" do
+            new_profile = profile.with_plan(new_plan)
+            driver.set_plan(new_profile)
+            status.plan_id.should == new_plan
+          end
+
+          it "returns self" do
+            driver.set_plan(profile).should == driver
+          end
+        end
+
+      end
+
+      describe "saving a card" do
+        context "for an invalid card" do
+          let(:card) { fixture(:invalid_credit_card) }
+
+          it "raises an error" do
+            expect { 
+              driver.save_card profile, card 
+            }.to raise_error(CardDeclinedError)
+          end
+        end
+
+        context "when there is no account" do
+          let(:card) { fixture(:valid_credit_card) }
+          before { driver.save_card profile, card }
+
+          it "creates the account with the correct attributes" do
+            status.card_details.last_four.should == card.number[-4..-1]
+            status.next_billing_date.should == profile.trial_end_date
+          end
+        end
+
+        context "for an existing account" do
+          before do
+            original_card = fixture(:other_valid_credit_card)
+            driver.save_card profile, original_card
+          end
+
+          it "saves the card details" do
+            new_card = fixture(:valid_credit_card)
+            driver.save_card(profile, new_card)
+            status.card_details.last_four.should == new_card.number[-4..-1]
+          end
+        end
+
+        context "when payment is overdue" do
+          let(:profile) { create_user_profile(trial_end_date: Date.today - 45) }
+
+          it "bills the customer immediately, and sets the next billing date to one month from now" do
+            status.next_billing_date.should == Date.today
+            driver.save_card profile, fixture(:valid_credit_card)
+            status.next_billing_date.should == Date.today.next_month
+          end
+
+        end
+
+      end
+
+      describe "cancelling an account" do
+        context "an existing account with a subscription" do
+          before { driver.save_card profile, fixture(:valid_credit_card) }
+
+          it "returns self" do
+            driver.cancel_subscription(profile).should == driver
+          end
+        end
+
+        context "an account with no subscription" do
+          it "doesn't fail" do
+            expect { driver.cancel_subscription(profile) }.not_to raise_error
+          end
+        end
+      end
+
+      describe "fetching account status" do
+
+        context "when there is no account" do
+          it "has blank card details" do
+            card = status.card_details
+            card.number.should == ''
+            card.first_name.should == ''
+            card.last_name.should == ''
+            card.expiry_month.should == ''
+            card.expiry_year.should == ''
+            card.cvv.should == ''
+          end
+
+          it "is inactive" do
+            status.should_not be_active
+          end
+
+          it "takes the next billing date from the profile" do
+            status.next_billing_date.should == profile.trial_end_date
+          end
+        end
+
+        context "an exsting account" do
+          before do
+            driver.set_plan(profile)
+            driver.save_card(profile, card_details)
+          end
+
+          # we use the 'other card' fixture here as it has a unique last four digits, which we need for one of the specs
+          let(:card_details) { fixture :other_valid_credit_card }
+
+          it "returns an account status" do
+            status.should be_instance_of(AccountStatus)
+          end
+
+          it "returns the correct plan id" do
+            status.plan_id.should == profile.plan
+          end
+
+          it "is active" do
+            status.should be_active
+          end
+
+          it "uses the correct last four digits in the masked card details" do
+            expected = card_details.number[-4..-1]
+            actual = status.card_details.last_four
+            expected.should == actual
+          end
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: relish-billing
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Matt Wynne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: guard-cucumber
+  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: guard-rspec
+  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: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: capybara-webkit
+  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: headless
+  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: recurly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+description: Handles billing
+email:
+- matt@mattwynne.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- features/cancel_subscription.feature
+- features/create_new_account.feature
+- features/see_account_status.feature
+- features/step_definitions/steps.rb
+- features/support/dsl.rb
+- features/support/headless.rb
+- features/support/recurly.rb
+- features/update_card_details.feature
+- features/upgrade_account.feature
+- lib/relish/billing.rb
+- lib/relish/billing/account.rb
+- lib/relish/billing/entities.rb
+- lib/relish/billing/fake_driver.rb
+- lib/relish/billing/recurly_api_driver.rb
+- lib/relish/billing/testing_helper.rb
+- lib/relish/billing/version.rb
+- relish-billing.gemspec
+- script/ci
+- spec/relish/billing/fake_driver_spec.rb
+- spec/relish/billing/recurly_api_driver_spec.rb
+- spec/relish/billing/user_profile_spec.rb
+- spec/support/driver_examples.rb
+homepage: ''
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Billing service for Relish
+test_files:
+- features/cancel_subscription.feature
+- features/create_new_account.feature
+- features/see_account_status.feature
+- features/step_definitions/steps.rb
+- features/support/dsl.rb
+- features/support/headless.rb
+- features/support/recurly.rb
+- features/update_card_details.feature
+- features/upgrade_account.feature
+- spec/relish/billing/fake_driver_spec.rb
+- spec/relish/billing/recurly_api_driver_spec.rb
+- spec/relish/billing/user_profile_spec.rb
+- spec/support/driver_examples.rb
+- Guardfile