simple_payment 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 568aecde3af8a78ff56b34c0cd36c86068f796ea
+  data.tar.gz: 48d17402840eb17adea4217a84e2cdd16b12bce1
+SHA512:
+  metadata.gz: 43add00d4ba7b5698f4fc541db86f46a29d88ce5b7f0acfd554d02222facc05a874a9ddd38f06a3796d7d5f068f948fc1f1030c243d26fb525e9bf7b964fbea6
+  data.tar.gz: 8b8c1ba6dda9961654a9b45dc818a5e57983402297bec53614fac7546d214b5206e241efa54477a946b2ee0ee6b37fcc936689f911131e30922cdb54f450bd68

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_payment.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    simple_payment (0.1.1)
+      aasm (~> 5)
+      activerecord (~> 5)
+      braintree (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aasm (5.0.0)
+      concurrent-ruby (~> 1.0)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    braintree (2.64.0)
+      builder (>= 2.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    factory_bot (4.10.0)
+      activesupport (>= 3.0.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-collection_matchers (1.1.3)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  factory_bot (~> 4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-collection_matchers (~> 1)
+  simple_payment!
+  sqlite3 (~> 1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Doug Knight
+
+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,39 @@
+# SimplePayment
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_payment`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_payment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_payment
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_payment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_payment"
+
+# 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/simple_payment/braintree/gateway.rb

@@ -0,0 +1,56 @@
+require 'braintree'
+
+module SimplePayment
+  module Braintree
+    class Gateway
+      def execute(payment, nonce)
+        result = gateway.transaction.sale(execute_args(payment, nonce))
+        [Request.new(:sale), Response.new(result)]
+      rescue StandardError => e
+        raise TransmissionError.new Request.new(:sale), e.message
+      end
+
+      def completed?(payment)
+        transaction = gateway.transaction.find(payment.external_id)
+        %w(settling settled).include?(transaction.status)
+      rescue StandardError => e
+        raise TransmissionError.new Request.new(:find), e.message
+      end
+
+      def cancel(payment)
+        result = gateway.transaction.void(payment.external_id)
+        [Request.new(:cancel), Response.new(result)]
+      rescue StandardError => e
+        raise TransmissionError.new Request.new(:cancel), e.message
+      end
+
+      def refund(payment)
+        result = gateway.transaction.refund(payment.external_id)
+        [Request.new(:refund), Response.new(result)]
+      rescue StandardError => e
+        raise TransmissionError.new Request.new(:refund), e.message
+      end
+
+      private
+
+      def gateway
+        ::Braintree::Gateway.new
+      end
+
+      def execute_args(payment, nonce)
+        {
+          amount: payment.amount,
+          payment_method_nonce: nonce,
+          options: {
+            submit_for_settlement: true
+          }
+        }.tap do |a|
+          if payment.payable&.respond_to?(:custom_fields) &&
+              payment.payable&.custom_fields.present?
+            a[:custom_fields] = payment.payable.custom_fields
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_payment/braintree/request.rb

@@ -0,0 +1,13 @@
+module SimplePayment
+  module Braintree
+    class Request
+      def initialize(method)
+        @method = method
+      end
+
+      def serialize
+        @method.to_s
+      end
+    end
+  end
+end

data/lib/simple_payment/braintree/response.rb

@@ -0,0 +1,17 @@
+module SimplePayment
+  module Braintree
+    class Response
+      def initialize(result)
+        @result = result
+      end
+
+      def serialize
+        @result.to_yaml
+      end
+
+      def success?
+        @result.success?
+      end
+    end
+  end
+end

data/lib/simple_payment/models/payment.rb

@@ -0,0 +1,111 @@
+module SimplePayment
+  class Payment < ActiveRecord::Base
+    include AASM
+
+    self.table_name = 'simple_payments'
+
+    belongs_to :payable, polymorphic: true
+    has_many :transactions
+
+    validates_presence_of :amount, :payable_id, :payable_type, :status
+
+    scope :accepted, ->{ where status: %w(approved completed) }
+
+    aasm column: 'status' do
+      state :pending
+      state :approved
+      state :cancelled
+      state :completed
+      state :failed
+      state :refunded
+
+      event :_approve do
+        transitions from: :pending, to: :approved
+      end
+
+      event :_fail do
+        transitions from: :pending, to: :failed
+      end
+
+      event :_complete do
+        transitions from: :approved, to: :completed
+      end
+
+      event :_cancel do
+        transitions from: :approved, to: :cancelled
+      end
+
+      event :_refund do
+        transitions from: :completed, to: :refunded
+      end
+    end
+
+    # Calls the gateway to execute the payment, saving the
+    # communication details and status change to the model
+    def execute!(nonce)
+      return unless may__approve?
+      request, response = gateway.execute(self, nonce)
+      if response.success?
+        _approve
+      else
+        _fail
+      end
+      self.external_id ||= response.external_id
+      self.external_fee = gateway.calculate_fee(self)
+      save!
+
+      persist_transaction request, response
+      response.success?
+    rescue TransmissionError => e
+      handle_error e
+      false
+    end
+
+    # Calls the gateway to see if an approved payment has been completed
+    def complete!
+      return unless may__complete?
+      _complete! if gateway.completed?(self)
+
+    rescue TransmissionError => e
+      handle_error e
+    end
+
+    # Calls the gateway to cancel an approved payment or
+    # to refund a completed payment.
+    def cancel!
+      return unless approved?
+      request, response = gateway.cancel self
+      _cancel! if response.success?
+      persist_transaction request, response
+    rescue TransmissionError => e
+      handle_error e
+    end
+
+    def refund!
+      return unless completed?
+      request, response = gateway.refund self
+      _refund! if response.success?
+      persist_transaction request, response
+    rescue TransmissionError => e
+      handle_error e
+    end
+
+    private
+
+    def handle_error(error)
+      transactions.create! \
+        request: error.request.serialize,
+        error:   error.serialize
+    end
+
+    def gateway
+      SimplePayment::gateway
+    end
+
+    def persist_transaction(request, response)
+      transactions.create! \
+        request: request.serialize,
+        response: response.serialize
+    end
+  end
+end

data/lib/simple_payment/models/transaction.rb

@@ -0,0 +1,8 @@
+module SimplePayment
+  class Transaction < ActiveRecord::Base
+
+    self.table_name = 'simple_transactions'
+
+    validates_presence_of :payment_id, :request
+  end
+end

data/lib/simple_payment/test/gateway.rb

@@ -0,0 +1,34 @@
+module SimplePayment
+  module Test
+    class Gateway
+      def execute(payment, nonce)
+        [
+          Request.new,
+          Response.new
+        ]
+      end
+
+      def completed?(payment)
+        true
+      end
+
+      def cancel(payment)
+        [
+          Request.new,
+          Response.new
+        ]
+      end
+
+      def refund(payment)
+        [
+          Request.new,
+          Response.new
+        ]
+      end
+
+      def calculate_fee(payment)
+        1.23
+      end
+    end
+  end
+end

data/lib/simple_payment/test/request.rb

@@ -0,0 +1,9 @@
+module SimplePayment
+  module Test
+    class Request
+      def serialize
+        '<test request>'
+      end
+    end
+  end
+end

data/lib/simple_payment/test/response.rb

@@ -0,0 +1,17 @@
+module SimplePayment
+  module Test
+    class Response
+      def success?
+        true
+      end
+
+      def serialize
+        '<test response>'
+      end
+
+      def external_id
+        SecureRandom.hex(10)
+      end
+    end
+  end
+end

data/lib/simple_payment/transmission_error.rb

@@ -0,0 +1,15 @@
+module SimplePayment
+  class TransmissionError < StandardError
+
+    attr_reader :request
+
+    def initialize(request, message = 'Unable to complete the transmission')
+      super message
+      @request = request
+    end
+
+    def serialize
+      message
+    end
+  end
+end

data/lib/simple_payment/version.rb

@@ -0,0 +1,3 @@
+module SimplePayment
+  VERSION = "0.1.1"
+end

data/lib/simple_payment.rb

@@ -0,0 +1,29 @@
+require 'aasm'
+require 'active_record'
+require 'simple_payment/transmission_error'
+require 'simple_payment/braintree/gateway'
+require 'simple_payment/braintree/request'
+require 'simple_payment/braintree/response'
+require 'simple_payment/models/payment'
+require 'simple_payment/models/transaction'
+require 'simple_payment/version'
+require 'simple_payment/test/gateway'
+require 'simple_payment/test/request'
+require 'simple_payment/test/response'
+
+module SimplePayment
+  class << self
+    def gateway
+      @gateway.new
+    end
+
+    def configure(options)
+      @gateway = options[:gateway]
+      @gateway = SimplePayment::Test::Gateway if @gateway == :test
+    end
+
+    def clear_configuration
+      @gateway = nil
+    end
+  end
+end

data/simple_payment.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_payment/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_payment"
+  spec.version       = SimplePayment::VERSION
+  spec.authors       = ["Doug Knight"]
+  spec.email         = ["dougbknight@gmail.com"]
+
+  spec.summary       = %q{Payment library using an active record model with state machine.}
+  spec.description   = %q{Payment library seeking to make payment interactions simple and reusable.}
+  spec.homepage      = "https://github.com/dgknght/simple_payment"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'activerecord', '~> 5'
+  spec.add_dependency 'aasm', '~> 5'
+  spec.add_dependency 'braintree', '~> 2'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
+  spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'factory_bot', '~> 4'
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: simple_payment
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Doug Knight
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: braintree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Payment library seeking to make payment interactions simple and reusable.
+email:
+- dougbknight@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_payment.rb
+- lib/simple_payment/braintree/gateway.rb
+- lib/simple_payment/braintree/request.rb
+- lib/simple_payment/braintree/response.rb
+- lib/simple_payment/models/payment.rb
+- lib/simple_payment/models/transaction.rb
+- lib/simple_payment/test/gateway.rb
+- lib/simple_payment/test/request.rb
+- lib/simple_payment/test/response.rb
+- lib/simple_payment/transmission_error.rb
+- lib/simple_payment/version.rb
+- simple_payment.gemspec
+homepage: https://github.com/dgknght/simple_payment
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Payment library using an active record model with state machine.
+test_files: []