chimpy 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c969ef0d51ce19648c2fef489ec6b596d1c32df
+  data.tar.gz: d2a8eb0e5fc334e4e8506367ed472f9fa2862312
+SHA512:
+  metadata.gz: 339cc748a5107dedc441e986e6eed947a57e02d5989cb0730a1e3eb987eab9809c6b0b792a9cb9a8fc909794775654101c1e52de8dcbb5cc8a03ad1c2e5be057
+  data.tar.gz: 9240d729f13d671a2a06936eb741adebe60af4951c4fcb5735e399f74f94065f90b90273572a463b53693dc2cd4bfcec06f38a96dace8f35cd046e434440740c

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+.DS_Store
+test/dummy/log/
+test/dummy/log/development.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chimpy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ignacio Gutierrez
+
+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,47 @@
+# Chimpy
+
+Chimpy syncs your users from your DB to your respective lists in MailChimp.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chimpy'
+
+Then execute:
+
+    $ bundle
+
+Create an initializer with the details for the class you would like to sync with MailChimp and your mailchimp keys. It defaults to User
+
+``` ruby
+#initializers/chimpy.rb
+
+Chimpy.configure do |config|
+  config.sync_class = User
+  config.mailchimp_api_key = "549391d6ed3fc64fd42e4b5cf83ceba9-us8"
+  config.mailchimp_list_id = "788e29440b"
+end
+
+```
+Run Chimpy Generator
+
+    $ rails g chimpy:migrate
+
+After that execute the generated migration
+
+    $ rake db:migration
+
+## Usage
+
+To sync your users just run the following rake task. It is recommended to run it frequently with a cron or schedule it with Heroku Scheduler.
+
+    $ rake chimpy:sync
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/chimpy/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 new Pull Request

data/README.rdoc

@@ -0,0 +1,3 @@
+= Chimpy
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+end

data/chimpy.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chimpy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chimpy"
+  spec.version       = Chimpy::VERSION
+  spec.authors       = ["Ignacio Gutierrez"]
+  spec.email         = ["nachojgutierrez@gmail.com"]
+  spec.summary       = %q{Chimpy syncs your users from your DB to your respective lists in MailChimp.}
+  spec.description   = %q{Chimpy syncs your users from your DB to your respective lists in MailChimp.}
+  spec.homepage      = ""
+  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_dependency'gibbon', '>= 1.1.2'
+  spec.add_dependency 'railties', '>= 3.0.0'
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "vcr"
+
+  spec.add_development_dependency "rails", ">= 4.0.2"
+  spec.add_development_dependency "sqlite3"
+
+end

data/fixtures/vcr_cassettes/run.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://us8.api.mailchimp.com/2.0/lists/batch-subscribe
+    body:
+      encoding: UTF-8
+      string: '{"apikey":"549391d6ed3fc64fd42e4b5cf83ceba9-us8","id":"788e29440b","batch":[{"email":{"email":"david.gilmour@gmail.com"}},{"email":{"email":"nick.mason@gmail.com"}}],"update_existing":true,"double_optin":false}'
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '229'
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Sat, 10 May 2014 23:03:46 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - _AVESTA_ENVIRONMENT=prod; path=/
+    body:
+      encoding: UTF-8
+      string: '{"add_count":2,"adds":[{"email":"david.gilmour@gmail.com","euid":"0a80c3e59f","leid":"151471181"},{"email":"nick.mason@gmail.com","euid":"678343bc63","leid":"151471185"}],"update_count":0,"updates":[],"error_count":0,"errors":[]}'
+    http_version: 
+  recorded_at: Sat, 10 May 2014 23:03:44 GMT
+recorded_with: VCR 2.8.0

data/fixtures/vcr_cassettes/succesful_list_subscription.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://us8.api.mailchimp.com/2.0/lists/batch-subscribe
+    body:
+      encoding: UTF-8
+      string: '{"apikey":"549391d6ed3fc64fd42e4b5cf83ceba9-us8","id":"788e29440b","batch":[{"email":{"email":"johndonson@gmail.com"}},{"email":{"email":"donjohnson@gmail.com"}}],"update_existing":true,"double_optin":false}'
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '227'
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Fri, 09 May 2014 21:17:33 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - _AVESTA_ENVIRONMENT=prod; path=/
+    body:
+      encoding: UTF-8
+      string: '{"add_count":2,"adds":[{"email":"johndonson@gmail.com","euid":"d4c1408824","leid":"151330921"},{"email":"donjohnson@gmail.com","euid":"7f18d87748","leid":"151330925"}],"update_count":0,"updates":[],"error_count":0,"errors":[]}'
+    http_version: 
+  recorded_at: Fri, 09 May 2014 21:17:33 GMT
+recorded_with: VCR 2.8.0

data/lib/chimpy.rb

@@ -0,0 +1,22 @@
+require 'chimpy/version'
+require 'chimpy/configuration'
+require 'chimpy/base'
+require 'chimpy/user_manager'
+require 'chimpy/email_service'
+require 'chimpy/railtie' if defined?(Rails)
+
+
+module Chimpy
+
+  def self.run
+    Base.run
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/chimpy/base.rb

@@ -0,0 +1,9 @@
+module Chimpy
+  class Base
+    def self.run
+      user_manager = UserManager.new
+      synced_users = EmailService.new.sync(user_manager.to_sync)
+      user_manager.mark_as_synced(synced_users)
+    end
+  end
+end

