slack-ruby-bot-server-mailchimp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40656585b497e172f926371881eaf7e72c41fcda402abcf878df85902922f3f5
+  data.tar.gz: c7c09b96b872061811ee730d5ca76100e0f22ed5da25e546f7a6921aef6f953a
+SHA512:
+  metadata.gz: 359aa967108d4a5761aeffd70250a06854b617092b21369faf63d14262179a82e2df7eafc801f32ece6d94748ab7c95586a54505e12bf1c80630208221592aa5
+  data.tar.gz: b697c374b469e6f18cbd804b2edd60b5045aea3f4ba4698106e78d9cbc32ad6d8c2747be1e15191d553983f7a9dc06d59b77383dbdd29d40db43d89aecb37ecf

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
+
+Metrics/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,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-03-23 14:46:53 -0400 using RuboCop version 0.66.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
+Lint/NonLocalExitFromIterator:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/mailchimp/lifecycle.rb'
+
+# Offense count: 2
+# 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-mailchimp.rb'
+    - 'spec/support/slack-ruby-bot-server.rb'

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.6.2
+      script:
+        - bundle exec danger
+    - rvm: 2.6.2
+      env: DATABASE_ADAPTER=activerecord
+      services:
+        - postgresql
+    - rvm: 2.6.2
+      env: DATABASE_ADAPTER=mongoid
+      services:
+        - mongodb

