gogogibbon 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67f93827920932b5384a0fd9554480650fcdeed698343cb2c022140992276f9d
+  data.tar.gz: 451d17a1a97d08e88fc44dd6c8f69edf9d9a372c322e536a3edf2501b05fe66b
+SHA512:
+  metadata.gz: 6be359084aa1139bcc02d071bf68017a50132dfc025e054abda77cca37558c56b401c3a7ee9043c48e257225b7c22134b7de8811aa4c4ea0d60ebe62d7125ba7
+  data.tar.gz: f4465841d537ac0b149f4e7bc3dc18e58ec1486b6b31317d69e8d4db67fe1d62af11b649c7eadf1442cd64d15b45bb994645438c481940a7233c802483043981

data/gogogibbon.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/gogogibbon/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'gogogibbon'
+  s.version       = GoGoGibbon::VERSION
+  s.summary       = 'Useful helpers for Gibbon'
+  s.description   = 'A wrapper for Gibbon containing useful helper methods.'
+  s.authors       = ['GoGoCarl']
+  s.email         = 'carl.scott@solertium.com'
+  s.files         = Dir['lib/**/*'] + Dir['*.rb'] + ["gogogibbon.gemspec"]
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://github.com/GoGoCarl/gogogibbon'
+
+  s.add_dependency 'gibbon', '~> 2.2'
+end

data/lib/gogogibbon/callbacks.rb

@@ -0,0 +1,42 @@
+module GoGoGibbon
+
+  class Callbacks
+
+    def initialize opts={}
+      @options = { :thread => false }
+      @options.merge! opts
+    end
+
+    def after_create record
+      run do
+        GoGoGibbon.subscribe record
+      end
+    end
+
+    def after_update record
+      if record.email_changed? || record.first_name_changed? || record.last_name_changed?
+        run do 
+          GoGoGibbon.update_subscription record.email_was, record
+        end
+      end
+    end
+
+    def after_destroy record
+      run do
+        GoGoGibbon.cancel_user record
+      end
+    end
+
+    def run &block
+      if @options[:thread] == true
+        Thread.new do
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+  end
+
+end

data/lib/gogogibbon/commands.rb

@@ -0,0 +1,173 @@
+require 'gibbon'
+
+module GoGoGibbon
+  module Commands
+    class << self
+      # Store a hash of list name to ID
+      LIST_CACHE = {}
+
+      #
+      # Subscribe to the subscription list
+      #
+      def subscribe user, list_name=sub_list
+        result = false
+        sub_id = list list_name
+        unless sub_id.nil?
+          begin
+            body = {
+              'email_address' => user.email,
+              'status' => 'subscribed',
+              'merge_fields' => { 'FNAME' => user.first_name, 'LNAME' => user.last_name }
+            }
+            result = chimp.lists(sub_id).members.create(body: body)
+          rescue Gibbon::MailChimpError => e
+            raise e unless e.body['status'] == 400 && e.body['title'] == 'Member Exists'
+          end
+        end
+        result
+      end
+
+      def subscribe_set users, list_name=sub_list
+        result = false
+
+        sub_id = list list_name
+        unless sub_id.nil?
+          batch = []
+
+          defaults = { 'method' => 'POST', 'path' => "lists/#{sub_id}/members" }
+          handler = lambda do |user|
+            batch << defaults.merge("body" => {
+              'email_address' => user.email, 'status' => 'subscribed',
+              'merge_fields' => { 'FNAME' => user.first_name, 'LNAME' => user.last_name }
+            }.to_json)
+          end
+
+          if users.respond_to? :find_each
+            users.find_each { |user| handler.call(user) }
+          else
+            users.each { |user| handler.call(user) }
+          end
+
+          body = { "operations" => batch }
+
+          result = chimp.batches.create(body: body)
+          batch_id = result['id']
+          attempts = 1, backoff = 2
+          while result['status'] != 'finished' && attempts <= 10
+            sleep attempts * backoff
+            result = chimp.batches(batch_id).retrieve
+            attempts += 1
+          end
+
+          if result['status'] == 'finished'
+            result = {
+              'add_count' => result['finished_operations'],
+              'update_count' => 0,
+              'error_count' => result['errored_operations'],
+              'total_count' => result['total_operations'],
+              'errors' => []
+            }
+
+          else
+            result = false
+          end
+
+        end
+        result
+      end
+
+      def unsubscribe user, list_name=unsub_list
+        result = false
+
+        sub_id = list list_name
+        unless sub_id.nil?
+          begin
+            result = chimp.lists(sub_id).members(user_id(user.email)).delete
+          rescue Gibbon::MailChimpError => e
+            if e.body['status'] == 404
+              return true
+            else
+              raise e
+            end
+          end
+        end
+        result.nil?
+      end
+
+      #
+      # Unsubscribe from the subscription list, 
+      # subscribe to the unsubscription list.
+      #
+      def cancel_user user
+        result = false
+        unsubscribe user, sub_list
+        result = subscribe user, unsub_list
+        result
+      end
+
+      def list list_name
+        return LIST_CACHE[list_name] if LIST_CACHE.key?(list_name)
+        items = lists
+        list = nil
+        if items
+          p = items.select { |i| i['name'] == list_name }
+          if p.any?
+            list = p.first['id']
+          end
+        end
+        list
+      end
+
+      def update_subscription old_email, user, list_name=sub_list
+        result = false
+
+        sub_id = list list_name
+        unless sub_id.nil?
+          if old_email != user.email
+            unsubscribe Struct.new(:email).new(old_email), list_name
+          end
+
+          body = { 
+            'email_address' => user.email, 'status' => 'subscribed',
+            'merge_fields' => { 'FNAME' => user.first_name, 'LNAME' => user.last_name }
+          }
+
+          result = chimp.lists(sub_id).members(user_id(user.email)).upsert(body: body)
+        end
+        result
+      end
+
+      def lists
+        result = nil
+        begin
+          result = chimp.lists.retrieve(params: { "count" => 100, "fields" => "lists.id,lists.name" })["lists"]
+          result.each do |item|
+            LIST_CACHE[item['name']] = item['id']
+          end
+        rescue Gibbon::MailChimpError => e
+          puts e.detail
+          raise e unless e.body['status'] == 200
+        end
+        result
+      end
+
+      def chimp
+        GoGoGibbon::Config.chimp
+      end
+
+      def sub_list
+        GoGoGibbon::Config.subscribed
+      end
+
+      def unsub_list
+        GoGoGibbon::Config.unsubscribed
+      end
+
+      private
+
+      def user_id email
+        Digest::MD5.new.update(email.downcase).hexdigest
+      end
+    end
+  end
+end

