solidus_mailchimp_sync 1.0.0.beta01

data/app/synchronizers/solidus_mailchimp_sync/variant_synchronizer.rb

@@ -0,0 +1,23 @@
+module SolidusMailchimpSync
+  class VariantSynchronizer < BaseSynchronizer
+    self.serializer_class_name = "::SolidusMailchimpSync::VariantSerializer"
+    # Price updates are caught from after commit on Spree::Price
+    self.synced_attributes = %w{id sku}
+
+    def sync
+      put
+    rescue SolidusMailchimpSync::Error => e
+      tries ||= 0 ; tries += 1
+      if tries <= 1 && e.status == 400 && e.title == 'Parent Product Does Not Exist'
+        ProductSynchronizer.new(model.product).sync
+        retry
+      else
+        raise e
+      end
+    end
+
+    def path
+      "/products/#{model.product.id}/variants/#{model.id}"
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/lib/generators/solidus_mailchimp_sync/install/install_generator.rb

@@ -0,0 +1,27 @@
+module SolidusMailchimpSync
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def copy_initializer
+        copy_file "config/initializers/solidus_mailchimp_sync.rb"
+      end
+
+      # No migrations at present
+
+      # def add_migrations
+      #   run 'bundle exec rake railties:install:migrations FROM=solidus_mailchimp_sync'
+      # end
+
+      # def run_migrations
+      #   run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+      #   if run_migrations
+      #     run 'bundle exec rake db:migrate'
+      #   else
+      #     puts 'Skipping rake db:migrate, don\'t forget to run it!'
+      #   end
+      # end
+    end
+  end
+end

data/lib/generators/solidus_mailchimp_sync/install/templates/config/initializers/solidus_mailchimp_sync.rb

@@ -0,0 +1,36 @@
+# https://github.com/friendsoftheweb/solidus_mailchimp_sync
+
+# Strogly suggest you set your mailchimp API key in your ENV
+SolidusMailchimpSync.api_key = ENV['MAILCHIMP_API_KEY']
+
+# These ones are not especially confidential and don't need to be ENV,
+# you can set them however you like:
+
+# We need to know the id of the Mailchimp Store object. If you don't
+# have one, you can create one with `rake solidus_mailchimp_sync:create_store LIST_ID=xxxx`
+SolidusMailchimpSync.store_id = ENV['MAILCHIMP_STORE_ID']
+
+# Disable automatic sync except in production. Feel free to change
+# this is you like.
+SolidusMailchimpSync.auto_sync_enabled = Rails.env.production?
+
+# Automatic synchronization is done with ActiveJob, use a queue
+# other than :default if you want:
+# SolidusMailchimpSync::SyncJob.use_queue_name = :mailchimp_sync
+
+# Turn off not just auto-sync, but completely disable connections
+# to mailchip at all, make them no-op.
+# SolidusMailchimpSync.enabled = false
+
+# You may want to provide custom serializers, to provide custom
+# urls (esp if you don't use Solidus frontend), or account
+# for custom data or logic, or sync more Customer attributes
+# from your local User class.
+#
+# SolidusMailchimpSync::OrderSynchronizer.serializer_class_name = "::SolidusMailchimpSync::MyAppOrderSerializer"
+# SolidusMailchimpSync::VariantSynchronizer.serializer_class_name = "::SolidusMailchimpSync::MyAppVariantSerializer"
+#
+# SolidusMailchimpSync::UserSynchronizer.synced_attributes.concat ['first_name', 'last_name'] # need to be strings
+# SolidusMailchimpSync::UserSynchronizer.serializer_class_name = "::SolidusMailchimpSync::MyAppCustomerSerializer"
+
+

data/lib/solidus_mailchimp_sync.rb

@@ -0,0 +1,22 @@
+require 'solidus_core'
+require 'solidus_mailchimp_sync/engine'
+
+module SolidusMailchimpSync
+  mattr_accessor :api_key
+  mattr_accessor :store_id
+  mattr_accessor :enabled
+  self.enabled = true
+  mattr_accessor :auto_sync_enabled
+
+  def self.data_center
+    @data_center ||= begin
+      if api_key.present?
+        dc = api_key.split('-').last
+        if dc.empty? || dc == api_key
+          raise ArgumentError, "Mailchimp API key is expected to end in a hyphen and data center code, but was not found in `#{api_key}`, do not know how to proceed"
+        end
+        dc
+      end
+    end
+  end
+end

data/lib/solidus_mailchimp_sync/engine.rb

@@ -0,0 +1,20 @@
+module SolidusMailchimpSync
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_mailchimp_sync'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_mailchimp_sync/factories.rb

@@ -0,0 +1,35 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_mailchimp_sync/factories'
+end
+
+
+FactoryGirl.modify do
+  factory :order do
+    factory :order_with_line_items do
+      # This custom factory is from Solidus master at:
+      # https://github.com/solidusio/solidus/blob/3a0bbb63338b31c308a7d26205c4b21f9baed85a/core/lib/spree/testing_support/factories/order_factory.rb#L55
+      # But was not yet included in a solidus release, and we need it.
+      factory :order_ready_to_complete do
+        state 'confirm'
+        payment_state 'checkout'
+
+        transient do
+          payment_type :credit_card_payment
+        end
+
+        after(:create) do |order, evaluator|
+          create(evaluator.payment_type, {
+            amount: order.total,
+            order: order,
+            state: order.payment_state
+          })
+
+          order.payments.reload
+        end
+      end
+    end
+  end
+end

data/lib/solidus_mailchimp_sync/version.rb

@@ -0,0 +1,3 @@
+module SolidusMailchimpSync
+  VERSION = '1.0.0.beta01'
+end

