rails_admin_cms 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc83df591531fab36fe6ae31d019ef6b21c5619f
-  data.tar.gz: 4af4e3c05fa7fa5c73b50f71931d43a7fa908285
+  metadata.gz: bf5853464f21749a2648751253c62546a51ccb93
+  data.tar.gz: 57179f31f7a558b898a255a64ad0b51fab8ceb00
 SHA512:
-  metadata.gz: eaa33d3396a9fab4069fc6b76c6c8c7b6d118208342a86d59de150c068c56717c88f007da0db4f018ca062e2b4ab4e4fd8a927f014a40fbe81ccdbb51e6aa9bd
-  data.tar.gz: eebcb2e4f4c0a78dc50d3000f13bf2ab2ce83078b24ab3079538517135e5e5989947697dc48851d1878655f5ac8651952a0b52593f6c084c8aaf20c25d5312a5
+  metadata.gz: d3ef20bac7f0ce1bde7fb9ab5012113e7c5de0429037bf73a2321a701c8a98025e7855d8ea48193f5b52f4757db47ca4d7d60cea7026e8280838c23854672ea8
+  data.tar.gz: 75ee89c13537b749efc125c3ab885f2f6bae8cfdf58de6c9bab08d755ca7df991e8e5068d93e1182b9e5e230e2c739a59da86f7155dfa8ac592cea9e8f00359c

data/README.md

@@ -47,6 +47,19 @@ What's going on:
 1. `cms_link_to_edit_mode`
 1. `current_admin?`
 
+## Mailchimp
+
+First, `mailchimp_api_key` and `mailchimp_list_id_en` (and `mailchimp_list_id_xx` where `xx` is the locale) need to be defined within `config/secrets.yml`.
+Then, use the partial `app/views/cms/shared/_mailchimp.html.erb` to output the mailchimp form:
+
+```ruby
+<%= render 'cms/shared/mailchimp' %>
+```
+
+1. Flash messages could be overriden by the keys `flash_messages.mailchimp.subscribe.(success|error)`.
+1. Input placeholder could be overriden by the key `simple_form.placeholders.mailchimp.email`. 
+1. Input and submit button are wrapper in a div tag with the class `cms-mailchimp`. 
+
 ## TODO
 
 * Documentation
@@ -57,7 +70,6 @@ What's going on:
 * Link to image edit in edit form (for cropping)
 * Confirmation email for forms
 * Published Pages/Forms
-* Mailchimp integration
 * Redirector
 * Setting fetched from Yaml file
 * Pretty Url for Viewable::LinkPresenter#url as file_url

data/app/assets/javascripts/rails_admin_cms/cms.js.coffee

@@ -12,6 +12,7 @@ class CMS
     @ready =>
       @clear_event_handlers()
       @flash_messages()
+      @validate_mailchimp()
 
     @ready_with_scope 'cms-forms', =>
       @validate()
@@ -45,6 +46,9 @@ class CMS
   @validate: =>
     $.validate(validateOnBlur: false)
 
+  @validate_mailchimp: =>
+    $.validate(form: '#mailchimp_form', validateOnBlur: false)
+
   @with_scope_any: (body_classes..., handler) =>
     for body_class in body_classes
       if @with_scope(body_class, handler)

data/app/controllers/cms/mailchimp_controller.rb

@@ -0,0 +1,24 @@
+module CMS
+  class MailchimpController < RailsAdminCMS::Config.parent_controller
+    invisible_captcha only: [:subscribe]
+
+    def subscribe
+      respond_to do |format|
+        format.js do
+          begin
+            gb = Gibbon::API.new(Rails.application.secrets.mailchimp_api_key, { timeout: 15 })
+            gb.lists.subscribe(
+              id: Rails.application.secrets.send(:"mailchimp_list_id_#{I18n.locale}"),
+              email: { email: params[:mailchimp][:email] },
+              double_optin: false
+            )
+            flash_now!(:success)
+          rescue Gibbon::MailChimpError => exception
+            cms_logger exception, 'mailchimp'
+            flash_now!(:error)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/cms/pages_controller.rb

@@ -1,6 +1,6 @@
 module CMS
   class PagesController < RailsAdminCMS::Config.parent_controller
-    after_action :allow_iframe, if: RailsAdminCMS::Config.allow_iframe_from
+    after_action :allow_iframe
 
     def show
       @cms_view = Viewable::Page.find(params[:id]) if params[:id].present?
@@ -15,7 +15,9 @@ module CMS
     private
 
     def allow_iframe
