mailfox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ace07536211ef8f493dc0df1cb9f2421eb709fe
+  data.tar.gz: 4cbb42a06cf3ad587643c00e8c89bdbb9d25b166
+SHA512:
+  metadata.gz: af1a2c0c9f40e0527ddecc9163915845e8c3e828b4f329e680dfcc797e8863ae8bcdd57dd0313576a832c9c36591aad5c4e269a39822e6fc09b2e4bdedccce16
+  data.tar.gz: 2a7cfe37ff6350e8be7fd5f51d65b0ce7f8f7e8b927a6004c7dc1f5eda5da2d142dd9e470fc39398939bebff35cec565fe2fc204bfc2a53be15c5dc2e56f2c49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Adam Bahlke
+
+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/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mailfox'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+task :routes => 'app:environment' do
+  Rails.application.reload_routes!
+  all_routes = Mailfox::Engine.routes.routes
+end

data/app/assets/javascripts/mailfox/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/mailfox/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/cms/snippets/newsletter_partial.snippet

@@ -0,0 +1,6 @@
+{{ cms:field:newsletter.list_id }}
+{{ cms:field:newsletter.placeholder }}
+{{ cms:field:newsletter.disable_with_message }}
+{{ cms:field:newsletter.button }}
+
+{{ cms:partial:mailfox/newsletters/cms/form }}

data/app/controllers/mailfox/application_controller.rb

@@ -0,0 +1,5 @@
+module Mailfox
+  class ApplicationController < ActionController::Base
+    helper Mailfox::ApplicationHelper
+  end
+end

data/app/controllers/mailfox/newsletters_controller.rb

@@ -0,0 +1,71 @@
+module Mailfox
+  class NewslettersController < Mailfox::ApplicationController
+
+  #
+  # Settings
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  layout false
+
+  #
+  # Filter
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  #
+  # Plugins
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  #
+  # Actions
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  def create
+    @customer = MailService::Customer.create(permitted_params)
+
+    respond_to do |format|
+      format.js
+    end
+  end
+
+  #
+  # Protected
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  protected
+
+  #
+  # Private
+  # ---------------------------------------------------------------------------------------
+  #
+  #
+  #
+  #
+
+  private
+
+  def permitted_params
+    params.require(:newsletter).permit(:email, :list_id)
+  end
+
+  end
+end

data/app/helpers/mailfox/application_helper.rb

@@ -0,0 +1,13 @@
+module Mailfox
+  module ApplicationHelper
+    def error_messages_for(object, options = {})
+      messages = options[:length] ? [object.errors.full_messages[options[:length] - 1]] : object.errors.full_messages
+      
+      content_tag :ul, class: 'error-messages' do
+        messages.each do |msg|
+          concat content_tag(:li, msg)
+        end
+      end
+    end
+  end
+end

data/app/services/mail_service.rb

@@ -0,0 +1,16 @@
+require 'mail_service/member'
+require 'mail_service/customer'
+
+module MailService
+  autoload :Member, 'mail_service/member'
+  autoload :Customer, 'mail_service/customer'
+
+  Gibbon::API.api_key = Mailfox.mailservices['mailchimp']['api_key']
+  Gibbon::API.timeout = 15
+  Gibbon::API.throws_exceptions = false
+  
+  def self.connection(api_key = nil)
+    Gibbon::API.new(api_key)
+  end
+
+end

data/app/services/mail_service/customer.rb

@@ -0,0 +1,103 @@
+module MailService
+  class Customer < Member
+
+    #
+    # Concerns
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Constants
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Index
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Attribute Settings
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Validations
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+            
+    #
+    # Callbacks
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Constructor
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    def initialize(attributes = {})
+      defaults = { list_id: Mailfox.mailservices['mailchimp']['list_id']['customer'] }
+      attributes = defaults.merge(attributes).symbolize_keys
+      
+      super
+    end
+
+    #
+    # Instance Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Class Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+    #
+    # Protected Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    protected
+
+    #
+    # Private Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    private
+  
+  end
+end

data/app/services/mail_service/list.rb

