saucy 0.2.3 → 0.2.4

data/README.md

@@ -28,6 +28,12 @@ After you bundle, run the generators:
 
 You will want to include the `ensure_active_account` `before_filter` in any controller actions that you want to protect if the user is using an past due paid account.
 
+You will want to custom the from email address on billing emails:
+
+Saucy::Configuration.mailer_sender = "billingemail@example.com"
+
+In addition, there are a number of string such as application name, support url, etc. that are provided and customized with i18n translations.  You can customize these in your app, and you can see what they are by looking at config/locales/en.yml in saucy.
+
 Development environment
 -----------------------
 

data/app/mailers/billing_mailer.rb

@@ -0,0 +1,20 @@
+class BillingMailer < ActionMailer::Base
+  def receipt(account, transaction)
+    @account = account
+    @transaction = transaction
+    mail(:to       => account.customer.email,
+         :subject  => I18n.t(:subject,
+                             :scope   => [:saucy, :mailers, :billing_mailer, :receipt],
+                             :default => "Subscription receipt"),
+         :from     => Saucy::Configuration.mailer_sender)
+  end
+
+  def problem(account, transaction)
+    @account = account
+    mail(:to       => account.customer.email,
+         :subject  => I18n.t(:subject,
+                             :scope   => [:saucy, :mailers, :billing_mailer, :problem],
+                             :default => "Problem with subscription billing"),
+         :from     => Saucy::Configuration.mailer_sender)
+  end
+end

data/app/views/billing_mailer/problem.html.erb

@@ -0,0 +1,13 @@
+<p>Unfortunately there was a problem processing your latest payment for your <%= @account.name -%> account on <%= t("app_name") %>.</p>
+
+<p>Some functionality of your <%= @account.name -%> account on <%= t("app_name") %> is now disabled.</p>
+
+<p>Please verify and fix the credit card details <%= link_to "here", account_billing_url(@account) %> to restore full access to the account.</p>
+
+<p>If you have any questions, please contact us anytime at <%= mail_to t("support_email"), t("support_email") %>.</p>
+
+<hr/>
+
+<p>Thanks for your business,<br/>
+The <%= t("app_name") %> Team<br/>
+<%= t("app_url") %></p>

data/app/views/billing_mailer/problem.text.erb

@@ -0,0 +1,14 @@
+Unfortunately there was a problem processing your latest payment for your <%= @account.name -%> account on <%= t("app_name") %>.
+
+Some functionality of your <%= @account.name -%> account on <%= t("app_name") %> is now disabled.
+
+Please verify and fix the credit card details at the following url to restore full access to the account:
+<%= account_billing_url(@account) %>
+
+If you have any questions, please contact us anytime at <%= t("support_email") %>.
+
+============================================================
+
+Thanks for your business,
+The <%= t("app_name") %> Team
+<%= t("app_url") %>

data/app/views/billing_mailer/receipt.html.erb

@@ -0,0 +1,41 @@
+<p><strong>Thanks for your business!</strong></p>
+
+<p>The latest payment for your <strong><%= @account.name -%> account on <%= t("app_name") %></strong> has been approved.  This is only a receipt, no payment is due. If you have any questions, please contact us anytime at <%= mail_to t("support_email"), t("support_email") %></p>
+
+<hr/>
+
+<table>
+  <tr>
+    <td>
+      RECEIPT
+    </td>
+    <td>
+      <%= @transaction.created_at.to_s(:short_date) -%>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      Plan: <%= @account.plan.name -%></br>
+      Charge: USD <%= number_to_currency @account.plan.price -%>*<br/>
+      Credit card: XXXX-XXXX-XXXX-<%= @account.credit_card.last_4 %>
+
+      <p><small>* EU customers: prices exclude VAT</small></p>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <%= t("saucy.billing_address") %>
+    </td>
+    <td>
+      <strong>Bill to:</strong><br/>
+      <%= @account.name %><br/>
+      <%= @account.credit_card.cardholder_name %>
+    </td>
+  </tr>
+</table>
+
+<hr/>
+
+<p>Thanks for your business,<br/>
+The <%= t("app_name") %> Team<br/>
+<%= link_to t("app_url"), t("app_url") %></p>

data/app/views/billing_mailer/receipt.text.erb