-      response.headers['X-FRAME-OPTIONS'] = RailsAdminCMS::Config.allow_iframe_from
+      if RailsAdminCMS::Config.allow_iframe_from.present?
+        response.headers['X-FRAME-OPTIONS'] = RailsAdminCMS::Config.allow_iframe_from
+      end
     end
   end
 end

data/app/controllers/cms/viewables_controller.rb

@@ -2,6 +2,7 @@ module CMS
   class ViewablesController < RailsAdminCMS::Config.parent_controller
     before_action :authenticate_admin_user!
 
+    # used by the add viewable link
     def create
       current_count = UniqueKey.where(list_key_params).count
 
@@ -22,6 +23,7 @@ module CMS
       end
     end
 
+    # used by [data-js-cms-sortable] element to modify the viewable position within the list
     def update
       unique_key = UniqueKey.find(params[:id])
 

data/app/controllers/concerns/cms/rescue.rb

@@ -14,6 +14,7 @@ module CMS
 
     def render_500(exception = nil)
       cms_logger exception
+      self.response_body = nil # make sure that there is no DoubleRenderError
       render file: 'public/500.html', status: 500, layout: false
     end
   end

data/app/helpers/cms/viewable_helper.rb

@@ -11,7 +11,7 @@ module CMS
     ::Naming::Viewable::Block.names.each do |type|
       define_cms_view_helper(type)
 
-      define_method "cms_#{type}" do |name = 'cms', min = 1, max = nil| # max = FLOAT::INFINITY
+      define_method "cms_#{type}" do |name = 'cms', min = 1, max = nil|
         name, min, max = adjust_arguments(name, min, max)
 
         cms_block("#{type}/#{name}", min, max)
@@ -21,6 +21,11 @@ module CMS
     ::Naming::Viewable.names.each do |type|
       define_cms_view_helper(type)
 
+      # access a Viewable within the current context
+      # name(optional):
+      # min (optional): defines how many viewables are created by default
+      # max (optional): defines the limit of viewables that could added (must be greater than min)
+      # * if min = 1, then a single ViewablePresenter is returned, otherwise, a ViewablePresenterList is returned
       define_method "cms_#{type}" do |name = 'cms', min = 1, max = nil| # max = FLOAT::INFINITY
         name, min, max = adjust_arguments(name, min, max)
 

data/app/models/admin/viewable/string.rb

@@ -0,0 +1,15 @@
+module Admin
+  module Viewable
+    module String
+      extend ActiveSupport::Concern
+
+      included do
+        rails_admin do
+          visible false
+
+          field :string
+        end
+      end
+    end
+  end
+end

data/app/models/viewable/string.rb

@@ -0,0 +1,6 @@
+module Viewable
+  class String < ActiveRecord::Base
+    include Viewable
+    include Admin::Viewable::String
+  end
+end

data/app/views/cms/mailchimp/subscribe.js.erb

@@ -0,0 +1 @@
+<%= render 'cms/shared/flash_messages' %>

data/app/views/cms/shared/_flash_messages.js.erb

@@ -1,2 +1,2 @@
-CMS.element('cms-flash').replaceWith("<%= j cms_flash_messages %>");
+CMS.data_js('cms-flash').replaceWith("<%= j cms_flash_messages %>");
 CMS.flash_messages();

data/app/views/cms/shared/_mailchimp.html.erb

@@ -0,0 +1,7 @@
+<%= simple_form_for :mailchimp, url: main_app.mailchimp_url(format: :js), remote: true, html: { id: 'mailchimp_form' } do |f| %>
+  <%= invisible_captcha %>
+  <div class="cms-mailchimp">
+    <%= f.input :email, label: false, wrapper: false, input_html: cms_validate_email %>
+    <%= f.submit cms_form_send, cms_form_sending %>
+  </div>
+<% end %>

data/config/locales/flash.en.yml

@@ -18,6 +18,10 @@ en:
     #     error: "Something went wrong. Please take a look at the form to see what went wrong."
     #
     # Add flash messages for controller actions:
+    mailchimp:
+      subscribe:
+        success: Thanks for subscribing to our newsletter.
+        error: Sorry, an error happened (you might already be subscribed or your email is not valid).
     # products:
     #   create:
     #     success: "This is a notification"

data/config/locales/flash.fr.yml

@@ -18,6 +18,10 @@ fr:
     #     error: "Something went wrong. Please take a look at the form to see what went wrong."
     #
     # Add flash messages for controller actions:
+    mailchimp:
+      subscribe:
+        success: Merci pour votre inscription à notre infolettre.
+        error: Désolé, une erreur est survenue (vous êtes peut-être déjà inscrit, veuillez vérifier votre boîte de courriels).
     # products:
     #   create:
     #     success: "This is a notification"

