chimp_sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f370c639ff0268c115d070640aeca13cde8d3424
+  data.tar.gz: 7db796dba59c8a71b78905b90846d645ab854a69
+SHA512:
+  metadata.gz: 8b8fdb8e644e548af516b831fe11b11999beb580a6f1c6ed34fabc00af29faf9cb77b258bb95bd6772c56f14bb5c629b07606a509d15797746f3ee591c22d74a
+  data.tar.gz: 397dd376d3aa07036b47e8ca2a065e05b9fe616815318c2a0cc21e94dd0e046d2ef060ce6f0e2d4771f0c1827cd340f31491025010f42c5bc30f36689aa2439e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pat Allan and Inspire9
+
+MIT License
+
+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,50 @@
+# ChimpSync
+
+ChimpSync keeps MailChimp list subscription details synced with your own data.
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem 'chimp_sync', '~> 0.0.1'
+```
+
+This gem uses Panthoot for receiving MailChimp webhooks. If you're using Rails, the endpoint is automatically connected to `/panthoot/hooks`. If you're not using Rails, then you'll want to mount `Panthoot::App.new` into your app somewhere.
+
+## Usage
+
+In an initializer or similar, to ensure any changes made from MailChimp's side of things are reflected in your app:
+
+```ruby
+# Repeat as needed for as many lists as required - the label argument must be
+# unique for each, though.
+ChimpSync.sync :my_label do |list|
+  list.api_key = ENV['MAILCHIMP_API_KEY']
+  list.id      = ENV['MAILCHIMP_LIST_ID']
+
+  list.update_local = lambda { |email, subscribed|
+    # email is the email address as a string, subscribed is a boolean
+    # indicating the new subscription status via MailChimp.
+    User.find_by(email: email).update_attributes(subscribed: subscribed)
+  }
+end
+```
+
+You'll also want to pass back local changes to MailChimp:
+
+```ruby
+ChimpSync::Update.subscribed :my_label, user.email, user.subscribed
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/inspire9/chimp_sync/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Credits
+
+Copyright (c) 2014, ChimpSync is developed and maintained by Pat Allan and "Inspire9":http://inspire9.com, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/chimp_sync.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'chimp_sync'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = %q{Keep MailChimp list subscriptions synchronised.}
+  spec.description   = %q{Synchronise your MailChimp list subscription details with your own data.}
+  spec.homepage      = 'https://github.com/inspire9/chimp_sync'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'gibbon',   '~> 1.1'
+  spec.add_runtime_dependency 'panthoot', '>= 0.2.1'
+
+  spec.add_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'rails',       '~> 4.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0.1'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.9'
+  spec.add_development_dependency 'webmock',     '~> 1.18.0'
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/chimp_sync.rb

@@ -0,0 +1,24 @@
+require 'gibbon'
+require 'panthoot'
+
+module ChimpSync
+  def self.lists_for(list_id)
+    lists.values.select { |list| list.id == list_id }
+  end
+
+  def self.lists
+    @lists ||= {}
+  end
+
+  def self.reset
+    @lists = {}
+  end
+
+  def self.sync(label, &block)
+    lists[label] = ChimpSync::List.new.tap { |list| block.call list }
+  end
+end
+
+require 'chimp_sync/list'
+require 'chimp_sync/subscriber'
+require 'chimp_sync/update'

data/lib/chimp_sync/list.rb

@@ -0,0 +1,3 @@
+class ChimpSync::List
+  attr_accessor :id, :api_key, :update_local
+end

data/lib/chimp_sync/subscriber.rb

@@ -0,0 +1,37 @@
+class ChimpSync::Subscriber
+  def self.add(*types, &block)
+    types.each do |type|
+      ActiveSupport::Notifications.subscribe("#{type}.panthoot") do |*args|
+        new(type, &block).call *args
+      end
+    end
+  end
+
+  def initialize(type, &block)
+    @type, @block = type, block
+  end
+
+  def call(*arguments)
+    data = ActiveSupport::Notifications::Event.new(*arguments).payload[type]
+
+    ChimpSync.lists_for(data.list_id).each do |list|
+      block.call list, data
+    end
+  end
+
+  private
+
+  attr_reader :type, :block
+end
+
+ChimpSync::Subscriber.add :subscribe do |list, data|
+  list.update_local.call data.email, true
+end
+
+ChimpSync::Subscriber.add :unsubscribe, :email_cleaned do |list, data|
+  list.update_local.call data.email, false
+end
+
+ChimpSync::Subscriber.add :email_address_change do |list, data|
+  list.update_local.call data.old_email, false
+end

data/lib/chimp_sync/update.rb

@@ -0,0 +1,21 @@
+class ChimpSync::Update
+  def self.subscribed(label, email, subscribed)
+    list   = ChimpSync.lists[label]
+    gibbon = Gibbon::API.new list.api_key
+
+    if subscribed
+      gibbon.lists.subscribe id: list.id, email: {email: email},
+        double_optin: false, send_welcome: true
+    else
+      gibbon.lists.unsubscribe id: list.id, email: {email: email}
+    end
+  end
+
+  def self.email(label, old_email, new_email)
+    raise 'Not yet implemented.'
+    list   = ChimpSync.lists[label]
+    gibbon = Gibbon::API.new list.api_key
+
+    gibbon.lists.update_member id: list.id, email: {email: new_email}
+  end
+end