@@ -0,0 +1,25 @@
+Thanks for your business!
+
+The latest payment for your <%= @account.name -%> account on <%= t("app_name") %> has been approved.  This is only a receipt, no payment is due. If you have any questions, please contact us anytime at <%= t("support_email") %>.
+
+============================================================
+RECEIPT                                             <%= @transaction.created_at.to_s(:short_date) -%>
+
+
+Plan: <%= @account.plan.name -%>
+Charge: USD <%= number_to_currency @account.plan.price -%>*
+Credit card: XXXX-XXXX-XXXX-<%= @account.credit_card.last_4 %>
+
+<%= t("saucy.billing_address") %>
+
+Bill to:
+<%= @account.name %>
+<%= @account.credit_card.cardholder_name %>
+
+* EU customers: prices exclude VAT
+
+============================================================
+
+Thanks for your business,
+The <%= t("app_name") %> Team
+<%= t("app_url") %>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  app_name: App Name
+  app_url: 'http://example.com'
+  support_email: support@example.com
+  saucy:
+    billing_address: Billing Address

data/lib/saucy/account.rb

@@ -197,6 +197,11 @@ module Saucy
           account.subscription_status = account.subscription.status
           account.next_billing_date = account.subscription.next_billing_date
           account.save!
+          if account.past_due?
+            BillingMailer.problem(account, account.subscription.transactions.last).deliver!
+          else
+            BillingMailer.receipt(account, account.subscription.transactions.last).deliver!
+          end
         end
       end
     end

data/lib/saucy/configuration.rb

@@ -3,8 +3,10 @@ require 'saucy/layouts'
 module Saucy
   class Configuration
     attr_reader :layouts
+    cattr_accessor :mailer_sender
 
     def initialize
+      @@mailer_sender = 'donotreply@example.com'
       @layouts = Layouts.new
     end
   end

data/lib/saucy/engine.rb

@@ -4,6 +4,10 @@ require "rails"
 module Saucy
   class Engine < Rails::Engine
     config.saucy = Configuration.new
+
+    rake_tasks do
+      load "saucy/railties/tasks.rake"
+    end 
   end
 end
 

data/lib/saucy/fake_braintree.rb

@@ -31,6 +31,10 @@ class FakeBraintree
     failure["errors"] ||= { "errors" => [] }
     { "message" => failure["message"], "verification" => { "status" => failure["status"], "processor_response_text"  => failure["message"], "processor-response-code" => failure["code"], "gateway_rejection_reason" => "cvv", "cvv_response_code" => failure["code"] }, "errors" => failure["errors"], "params" => {}}
   end
+
+  def self.generated_transaction
+    {"status_history"=>[{"timestamp"=>Time.now, "amount"=>"50.00", "transaction_source"=>"CP", "user"=>"copycopter", "status"=>"authorized"}, {"timestamp"=>Time.now, "amount"=>"50.00", "transaction_source"=>"CP", "user"=>"copycopter", "status"=>FakeBraintree.transaction[:status]}], "created_at"=>Time.now, "currency_iso_code"=>"USD", "settlement_batch_id"=>nil, "processor_authorization_code"=>"ZKB4VJ", "avs_postal_code_response_code"=>"I", "order_id"=>nil, "updated_at"=>Time.now, "refunded_transaction_id"=>nil, "amount"=>"50.00", "credit_card"=>{"last_4"=>"1111", "card_type"=>"Visa", "token"=>"8yq7", "customer_location"=>"US", "expiration_year"=>"2013", "expiration_month"=>"02", "bin"=>"411111", "cardholder_name"=>"Chad Lee Pytel"}, "refund_id"=>nil, "add_ons"=>[], "shipping"=>{"region"=>nil, "company"=>nil, "country_name"=>nil, "extended_address"=>nil, "postal_code"=>nil, "id"=>nil, "street_address"=>nil, "country_code_numeric"=>nil, "last_name"=>nil, "locality"=>nil, "country_code_alpha2"=>nil, "country_code_alpha3"=>nil, "first_name"=>nil}, "id"=>"49sbx6", "merchant_account_id"=>"Thoughtbot", "type"=>"sale", "cvv_response_code"=>"I", "subscription_id"=>FakeBraintree.transaction[:subscription_id], "custom_fields"=>"\n    ", "discounts"=>[], "billing"=>{"region"=>nil, "company"=>nil, "country_name"=>nil, "extended_address"=>nil, "postal_code"=>nil, "id"=>nil, "street_address"=>nil, "country_code_numeric"=>nil, "last_name"=>nil, "locality"=>nil, "country_code_alpha2"=>nil, "country_code_alpha3"=>nil, "first_name"=>nil}, "processor_response_code"=>"1000", "refund_ids"=>[], "customer"=>{"company"=>nil, "id"=>"108427", "last_name"=>nil, "fax"=>nil, "phone"=>nil, "website"=>nil, "first_name"=>nil, "email"=>"cpytel@thoughtbot.com"}, "avs_error_response_code"=>nil, "processor_response_text"=>"Approved", "avs_street_address_response_code"=>"I", "status"=>FakeBraintree.transaction[:status], "gateway_rejection_reason"=>nil}
+  end
 end
 
 ShamRack.at("www.braintreegateway.com", 443).sinatra do