data/lib/tasks/solidus_mailchimp_sync.rake

@@ -0,0 +1,66 @@
+namespace :solidus_mailchimp_sync do
+  desc "Create a Mailchimp Store. ENV LIST_ID param is required"
+  task create_mailchimp_store: :environment do
+    unless ENV["LIST_ID"].present?
+      raise ArgumentError, "LIST_ID env arg is required. Your mailchimp Listserv ID."
+    end
+
+    response = SolidusMailchimpSync::Mailchimp.request(:post, "/ecommerce/stores", body: {
+      list_id: ENV["LIST_ID"],
+      id: ENV["NEW_STORE_ID"] || (Spree::Store.default.name || "solidus").parameterize,
+      name: Spree::Store.default.name || "Solidus",
+      currency_code: Spree::Store.default.default_currency || 'USD'
+    })
+    store_id = response["id"]
+
+    raise TypeError, "Unexpected response from Mailchimp, can't find created store id" unless store_id.present?
+
+    puts "\nNew Mailchimp Store created with id: `#{store_id}`"
+    puts
+    puts "You probably want to add to your ./config/initializers/solidus_mailchimp_sync.rb:"
+    puts
+    puts "   SolidusMailchimpSync.store_id='#{store_id}'"
+    puts
+  end
+
+  desc "sync ALL data to mailchimp"
+  task :bulk_sync => :environment do
+    require 'ruby-progressbar'
+
+    progress_format = '%t %c of %C |%B| %e'
+
+    puts "\nSyncing Users, Products, and Orders to mailchimp, this could take a while...\n\n"
+
+    if Spree.user_class
+      user_count = Spree.user_class.count
+      progress_bar = ProgressBar.create(total: user_count, format: progress_format, title: Spree.user_class.name.pluralize)
+      Spree.user_class.find_each do |user|
+        begin
+          SolidusMailchimpSync::UserSynchronizer.new(user).sync
+        rescue SolidusMailchimpSync::Error => e
+          # just so we know what user failed.
+          puts user.inspect
+          raise e
+        end
+        progress_bar.increment
+      end
+      progress_bar.finish
+    end
+
+    product_count = Spree::Product.count
+    progress_bar = ProgressBar.create(total: product_count, format: progress_format, title: "Spree::Products")
+    Spree::Product.find_each do |product|
+      SolidusMailchimpSync::ProductSynchronizer.new(product).sync
+      progress_bar.increment
+    end
+    progress_bar.finish
+
+    order_count = Spree::Order.complete.count
+    progress_bar = ProgressBar.create(total: order_count, format: progress_format, title: "Completed Spree::Orders")
+    Spree::Order.complete.find_each do |order|
+      SolidusMailchimpSync::OrderSynchronizer.new(order).sync
+      progress_bar.increment
+    end
+    progress_bar.finish
+  end
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: solidus_mailchimp_sync
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta01
+platform: ruby
+authors:
+- Jonathan Rochkind, Friends of the Web
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: poltergeist
+  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: coffee-rails
+  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: sass-rails
+  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: database_cleaner
+  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: factory_girl
+  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: rspec-rails
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email: shout@friendsoftheweb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_mailchimp_sync.js
+- app/assets/javascripts/spree/frontend/solidus_mailchimp_sync.js
+- app/assets/stylesheets/spree/backend/solidus_mailchimp_sync.css
+- app/assets/stylesheets/spree/frontend/solidus_mailchimp_sync.css
+- app/jobs/solidus_mailchimp_sync/sync_job.rb
+- app/models/solidus_mailchimp_sync/error.rb
+- app/models/solidus_mailchimp_sync/mailchimp.rb
+- app/serializers/solidus_mailchimp_sync/customer_serializer.rb
+- app/serializers/solidus_mailchimp_sync/line_item_serializer.rb
+- app/serializers/solidus_mailchimp_sync/order_serializer.rb
+- app/serializers/solidus_mailchimp_sync/product_serializer.rb
+- app/serializers/solidus_mailchimp_sync/variant_serializer.rb
+- app/solidus_decorators/spree/image_decorator.rb
+- app/solidus_decorators/spree/line_item_decorator.rb
+- app/solidus_decorators/spree/order_decorator.rb
+- app/solidus_decorators/spree/price_decorator.rb
+- app/solidus_decorators/spree/product_decorator.rb
+- app/solidus_decorators/spree/user_decorator.rb
+- app/solidus_decorators/spree/variant_decorator.rb
+- app/synchronizers/solidus_mailchimp_sync/base_synchronizer.rb
+- app/synchronizers/solidus_mailchimp_sync/order_synchronizer.rb
+- app/synchronizers/solidus_mailchimp_sync/product_synchronizer.rb
+- app/synchronizers/solidus_mailchimp_sync/user_synchronizer.rb
+- app/synchronizers/solidus_mailchimp_sync/variant_synchronizer.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_mailchimp_sync/install/install_generator.rb
+- lib/generators/solidus_mailchimp_sync/install/templates/config/initializers/solidus_mailchimp_sync.rb
+- lib/solidus_mailchimp_sync.rb
+- lib/solidus_mailchimp_sync/engine.rb
+- lib/solidus_mailchimp_sync/factories.rb
+- lib/solidus_mailchimp_sync/version.rb
+- lib/tasks/solidus_mailchimp_sync.rake
+homepage: http://github.com/friendsoftheweb/solidus_mailchimp_sync
+licenses:
+- BSD-3-Clause
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Solidus -> Mailchimp Ecommerce synchronization
+test_files: []
+has_rdoc: