relish-billing 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1b1be88caf4798b4983d474584b4f2dd15fd303
+  data.tar.gz: e186dd758c0ace91a9cc75110d4b14805b432eff
+SHA512:
+  metadata.gz: fce9f8fd37a1af4a808f3d0a4b8302b12f8c385c431ba21f66b9957327faa2a33cd803a93a075ec8bc924acbd0d71a900dcb2afebf647fd0625618c8c67e9b5f
+  data.tar.gz: 9e71a693e922b5a0f491fdafdf276765cd3d4f66053b314c2ab5a14925885125026a57811c57d1c9fa848be1aad291adf95a8ae4e443492bd56b8b46322f9547

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.sw*
+cucumber.yml
+tags
+rerun.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p194@relish-billing --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in relish-billing.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'cucumber', cli: '--format pretty' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/.+\.rb$}) { 'features' }
+end
+
+guard 'rspec', version: 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})    { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,14 @@
+# Relish Billing
+
+This gem provides the billing subsystem to the main Relish application.
+
+See the features directory for details.
+
+# Some notes on SagePay's API
+
+Recurly uses SagePage on the back-end. Their API has the following mandatory fields:
+- address line 1
+- address city
+- address state (for US address)
+
+However, I can disable address checking via the admin interface, then just send dummy values for these fields.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => ['rspec', 'cucumber', 'ctags']
+
+task(:rspec) { sh 'rspec' }
+task(:cucumber) { sh 'cucumber --format progress -t ~@todo' }
+task(:ctags) { sh 'ctags -R' }

data/features/cancel_subscription.feature

@@ -0,0 +1,8 @@
+Feature: Cancel subscription
+
+  The customer no longer wishes to use Relish, so cancels their subscription
+
+  Scenario: Publisher decides to cancel their subscription
+    Given I have started a paid subscription on the pro plan
+    When I choose to cancel the subscription
+    Then I should see a confirmation message that my subscription has been cancelled

data/features/create_new_account.feature

@@ -0,0 +1,17 @@
+Feature: Create new billing account
+
+  As part of the sign-up process, once we've created their user or organization profile,
+  we need to create a billing account if they've opted for a paid plan.
+
+  Scenario: Create a billing account with a free trial
+    Given I have an account on the free plan
+    When I choose a paid plan, entering valid card details
+    Then I should see that my plan has been set
+    And I should see that my card details have been saved
+
+  Scenario: Try to create a billing account with a duff card
+    Given I have an account on the free plan
+    When I choose a paid plan, entering invalid card details
+    Then I should see that my plan has been set
+    And I should see that my card details were invalid
+

data/features/see_account_status.feature

@@ -0,0 +1,43 @@
+Feature: See account status
+
+  When the user goes to their 'my account' page, they'll expect to be able to
+  see details like:
+
+    * what plan they're currently on
+    * next billing date
+    * some details of current card
+    * messaging if they've cancelled their account or their card has become invalid
+
+  We let you sign up and choose your plan without forcing you to enter credit card details.
+
+  You can then go and set them from the account page.
+
+  Scenario: New subscriber sees they need to enter credit card details
+    Given I have started a paid subscription
+    When I view my account status
+    Then I should see that my account is not active
+    When I enter a valid credit card
+    Then I should see that my card details have been saved
+    When I view my account status
+    And I should see that my account is active
+
+  Scenario: Existing subscriber sees their billing details
+    Given I have started a paid subscription on the pro plan
+    And I have entered a valid credit card
+    When I view my account status
+    Then I should see that I am on the pro plan
+    And I should see that my account is active
+    And I should see my masked card number
+    And I should see my next billing date
+
+  Scenario: Free plan user sees account status
+    Given I have an account on the free plan
+    When I view my account status
+    Then I should see that my account is not active
+
+  Scenario: Subscriber who has cancelled can access their details until the end of their billing cycle
+    Given I have started a paid subscription
+    And I have entered a valid credit card
+    When I choose to cancel the subscription
+    And I view my account status
+    Then I should be told that my account will not be renewed at the next billing date

data/features/step_definitions/steps.rb

@@ -0,0 +1,89 @@
+Given /^I have an account on the free plan$/ do
+  create_user plan: 'free'
+end
+
+When /^I choose a paid plan, entering valid card details$/ do
+  choose_plan 'pro'
+  save_card valid_credit_card
+end
+
+When /^I choose a paid plan, entering invalid card details$/ do
+  choose_plan 'pro'
+  save_card invalid_credit_card
+end
+
+Given /^I have started a paid subscription(?: on the pro plan)?$/ do
+  create_user plan: 'pro'
+end
+
+Given /^I (?:enter|have entered) a valid credit card$/ do
+  save_card valid_credit_card
+end
+
+When /^I try to change to an invalid card$/ do
+  save_card invalid_credit_card
+end
+
+When /^I (?:choose|change to) the starter plan$/ do
+  choose_plan 'starter'
+end
+
+Then /^I should now be on the starter plan$/ do
+  current_plan.should == 'starter'
+end
+
+When /^I choose to update which card is billed$/ do
+  save_card other_valid_credit_card
+end
+
+When /^I (?:choose|have chosen) to cancel the subscription$/ do
+  cancel_subscription
+end
+
+When /^I view my account status$/ do
+  view_account_status
+end
+
+Then /^I should see that I am on the (\w+) plan$/ do |plan_id|
+  account_status.plan_id.should == plan_id
+end
+
+Then /^I should see that my account is not active$/ do
+  account_status.should_not be_active
+end
+
+And /^I should see that my account is active$/ do
+  account_status.should be_active
+end
+
+Then /^I should see my masked card number$/ do
+  account_status.card_details.last_four.should == current_card.number[12..-1]
+end
+
+Then /^I should see my next billing date$/ do
+  account_status.next_billing_date.should_not be_nil
+end
+
+Then /^I should be told that my account will not be renewed at the next billing date$/ do
+  account_status.should be_non_renewing
+end
+
+Then /^I should see that my plan has been set$/ do
+  ui.shows(:plan_set)
+end
+
+Then /^I should see that my card details have been saved$/ do
+  ui.shows(:card_saved)
+end
+
+Then /^I should see that my card has been delined$/ do
+  ui.shows(:transaction_declined)
+end
+
+Then /^I should see a confirmation message that my subscription has been cancelled$/ do
+  ui.shows(:subscription_cancelled)
+end
+
+Then /^I should see that my card details were invalid$/ do
+  ui.shows(:transaction_declined)
+end

data/features/support/dsl.rb

@@ -0,0 +1,113 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../../lib')
+require 'relish/billing'
+require 'relish/billing/testing_helper'
+require 'securerandom'
+module Relish
+  module Billing
+
+    module AcceptanceTestDsl
+
+      include TestingHelper
+
+      def valid_credit_card
+        fixture :valid_credit_card
+      end
+
+      def invalid_credit_card
+        fixture :invalid_credit_card
+      end
+
+      def other_valid_credit_card
+        fixture :other_valid_credit_card
+      end
+
+      def choose_plan(plan_id)
+        change_users_plan_to(plan_id)
+      end
+
+      def current_plan
+        view_account_status
+        account_status.plan_id
+      end
+
+      def cancel_subscription
+        account.cancel ui
+      end
+
+      attr_reader :current_card
+      def save_card(card)
+        account.save_card card, ui
+        @current_card = card
+      end
+
+      attr_reader :account_status
+      def view_account_status
+        @account_status = account.status
+      end
+
+      def ui
+        @ui ||= FakeUI.new
+      end
+
+      private
+
+      def account
+        Account.new(user_profile, driver)
+      end
+
+      def create_user(attributes)
+        @user_profile = create_user_profile(attributes)
+      end
+
+      def user_profile
+        @user_profile || raise("No user profile defined")
+      end
+
+      def change_users_plan_to(new_plan)
+        @user_profile = user_profile.with_plan(new_plan)
+        account.plan_changed ui
+      end
+
+      def driver
+        @driver ||= Billing.driver
+      end
+
+      class FakeUI
+        attr_reader :status
+
+        def method_missing(message, *args)
+          return super unless in_protocol?(message)
+          messages << message
+        end
+
+        def shows(message)
+          return if messages.include?(message)
+          raise RSpec::Expectations::ExpectationNotMetError, "The expected message #{message.inspect} is not one of #{messages.inspect}"
+        end
+
+        private
+
+        def messages
+          @messages ||= []
+        end
+
+        def in_protocol?(message)
+          [
+            :plan_set,
+            :card_saved,
+            :transaction_declined,
+            :subscription_cancelled,
+          ].include?(message)
+        end
+      end
+
+    end
+
+  end
+end
+
+World(Relish::Billing::AcceptanceTestDsl)
+
+Relish::Billing.configure do |config|
+  config.driver = :recurly if ENV['HIT_THE_WEB']
+end

data/features/support/headless.rb

@@ -0,0 +1,11 @@
+if ENV['HEADLESS'] == 'true'
+  require 'headless'
+
+  headless = Headless.new
+  headless.start
+
+  at_exit do
+    headless.destroy
+  end
+end
+

data/features/support/recurly.rb

@@ -0,0 +1,3 @@
+Relish::Billing::RecurlyApiDriver.configure do |config|
+  config.environment = :test
+end

data/features/update_card_details.feature

@@ -0,0 +1,15 @@
+Feature: Update card details
+
+  Need to be able to update my card, e.g. if I decide
+  to use a different one for billing.
+  
+  Background:
+    Given I have started a paid subscription on the pro plan
+
+  Scenario: Update card details successfully
+    When I choose to update which card is billed
+    Then I should see that my card details have been saved
+
+  Scenario: Use a bad card
+    When I try to change to an invalid card
+    Then I should see that my card has been declined

data/features/upgrade_account.feature

@@ -0,0 +1,10 @@
+Feature: Upgrading an account
+
+  The existing publisher is so happy with the service that they decide to upgrade
+
+  Scenario: Publisher upgrades from a paid plan to a better paid plan
+    Given I have started a paid subscription on the pro plan
+    And I have entered a valid credit card
+    When I change to the starter plan
+    Then I should see that my plan has been set
+    And I should now be on the starter plan

data/lib/relish/billing.rb

@@ -0,0 +1,38 @@
+require "relish/billing/version"
+require "relish/billing/account"
+require 'relish/billing/recurly_api_driver'
+require 'relish/billing/fake_driver'
+
+module Relish
+  module Billing
+    class << self
+      def account_for(user_profile)
+        Account.new(user_profile, driver)
+      end
+
+      def configure
+        yield config
+      end
+
+      def driver
+        @driver ||= {
+          fake:    FakeDriver,
+          recurly: RecurlyApiDriver
+        }.fetch(config.driver).new
+      end
+
+      def config
+        @config ||= Config.new(driver: :fake)
+      end
+
+      private
+
+      Config = Class.new do
+        attr_accessor :driver
+        def initialize(attributes)
+          @driver = attributes.fetch(:driver)
+        end
+      end
+    end
+  end
+end

data/lib/relish/billing/account.rb

@@ -0,0 +1,37 @@
+module Relish
+  module Billing
+    class Account
+      def initialize(user_profile, driver)
+        raise ArgumentError.new("please pass a UserProfile") unless user_profile.is_a?(UserProfile)
+        @user_profile, @driver = user_profile, driver
+      end
+
+      def status
+        @driver.account_status(@user_profile)
+      end
+
+      def save_card(card, listener)
+        @driver.save_card @user_profile, card
+        listener.card_saved
+      rescue CardDeclinedError => exception
+        listener.transaction_declined(exception.reason)
+      ensure
+        self
+      end
+
+      def cancel(listener)
+        @driver.cancel_subscription @user_profile
+        listener.subscription_cancelled
+        self
+      end
+
+      def plan_changed(listener)
+        @driver.set_plan(@user_profile)
+        listener.plan_set @user_profile.plan
+        self
+      end
+
+    end
+  end
+end
+