@@ -109,6 +113,6 @@ ShamRack.at("www.braintreegateway.com", 443).sinatra do
 
   post "/merchants/:merchant_id/transactions/advanced_search" do
     # "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<search>\n  <ids type=\"array\">\n    <item>49sbx6</item>\n  </ids>\n  <created-at>\n    <min type=\"datetime\">2011-01-10T14:14:26Z</min>\n  </created-at>\n</search>\n"
-    [200, { "Content-Encoding" => "gzip" }, ActiveSupport::Gzip.compress("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<credit-card-transactions type=\"collection\">\n  <current-page-number type=\"integer\">1</current-page-number>\n  <page-size type=\"integer\">50</page-size>\n  <total-items type=\"integer\">1</total-items>\n  <transaction>\n    <id>49sbx6</id>\n    <status>#{FakeBraintree.transaction[:status]}</status>\n    <type>sale</type>\n    <currency-iso-code>USD</currency-iso-code>\n    <amount>50.00</amount>\n    <merchant-account-id>Thoughtbot</merchant-account-id>\n    <order-id></order-id>\n    <created-at type=\"datetime\">2011-01-11T14:08:12Z</created-at>\n    <updated-at type=\"datetime\">2011-01-11T14:08:12Z</updated-at>\n    <customer>\n      <id>108427</id>\n      <first-name nil=\"true\"></first-name>\n      <last-name nil=\"true\"></last-name>\n      <company nil=\"true\"></company>\n      <email>cpytel@thoughtbot.com</email>\n      <website nil=\"true\"></website>\n      <phone nil=\"true\"></phone>\n      <fax nil=\"true\"></fax>\n    </customer>\n    <billing>\n      <id nil=\"true\"></id>\n      <first-name nil=\"true\"></first-name>\n      <last-name nil=\"true\"></last-name>\n      <company nil=\"true\"></company>\n      <street-address nil=\"true\"></street-address>\n      <extended-address nil=\"true\"></extended-address>\n      <locality nil=\"true\"></locality>\n      <region nil=\"true\"></region>\n      <postal-code nil=\"true\"></postal-code>\n      <country-name nil=\"true\"></country-name>\n      <country-code-alpha2 nil=\"true\"></country-code-alpha2>\n      <country-code-alpha3 nil=\"true\"></country-code-alpha3>\n      <country-code-numeric nil=\"true\"></country-code-numeric>\n    </billing>\n    <refund-id nil=\"true\"></refund-id>\n    <refund-ids type=\"array\"/>\n    <refunded-transaction-id nil=\"true\"></refunded-transaction-id>\n    <settlement-batch-id nil=\"true\"></settlement-batch-id>\n    <shipping>\n      <id nil=\"true\"></id>\n      <first-name nil=\"true\"></first-name>\n      <last-name nil=\"true\"></last-name>\n      <company nil=\"true\"></company>\n      <street-address nil=\"true\"></street-address>\n      <extended-address nil=\"true\"></extended-address>\n      <locality nil=\"true\"></locality>\n      <region nil=\"true\"></region>\n      <postal-code nil=\"true\"></postal-code>\n      <country-name nil=\"true\"></country-name>\n      <country-code-alpha2 nil=\"true\"></country-code-alpha2>\n      <country-code-alpha3 nil=\"true\"></country-code-alpha3>\n      <country-code-numeric nil=\"true\"></country-code-numeric>\n    </shipping>\n    <custom-fields>\n    </custom-fields>\n    <avs-error-response-code nil=\"true\"></avs-error-response-code>\n    <avs-postal-code-response-code>I</avs-postal-code-response-code>\n    <avs-street-address-response-code>I</avs-street-address-response-code>\n    <cvv-response-code>I</cvv-response-code>\n    <gateway-rejection-reason nil=\"true\"></gateway-rejection-reason>\n    <processor-authorization-code>ZKB4VJ</processor-authorization-code>\n    <processor-response-code>1000</processor-response-code>\n    <processor-response-text>Approved</processor-response-text>\n    <credit-card>\n      <token>8yq7</token>\n      <bin>411111</bin>\n      <last-4>1111</last-4>\n      <card-type>Visa</card-type>\n      <expiration-month>02</expiration-month>\n      <expiration-year>2013</expiration-year>\n      <customer-location>US</customer-location>\n      <cardholder-name>Chad Lee Pytel</cardholder-name>\n    </credit-card>\n    <status-history type=\"array\">\n      <status-event>\n        <timestamp type=\"datetime\">2011-01-11T14:08:12Z</timestamp>\n        <status>authorized</status>\n        <amount>50.00</amount>\n        <user>copycopter</user>\n        <transaction-source>CP</transaction-source>\n      </status-event>\n      <status-event>\n        <timestamp type=\"datetime\">2011-01-11T14:08:12Z</timestamp>\n        <status>#{FakeBraintree.transaction[:status]}</status>\n        <amount>50.00</amount>\n        <user>copycopter</user>\n        <transaction-source>CP</transaction-source>\n      </status-event>\n    </status-history>\n    <subscription-id>#{FakeBraintree.transaction[:subscription_id]}</subscription-id>\n    <add-ons type=\"array\"/>\n    <discounts type=\"array\"/>\n  </transaction>\n</credit-card-transactions>\n")]
+    [200, { "Content-Encoding" => "gzip" }, ActiveSupport::Gzip.compress(FakeBraintree.generated_transaction.to_xml)]
   end
 end