data/lib/chimpy/configuration.rb

@@ -0,0 +1,11 @@
+module Chimpy
+  class Configuration
+    attr_accessor :sync_class, :mailchimp_api_key, :mailchimp_list_id
+
+    def initialize
+      @sync_class = User
+      @mailchimp_api_key = ENV['MAILCHIMP_API_KEY']
+      @mailchimp_list_id = ENV['MAILCHIMP_LIST_ID']
+    end
+  end
+end

data/lib/chimpy/email_service.rb

@@ -0,0 +1,40 @@
+require 'gibbon'
+
+module Chimpy
+  class EmailService
+    attr_reader :mailchimp, :mailchimp_api_key, :mailchimp_list_id
+
+    def initialize
+      @mailchimp_api_key = Chimpy.configuration.mailchimp_api_key
+      @mailchimp_list_id = Chimpy.configuration.mailchimp_list_id
+      @mailchimp = create_mailchimp_client
+    end
+
+    def sync(users)
+      struct = users.map { |user| { email: { email: user.email } } }
+      response = mailchimp.lists.batch_subscribe(id: mailchimp_list_id,
+                                                 batch: struct,
+                                                 update_existing: true,
+                                                 double_optin: false)
+      synced_users(response)
+    end
+
+    private
+
+    def synced_users(response)
+      emails = []
+      response['adds'].each do |add|
+        emails << add['email']
+      end
+
+      response['updates'].each do |update|
+        emails << update['email']
+      end
+      emails
+    end
+
+    def create_mailchimp_client
+      Gibbon::API.new(mailchimp_api_key)
+    end
+  end
+end

data/lib/chimpy/railtie.rb

@@ -0,0 +1,16 @@
+require 'chimpy'
+require 'rails'
+module Chimpy
+  class Railtie < Rails::Railtie
+    railtie_name :chimpy
+
+    rake_tasks do
+      load "tasks/chimpy.rake"
+    end
+
+    generators do
+      load "generators/migration_generator.rb"
+    end
+
+  end
+end

data/lib/chimpy/user_manager.rb

@@ -0,0 +1,22 @@
+module Chimpy
+  class UserManager
+    attr_reader :sync_class
+
+    def initialize
+      @sync_class = Chimpy.configuration.sync_class
+    end
+
+    def to_sync
+      never_synced = sync_class.where(chimpy_synced_at: nil)
+      needing_sync = sync_class.where('updated_at > chimpy_synced_at')
+      never_synced + needing_sync
+    end
+
+    def mark_as_synced(emails)
+      emails.each do |email|
+        found = sync_class.find_by_email(email)
+        found.update(chimpy_synced_at: Time.now) if found
+      end
+    end
+  end
+end

data/lib/chimpy/version.rb

@@ -0,0 +1,3 @@
+module Chimpy
+  VERSION = '0.0.6'
+end

data/lib/generators/migration_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+
+module Chimpy
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      @sync_class = Chimpy.configuration.sync_class.to_s
+      migration_template('add_column_to_sync_class.rb.erb', "db/migrate/add_chimpy_to_#{@sync_class.underscore.pluralize}.rb")
+    end
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  end
+end

data/lib/generators/templates/add_column_to_sync_class.rb.erb

@@ -0,0 +1,5 @@
+class AddChimpyTo<%= @sync_class.to_s.pluralize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= @sync_class.parameterize.underscore.pluralize.to_sym %>, :chimpy_synced_at, :datetime
+  end
+end

data/lib/tasks/chimpy.rake

@@ -0,0 +1,6 @@
+namespace :chimpy do
+  desc 'Runs Chimpy. It syncs your users to your desired MailChimp list'
+  task :sync => :environment do
+    Chimpy::Base.run
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Chimpy::Base do
+
+  before do
+    Chimpy.configure do |config|
+      config.sync_class = User
+      config.mailchimp_api_key = "549391d6ed3fc64fd42e4b5cf83ceba9-us8"
+      config.mailchimp_list_id = "788e29440b"
+    end
+  end
+
+  describe "run" do
+    before do
+      @new_user = User.create(email: "david.gilmour@gmail.com")
+      @already_synced = User.create(email: "roger.waters@gmail.com", chimpy_synced_at: 1.day.ago, updated_at: 3.days.ago)
+      @to_sync = User.create(email: "nick.mason@gmail.com", chimpy_synced_at: 5.days.ago, updated_at: 1.day.ago)
+      VCR.use_cassette('run') do
+        Chimpy.run
+      end
+    end
+
+    it "syncs the new user" do
+      @new_user.reload.chimpy_synced_at.wont_equal nil
+    end
+
+    it "syncs the user who needs sync" do
+      @to_sync.chimpy_synced_at.must_be :<, @to_sync.reload.chimpy_synced_at
+    end
+
+    it "leaves the already synced user untouched" do
+      @already_synced.chimpy_synced_at.must_equal  @already_synced.reload.chimpy_synced_at
+    end
+  end
+end
+

data/test/configuration_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+describe Chimpy::Configuration do
+  describe "#sync_class" do
+    it "default value is User" do
+      Chimpy::Configuration.new.sync_class.must_equal User
+    end
+  end
+  describe "#sync_class=" do
+    it "can set value" do
+      config = Chimpy::Configuration.new
+      config.sync_class = Object.const_set("Admin" ,Class.new)
+      config.sync_class.must_equal Admin
+    end
+  end
+end