devise_mailjet 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e54b0e5430f9fd1e5c9fedc92190caffbe4adfb
+  data.tar.gz: f3964d2f000ff3bcad2f68da8676b02608a1137f
+SHA512:
+  metadata.gz: cd182ae9e33c74538caba2d7cc94594b95d2efdbf456720cf2385c746314275e9bae02bf7f71a7f009beaad98683283254b44ec726a7c8b3fffbdb52444b12cb
+  data.tar.gz: eb1f2aecffd249046e3704765a90ac5cf635e4bb92508e0ff81c26012cd18d037dd2aaa19a36573852be3d5fcbdeef74be0ed768bf6468658d58bcec6ef926c7

data/.gitignore

@@ -0,0 +1,5 @@
+.idea
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/MIT_LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2011 Justin Cunningham
+
+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.rdoc

@@ -0,0 +1,103 @@
+= Devise MailJet
+
+Devise MailJet adds a MailJet option to {devise}[https://github.com/plataformatec/devise] that easily enables users
+to join your mailing list when they create an account.
+
+{Delayed Job}[https://github.com/collectiveidea/delayed_job] is used automatically if your project uses it, and the
+mapping between list names and list ids is cached automatically.
+
+== Getting started
+
+In your Gemfile, add devise_mailjet after devise:
+
+  gem "devise"
+  gem "devise_mailjet"  # Last officially released gem
+
+In your User model, add :mailjet to the devise call and make :join_mailing_list accessible:
+
+  devise :database_authenticatable, ..., :mailjet
+  attr_accessible :join_mailing_list
+
+In your devise initializer (config/initializers/devise.rb), set your API key and mailing list name:
+
+  Devise.mailjet_api_key = 'your_api_key'
+  Devise.mailing_list_name = 'List Name'
+  Devise.double_opt_in = false  
+  Devise.send_welcome_email = false  
+
+If you are using the default Devise registration views, the Join Mailing List checkbox is added automatically, if not,
+either include the form partial in your new registration form:
+
+  <%= render :partial => "devise/shared/mailjet/form", :locals => {:form => f} %>
+
+Or manually add a "Join Mailing List" checkbox to your new registration form:
+
+  <%= form.check_box :join_mailing_list %>
+
+If you are using Simple Form, you can use:
+
+  <%= f.input :join_mailing_list, :as => :boolean %>
+
+== Configuration
+
+Create an initializer, and set your MailJet API key.  To generate a new API key, go to the account tab in your
+MailJet account and select API Keys & Authorized Apps, then add a key.
+
+  Devise.mailjet_api_key = 'your_api_key'
+
+Create a mailing list, and set the mailing list name in the initializer.  To create a MailJet list, from your account
+go to the Lists tab, then hit create list.
+
+  Devise.mailing_list_name = 'List Name'
+
+Add options from the {MailJet API Docs}[http://dev.mailjet.com/] using the following code in user.rb model. For GROUPINGS, you can get the Group ID by clicking "import to" and looking at the URL https://us6.admin.mailjet.com/lists/members/import?id=1234&grp=9999&int=1
+
+  def mailjet_list_subscribe_options
+    {'FNAME' => self.first_name, 'LNAME' => self.last_name, 'GROUPINGS'=> { 0 => {'id' => 9999, 'groups' => "Signed Up" } } }
+  end
+
+For all the configuration settings, take a look at the {model documenation}[http://rubydoc.info/github/zedalaye/devise_mailjet/master/Devise/Models/Mailjet#].
+
+== Documentation
+
+Full documentation is available at {rdoc.info}[http://rdoc.info/github/zedalaye/devise_mailjet/master/frames].
+
+== Demo Application
+
+A demo application is available at {github}[https://github.com/zedalaye/devise_mailjet_demo].
+
+== Example Usage
+
+Users will join the default mailing list if join_mailing_list is set to true when the user is created.  To manually add
+a user:
+
+  User.find(1).add_to_mailjet_list('Site Administrators List')
+
+To manually remove a user:
+
+  User.find(1).remove_from_mailjet_list('Site Administrators List')
+
+NOTE:  You MUST have the users permission to add them to a mailing list.
+
+== Customization
+
+To have the user join more than one list, or to override the lists that the user will join, override
+mailjet_lists_to_join in your model.  Your method should return a single list, or an array of lists.
+
+  def mailjet_lists_to_join
+    lists = ["Site Users List"]
+    lists << "Site Admins List" if admin?
+    return lists
+  end
+
+If all users will join the same list or lists, just set the mailing_list_name configuration option.
+
+== Contributions
+
+Please help this software improve by submitting pull requests, preferably with tests.
+
+View our {contributors}[https://github.com/zedalaye/devise_mailjet/contributors].
+
+== Copyright
+
+Copyright (c) 2011 {Justin Cunningham}[http://littlebitofcode.com] and 2014 {Pierre Yager}[http://levosgien.net]. See MIT_LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/views/devise/registrations/new.html.erb

@@ -0,0 +1,28 @@
+<%= bootstrap_devise_error_messages! %>
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4><%= t('.sign_up', :default => "Sign up") %></h4>
+  </div>
+  <div class="panel-body">
+    <%= form_for(resource, :as => resource_name, :url => registration_path(resource_name), html: { role: "form" }) do |f| %>
+      <div class="form-group">
+        <%= f.label :email %>
+        <%= f.email_field :email, class: "form-control" %>
+      </div>
+      <div class="form-group">
+        <%= f.label :password %><br />
+        <%= f.password_field :password, class: "form-control" %>
+      </div>
+      <div class="form-group">
+        <%= f.label :password_confirmation %>
+        <%= f.password_field :password_confirmation, class: "form-control" %>
+      </div>
+
+      <%= render :partial => "devise/shared/mailjet/form", :locals => {:form => f} %>
+
+      <%= f.submit t('.sign_up', :default => "Sign up"), class: "btn btn-primary" %>
+    <% end %>
+  </div>
+</div>
+
+<%= render "devise/shared/links" %>

data/app/views/devise/shared/mailjet/_form.html.erb

@@ -0,0 +1,4 @@
+  <div class="form-group">
+    <%= form.label :join_mailing_list %>
+    <%= form.check_box :join_mailing_list %>
+  </div>

data/devise_mailjet.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_mailjet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devise_mailjet"
+  s.version     = DeviseMailjet::VERSION
+  s.authors     = ["Justin Cunningham", "Pierre Yager"]
+  s.email       = ["justin@compucatedsolutions.com", "pierre@levosgien.net"]
+  s.homepage    = "http://zedalaye.github.com/devise_mailjet/"
+  s.summary     = %q{Easy MailJet integration for Devise}
+  s.description = %q{Devise MailJet adds a MailJet option to devise that easily enables users to join your mailing list when they create an account.}
+  s.licenses    = 'MIT'
+
+  s.rubyforge_project = "devise_mailjet"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  {
+    'rails'  => '~> 4.1',
+    'devise' => '~> 3.3',
+    'devise-bootstrap-views' => '~> 0.0',
+    'mailjet' => '~> 1.0'
+  }.each do |lib, version|
+    s.add_runtime_dependency(lib, *version)
+  end
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/devise_mailjet.rb

@@ -0,0 +1,33 @@
+require 'devise'
+
+require "devise_mailjet/version"
+
+module DeviseMailjet
+  class Engine < Rails::Engine
+  end
+  # Your code goes here...
+end
+
+module Devise
+  # Public: Default mailing list for user to join.  This can be an array of strings, or just one string.
+  # By default, this is "Site List".  If this will be configurable for each user, override
+  # mailjet_lists_to_join returning the list name or an array of list names for the user to
+  # join.
+  # Set mailing_list_name in the Devise configuration file (config/initializers/devise.rb)
+  #
+  #   Devise.mailing_list_name = "Your Mailing List Name"
+  mattr_accessor :mailing_list_name
+  @@mailing_list_name = "Newsletter"
+
+  # Public: Determines if the checkbox for the user to opt-in to the mailing list should
+  # be checked by default, or not.  Defaults to true.
+  # Set mailing_list_opt_in_by_default in the Devise configuration file (config/initializers/devise.rb)
+  #
+  #   Devise.mailing_list_opt_in_by_default = false
+  mattr_accessor :mailing_list_opt_in_by_default
+  @@mailing_list_opt_in_by_default = true
+end
+
+Devise.add_module :mailjet, :model => 'devise_mailjet/model'
+
+require 'devise_mailjet/mailjet_list_api_mapper'

data/lib/devise_mailjet/mailjet_list_api_mapper.rb

@@ -0,0 +1,114 @@
+require 'mailjet'
+
+module Devise
+  module Models
+    module Mailjet
+      class MailjetListApiMapper
+        LISTS_CACHE_KEY = "devise_mailjet/lists"
+        CONTACTS_CACHE_KEY = "devise_mailjet/contacts"
+
+        # looks the name up in the cache.  if it doesn't find it, looks it up using the api and saves it to the cache
+        def list_name_to_id(list_name)
+          load_cached_lists
+          unless @lists.has_key?(list_name)
+            list = mailjet_list.first(name: list_name)
+            list = mailjet_list.create(name: list_name) if list.nil?
+            @lists[list_name] = list.id
+            save_cached_lists
+          end
+          @lists[list_name]
+        end
+
+        def contact_email_to_id(email)
+          load_cached_contacts
+          unless @contacts.has_key?(email)
+            contact = mailjet_contact.find(email) # email is a valid key for finding contact resources
+            contact = mailjet_contact.create(email: email) if contact.nil?
+            @contacts[email] = contact.id
+            save_cached_contacts
+          end
+          @contacts[email]
+        end
+
+        # subscribes the user to the named mailing list(s).  list_names can be the name of one list, or an array of
+        # several.
+        #
+        # NOTE: Do not use this method unless the user has opted in.
+        def subscribe_to_lists(list_names, email)
+          walk_recipients(list_names, email) do |lr, list_id, contact_id|
+            if lr.nil?
+              mailjet_rcpt.create('ListID' => list_id, 'ContactID' => contact_id, is_active: true)
+            elsif lr.is_unsubscribed
+              lr.is_unsubscribed = false
+              lr.is_active = true
+              lr.save
+            end
+          end
+        end
+
+        # unsubscribe the user from the named mailing list(s).  list_names can be the name of one list, or an array of
+        # several.
+        def unsubscribe_from_lists(list_names, email)
+          walk_recipients(list_names, email) do |lr, _, _|
+            if lr && !lr.is_unsubscribed
+              lr.is_unsubscribed = true
+              lr.is_active = false
+              lr.save
+            end
+          end
+        end
+
+        class ListLookupError < RuntimeError; end
+
+        private
+
+        def walk_recipients(list_names, email)
+          contact_id = contact_email_to_id(email)
+          list_names = [list_names] unless list_names.is_a?(Array)
+          list_names.each do |list_name|
+            list_id = list_name_to_id(list_name)
+            lr = mailjet_rcpt.first('ContactsList' => list_id, 'Contact' =>  contact_id)
+            yield lr, list_id, contact_id if block_given?
+          end
+        end
+
+        # load the list from the cache
+        def load_cached_lists
+          @lists ||= Rails.cache.fetch(LISTS_CACHE_KEY) do
+            {}
+          end.dup
+        end
+
+        # save the modified list back to the cache
+        def save_cached_lists
+          Rails.cache.write(LISTS_CACHE_KEY, @lists)
+        end
+
+        # load contacts from the cache
+        def load_cached_contacts
+          @contacts ||= Rails.cache.fetch(CONTACTS_CACHE_KEY) do
+            {}
+          end.dup
+        end
+
+        # save the modified contacts back to the cache
+        def save_cached_contacts
+          Rails.cache.write(CONTACTS_CACHE_KEY, @contacts)
+        end
+
+        # the mailjet api helpers
+        def mailjet_contact
+          ::Mailjet::Contact
+        end
+
+        def mailjet_list
+          ::Mailjet::Contactslist
+        end
+
+        def mailjet_rcpt
+          ::Mailjet::Listrecipient
+        end
+      end
+    end
+  end
+end

data/lib/devise_mailjet/model.rb

@@ -0,0 +1,84 @@
+module Devise
+  module Models
+    # Mailjet is responsible for joining users to mailjet lists when the create accounts with devise
+    # When a user is created, and join_mailing_list is set to true, they will automatically be added to one or more
+    # mailing lists returned by mailjet_lists_to_join.
+    #
+    # Configuration
+    #
+    #   mailing_list_name: Default mailing list for user to join.  This can be an array of strings, or just one string.
+    #                      By default, this is "Site List".  If this will be configurable for each user, override
+    #                      mailjet_lists_to_join returning the list name or an array of list names for the user to
+    #                      join.
+    #
+    #   mailing_list_opt_in_by_default: Determines if the checkbox for the user to opt-in to the mailing list should
+    #                                   be checked by default, or not.  Defaults to true.
+    #
+    # Examples:
+    #
+    #   User.find(1).add_to_mailjet_list('Site Administrators List')
+    #   User.find(1).remove_from_mailjet_list('Site Administrators List')
+    #
+    #   u = User.new
+    #   u.join_mailing_list = true
+    #   u.save
+    module Mailjet
+      extend ActiveSupport::Concern
+
+      included do
+        after_create :commit_mailing_list_join
+        after_update :commit_mailing_list_join
+      end
+
+      def self.required_fields(klass)
+        [ :join_mailing_list ]
+      end
+
+      # Set this to true to have the user automatically join the mailjet_lists_to_join
+      def join_mailing_list=(join)
+        join.downcase! if join.is_a?(String)
+        write_attribute(:join_mailing_list, ['yes','true',true,'1',1].include?(join))
+      end
+
+      def join_mailing_list
+        (new_record?) ? self.class.mailing_list_opt_in_by_default : read_attribute(:join_mailing_list)
+      end
+
+      # The mailing list or lists the user will join
+      # Should return either a single string or an array of strings.  By default, returns the mailing_list_name
+      # configuration option.  If you want to customize the lists based on other information, override this method in
+      # your model.
+      def mailjet_lists_to_join
+        self.class.mailing_list_name
+      end
+
+      # Add the user to the mailjet list with the specified name
+      def add_to_mailjet_list(list_name)
+        mapper = mailjet_list_mapper.respond_to?(:delay) ? mailjet_list_mapper.delay : mailjet_list_mapper
+        # options = self.respond_to?(:mailjet_list_subscribe_options) ? mailjet_list_subscribe_options : {}
+        mapper.subscribe_to_lists(list_name, self.email)
+      end
+
+      # remove the user from the mailjet list with the specified name
+      def remove_from_mailjet_list(list_name)
+        mapper = mailjet_list_mapper.respond_to?(:delay) ? mailjet_list_mapper.delay : mailjet_list_mapper
+        mapper.unsubscribe_from_lists(list_name, self.email)
+      end
+
+      # Commit the user to the mailing list if they have selected to join
+      def commit_mailing_list_join
+        add_to_mailjet_list(mailjet_lists_to_join) if self.join_mailing_list
+      end
+
+      # mapper that helps convert list names to mailjet ids
+      def mailjet_list_mapper
+        @@mailjet_list_mapper ||= MailjetListApiMapper.new
+      end
+
+      module ClassMethods
+        Devise::Models.config(self, :mailing_list_name)
+        Devise::Models.config(self, :mailing_list_opt_in_by_default)
+      end
+    end
+  end
+end

data/lib/devise_mailjet/version.rb

@@ -0,0 +1,3 @@
+module DeviseMailjet
+  VERSION = "0.0.5"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: devise_mailjet
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Justin Cunningham
+- Pierre Yager
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: devise-bootstrap-views
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: mailjet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Devise MailJet adds a MailJet option to devise that easily enables users
+  to join your mailing list when they create an account.
+email:
+- justin@compucatedsolutions.com
+- pierre@levosgien.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT_LICENSE
+- README.rdoc
+- Rakefile
+- app/views/devise/registrations/new.html.erb
+- app/views/devise/shared/mailjet/_form.html.erb
+- devise_mailjet.gemspec
+- lib/devise_mailjet.rb
+- lib/devise_mailjet/mailjet_list_api_mapper.rb
+- lib/devise_mailjet/model.rb
+- lib/devise_mailjet/version.rb
+homepage: http://zedalaye.github.com/devise_mailjet/
+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: devise_mailjet
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easy MailJet integration for Devise
+test_files: []