slack-ruby-bot-server-stripe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b590c6a22b2c9af304f57df7b5e2549fd313877cd61c61790419ed9bba3a21e7
+  data.tar.gz: cb016ad20cc78d2f456b36177b018a3211e2453e168b0bd6e5b455c4e192f675
+SHA512:
+  metadata.gz: d1a9b2c0a58181f9f41f60d3e317ad1233d19ea76c16ddafaed129d900c263fe0fd8e58698ba2a627be8579902f4c8e2b80a5356e855aa456eb18522fb5a54f7
+  data.tar.gz: fb0f0f5e861bbab49ac4a88234d2ca34013e9e6164d3ae93a532e72673674893682ced9d59a1d0b6cb44003ab3ff8f655809ec995a042c849b7ccfc4fa0d2ad9

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.rvmrc
+.irbrc
+.bundle
+log
+.env
+*.swp
+Gemfile.lock
+.ruby-version
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 500
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-26 19:57:20 -0400 using RuboCop version 0.81.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-stripe.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/slack-ruby-bot-server-stripe/api/endpoints/subscriptions_endpoint_spec.rb'
+
+# Offense count: 1
+Style/MultilineTernaryOperator:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-stripe/models/methods.rb'
+
+# Offense count: 1
+Style/NestedTernaryOperator:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-stripe/models/methods.rb'

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.6.2
+      script:
+        - bundle exec danger
+    - rvm: 2.6.2
+      env: DATABASE_ADAPTER=activerecord
+      services:
+        - postgresql
+        - xvfb
+      addons:
+        firefox: 54.0
+    - rvm: 2.6.2
+      env: DATABASE_ADAPTER=mongoid
+      services:
+        - mongodb
+        - xvfb
+      addons:
+        firefox: 54.0
+
+before_install:
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.18.0/geckodriver-v0.18.0-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.18.0-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+#### 0.1.0 (4/26/2020)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to SlackRubyBotServer::Stripe
+
+This project is work of [many contributors](https://github.com/slack-ruby/slack-ruby-bot-server-stripe/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/slack-ruby/slack-ruby-bot-server-stripe/pulls), [propose features and discuss issues](https://github.com/slack-ruby/slack-ruby-bot-server-stripe/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/slack-ruby/slack-ruby-bot-server-stripe) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-bot-server-stripe.git
+cd slack-ruby-bot-server-stripe
+git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server-stripe.git
+```
+
+## Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+Add to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
+Run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+## Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+## Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
+Make it look like every other line, including your name and link to your Github account.
+
+## Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/slack-ruby-bot-server-stripe and select your feature branch.
+Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+## Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/slack-ruby/slack-ruby-bot-server-stripe/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: 'slack-ruby-danger')

data/Gemfile

@@ -0,0 +1,42 @@
+source 'https://rubygems.org'
+
+case ENV['DATABASE_ADAPTER']
+when 'mongoid' then
+  gem 'kaminari-mongoid'
+  gem 'mongoid'
+  gem 'mongoid-scroll'
+when 'activerecord' then
+  gem 'activerecord', '~> 5.0.0'
+  gem 'otr-activerecord', '~> 1.2.1'
+  gem 'virtus'
+  gem 'cursor_pagination' # rubocop:disable Bundler/OrderedGems
+  gem 'pg'
+when nil
+  warn "Missing ENV['DATABASE_ADAPTER']."
+else
+  warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
+end
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'capybara'
+  gem 'database_cleaner'
+  gem 'fabrication'
+  gem 'faker'
+  gem 'hyperclient'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', '0.81.0'
+  gem 'selenium-webdriver'
+  gem 'stripe-ruby-mock', '~> 2.4.1', require: 'stripe_mock'
+  gem 'timecop'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :test do
+  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Doubrovkine & Contributors
+
+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,278 @@
+Slack Ruby Bot Server Stripe Extension
+======================================
+
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-stripe.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-stripe)
+[![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-stripe.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-stripe)
+
+A model extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that enables trials and paid subscriptions for your bots using [Stripe](https://stripe.com).
+
+### Sample
+
+See [slack-ruby/slack-ruby-bot-server-stripe-sample](https://github.com/slack-ruby/slack-ruby-bot-server-stripe-sample) for a working sample.
+
+### Usage
+
+#### Gemfile
+
+Add 'slack-ruby-bot-server-stripe' to Gemfile.
+
+```ruby
+gem 'slack-ruby-bot-server-stripe'
+```
+
+#### Configure
+
+Configure your app, typically via `config/initializers/slack_ruby_bot_server_stripe.rb`.
+
+```ruby
+SlackRubyBotServer::Stripe.configure do |config|
+  config.stripe_api_key = ENV['STRIPE_API_KEY'] # Stripe API key
+  config.stripe_api_publishable_key = ENV['STRIPE_API_PUBLISHABLE_KEY'] # Stripe publishable API key
+  config.subscription_plan_id = ENV['STRIPE_SUBSCRIPTION_PLAN_ID'] # Stripe subscription plan ID
+  config.trial_duration = 2.weeks # Trial duration
+  config.root_url = ENV['URL'] || 'http://localhost:5000' # Bot root of subscription info links
+end
+```
+
+By default the configuration will use the values in the environment variables above.
+
+#### Database Schema
+
+Define additional fields on your database.
+
+##### Mongoid
+
+Additional fields from [models/mongoid.rb](lib/slack-ruby-bot-server/stripe/models/mongoid.rb) are automatically included.
+
+##### ActiveRecord
+
+Add migrations for additional fields from [activerecord/schema.rb](spec/database_adapters/activerecord/schema.rb).
+
+#### Implement Callbacks
+
+Use callbacks together with default `_text` methods to communicate subscription life cycle to your users. These are typically added by creating `lib/models/team.rb`.
+
+```ruby
+class Team
+  before_trial_expiring do
+    inform!(text: trial_text)
+  end
+
+  after_subscribed do
+    inform!(text: subscribed_text)
+  end
+
+  after_unsubscribed do
+    inform!(text: unsubscribed_text)
+  end
+
+  after_subscription_expired do
+    inform!(text: subscription_expired_text)
+  end
+
+  after_subscription_past_due do
+    inform!(text: subscription_past_due_text)
+  end
+
+  private
+
+  def slack_client
+    @slack_client ||= Slack::Web::Client.new(token: token)
+  end
+
+  def slack_channels
+    slack_client.channels_list(
+      exclude_archived: true,
+      exclude_members: true
+    )['channels'].select do |channel|
+      channel['is_member']
+    end
+  end
+
+  def inform!(message)
+    slack_channels.each do |channel|
+      message_with_channel = message.merge(channel: channel['id'], as_user: true)
+      slack_client.chat_postMessage(message_with_channel)
+    end
+  end
+end
+```
+
+#### Add Trial Link
+
+Your bot's help command should display trial text and subscription link. This is typically done in `lib/commands/help.rb`.
+
+```ruby
+class Help < SlackRubyBot::Commands::Base
+  HELP = <<-EOS.freeze
+```
+Sample bot.
+
+General
+-------
+
+help               - get this helpful message
+
+```
+EOS
+
+  def self.call(client, data, _match)
+    client.say(channel: data.channel, text: [
+      HELP,
+      client.owner.reload.subscribed? ? nil : client.owner.trial_text
+    ].compact.join("\n"))
+
+    client.say(channel: data.channel, gif: 'help')
+  end
+end
+```
+
+### Attributes
+
+This library adds the following public attributes to the `Team` class.
+
+#### stripe_customer_id
+
+Stripe customer string ID.
+
+#### subscribed
+
+Boolean whether the team is subscribed.
+
+When set without a Stripe customer ID creates a perpetual subscription.
+
+#### subscription_expired_at
+
+Timestamp for when a subscription has expired.
+
+#### trial_informed_at
+
+Timestamp for when the team was informed of a pending end of trial.
+
+#### trial_ends_at
+
+Timestamp for when the trial ends. Will raise an error if a team is subscribed.
+
+### Methods
+
+The following public methods are added to `Team`.
+
+#### trial_text
+
+A message about the remaining trial period. Will raise an error if a team is subscribed.
+
+e.g. `Your trial subscription expires in 3 days. Subscribe your team at https://example.com?team_id=id.`
+
+#### subscribed_text
+
+A message upon successful subscription.
+
+e.g. `Your team has been subscribed.`
+
+#### unsubscribed_text
+
+A message to use when unsubscribed.
+
+e.g. `Your team has been unsubscribed. Subscribe your team at https://example.com?team_id=id.`
+
+#### subscription_expired_text
+
+A message to use upon subscription expiration.
+
+e.g. `Your subscription has expired. Subscribe your team at https://example.com?team_id=id.`
+
+#### subscription_past_due_text
+
+A message to use when paid subscription is past due.
+
+e.g. `Your subscription is past due. Update your credit card info at https://example.com?update_cc?team_id=id.`
+
+#### trial_expired?
+
+True if number of remaining trial days is zero. Will raise an error if a team is subscribed.
+
+#### remaining_trial_days
+
+Number of days remaining in the trial. Will raise an error if a team is subscribed.
+
+#### subscription_expired?
+
+Returns `true` when the trial period has ended and/or a subscription has expired.
+
+#### tags
+
+A set of tags to support other extensions, such as [slack-ruby-bot-server-mailchimp](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp). Possible values are `subscribed`, `trial` and `paid`.
+
+#### active_stripe_subscription
+
+An active Stripe subscription, if any.
+
+#### active_stripe_subscription?
+
+Returns `true` if the team has an active Stripe subscription.
+
+#### subscription_text(params)
+
+Returns detailed subscription info or a trial message, typically used in a bot command.
+
+Pass `include_admin_info: true` to include detailed credit card on file information.
+
+#### subscribe!(params)
+
+Creates and returns a Stripe customer. Updates subscription fields. Invokes `subscribed` callbacks.
+
+Parameters are `stripe_token`, `stripe_email` and an optional `subscription_plan_id`.
+
+#### unsubscribe!
+
+Marks a Stripe subscription to be terminated at period end. Invokes `unsubscribed` callbacks.
+
+#### update_subscription!(params)
+
+Updates a Stripe customer.
+
+Parameters are `stripe_token` for the new payment instrument.
+
+### Lifecycle Methods
+
+The following methods are invoked before a team is started and from a daily lifecycle cron via `Team#check_stripe!`.
+
+#### check_subscription!
+
+Invoked for subscribed teams, unsubscribes teams that have canceled subscriptions or past due payments.
+
+#### check_trials!
+
+Invoked for teams during trial. Notify teams that their trial is about to expire.
+
+### API Endpoints
+
+This extension adds the following API endpoints.
+
+#### POST /subscriptions
+
+Creates or updates a subscription for a team, using a payment method tokenized by Stripe. See [subscription_endpoint.rb](lib/slack-ruby-bot-server-stripe/api/endpoints/subscription_endpoint.rb) for details.
+
+### HTML Views
+
+#### /subscribe
+
+This extension adds a [subscription page](slack-ruby-bot-server-stripe/public/subscribe.html.erb) that handles initial subscriptions and credit card updates. Clone the page into your own project's `public/subscribe.html.erb` to customize.
+
+### Slack Commands
+
+This extension adds the following Slack commands.
+
+#### subscription
+
+Displays current subscription information, see [subscription.rb](lib/slack-ruby-bot-server-stripe/commands/subscription.rb). This command also displays partial credit card information to the user that has installed the bot.
+
+#### unsubscribe
+
+Turns off auto-renew for the current subscription, see [unsubscribe.rb](lib/slack-ruby-bot-server-stripe/commands/unsubscribe.rb). This command will only succeed when run by the user that has installed the bot.
+
+### Copyright & License
+
+Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2019-2020
+
+[MIT License](LICENSE)