data/spec/models/account_spec.rb

@@ -296,4 +296,44 @@ describe Account, "with a paid subscription" do
       subject.next_billing_date.to_s.should == subscription["next_billing_date"].to_s
     end
   end
+
+  it "receives a receipt email at it's billing email with transaction details" do
+    subscription = FakeBraintree.subscriptions[subject.subscription_token]
+    subscription["status"] = Braintree::Subscription::Status::Active
+    subscription["next_billing_date"] = 2.months.from_now
+    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Settled,
+                                  :subscription_id => subject.subscription_token }
+    subscription["transactions"] = [FakeBraintree.generated_transaction]
+
+    Timecop.travel(subject.next_billing_date + 1.day) do
+      ActionMailer::Base.deliveries.clear
+
+      Account.update_subscriptions!
+
+      ActionMailer::Base.deliveries.any? do |email|
+        email.to == [subject.billing_email] &&
+        email.subject =~ /receipt/i
+      end.should be
+    end
+  end
+
+  it "receives a receipt email at it's billing email with a notice that it failed when billing didn't work" do
+    subscription = FakeBraintree.subscriptions[subject.subscription_token]
+    subscription["status"] = Braintree::Subscription::Status::PastDue
+    subscription["next_billing_date"] = 2.months.from_now
+    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Failed,
+                                  :subscription_id => subject.subscription_token }
+    subscription["transactions"] = [FakeBraintree.generated_transaction]
+
+    Timecop.travel(subject.next_billing_date + 1.day) do
+      ActionMailer::Base.deliveries.clear
+
+      Account.update_subscriptions!
+
+      ActionMailer::Base.deliveries.any? do |email|
+        email.to == [subject.billing_email] &&
+        email.subject =~ /problem/i
+      end.should be
+    end
+  end
 end

data/spec/saucy_spec.rb

@@ -4,4 +4,8 @@ describe Saucy::Configuration do
   it "has layouts" do
     subject.layouts.should be_a(Saucy::Layouts)
   end
+
+  it "has a mailer_sender" do
+    subject.mailer_sender.should_not be_nil
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saucy
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -128,6 +128,7 @@ files:
 - Gemfile.lock
 - Rakefile
 - README.md
+- config/locales/en.yml
 - config/routes.rb
 - app/controllers/accounts_controller.rb
 - app/controllers/billings_controller.rb
@@ -135,6 +136,7 @@ files:
 - app/controllers/memberships_controller.rb
 - app/controllers/plans_controller.rb
 - app/controllers/profiles_controller.rb
+- app/mailers/billing_mailer.rb
 - app/models/invitation.rb
 - app/models/limit.rb
 - app/models/membership.rb
@@ -147,9 +149,12 @@ files:
 - app/views/accounts/edit.html.erb
 - app/views/accounts/index.html.erb
 - app/views/accounts/new.html.erb
+- app/views/billing_mailer/problem.html.erb
+- app/views/billing_mailer/problem.text.erb
+- app/views/billing_mailer/receipt.html.erb
+- app/views/billing_mailer/receipt.text.erb
 - app/views/billings/_form.html.erb
 - app/views/billings/edit.html.erb
-- app/views/billings/past_due.html.erb
 - app/views/billings/show.html.erb
 - app/views/invitation_mailer/invitation.text.erb
 - app/views/invitations/new.html.erb