data/spec/internal/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |table|
+    table.string  :email,      null: false
+    table.boolean :subscribed, null: false
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/requests/sync_from_webhooks_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe 'Sync from Webhooks', type: :request do
+  let(:list_id) { 'a6b5da1054' }
+  let(:email)   { 'pat@test.com' }
+
+  before :each do
+    ChimpSync.reset
+    ChimpSync.sync :test_list do |list|
+      list.api_key = 'my-api-key'
+      list.id      = list_id
+
+      list.update_local = lambda { |email, subscribed|
+        User.find_by(email: email).update_attributes(subscribed: subscribed)
+      }
+    end
+  end
+
+  it 'marks users as subscribed when MailChimp sends a subscribe hook' do
+    user = User.create! email: email, subscribed: false
+
+    post '/panthoot/hooks', 'type' => 'subscribe',
+      'fired_at' => Time.zone.now.to_s(:db), 'data[id]' => '8a25ff1d98',
+      'data[list_id]' => list_id, 'data[email]' => email,
+      'data[email_type]' => 'html', 'data[merges][EMAIL]' => 'email',
+      'data[merges][FNAME]' => 'MailChimp', 'data[merges][LNAME]' => 'API',
+      'data[ip_opt]' => '10.20.10.30', 'data[ip_signup]' => '10.20.10.30'
+
+    expect(user.reload).to be_subscribed
+  end
+
+  it 'marks users as unsubscribed when MailChimp sends an unsubscribe hook' do
+    user = User.create! email: email, subscribed: true
+
+    post '/panthoot/hooks', 'type' => 'unsubscribe',
+      'fired_at' => Time.zone.now.to_s(:db), 'data[id]' => '8a25ff1d98',
+      'data[list_id]' => list_id, 'data[email]' => email,
+      'data[email_type]' => 'html', 'data[merges][EMAIL]' => 'email',
+      'data[merges][FNAME]' => 'MailChimp', 'data[merges][LNAME]' => 'API',
+      'data[ip_opt]' => '10.20.10.30', 'data[ip_signup]' => '10.20.10.30'
+
+    expect(user.reload).to_not be_subscribed
+  end
+
+  it 'marks users as unsubscribed when MailChimp sends a clean hook' do
+    user = User.create! email: email, subscribed: true
+
+    post '/panthoot/hooks', 'type' => 'cleaned',
+      'fired_at' => Time.zone.now.to_s(:db), 'data[list_id]' => list_id,
+      'data[campaign_id]' => '4fjk2ma9xd', 'data[reason]' => 'hard',
+      'data[email]' => email
+
+    expect(user.reload).to_not be_subscribed
+  end
+
+  it 'marks users as unsubscribed when MailChimp sends a change hook' do
+    user = User.create! email: email, subscribed: true
+
+    post '/panthoot/hooks', 'type' => 'upemail',
+      'fired_at' => Time.zone.now.to_s(:db), 'data[list_id]' => list_id,
+      'data[new_id]' => '51da8c3259',
+      'data[new_email]' => 'api+new@mailchimp.com', 'data[old_email]' => email
+
+    expect(user.reload).to_not be_subscribed
+  end
+end

data/spec/requests/update_via_api_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'Update subscriptions via API' do
+  let(:list_id) { 'a6b5da1054' }
+  let(:email)   { 'pat@test.com' }
+
+  before :each do
+    ChimpSync.reset
+    ChimpSync.sync :test_list do |list|
+      list.api_key = 'my-api-key'
+      list.id      = list_id
+
+      list.update_local = lambda { |email, subscribed|
+        User.find_by(email: email).update_attributes(subscribed: subscribed)
+      }
+    end
+
+    stub_request(:post, %r{\Ahttps://key\.api\.mailchimp\.com/2\.0/lists/}).
+      to_return(body: '')
+  end
+
+  it 'can mark an email address as subscribed' do
+    ChimpSync::Update.subscribed :test_list, 'pat@test.com', true
+
+    expect(
+      a_request(:post, 'https://key.api.mailchimp.com/2.0/lists/subscribe').
+        with(body: "{\"apikey\":\"my-api-key\",\"id\":\"a6b5da1054\",\"email\":{\"email\":\"pat@test.com\"},\"double_optin\":false,\"send_welcome\":true}")
+    ).to have_been_made
+  end
+
+  it 'can mark an email address as unsubscribed' do
+    ChimpSync::Update.subscribed :test_list, 'pat@test.com', false
+
+    expect(
+      a_request(:post, 'https://key.api.mailchimp.com/2.0/lists/unsubscribe').
+        with(body: "{\"apikey\":\"my-api-key\",\"id\":\"a6b5da1054\",\"email\":{\"email\":\"pat@test.com\"}}")
+    ).to have_been_made
+  end
+
+  it 'can update an email address' do
+    pending 'Need to identify the current email when sending through the new one'
+    ChimpSync::Update.email :test_list, 'pat@test.com', 'pat+new@test.com'
+
+    expect(a_request(
+      :post, 'https://key.api.mailchimp.com/2.0/lists/update-member'
+    ).with(
+      body: "{\"apikey\":\"my-api-key\",\"id\":\"a6b5da1054\",\"email\":{\"email\":\"pat+new@test.com\"}}"
+    )).to have_been_made
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+
+Bundler.setup :default, :development
+
+require 'rails'
+require 'combustion'
+require 'chimp_sync'
+
+Combustion.initialize! :action_controller, :active_record
+
+require 'rspec/rails'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: chimp_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gibbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: panthoot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+description: Synchronise your MailChimp list subscription details with your own data.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chimp_sync.gemspec
+- config.ru
+- lib/chimp_sync.rb
+- lib/chimp_sync/list.rb
+- lib/chimp_sync/subscriber.rb
+- lib/chimp_sync/update.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/requests/sync_from_webhooks_spec.rb
+- spec/requests/update_via_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/inspire9/chimp_sync
+licenses:
+- MIT
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Keep MailChimp list subscriptions synchronised.
+test_files:
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/requests/sync_from_webhooks_spec.rb
+- spec/requests/update_via_api_spec.rb
+- spec/spec_helper.rb