ashmont 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f63b6c7b821f3dae27701be2e0df7f3b8af6ded5
+  data.tar.gz: dd9f6f848a7bc533b7ce215bdfe38c4babe93c4e
+SHA512:
+  metadata.gz: 4669eecb9e0d67700d3726a61a1da4519be58a83963251c0f4530d3ea6557d14dc6c47bacd97d03e571a1ce03de252b61bf71b1936bdec464df0ebe693cead00
+  data.tar.gz: 44e257f514158d23b876a352e086819c5571c72c274c2b27e651e617d5381e5dd74b169ad03ed183db10713f371ecdf6e6087a9ff26160f0cd0685ede8dea500

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+~
+*.swp
+i*.swo
+# ruby version and gemsets
+.ruby-*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+##v0.0.12
+
+* bumped up version of braintree gem in gemspec
+
+## v0.0.11
+
+* initial release
+* modernized gem by fleshing out some missing files .travis.yml, CODE_OF_CONDUCT.md, LICENSE.txt, bin/console, bin/setup, spec/ashmont_spec.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rocketeer.captproton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Tanner
+
+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/README.md

@@ -0,0 +1,119 @@
+Ashmont
+=======
+
+Ashmont is a set of classes that make it easier to use
+[Braintree payment processing](http://www.braintreepayments.com/) in a Rails application.
+
+Ashmont attempts to make the following tasks easier:
+
+* Processing error messages from Braintree and using them in the ActiveModel API
+* Delegating and caching relevant information in a model backed by a Braintree
+  recurring subscription
+* Delegating and caching relevant information in a model backed by a Braintree
+  customer with a credit card
+* Determining what actions are necessary to handle a form update, such as
+  updating a credit card, switching subscription plans, or retrying failed
+  subscription transactions
+
+Ashmont is still an early work in progress and the API may change dramatically with each release.
+
+Installation
+------------
+
+In your Gemfile:
+
+    gem "ashmont"
+
+If you have an account with Braintree with multiple merchant accounts you'll
+want to configure the merchant account for this application:
+
+    Ashmont.merchant_account_id = 'your merchant account id'
+
+Ashmont converts billing dates from Braintree into TimeWithZone instances to
+avoid time zone mishaps. You'll want to configure Ashmont with the correct
+timezone so that billing dates end up on the correct day.
+
+    Ashmont.merchant_account_time_zone = 'Eastern Time (US & Canada)'
+
+Usage
+-----
+
+In order to process payments with Braintree, you'll want to store customer and
+subscription tokens locally. You'll also need to store the billing status next
+billing date in order to synchronize account status with Braintree.
+
+    create_table "users" do |t|
+      t.string   "customer_token"
+      t.string   "subscription_token"
+      t.datetime "next_billing_date"
+      t.string   "subscription_status"
+    end
+
+Here's a simple example for creating and updating a subscribed customer:
+
+    class User < ActiveRecord::Base
+      before_create :create_customer
+      after_destroy :destroy_customer
+      memoize :customer
+
+      def past_due?
+        customer.past_due?
+      end
+
+      def save_customer(attributes)
+        customer.save(attributes)
+      end
+
+      private
+
+      def create_customer
+        save_customer(:email => email)
+        if customer.save(:email => email)
+          self.customer_token = customer.token
+          self.subscription_token = customer.subscription_token
+          self.next_billing_date = customer.next_billing_date
+          self.subscription_status = customer.status
+          true
+        else
+          copy_errors customer.errors
+          false
+        end
+      end
+
+      def destroy_customer
+        customer.delete
+      end
+
+      def copy_errors(source_errors)
+        source_errors.to_hash.each do |attribute, messages|
+          errors.set(attribute, messages)
+        end
+      end
+
+      def customer
+        Ashmont::SubscribedCustomer.new(
+          Ashmont::Customer.new(customer_token),
+          Ashmont::Subscription.new(subscription_token, :status => subscription_status)
+        )
+      end
+    end
+
+    user = User.new(params[:user])
+    user.save_customer(params[:customer])
+
+The above `save_customer` method will accept attributes related to
+subscriptions, customrers, and credit cards.
+
+Testing
+-------
+
+We recommend testing your applications using the
+[fake_braintree](https://github.com/thoughtbot/fake_braintree) library, which
+allows applications to use the real Braintree API without actually hitting
+Braintree's servers during automated tests.
+
+License
+-------
+
+Ashmont is Copyright © 2011-2013 thoughtbot, inc. It is free software, and may be
+redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/{*_spec.rb}'
+end
+
+task :default => [:spec]

data/ashmont.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ashmont/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ashmont"
+  s.version     = Ashmont::VERSION.dup
+  s.authors     = ["thoughtbot"]
+  s.email       = ["jferris@thoughtbot.com"]
+  s.homepage    = ""
+  s.summary     = %q{ActiveModel-like objects and helpers for interacting with Braintree.}
+  s.description = %q{ActiveModel-like objects and helpers for interacting with Braintree.}
+
+  s.rubyforge_project = "ashmont"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('braintree', '>= 2.74.0')
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.add_dependency('i18n', '>= 0.6')
+  s.add_dependency('tzinfo', '>= 0.3')
+  s.add_development_dependency('bourne')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('timecop')
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ashmont"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ashmont/customer.rb

@@ -0,0 +1,146 @@
+module Ashmont
+  class Customer
+    CREDIT_CARD_ATTRIBUTES = [:cardholder_name, :number, :cvv, :expiration_month, :expiration_year].freeze
+    ADDRESS_ATTRIBUTES = [:street_address, :extended_address, :locality, :region, :postal_code, :country_name].freeze
+    BILLING_ATTRIBUTES = (CREDIT_CARD_ATTRIBUTES + ADDRESS_ATTRIBUTES).freeze
+
+    attr_reader :token, :errors
+
+    def initialize(token = nil)
+      @token = token
+      @errors = {}
+    end
+
+    def credit_card
+      credit_cards[0]
+    end
+
+    def credit_cards
+      if persisted?
+        remote_customer.credit_cards
+      else
+        []
+      end
+    end
+
+    def has_billing_info?
+      credit_card.present?
+    end
+
+    def payment_method_token
+      credit_card.token if credit_card
+    end
+
+    def billing_email
+      remote_customer.email if persisted?
+    end
+
+    def save(attributes)
+      handle_result create_or_update(attributes)
+    end
+
+    def delete
+      Braintree::Customer.delete(@token)
+    end
+
+    def last_4
+      credit_card.last_4 if credit_card
+    end
+
+    def cardholder_name
+      credit_card.cardholder_name if credit_card
+    end
+
+    def expiration_month
+      credit_card.expiration_month if credit_card
+    end
+
+    def expiration_year
+      credit_card.expiration_year if credit_card
+    end
+
+    def street_address
+      credit_card.billing_address.street_address if credit_card
+    end
+
+    def extended_address
+      credit_card.billing_address.extended_address if credit_card
+    end
+
+    def locality
+      credit_card.billing_address.locality if credit_card
+    end
+
+    def region
+      credit_card.billing_address.region if credit_card
+    end
+
+    def postal_code
+      credit_card.billing_address.postal_code if credit_card
+    end
+
+    def country_name
+      credit_card.billing_address.country_name if credit_card
+    end
+
+    def confirm(query_string)
+      handle_result Braintree::TransparentRedirect.confirm(query_string)
+    end
+
+    private
+
+    def create_or_update(attributes)
+      remote_attributes = build_attribute_hash(attributes.symbolize_keys)
+      if persisted?
+        update(remote_attributes)
+      else
+        create(remote_attributes)
+      end
+    end
+
+    def build_attribute_hash(attributes)
+      result = { :email => attributes[:email] }
+      if BILLING_ATTRIBUTES.any? { |attribute| attributes[attribute].present? }
+        result[:credit_card] = CREDIT_CARD_ATTRIBUTES.inject({}) do |credit_card_attributes, attribute|
+          credit_card_attributes.update(attribute => attributes[attribute])
+        end
+        result[:credit_card][:billing_address] = ADDRESS_ATTRIBUTES.inject({}) do |address_attributes, attribute|
+          address_attributes.update(attribute => attributes[attribute])
+        end
+        if payment_method_token
+          result[:credit_card][:options] = { :update_existing_token => payment_method_token }
+        end
+      else
+        result[:credit_card] = {}
+      end
+      result
+    end
+
+    def create(attributes)
+      Braintree::Customer.create(attributes)
+    end
+
+    def update(attributes)
+      Braintree::Customer.update(@token, attributes)
+    end
+
+    def handle_result(result)
+      if result.success?
+        @token = result.customer.id
+        @remote_customer = result.customer
+        true
+      else
+        @errors = Ashmont::Errors.new(result.credit_card_verification, result.errors)
+        false
+      end
+    end
+
+    def persisted?
+      @token.present?
+    end
+
+    def remote_customer
+      @remote_customer ||= Braintree::Customer.find(@token)
+    end
+  end
+end

data/lib/ashmont/errors.rb

@@ -0,0 +1,47 @@
+module Ashmont
+  class Errors
+    ERROR_MESSAGE_PREFIXES = {
+      "number" => "Credit card number ",
+      "CVV" => "CVV ",
+      "expiration_month" => "Expiration month ",
+      "expiration_year" => "Expiration year "
+    }
+
+    def initialize(result, remote_errors)
+      @errors = {}
+      parse_result(result)
+      parse_remote_errors(remote_errors)
+    end
+
+    def to_hash
+      @errors.dup
+    end
+
+    private
+
+    def parse_result(result)
+      if result.respond_to?(:status)
+        case result.status
+        when "processor_declined"
+          add_error :number, "was denied by the payment processor with the message: #{result.processor_response_text}"
+        when "gateway_rejected"
+          add_error :cvv, "did not match"
+        end
+      end
+    end
+
+    def parse_remote_errors(remote_errors)
+      remote_errors.each do |error|
+        if prefix = ERROR_MESSAGE_PREFIXES[error.attribute]
+          message = error.message.sub(prefix, "")
+          add_error error.attribute.downcase, message
+        end
+      end
+    end
+
+    def add_error(attribute, message)
+      @errors[attribute] ||= []
+      @errors[attribute] << message
+    end
+  end
+end

data/lib/ashmont/subscribed_customer.rb

@@ -0,0 +1,80 @@
+require 'delegate'
+require 'forwardable'
+
+module Ashmont
+  class SubscribedCustomer < DelegateClass(Customer)
+    CUSTOMER_ATTRIBUTES = [:cardholder_name, :email, :number,
+                           :expiration_month, :expiration_year, :cvv,
+                           :street_address, :extended_address, :locality,
+                           :region, :postal_code, :country_name]
+
+    extend Forwardable
+
+    def initialize(customer, subscription)
+      super(customer)
+      @customer = customer
+      @subscription = subscription
+    end
+
+    def_delegators :@subscription, :reload, :status, :next_billing_date,
+      :transactions, :most_recent_transaction, :retry_charge, :past_due?
+
+    def subscription_token
+      @subscription.token
+    end
+
+    def save(attributes)
+      apply_customer_changes(attributes) && ensure_subscription_active && apply_subscription_changes(attributes)
+    end
+
+    def errors
+      super.to_hash.merge(@subscription.errors.to_hash)
+    end
+
+    private
+
+    def apply_customer_changes(attributes)
+      if new_customer? || changing_customer?(attributes)
+        @customer.save(attributes)
+      else
+        true
+      end
+    end
+
+    def new_customer?
+      token.nil?
+    end
+
+    def changing_customer?(attributes)
+      CUSTOMER_ATTRIBUTES.any? { |attribute| attributes[attribute].present? }
+    end
+
+    def ensure_subscription_active
+      if past_due?
+        retry_charge
+      else
+        true
+      end
+    end
+
+    def apply_subscription_changes(attributes)
+      if changing_subscription?(attributes)
+        save_subscription(attributes)
+      else
+        true
+      end
+    end
+
+    def changing_subscription?(attributes)
+      attributes[:plan_id].present?
+    end
+
+    def save_subscription(attributes)
+      @subscription.save(
+        :plan_id => attributes[:plan_id],
+        :price => attributes[:price].to_s,
+        :payment_method_token => payment_method_token
+      )
+    end
+  end
+end