data/lib/gogogibbon/config.rb

@@ -0,0 +1,28 @@
+require 'gibbon'
+
+module GoGoGibbon
+  class Config
+    class << self
+
+      attr_accessor :subscribed, :unsubscribed, :api_key, :chimp, :errors, :on_fail
+
+      def api_key=(value)
+        @chimp = Gibbon::Request.new api_key: value
+        @api_key = value
+      end
+
+      def configured?
+        !(@api_key.nil? || @subscribed.nil?)
+      end
+
+      def fail!
+        msg = 'MailChimp Configuration not complete. Please specify an api_key and subscription list.'
+        if @on_fail == :error
+          raise Exception.new msg
+        else
+          puts msg unless @on_fail == :silent
+        end
+      end
+    end
+  end
+end

data/lib/gogogibbon/methods.rb

@@ -0,0 +1,48 @@
+module GoGoGibbon
+  module Methods
+
+    def self.included base
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      #
+      # Options map can contain the following:
+      # * :thread -- true to run in a new thread, false otherwise (default false)
+      #
+
+      #
+      # When a user is created, subscribe that user to the mailing list
+      #
+      def mailchimp_on_create opts={}
+        after_create GoGoGibbon::Callbacks.new opts
+      end
+
+      #
+      # When a user is updated, update their profile, if necessary
+      #
+      def mailchimp_on_update opts={}
+        after_update GoGoGibbon::Callbacks.new opts
+      end
+
+      #
+      # When a user is deleted, cancel that user.
+      #
+      def mailchimp_on_destroy opts={}
+        after_destroy GoGoGibbon::Callbacks.new opts
+      end
+
+      #
+      # Return a list of users eligible to receive mail. Defaults to this class, 
+      # but can return anything relation
+      #
+      def Mailable
+        self
+      end
+
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, GoGoGibbon::Methods

data/lib/gogogibbon/version.rb

@@ -0,0 +1,3 @@
+module GoGoGibbon
+  VERSION = '2.0.0'
+end

data/lib/gogogibbon.rb

@@ -0,0 +1,59 @@
+require 'gogogibbon/commands'
+require 'gogogibbon/config'
+require 'gogogibbon/version'
+require 'gogogibbon/callbacks'
+require 'gogogibbon/methods'
+
+module GoGoGibbon
+  class << self
+
+    #
+    # Add a new user to the MailChimp subscription list
+    #
+    def subscribe user
+      execute { GoGoGibbon::Commands.subscribe user }
+    end
+
+    #
+    # Remove the user from the MailChimp subscription list.  If there is 
+    # a cancellation list configured, they will be subscribed to that.
+    #
+    def cancel_user user
+      execute { GoGoGibbon::Commands.cancel_user user }
+    end
+
+    #
+    # Update a user subscription given a user with the properties 
+    # email, first_name, and last_name.  You can always pass a struct 
+    # with these properties if your user object has these fields named 
+    # differently.
+    #
+    def update_subscription old_email, user
+      execute { GoGoGibbon::Commands.update_subscription old_email, user }
+    end
+
+    def execute &block
+      return unless ready?
+      yield
+    rescue Exception => e
+      if GoGoGibbon::Config.errors = :throw
+        raise e
+      else
+        return false
+      end
+    end
+
+    #
+    # Returns true if Gibbon has enough information to run, false otherwise. 
+    # API Key and subscription list are minimally required.
+    #
+    def ready?
+      result = GoGoGibbon::Config.configured?
+      unless result
+        GoGoGibbon::Config.fail!
+      end
+      result
+    end
+
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: gogogibbon
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- GoGoCarl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gibbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A wrapper for Gibbon containing useful helper methods.
+email: carl.scott@solertium.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- gogogibbon.gemspec
+- lib/gogogibbon.rb
+- lib/gogogibbon/callbacks.rb
+- lib/gogogibbon/commands.rb
+- lib/gogogibbon/config.rb
+- lib/gogogibbon/methods.rb
+- lib/gogogibbon/version.rb
+homepage: http://github.com/GoGoCarl/gogogibbon
+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: Useful helpers for Gibbon
+test_files: []