data/config/locales/simple_form.en.yml

@@ -0,0 +1,5 @@
+en:
+  simple_form:
+    placeholders:
+      mailchimp:
+        email: Email address

data/config/locales/simple_form.fr.yml

@@ -0,0 +1,5 @@
+fr:
+  simple_form:
+    placeholders:
+      mailchimp:
+        email: Entrez votre adresse courriel

data/config/routes.rb

@@ -1,5 +1,7 @@
 Rails.application.routes.draw do
   scope module: 'cms' do
+    post 'mailchimp/subscribe' => 'mailchimp#subscribe', format: true, constraints: { format: :js }, as: :mailchimp
+
     get 'viewables/new' => 'viewables#create', format: false, as: :new_viewable
     post 'viewables/edit' => 'viewables#update', format: true, constraints: { format: :js }, as: :edit_viewable
 

data/db/migrate/20160201181310_create_viewable_string.rb

@@ -0,0 +1,9 @@
+class CreateViewableString < ActiveRecord::Migration
+  def change
+    create_table :viewable_strings do |t|
+      t.string     :string
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/rails_admin_cms/utils.rb

@@ -8,18 +8,21 @@ module CMS
     rb_names(dirname)
   end
 
+  # list the ruby file names within a directory (ex.: used to get all viewable names)
   def rb_names(dirname)
     Dir["#{Rails.root}/#{dirname}/*.rb"].map do |name|
       File.basename(name).sub(/\.rb$/, '')
     end
   end
 
+  # list the html file names within a directory (ex.: used to get all page templates)
   def html_names(dirname)
     Dir["#{Rails.root}/#{dirname}/*.html.*"].map do |name|
       File.basename(name).sub(/\.html\..+$/, '').sub(/^_/, '')
     end
   end
 
+  # list the folder names within a directory (ex.: used to get all form models)
   def dir_names(dirname)
     Dir["#{Rails.root}/#{dirname}/*"].select{ |name|
       File.directory? name

data/lib/rails_admin_cms/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminCMS
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_cms
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Patrice Lebel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -392,6 +392,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !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: paper_trail
   requirement: !ruby/object:Gem::Requirement
@@ -660,6 +674,7 @@ files:
 - app/controllers/cms/attachments_controller.rb
 - app/controllers/cms/files_controller.rb
 - app/controllers/cms/forms_controller.rb
+- app/controllers/cms/mailchimp_controller.rb
 - app/controllers/cms/pages_controller.rb
 - app/controllers/cms/viewables_controller.rb
 - app/controllers/concerns/cms/editing.rb
@@ -688,6 +703,7 @@ files:
 - app/models/admin/viewable/link.rb
 - app/models/admin/viewable/page.rb
 - app/models/admin/viewable/select.rb
+- app/models/admin/viewable/string.rb
 - app/models/admin/viewable/text.rb
 - app/models/callbacks/form/field_after_create.rb
 - app/models/callbacks/form/field_after_destroy.rb
@@ -723,6 +739,7 @@ files:
 - app/models/viewable/link.rb
 - app/models/viewable/page.rb
 - app/models/viewable/select.rb
+- app/models/viewable/string.rb
 - app/models/viewable/text.rb
 - app/presenters/base_list_presenter.rb
 - app/presenters/base_presenter.rb
@@ -739,7 +756,9 @@ files:
 - app/presenters/viewable_list_presenter.rb
 - app/presenters/viewable_presenter.rb
 - app/views/cms/forms/create.js.erb
+- app/views/cms/mailchimp/subscribe.js.erb
 - app/views/cms/shared/_flash_messages.js.erb
+- app/views/cms/shared/_mailchimp.html.erb
 - app/views/cms/viewables/update.js.erb
 - app/views/layouts/rails_admin/_secondary_navigation.html.haml
 - config/initializers/assets.rb
@@ -750,6 +769,8 @@ files:
 - config/locales/flash.fr.yml
 - config/locales/routes.en.yml
 - config/locales/routes.fr.yml
+- config/locales/simple_form.en.yml
+- config/locales/simple_form.fr.yml
 - config/routes.rb
 - config/spring.rb
 - db/migrate/20150111082038_create_versions.rb
@@ -771,6 +792,7 @@ files:
 - db/migrate/20160102010317_create_form_field.rb
 - db/migrate/20160103120544_create_form_email.rb
 - db/migrate/20160111072418_add_cms_og_tags_settings.rb
+- db/migrate/20160201181310_create_viewable_string.rb
 - lib/active_type/virtual_attributes_decorator.rb
 - lib/generators/cms/install/USAGE
 - lib/generators/cms/install/install_generator.rb