slack-ruby-bot-server-stripe 0.1.0

data/RELEASING.md

@@ -0,0 +1,61 @@
+# Releasing Slack-Ruby-Bot-Server-Stripe
+
+There're no hard rules about when to release slack-ruby-bot-server-stripe. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-stripe) for all supported platforms.
+
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-bot-server-stripe 0.2.2 built to pkg/slack-ruby-bot-server-stripe-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-bot-server-stripe 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/slack-ruby-bot-server-stripe/version.rb](lib/slack-ruby-bot-server-stripe/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/slack-ruby-bot-server-stripe/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].exclude(%r{ext\/(?!#{ENV['DATABASE_ADAPTER']})})
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/slack-ruby-bot-server-stripe.rb

@@ -0,0 +1,15 @@
+require 'stripe'
+
+require 'slack-ruby-bot-server'
+
+require_relative 'slack-ruby-bot-server-stripe/version'
+require_relative 'slack-ruby-bot-server-stripe/config'
+require_relative 'slack-ruby-bot-server-stripe/errors'
+require_relative 'slack-ruby-bot-server-stripe/models'
+require_relative 'slack-ruby-bot-server-stripe/lifecycle'
+require_relative 'slack-ruby-bot-server-stripe/api'
+require_relative 'slack-ruby-bot-server-stripe/commands'
+
+SlackRubyBotServer::Config.view_paths << File.expand_path(File.join(__dir__, 'slack-ruby-bot-server-stripe/public'))
+
+require_relative 'slack-ruby-bot-server/api'

data/lib/slack-ruby-bot-server-stripe/api.rb

@@ -0,0 +1 @@
+require_relative 'api/endpoints'

data/lib/slack-ruby-bot-server-stripe/api/endpoints.rb

@@ -0,0 +1 @@
+require_relative 'endpoints/subscriptions_endpoint'

data/lib/slack-ruby-bot-server-stripe/api/endpoints/subscriptions_endpoint.rb

@@ -0,0 +1,44 @@
+module SlackRubyBotServer
+  module Stripe
+    module Api
+      module Endpoints
+        class SubscriptionsEndpoint < Grape::API
+          format :json
+
+          namespace :subscriptions do
+            desc 'Create or update a subscription.'
+            params do
+              requires :stripe_token, type: String
+              optional :stripe_token_type, type: String
+              optional :stripe_email, type: String
+              requires :team_id, type: String
+            end
+            post do
+              begin
+                team = Team.where(team_id: params[:team_id]).first || error!('Team Not Found', 404)
+                if team.subscribed?
+                  SlackRubyBotServer::Api::Middleware.logger.info "Updating a subscription for team #{team}."
+                  stripe_customer = team.update_subscription!(params)
+                  SlackRubyBotServer::Api::Middleware.logger.info "Updated subscription for team #{team}, stripe_customer_id=#{stripe_customer['id']}."
+                else
+                  SlackRubyBotServer::Api::Middleware.logger.info "Creating a subscription for team #{team}."
+                  stripe_customer = team.subscribe!(params)
+                  SlackRubyBotServer::Api::Middleware.logger.info "Subscription for team #{team} created, stripe_customer_id=#{stripe_customer['id']}."
+                end
+                present team, with: SlackRubyBotServer::Api::Presenters::TeamPresenter
+              rescue Errors::AlreadySubscribedError
+                error! 'Already Subscribed', 400
+              rescue Errors::StripeCustomerExistsError
+                error! 'Customer Already Registered', 400
+              rescue Errors::NotSubscribedError
+                error! 'Not a Subscriber', 400
+              rescue Errors::MissingStripeCustomerError
+                error! 'Missing Stripe Customer', 400
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/commands.rb

@@ -0,0 +1,2 @@
+require_relative 'commands/subscription'
+require_relative 'commands/unsubscribe'

data/lib/slack-ruby-bot-server-stripe/commands/subscription.rb

@@ -0,0 +1,14 @@
+module SlackRubyBotServer
+  module Stripe
+    module Commands
+      class Subscription < SlackRubyBot::Commands::Base
+        command 'subscription' do |client, data, _match|
+          team = ::Team.find(client.owner.id)
+          include_admin_info = (data.user == team.activated_user_id)
+          client.say(channel: data.channel, text: team.subscription_text(include_admin_info: include_admin_info))
+          logger.info "SUBSCRIPTION: #{client.owner} - #{data.user}"
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/commands/unsubscribe.rb

@@ -0,0 +1,34 @@
+module SlackRubyBotServer
+  module Stripe
+    module Commands
+      class Unsubscribe < SlackRubyBot::Commands::Base
+        command 'unsubscribe' do |client, data, match|
+          team = ::Team.find(client.owner.id)
+          if !team.active_stripe_subscription?
+            client.say(channel: data.channel, text: "You don't have a paid subscription, all set.")
+            logger.info "UNSUBSCRIBE: #{client.owner} - #{data.user} unsubscribe failed, no subscription"
+          elsif data.user == team.activated_user_id
+            subscription_info = []
+            subscription_id = match['expression']
+            active_subscription = team.active_stripe_subscription
+            if active_subscription && active_subscription.id == subscription_id
+              team.unsubscribe!
+              amount = ActiveSupport::NumberHelper.number_to_currency(active_subscription.plan.amount.to_f / 100)
+              subscription_info << "Successfully canceled auto-renew for #{active_subscription.plan.name} (#{amount})."
+              logger.info "UNSUBSCRIBE: #{client.owner} - #{data.user}, canceled #{subscription_id}"
+            elsif subscription_id
+              subscription_info << "Sorry, I cannot find a subscription with \"#{subscription_id}\"."
+            else
+              subscription_info << "Send \"unsubscribe #{active_subscription.id}\" to confirm."
+            end
+            client.say(channel: data.channel, text: subscription_info.compact.join("\n"))
+            logger.info "UNSUBSCRIBE: #{client.owner} - #{data.user}"
+          else
+            client.say(channel: data.channel, text: "Sorry, only <@#{team.activated_user_id}> can do that.")
+            logger.info "UNSUBSCRIBE: #{client.owner} - #{data.user} unsubscribe failed, not admin"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/config.rb

@@ -0,0 +1,41 @@
+module SlackRubyBotServer
+  module Stripe
+    module Config
+      extend self
+
+      attr_reader :stripe_api_key
+
+      def stripe_api_key=(value)
+        @stripe_api_key = value
+        ::Stripe.api_key = value
+      end
+
+      attr_accessor :stripe_api_publishable_key
+      attr_accessor :subscription_plan_id
+      attr_accessor :subscription_plan_amount
+      attr_accessor :trial_duration
+      attr_accessor :root_url
+
+      def reset!
+        self.stripe_api_publishable_key = ENV['STRIPE_API_PUBLISHABLE_KEY']
+        self.stripe_api_key = ENV['STRIPE_API_KEY']
+        self.subscription_plan_id = ENV['STRIPE_SUBSCRIPTION_PLAN_ID']
+        self.subscription_plan_amount = -1
+        self.root_url = ENV['URL']
+        self.trial_duration = 2.weeks
+      end
+
+      reset!
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/errors.rb

@@ -0,0 +1,10 @@
+module SlackRubyBotServer
+  module Stripe
+    module Errors
+      class StripeCustomerExistsError < StandardError; end
+      class MissingStripeCustomerError < StandardError; end
+      class AlreadySubscribedError < StandardError; end
+      class NotSubscribedError < StandardError; end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/lifecycle.rb

@@ -0,0 +1,17 @@
+SlackRubyBotServer::Config.service_class.instance.on :starting do |team|
+  begin
+    team.check_stripe!
+  rescue StandardError => e
+    SlackRubyBotServer::Service.logger.error e
+  end
+end
+
+SlackRubyBotServer::Config.service_class.instance.every :day do
+  Team.each do |team|
+    begin
+      team.check_stripe!
+    rescue StandardError => e
+      SlackRubyBotServer::Service.logger.error e
+    end
+  end
+end

data/lib/slack-ruby-bot-server-stripe/models.rb

@@ -0,0 +1,2 @@
+require_relative 'models/methods'
+require_relative "models/#{::SlackRubyBotServer::Config.database_adapter}.rb"

data/lib/slack-ruby-bot-server-stripe/models/activerecord.rb

@@ -0,0 +1,18 @@
+require_relative 'methods'
+
+module SlackRubyBotServer
+  module Stripe
+    module Models
+      module ActiveRecord
+        extend ActiveSupport::Concern
+        include Methods
+
+        included do
+          # TODO
+        end
+      end
+    end
+  end
+end
+
+Team.include SlackRubyBotServer::Stripe::Models::ActiveRecord

data/lib/slack-ruby-bot-server-stripe/models/methods.rb

@@ -0,0 +1,317 @@
+module SlackRubyBotServer
+  module Stripe
+    module Models
+      module Methods
+        extend ActiveSupport::Concern
+        extend ActiveModel::Callbacks
+
+        included do
+          define_model_callbacks :trial_expiring, :subscription_expired, :subscription_past_due, :unsubscribed
+          define_model_callbacks :subscribed, only: [:after]
+          before_validation :update_subscribed_at
+          before_validation :update_subscription_expired_at
+          after_update :subscribed!
+        end
+
+        # supports https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp
+        def tags
+          [
+            subscribed? ? 'subscribed' : 'trial',
+            stripe_customer_id? ? 'paid' : nil
+          ].compact
+        end
+
+        def subscription_expired?
+          return false if subscribed?
+          return true if subscription_expired_at
+
+          time_limit = Time.now - trial_duration
+          created_at < time_limit
+        end
+
+        def trial_expired?
+          remaining_trial_days <= 0
+        end
+
+        def subscription_text(options = { include_admin_info: false })
+          subscription_text = []
+          if active_stripe_subscription?
+            subscription_text << stripe_customer_text
+            subscription_text.concat(stripe_customer_subscriptions_info)
+            if options[:include_admin_info]
+              subscription_text.concat(stripe_customer_invoices_info)
+              subscription_text.concat(stripe_customer_sources_info)
+              subscription_text << update_cc_text
+            end
+          elsif subscribed && subscribed_at
+            subscription_text << subscriber_text
+          else
+            subscription_text << trial_text
+          end
+          subscription_text.compact.join("\n")
+        end
+
+        # params:
+        # - stripe_token
+        # - stripe_email
+        # - subscription_plan_id
+        def subscribe!(params)
+          raise Errors::AlreadySubscribedError if subscribed?
+          raise Errors::StripeCustomerExistsError if stripe_customer_id
+
+          customer = ::Stripe::Customer.create(
+            source: params[:stripe_token],
+            plan: params[:subscription_plan_id] || SlackRubyBotServer::Stripe.config.subscription_plan_id,
+            email: params[:stripe_email],
+            metadata: {
+              id: id,
+              team_id: team_id,
+              name: name,
+              domain: domain
+            }
+          )
+
+          update_attributes!(
+            subscribed: true,
+            subscribed_at: Time.now.utc,
+            stripe_customer_id: customer['id'],
+            subscription_expired_at: nil,
+            subscription_past_due_at: nil,
+            subscription_past_due_informed_at: nil
+          )
+
+          customer
+        end
+
+        # params:
+        # - stripe_token
+        def update_subscription!(params)
+          raise Errors::NotSubscribedError unless subscribed?
+          raise Errors::MissingStripeCustomerError unless active_stripe_subscription?
+
+          stripe_customer.source = params[:stripe_token]
+          stripe_customer.save
+
+          stripe_customer
+        end
+
+        def unsubscribe!
+          raise Errors::NotSubscribedError unless subscribed?
+          raise Errors::MissingStripeCustomerError unless active_stripe_subscription?
+
+          run_callbacks :unsubscribed do
+            active_stripe_subscription.delete(at_period_end: true)
+            update_attributes!(subscribed: false, stripe_customer_id: nil)
+          end
+        end
+
+        def active_stripe_subscription?
+          !active_stripe_subscription.nil?
+        end
+
+        def active_stripe_subscription
+          return unless stripe_customer
+
+          stripe_customer.subscriptions.detect do |subscription|
+            subscription.status == 'active' && !subscription.cancel_at_period_end
+          end
+        end
+
+        def trial_ends_at
+          raise Errors::AlreadySubscribedError if subscribed?
+
+          created_at + trial_duration
+        end
+
+        def remaining_trial_days
+          raise Errors::AlreadySubscribedError if subscribed?
+
+          [0, (trial_ends_at.to_date - Time.now.utc.to_date).to_i].max
+        end
+
+        def trial_text
+          raise Errors::AlreadySubscribedError if subscribed?
+
+          [
+            remaining_trial_days.zero? ?
+              'Your trial subscription has expired.' :
+              "Your trial subscription expires in #{remaining_trial_days} day#{remaining_trial_days == 1 ? '' : 's'}.",
+            subscribe_text
+          ].join(' ')
+        end
+
+        def unsubscribed_text
+          [
+            'Your team has been unsubscribed.',
+            subscribe_text
+          ].join(' ')
+        end
+
+        def subscribed_text
+          'Your team has been subscribed.'
+        end
+
+        def subscription_expired_text
+          [
+            'Your subscription has expired.',
+            subscribe_text
+          ].join(' ')
+        end
+
+        def subscription_past_due_text
+          [
+            'Your subscription is past due.',
+            update_cc_text
+          ].join(' ')
+        end
+
+        def check_trial!
+          raise Errors::AlreadySubscribedError if subscribed?
+          return if remaining_trial_days > 3
+
+          trial_expiring!
+        end
+
+        def check_subscription!
+          raise Errors::NotSubscribedError unless subscribed?
+          raise Errors::MissingStripeCustomerError unless stripe_customer
+
+          stripe_customer.subscriptions.each do |subscription|
+            case subscription.status
+            when 'past_due'
+              subscription_past_due!
+            when 'canceled', 'unpaid'
+              subscription_expired!
+            end
+          end
+        end
+
+        def check_stripe!
+          if subscribed? && active_stripe_subscription?
+            check_subscription!
+          elsif !subscribed?
+            check_trial!
+          end
+        end
+
+        private
+
+        def subscription_past_due!
+          return unless subscribed?
+          return if subscription_past_due_at && (Time.now.utc < subscription_past_due_informed_at + 3.days)
+
+          run_callbacks :subscription_past_due do
+            # use subscription_past_due_text to tell users to update their cc
+            update_attributes!(
+              subscription_past_due_at: subscription_past_due_at || Time.now.utc,
+              subscription_past_due_informed_at: Time.now.utc
+            )
+          end
+        end
+
+        def subscription_expired!
+          return if subscription_expired_at
+
+          run_callbacks :subscription_expired do
+            # use subscribe_text to tell users to (re)subscribe
+            update_attributes!(
+              subscribed: false,
+              subscription_expired_at: Time.now.utc
+            )
+          end
+        end
+
+        def update_cc_text
+          "Update your credit card info at #{root_url}/subscribe?team_id=#{team_id}."
+        end
+
+        def trial_expiring!
+          return false if subscribed? || subscription_expired?
+          return false if trial_informed_at && (Time.now.utc < trial_informed_at + 7.days)
+
+          run_callbacks :trial_expiring do
+            # use trial_text to inform users
+            update_attributes!(trial_informed_at: Time.now.utc)
+          end
+        end
+
+        def stripe_customer
+          return unless stripe_customer_id
+
+          @stripe_customer ||= ::Stripe::Customer.retrieve(stripe_customer_id)
+        end
+
+        def stripe_customer_text
+          "Customer since #{Time.at(stripe_customer.created).strftime('%B %d, %Y')}."
+        end
+
+        def subscriber_text
+          return unless subscribed_at
+
+          "Subscriber since #{subscribed_at.strftime('%B %d, %Y')}."
+        end
+
+        unless respond_to?(:subscribe_text)
+          def subscribe_text
+            "Subscribe your team at #{root_url}/subscribe?team_id=#{team_id}."
+          end
+        end
+
+        def trial_duration
+          SlackRubyBotServer::Stripe.config.trial_duration
+        end
+
+        def root_url
+          SlackRubyBotServer::Stripe.config.root_url
+        end
+
+        def stripe_customer_subscriptions_info
+          stripe_customer.subscriptions.map do |subscription|
+            amount = ActiveSupport::NumberHelper.number_to_currency(subscription.plan.amount.to_f / 100)
+            current_period_end = Time.at(subscription.current_period_end).strftime('%B %d, %Y')
+            "Subscribed to #{subscription.plan.name} (#{amount}), will#{subscription.cancel_at_period_end ? ' not' : ''} auto-renew on #{current_period_end}."
+          end
+        end
+
+        def stripe_auto_renew?
+          stripe_customer.subscriptions.any? do |subscription|
+            !subscription.cancel_at_period_end
+          end
+        end
+
+        def stripe_customer_invoices_info
+          stripe_customer.invoices.map do |invoice|
+            amount = ActiveSupport::NumberHelper.number_to_currency(invoice.amount_due.to_f / 100)
+            "Invoice for #{amount} on #{Time.at(invoice.date).strftime('%B %d, %Y')}, #{invoice.paid ? 'paid' : 'unpaid'}."
+          end
+        end
+
+        def stripe_customer_sources_info
+          stripe_customer.sources.map do |source|
+            "On file #{source.brand} #{source.object}, #{source.name} ending with #{source.last4}, expires #{source.exp_month}/#{source.exp_year}."
+          end
+        end
+
+        def subscribed!
+          return unless subscribed? && subscribed_changed?
+
+          run_callbacks :subscribed do
+            # use subscribed_text to inform users
+          end
+        end
+
+        def update_subscribed_at
+          return unless subscribed? && subscribed_changed?
+
+          self.subscribed_at = subscribed? ? DateTime.now.utc : nil
+        end
+
+        def update_subscription_expired_at
+          return unless subscribed? && subscription_expired_at?
+
+          self.subscription_expired_at = nil
+        end
+      end
+    end
+  end
+end