spree_sendwithus 2.0.11.1 → 2.0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850b7ac80790aca791f3d9eeda74ed44732cbd28
-  data.tar.gz: 3af2cadc05bfe6f711ef005c35f21eec19942990
+  metadata.gz: 1f0a71a42a0dcd0028ccdd3cbc877fd797d32b5a
+  data.tar.gz: 85d4d07d7ec496a39b0685db8dbbd53e3abe5715
 SHA512:
-  metadata.gz: 54939c0fb1a2da26f20d6cbdef1644abb70c9c82d4b2a3f4978780acf15546dc75fd009f5ee3cc0cae2335bd77001e155c6745c53c93662ac8de2f18b9b68325
-  data.tar.gz: 9e39d176bd5bb2e8482ebd82049b4b691aaac00eccfe59daf66a9b3cd0165df9e17d006188d78e67f3b2b7e82227f50a43a5ff10011a01cb842220391c810d6f
+  metadata.gz: f54433b26fe7755bdb5ebe043f21ad526b61ab27956fee446db2d5088832675e629050c0755e5b18e14376a4b9710b2c4a666cc5ca76f2f85a6b69c8265594cc
+  data.tar.gz: 20baf37b7ca485bdcfe435354b89654b6f08fad17fafa892e0c2793502cf92ed8d8ed3dcf05644c51a46da42705da90542f71a3cbdb25dd7d39a558ae4bae286

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'pry-rails'
+  gem 'pry-byebug'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 FreeRunning Technologies
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,81 @@
+Spree SendWithUs
+================
+
+SendWithUs mailer you can use in Spree! Say what?!
+
+Installation
+------------
+
+Add spree_sendwithus to your Gemfile:
+
+```ruby
+gem 'spree_sendwithus', github: 'freerunningtech/spree_sendwithus'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle install
+```
+
+Add `send_with_us.rb` in `config/initializers` with the following:
+
+```ruby
+SendWithUs::Api.configure do |config|
+  config.api_key = ENV["SEND_WITH_US_API_KEY"]
+  config.debug = true
+end
+```
+
+Now you can configure any of your mailers to use SendWithUs by making them a subclass of `Spree::SendWithUsMailer::Base`. For example:
+
+```ruby
+# app/mailers/spree/quality_control_mailer.rb
+
+class Spree::QualityControlMailer < Spree::SendWithUsMailer::Base
+  default recipient_name: "Quality Control",
+          recipient_address: "quality@freerunningtech.com",
+          from_name: "Quality Control",
+          from_address: "quality@freerunningtech.com"
+
+  def reprint(original, reprint)
+    assign(:original, order_data(Spree::Order.find(original)))
+    assign(:reprint, order_data(Spree::Order.find(reprint)))
+
+    mail(email_id: "SEND_WITH_US_TEMPLATE_ID")
+  end
+
+  private
+  def order_data(order)
+    {
+      url: spree.admin_order_url(order),
+      number: order.number
+    }
+  end
+end
+```
+
+The mailer will work with delayed job or without:
+
+```ruby
+# Delayed
+Spree::QualityControlMailer.delay.reprint(1, 2)
+
+# Inline
+Spree::QualityControlMailer.reprint(1, 2).deliver
+```
+
+Also, the default URL host will be pulled from `config.action_mailer.default_url_options` so there's no need for any extra configuration! You're welcome!
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+Copyright (c) 2014 FreeRunning Technologies, released under the New BSD License

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_sendwithus'
+  Rake::Task['extension:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1 @@
+'2.0.x' => { branch: '2-0-stable' }

data/lib/spree_sendwithus/engine.rb

@@ -0,0 +1,29 @@
+module SpreeSendwithus
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_sendwithus'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer "sendwithus_mailer.set_configs" do |app|
+      ActiveSupport.on_load(:spree_sendwithus_mailer) do
+        include AbstractController::UrlFor
+        extend AbstractController::Railties::RoutesHelpers.with(app.routes)
+        include app.routes.mounted_helpers
+
+        if defined?(Delayed::DelayMail)
+          extend Delayed::DelayMail
+        end
+
+        options = app.config.action_mailer
+        send(:default_url_options=, options.default_url_options)
+      end
+    end
+  end
+end

data/lib/spree_sendwithus/mailer.rb

@@ -0,0 +1,53 @@
+module Spree
+  module SendWithUsMailer
+    class Base
+      class_attribute :defaults
+      class_attribute :default_url_options
+
+      self.defaults = {}.freeze
+
+      class << self
+        def default(value = nil)
+          self.defaults = defaults.merge(value).freeze if value
+          defaults
+        end
+
+        def mailer_methods
+          methods = public_instance_methods - superclass.public_instance_methods
+
+          # Reject route helper methods.
+          methods.reject{ |m| m.to_s.end_with?("_url", "_path") }
+        end
+
+        def method_missing(method_name, *args)
+          if mailer_methods.include?(method_name.to_sym)
+            new(method_name, *args).message
+          else
+            super(method_name, *args)
+          end
+        end
+
+        def respond_to?(symbol, include_private = false)
+          super || mailer_methods.include?(symbol)
+        end
+      end
+
+      attr_reader :message
+
+      def initialize(method_name, *args)
+        @message = Spree::SendWithUs::Message.new
+        self.send(method_name, *args)
+      end
+
+      def mail(params = {})
+        @message.merge!(self.class.defaults.merge(params))
+      end
+
+      def assign(key, value)
+        @message.assign(key, value)
+      end
+
+      ActiveSupport.run_load_hooks(:spree_sendwithus_mailer, self)
+    end
+  end
+end

data/lib/spree_sendwithus/message.rb

@@ -0,0 +1,48 @@
+require 'send_with_us'
+
+module Spree
+  module SendWithUs
+    class Message
+      attr_reader :to, :from, :email_id, :email_data, :cc, :bcc
+
+      def initialize
+        @email_data = {}
+        @to = {}
+        @from = {}
+        @cc = []
+        @bcc = []
+      end
+
+      def assign(key, value)
+        @email_data.merge!(key.to_sym => value)
+      end
+
+      def merge!(params = {})
+        params.each_pair do |key, value|
+          case key
+          when :email_id
+            @email_id = value
+          when :recipient_name
+            @to.merge!(name: value)
+          when :recipient_address
+            @to.merge!(address: value)
+          when :from_name
+            @from.merge!(name: value)
+          when :from_address
+            @from.merge!(address: value)
+          when :reply_to
+            @from.merge!(reply_to: value)
+          when :cc
+            @cc.concat(value)
+          when :bcc
+            @bcc.concat(value)
+          end
+        end
+      end
+
+      def deliver
+        ::SendWithUs::Api.new.send_with(@email_id, @to, @email_data, @from, @cc, @bcc)
+      end
+    end
+  end
+end

data/lib/spree_sendwithus.rb

@@ -0,0 +1,6 @@
+require 'send_with_us'
+
+require 'spree_core'
+require 'spree_sendwithus/mailer'
+require 'spree_sendwithus/message'
+require 'spree_sendwithus/engine'

data/script/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_sendwithus/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/lib/spree_sendwithus/mailer_spec.rb

@@ -0,0 +1,60 @@
+require 'rails_helper'
+
+describe Spree::SendWithUsMailer::Base do
+  class DummyMailer < Spree::SendWithUsMailer::Base
+    def test; end;
+  end
+
+  subject { DummyMailer }
+  it { is_expected.to respond_to(:test) }
+
+  it "raises an undefined method error when method is missing" do
+    expect{ DummyMailer.blargh }.to raise_error NoMethodError
+  end
+
+  describe "::new" do
+    subject { DummyMailer.test }
+    it "creates an new message" do
+      expect(subject).to be_a Spree::SendWithUs::Message
+    end
+  end
+
+  describe "::default" do
+    it { should respond_to(:default) }
+    describe "setting a default" do
+      subject { DummyMailer.default({hello: "world"}) }
+      it { is_expected.to eq Hash[hello: "world"] }
+    end
+  end
+
+  describe "::mailer_methods" do
+    subject { DummyMailer.mailer_methods }
+    it { is_expected.to eq [:test] }
+  end
+
+  describe "#mail" do
+    class MailerWithMail < Spree::SendWithUsMailer::Base
+      def test
+        mail email_id: "template_1234"
+      end
+    end
+
+    subject { MailerWithMail.test }
+    it "merges the values from mail into the message" do
+      expect(subject.email_id).to eq "template_1234"
+    end
+  end
+
+  describe "#assign" do
+    class MailerWithAssign < Spree::SendWithUsMailer::Base
+      def test
+        assign :user, "john"
+      end
+    end
+
+    subject { MailerWithAssign.test }
+    it "sets the (key, value) pair on the message" do
+      expect(subject.email_data).to eq Hash[user: "john"]
+    end
+  end
+end

data/spec/lib/spree_sendwithus/message_spec.rb

@@ -0,0 +1,94 @@
+require 'spree_sendwithus'
+
+describe Spree::SendWithUs::Message do
+  subject { Spree::SendWithUs::Message.new }
+
+  it { is_expected.to respond_to(:email_id, :to, :from, :cc, :bcc, :deliver) }
+  it { is_expected.not_to respond_to(:email_id=, :to=, :from=, :cc=, :bcc=) }
+
+  describe "initialization" do
+    it "creates an empty email_data on initialization" do
+      expect(subject.email_data).to be_empty
+    end
+  end
+
+  describe "#assign" do
+    let(:message) { Spree::SendWithUs::Message.new }
+
+    it "adds (key,value) pairs to email_data hash" do
+      message.assign(:user, {name: "Richard", email: "richard@example.com"})
+
+      expect(message.email_data).to eq Hash[
+        user: {name: "Richard", email: "richard@example.com"}
+      ]
+
+      message.assign(:url, "http://test.example.com")
+      expect(message.email_data).to eq Hash[
+        user: {name: "Richard", email: "richard@example.com"},
+        url: "http://test.example.com"
+      ]
+    end
+
+    it "symbolizes the keys" do
+      message.assign("company", "FreeRunning Tech")
+      expect(message.email_data).to have_key(:company)
+    end
+  end
+
+  describe "#merge!" do
+    let(:message) { Spree::SendWithUs::Message.new }
+    let(:params) { Hash[
+      email_id: "template_1234",
+      recipient_name: "John",
+      recipient_address: "john@example.com",
+      from_name: "Jared",
+      from_address: "jared@example.com",
+      reply_to: "gregor@example.com",
+      cc: ["sean@example.com"],
+      bcc: ["clarke@example.com", "kyria@example.com"]
+    ] }
+
+    before do
+      message.merge!(params)
+    end
+
+    subject { message }
+
+    it "contains the expected email_id" do
+      expect(subject.email_id).to eq "template_1234"
+    end
+    it "contains the expected to hash" do
+      expect(subject.to).to eq Hash[
+        name: "John",
+        address: "john@example.com"
+      ]
+    end
+    it "contains the expected from hash" do
+      expect(subject.from).to eq Hash[
+        name: "Jared",
+        address: "jared@example.com",
+        reply_to: "gregor@example.com"
+      ]
+    end
+    it "contains the expected cc array" do
+      expect(subject.cc).to match_array ["sean@example.com"]
+    end
+    it "contains the expected bcc array" do
+      expect(subject.bcc).to match_array [
+        "clarke@example.com",
+        "kyria@example.com"
+      ]
+    end
+  end
+
+  describe "#deliver" do
+    let(:api_double) { double("api") }
+
+    it "calls the send_with_us gem" do
+      allow(SendWithUs::Api).to receive(:new).and_return(api_double)
+      expect(api_double).to receive(:send_with)
+
+      subject.deliver
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,15 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'spec_helper'
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rspec/rails'
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  config.use_transactional_fixtures = true
+
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'vendor/bundle'
+  add_group 'Libraries', 'lib'
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color = true
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+end

data/spree_sendwithus.gemspec

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_sendwithus'
+  s.version     = '2.0.11.2'
+  s.summary     = 'SendWithUs integration'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'FreeRunning Technologies'
+  s.email     = 'contact@freerunningtech.com'
+  s.homepage  = 'http://www.freerunningtech.com'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'spree_core', '~> 2.0.11.beta'
+  s.add_dependency 'send_with_us', '~> 1.1.4'
+
+  s.add_development_dependency 'rspec-rails', '~> 3.0.0'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_sendwithus
 version: !ruby/object:Gem::Version
-  version: 2.0.11.1
+  version: 2.0.11.2
 platform: ruby
 authors:
 - FreeRunning Technologies
@@ -85,7 +85,24 @@ email: contact@freerunningtech.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- lib/spree_sendwithus.rb
+- lib/spree_sendwithus/engine.rb
+- lib/spree_sendwithus/mailer.rb
+- lib/spree_sendwithus/message.rb
+- script/rails
+- spec/lib/spree_sendwithus/mailer_spec.rb
+- spec/lib/spree_sendwithus/message_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spree_sendwithus.gemspec
 homepage: http://www.freerunningtech.com
 licenses: []
 metadata: {}