@@ -0,0 +1,128 @@
+module MailService
+  class List
+
+    #
+    # Concerns
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    include ActiveModel::Model
+
+    #
+    # Constants
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Index
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Attribute Settings
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Validations
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+            
+    #
+    # Callbacks
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Constructor
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Instance Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Class Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    def self.exists?(id)
+      find_by_id(id).present?
+    end
+
+    def self.find_by_id(id)
+      return nil unless id
+
+      response = fetch(filters: { list_id: id }).try(:with_indifferent_access)
+      response[:data].try(:map, &:with_indifferent_access).try(:first) if response[:total] == 1
+    end
+  
+    def self.all(options = {})
+      fetch(options)[:data].try(:map, &:with_indifferent_access)
+    end
+
+    def self.count(options = {})
+      fetch(options)[:total]
+    end
+
+    def self.fetch(options = {})
+      begin
+        parent.connection.lists.list(options).with_indifferent_access
+      rescue => e  
+        Rails.logger.info "**[MailService Error][Exists] #{e.message}"   
+        Rails.logger.warn "**[MailService Error][Exists] #{e.backtrace.join("\n")}" if Rails.env.development?
+        {}
+      end
+    end
+
+    #
+    # Protected Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    protected
+
+    #
+    # Private Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    private
+
+  end
+end

data/app/services/mail_service/member.rb

@@ -0,0 +1,224 @@
+module MailService
+  class Member
+
+    #
+    # Concerns
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    include ActiveModel::Model
+
+    #
+    # Constants
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Index
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Attribute Settings
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    attr_accessor :email, :list_id, :locale
+  
+    attr_reader :connection, :subscriber_id, :double_optin
+    
+    alias_method :name, :email
+
+    #
+    # Validations
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    validates :email, :list_id, presence: true
+
+    validates :email, email: true, allow_blank: true
+
+    validate :uniqueness_of_email
+
+    #
+    # Callbacks
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Constructor
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+  
+    def initialize(attributes = {})
+      defaults = {
+        locale: I18n.locale,
+        double_optin: true
+      }
+      
+      attributes = defaults.merge(attributes).symbolize_keys
+
+      @email = attributes[:email]
+      @locale = attributes[:locale]
+      @connection = self.class.parent.connection
+      @double_optin = attributes[:double_optin]
+      @list_id = attributes[:list_id]
+      
+      yield self if block_given?
+    end
+
+    #
+    # Instance Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    def list
+      List.find_by_list_id(list_id) if list_id
+    end
+
+    def info
+      begin
+        unless @info
+          response = connection.lists.member_info(id: list_id, emails: [{ email: email}]).with_indifferent_access
+          @info = response[:data].first if response[:success_count] && response[:success_count] >= 1
+        end
+      rescue => e
+        Rails.logger.info "**[MailService Error][Info] #{e.message}"
+        Rails.logger.warn "**[MailService Error][Info] #{e.backtrace.join("\n")}" if Rails.env.development?
+      end
+      
+      @info || {}
+    end
+
+    def persisted?
+      false
+    end
+
+    def save
+      return false unless valid?
+
+      return true if Rails.env.test?
+
+      begin
+        connection.lists.subscribe(
+          id: list_id, 
+          email: { email: email },
+          double_optin: double_optin,
+          merge_vars: { mc_language: locale }
+        )
+      rescue => e
+        Rails.logger.info "**[MailService Error][Save] #{e.message}"
+        Rails.logger.warn "**[MailService Error][Save] #{e.backtrace.join("\n")}" if Rails.env.development?
+        false
+      end
+    end
+
+    def destroy
+      begin
+        connection.lists.unsubscribe(
+          id: list_id, 
+          email: { email: email }
+        )
+      rescue => e
+        Rails.logger.info "**[MailService Error][Destroy] #{e.message}"
+        Rails.logger.warn "**[MailService Error][Destroy] #{e.backtrace.join("\n")}" if Rails.env.development?
+      end
+    end
+
+    def confirmed?
+      info[:timestamp_opt].present?
+    end
+
+    def method_missing(method_name, *args, &block)
+      if info.keys.include?(method_name.to_s)
+        info[method_name]
+      else
+        super
+      end
+    end
+
+    #
+    # Class Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    def self.create(attributes = {})
+      mailservice = new(attributes)
+      mailservice.save
+      mailservice
+    end
+
+    def self.find_by_email(email)
+      new(new(email: email).info.symbolize_keys)
+    end
+
+    def self.exists?(options = {})
+      return false if options.blank?
+
+      begin
+        new(options.slice(:email, :list_id)).info.present?
+      rescue => e  
+        Rails.logger.info "**[MailService Error][Exists] #{e.message}"   
+        Rails.logger.warn "**[MailService Error][Exists] #{e.backtrace.join("\n")}" if Rails.env.development?   
+        e.message
+      end
+    end
+
+    #
+    # Protected Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    protected
+
+    #
+    # Private Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    private
+
+    def uniqueness_of_email
+      existence = self.class.exists?(email: email, list_id: list_id)
+
+      case existence
+        when TrueClass then errors.add(:email, :taken)
+        when String then errors.add(:email, existence)
+      end
+    end
+
+  end
+end

data/app/views/layouts/mailfox/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mailfox</title>
+  <%= stylesheet_link_tag    "mailfox/application", media: "all" %>
+  <%= javascript_include_tag "mailfox/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/mailfox/newsletters/_form.html.erb

@@ -0,0 +1,6 @@
+<%= form_for MailService::Customer.new, url: mailfox.newsletter_subscribe_path, as: :newsletter, remote: true, html: { class: 'mailfox-newsletter-form' } do |f| %>
+  <%= f.hidden_field :list_id, value: list_id %>
+  <%= f.text_field :email, placeholder: placeholder, class: 'mailfox-newsletter-input' %>
+  <%= f.submit submit_button_message, class: 'mailfox-newsletter-submit', data: { disable_with: disable_with_message } %>
+  <div class="mailfox-newsletter-msg"></div>
+<% end %>

data/app/views/mailfox/newsletters/cms/_form.html.erb

@@ -0,0 +1 @@
+<%= render partial: "mailfox/newsletters/form", locals: {placeholder: cms_block_content("newsletter.placeholder"), list_id: cms_block_content("newsletter.list_id"), disable_with_message: cms_block_content("newsletter.disable_with_message"), submit_button_message: cms_block_content("newsletter.button")} %>

data/app/views/mailfox/newsletters/create.js.erb

@@ -0,0 +1,16 @@
+<% if @customer.errors.empty? %>
+
+$('.mailfox-newsletter-msg').html('<%= t(".success") %>');
+$('.mailfox-newsletter-input').val('');
+$('.mailfox-newsletter-form').removeClass('mailfox-newsletter-error').addClass('mailfox-newsletter-success');
+
+setTimeout(function() {
+  $('.mailfox-newsletter-form').removeClass('mailfox-newsletter-success');
+}, 5000);
+
+<% else %>
+
+$('.mailfox-newsletter-msg').html('<%= error_messages_for(@customer, length: 1).html_safe %>');
+$('.mailfox-newsletter-form').removeClass('mailfox-newsletter-success').addClass('mailfox-newsletter-error');
+
+<% end %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Mailfox::Engine.routes.draw do
+  # resource :newsletters, only: :create
+  controller :newsletters do
+    post "/newsletters", to: "newsletters#create", as: :newsletter_subscribe
+  end
+end

data/lib/mailfox.rb

@@ -0,0 +1,10 @@
+require "mailfox/engine"
+
+module Mailfox
+  mattr_accessor :mailservices
+  @@mailservices = nil
+
+  def self.setup
+    yield self
+  end
+end

data/lib/mailfox/engine.rb

@@ -0,0 +1,13 @@
+require "gibbon"
+require "jquery-rails"
+require "email_validator"
+
+module Mailfox
+  class Engine < ::Rails::Engine
+    isolate_namespace Mailfox
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/mailfox/gem_version.rb

@@ -0,0 +1,14 @@
+module Mailfox
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/mailfox/version.rb

@@ -0,0 +1,7 @@
+require_relative 'gem_version'
+
+module Mailfox
+  def self.version
+    gem_version
+  end
+end

data/lib/tasks/mailfox_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mailfox do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: mailfox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Bahlke
+- Michael Rüffer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gibbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: email_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: An easy-to-implement, reusable newsletter subscribe widget that connects
+  with Mailchimp.
+email:
+- develop@hitfoxgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/mailfox/application.js
+- app/assets/stylesheets/mailfox/application.css
+- app/cms/snippets/newsletter_partial.snippet
+- app/controllers/mailfox/application_controller.rb
+- app/controllers/mailfox/newsletters_controller.rb
+- app/helpers/mailfox/application_helper.rb
+- app/services/mail_service.rb
+- app/services/mail_service/customer.rb
+- app/services/mail_service/list.rb
+- app/services/mail_service/member.rb
+- app/views/layouts/mailfox/application.html.erb
+- app/views/mailfox/newsletters/_form.html.erb
+- app/views/mailfox/newsletters/cms/_form.html.erb
+- app/views/mailfox/newsletters/create.js.erb
+- config/routes.rb
+- lib/mailfox.rb
+- lib/mailfox/engine.rb
+- lib/mailfox/gem_version.rb
+- lib/mailfox/version.rb
+- lib/tasks/mailfox_tasks.rake
+homepage: http://hitfoxgroup.com
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Quickly plugin Mailchimp, including a CMS-snippet
+test_files: []