data/CHANGELOG.md

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

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to SlackRubyBotServer::Mailchimp
+
+This project is work of [many contributors](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp/pulls), [propose features and discuss issues](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp/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-mailchimp) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-bot-server-mailchimp.git
+cd slack-ruby-bot-server
+git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp.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 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-mailchimp/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,36 @@
+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 'cursor_pagination' # rubocop:disable Bundler/OrderedGems
+  gem 'pg'
+when nil then
+  warn "Missing ENV['DATABASE_ADAPTER']."
+else
+  warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
+end
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'database_cleaner'
+  gem 'fabrication'
+  gem 'faker'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', '0.66.0'
+  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,56 @@
+Slack Ruby Bot Server Mailchimp Extension
+=========================================
+
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-mailchimp.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-mailchimp)
+[![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-mailchimp.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-mailchimp)
+
+A lifecycle extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that subscribes new bot users to a Mailchimp mailing list.
+
+### Usage
+
+Add 'slack-ruby-bot-server-mailchimp' to Gemfile.
+
+```ruby
+gem 'slack-ruby-bot-server-mailchimp'
+```
+
+Configure.
+
+```ruby
+SlackRubyBotServer::Mailchimp.configure do |config|
+  config.mailchimp_api_key = ENV['MAILCHIMP_API_KEY'] # defaults to ENV['MAILCHIMP_API_KEY']
+  config.mailchimp_list_id = ENV['MAILCHIMP_LIST_ID'] # defaults to ENV['MAILCHIMP_LIST_ID']
+end
+```
+
+Users that install the bot are automatically subscribed via [bot server lifecycle](lib/slack-ruby-bot-server/mailchimp/lifecycle.rb).
+
+### Additional Member Tags
+
+If your `Team` model responds to `.tags`, those will be attached to new subscriptions and appear as "tags" in Mailchimp. You can also supplement member tags for new subscriptions through `member_tags` configuration.
+
+```ruby
+SlackRubyBotServer::Mailchimp.config.member_tags = ['my_bot']
+```
+
+### Additional Profile Information
+
+The default member profile information that appears in Mailchimp under "Profile Information" for each new subscriber contains the user's email address, first and last name from Slack. You can supplement this data with `additional_merge_fields`.
+
+```ruby
+SlackRubyBotServer::Mailchimp.config.additional_merge_fields = { 'BOT' => 'MyBot' }
+```
+
+### Double Opt-In
+
+This integration subscribes users with double opt-in by default. Configure `member_status` to disable double opt-in. See [this doc](https://developer.mailchimp.com/documentation/mailchimp/guides/manage-subscribers-with-the-mailchimp-api) for more details.
+
+```ruby
+SlackRubyBotServer::Mailchimp.config.member_status = 'subscribed'
+```
+
+### Copyright & License
+
+Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2019
+
+[MIT License](LICENSE)

data/RELEASING.md

@@ -0,0 +1,77 @@
+# Releasing Slack-Ruby-Bot-Server-Mailchimp
+
+There're no hard rules about when to release slack-ruby-bot-server-mailchimp. 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-mailchimp) 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.
+
+Change `**next**` in the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version with `**stable**`.
+
+```
+## Stable Release
+
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, 0.2.2. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+```
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-bot-server 0.2.2 built to pkg/slack-ruby-bot-server-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-bot-server 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-mailchimp/version.rb](lib/slack-ruby-bot-server-mailchimp/version.rb).
+
+Undo your change in README about the stable release.
+
+```
+## Stable Release
+
+You're reading the documentation for the **next** release of slack-ruby-bot-server. Please see the documentation for the [last stable release, v0.2.2](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp/blob/v0.2.2/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+```
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/slack-ruby-bot-server-mailchimp/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-mailchimp.rb

@@ -0,0 +1,5 @@
+require 'slack-ruby-bot-server'
+require 'mailchimp_api_v3'
+require 'slack-ruby-bot-server/mailchimp/version'
+require 'slack-ruby-bot-server/mailchimp/config'
+require 'slack-ruby-bot-server/mailchimp/lifecycle'

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

@@ -0,0 +1,33 @@
+module SlackRubyBotServer
+  module Mailchimp
+    module Config
+      extend self
+
+      attr_accessor :mailchimp_api_key
+      attr_accessor :mailchimp_list_id
+      attr_accessor :additional_member_tags
+      attr_accessor :additional_merge_fields
+      attr_accessor :member_status
+
+      def reset!
+        self.mailchimp_list_id = ENV['MAILCHIMP_LIST_ID']
+        self.mailchimp_api_key = ENV['MAILCHIMP_API_KEY']
+        self.additional_member_tags = []
+        self.additional_merge_fields = {}
+        self.member_status = 'pending'
+      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/mailchimp/lifecycle.rb

@@ -0,0 +1,47 @@
+SlackRubyBotServer::Config.service_class.instance.on :created do |team, _error, _options|
+  raise 'missing ENV["MAILCHIMP_API_KEY"]' unless SlackRubyBotServer::Mailchimp.config.mailchimp_api_key
+  raise 'missing ENV["MAILCHIMP_LIST_ID"]' unless SlackRubyBotServer::Mailchimp.config.mailchimp_list_id
+
+  mailchimp_client = Mailchimp.connect(SlackRubyBotServer::Mailchimp.config.mailchimp_api_key)
+  mailchimp_list = mailchimp_client.lists(SlackRubyBotServer::Mailchimp.config.mailchimp_list_id)
+
+  slack_client = Slack::Web::Client.new(token: team.token)
+
+  # fetch profile of the user installing the bot
+  raise 'missing team.activated_user_id' unless team.activated_user_id
+
+  profile = Hashie::Mash.new(slack_client.users_info(user: team.activated_user_id)).user.profile
+  raise "error fetching user profile for #{team.activated_user_id}" unless profile
+
+  # fetch and merge member tags
+  tags = SlackRubyBotServer::Mailchimp.config.additional_member_tags
+  tags = (tags + team.tags).uniq if team.respond_to?(:tags)
+
+  member = mailchimp_list.members.where(email_address: profile.email).first
+  if member
+    member_tags = member.tags.map { |tag| tag['name'] }.sort
+    tags = (member_tags + tags).uniq
+    if tags == member_tags
+      SlackRubyBot::Client.logger.debug "Skipping #{profile.email} with identical tags (#{tags.join(', ')}), will not be added to #{SlackRubyBotServer::Mailchimp.config.mailchimp_list_id}, #{team}."
+      next
+    end
+  end
+
+  # merge fields
+  merge_fields = SlackRubyBotServer::Mailchimp.config.additional_merge_fields.merge(
+    'FNAME' => profile.first_name.to_s,
+    'LNAME' => profile.last_name.to_s
+  )
+
+  # subscribe
+  mailchimp_list.members.create_or_update(
+    name: profile.name,
+    email_address: profile.email,
+    unique_email_id: "#{team.team_id}-#{team.activated_user_id}",
+    status: member ? member.status : SlackRubyBotServer::Mailchimp.config.member_status,
+    tags: tags,
+    merge_fields: merge_fields
+  )
+
+  SlackRubyBot::Client.logger.info "Subscribed #{profile.email} to #{SlackRubyBotServer::Mailchimp.config.mailchimp_list_id}, #{team}."
+end

data/lib/slack-ruby-bot-server/mailchimp/version.rb

@@ -0,0 +1,5 @@
+module SlackRubyBotServer
+  module Mailchimp
+    VERSION = '0.1.0'.freeze
+  end
+end

data/slack-ruby-bot-server-mailchimp.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack-ruby-bot-server/mailchimp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slack-ruby-bot-server-mailchimp'
+  spec.version       = SlackRubyBotServer::Mailchimp::VERSION
+  spec.authors       = ['Daniel Doubrovkine']
+  spec.email         = ['dblock@dblock.org']
+
+  spec.summary       = 'Mailchimp extension for slack-ruby-bot-server.'
+  spec.homepage      = 'https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mailchimp_api_v3'
+  spec.add_dependency 'slack-ruby-bot-server', '>= 0.10.0'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: slack-ruby-bot-server-mailchimp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mailchimp_api_v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-bot-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: 
+email:
+- dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Dangerfile
+- Gemfile
+- LICENSE
+- README.md
+- RELEASING.md
+- Rakefile
+- lib/slack-ruby-bot-server-mailchimp.rb
+- lib/slack-ruby-bot-server/mailchimp/config.rb
+- lib/slack-ruby-bot-server/mailchimp/lifecycle.rb
+- lib/slack-ruby-bot-server/mailchimp/version.rb
+- slack-ruby-bot-server-mailchimp.gemspec
+homepage: https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Mailchimp extension for slack-ruby-bot-server.
+test_files: []