cash_out 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89d3b16a65640bfe86c9c9b08db3415d802b5daa
+  data.tar.gz: e7264ed0558c1dd2ff12a1741ca08b1f6627c03a
+SHA512:
+  metadata.gz: ba3d8f16518bd1b28926a4a1d28cd8a70f867e5c7060f6c684429ef0191eef143e5b02ac558b1a0bb23ccbaea1cda1c7d57b08b49d7f701f83706bbbbb5745de
+  data.tar.gz: fa92ab005a40e0e61ef6540bacc53f11f6789dee1f3b7f0a2637676e6d496389fec00a47ad6ea08dcfcc170c8d3bae3614b80386fa1f16d7e7a40431019ab94d

data/.gitignore

@@ -0,0 +1 @@
+spec/examples.txt

data/.rspec

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

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 cash_out.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    cash_out (0.0.1)
+      active_interaction (~> 3.6)
+      railties (< 6.0)
+      stripe (~> 3.21)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_interaction (3.6.1)
+      activemodel (>= 4, < 6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    byebug (10.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    dante (0.2.0)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-activemodel-mocks (1.0.3)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    stripe (3.22.0)
+      faraday (~> 0.10)
+    stripe-ruby-mock (2.5.4)
+      dante (>= 0.2.0)
+      multi_json (~> 1.0)
+      stripe (>= 2.0.3)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cash_out!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-activemodel-mocks
+  stripe-ruby-mock (~> 2.5.4)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tyler Rockwell
+
+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,50 @@
+# Cash Out
+
+A gem developed with the express purpose of reducing development time when integrating
+with Stripe payments.
+
+This gem is targeted at API development and assumes your frontend is able to generate
+and send tokenized payment data to your endpoints.
+
+## Installation
+
+1. Add `gem cash_out` to your Gemfile
+1. `bundle install`
+1. `rails generate cash_out:install`
+1. Update the items in `config/initializers/cash_out.rb` with your Stripe api keys
+1. Create a migration to add a `stripe_id` field to `User` or whichever model will hold the Stripe token
+
+## Usage
+
+All `CashOut` services utilize [ActiveInteraction](https://github.com/AaronLasseigne/active_interaction)
+and will return an appropriate service object.
+
+### Creating a Stripe Customer
+
+Stripe Customer objects are used for making credit card purchases. You can create a
+Stripe Customer and store the token on your User with the following code.
+
+Inside your controller, add:
+```ruby
+def create
+  CashOut::Payments::Customer::Create.run(customer_params)
+end
+
+def customer_params
+  { user: current_user, stripe_token: params[:token] }
+end
+```
+
+### Deleting a Stripe Customer
+
+To remove payment information from your user, run the appropriate delete service
+
+Inside your controller, add:
+```ruby
+def destroy
+  CashOut::Payments::Customer::Delete.run(user: current_user)
+end
+```
+
+Note: This currently does not delete the payment information from Stripe. Support
+for this will be added in a future release.

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 "cash_out"
+
+# 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/cash_out.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cash_out/version"
+
+Gem::Specification.new do |s|
+  s.name = 'cash_out'
+  s.version = CashOut::VERSION
+  s.date = '2018-08-13'
+  s.summary = 'A gem to ease setup of Stripe Marketplace Payments'
+  s.description = 'A gem to ease setup of Stripe Marketplace Payments'
+  s.authors = ['Tyler Rockwell']
+  s.files = %w(README.md) + Dir.glob(File.join('lib', '**', '*.rb'))
+  s.homepage = 'http://rubygems.org/gems/cash_out'
+  s.license = 'MIT'
+
+  s.add_dependency 'active_interaction', '~> 3.6'
+  s.add_dependency 'stripe', '~> 3.21'
+  s.add_dependency 'railties', '< 6.0'
+
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-activemodel-mocks"
+  s.add_development_dependency 'stripe-ruby-mock', '~> 2.5.4'
+end

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  cash_out:
+    customer:
+      account_already_exists: "User already has a Stripe account"
+      invalid_card: "The card entered is not valid"
+    service:
+      success: "Success!"
+      failure: "Failure"
+

data/lib/cash_out/base.rb

@@ -0,0 +1,4 @@
+module CashOut
+  class Base
+  end
+end

data/lib/cash_out/configuration.rb

@@ -0,0 +1,10 @@
+module CashOut
+  class Configuration
+    attr_accessor :stripe_publishable_key, :stripe_secret_key, :stripe_api_key
+
+    def initialize
+      @stripe_publishable_key = nil
+      @stripe_secret_key = nil
+    end
+  end
+end

data/lib/cash_out/payments/customer/create.rb

@@ -0,0 +1,37 @@
+module CashOut
+  module Payments
+    module Customer
+      class Create < ::CashOut::ServiceBase
+        interface :user, methods: [:stripe_id]
+        string :stripe_token, default: nil
+
+        validate :customer_is_nil
+
+        def execute
+          customer = create_stripe_customer
+          user.stripe_id = customer["id"] if customer.is_a?(Stripe::Customer)
+          validate_and_save(user)
+        end
+
+        private
+
+        def create_stripe_customer
+          Stripe::Customer.create(source: stripe_token)
+
+        rescue *STRIPE_ERRORS => e
+          if e.class == Stripe::CardError
+            errors.add(:stripe, I18n.t('cash_out.customer.invalid_card'))
+          else
+            errors.add(:stripe, e.to_s)
+          end
+        end
+
+        def customer_is_nil
+          unless user.stripe_id.blank?
+            errors.add(:stripe, I18n.t('cash_out.customer.account_already_exists'))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cash_out/payments/customer/delete.rb

@@ -0,0 +1,23 @@
+module CashOut
+  module Payments
+    module Customer
+      class Delete < ::CashOut::ServiceBase
+        object :user
+
+        def execute
+          delete_customer
+          user.stripe_id = nil
+          validate_and_save(user)
+        end
+
+        private
+
+        def delete_customer
+          Stripe::Customer.retrieve(user.stripe_id).delete
+        rescue *STRIPE_ERRORS => e
+          errors.add(:stripe, e.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/cash_out/service_base.rb

@@ -0,0 +1,27 @@
+class CashOut::ServiceBase < ActiveInteraction::Base
+  STRIPE_ERRORS = [
+    Stripe::InvalidRequestError,
+    Stripe::AuthenticationError,
+    Stripe::APIConnectionError,
+    Stripe::StripeError
+  ].freeze
+
+  def validate_and_save(model_object)
+    unless model_object.save
+      errors.merge!(model_object.errors)
+    end
+    model_object
+  end
+
+  def success_message
+    I18n.t('cash_out.service.success')
+  end
+
+  def failure_message
+    I18n.t('cash_out.service.failure')
+  end
+
+  def failure_status
+    422
+  end
+end

data/lib/cash_out/version.rb

@@ -0,0 +1,4 @@
+module CashOut
+  VERSION = "0.0.2"
+end
+

data/lib/cash_out.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'cash_out/configuration'
+
+require 'active_interaction'
+require 'stripe'
+require 'cash_out/base'
+require 'cash_out/service_base'
+require 'cash_out/payments/customer/create'
+require 'cash_out/payments/customer/delete'
+
+module CashOut
+  extend self
+
+  attr_accessor :configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def reset
+    @configuration = Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+    Stripe.api_key = configuration.stripe_secret_key
+  end
+
+  def root
+    File.dirname __dir__
+  end
+end
+
+translation_path = [File.join(CashOut.root, 'config', 'locales', 'en.yml')]
+I18n.load_path += translation_path
+
+require 'generators/cash_out/templates/cash_out_config'
+require 'generators/cash_out/install_generator'

data/lib/generators/cash_out/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+module CashOut
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    desc "Generates configuration file for CashOut"
+
+    def create_initializer_file
+      template "cash_out_config.rb", "config/initializers/cash_out.rb"
+    end
+  end
+end

data/lib/generators/cash_out/templates/cash_out_config.rb

@@ -0,0 +1,5 @@
+CashOut.configure do |config|
+  config.stripe_publishable_key = ''
+  config.stripe_secret_key = ''
+  config.stripe_api_key = ''
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: cash_out
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tyler Rockwell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.21'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !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: pry-byebug
+  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: 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-activemodel-mocks
+  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: stripe-ruby-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+description: A gem to ease setup of Stripe Marketplace Payments
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cash_out.gemspec
+- config/locales/en.yml
+- lib/cash_out.rb
+- lib/cash_out/base.rb
+- lib/cash_out/configuration.rb
+- lib/cash_out/payments/customer/create.rb
+- lib/cash_out/payments/customer/delete.rb
+- lib/cash_out/service_base.rb
+- lib/cash_out/version.rb
+- lib/generators/cash_out/install_generator.rb
+- lib/generators/cash_out/templates/cash_out_config.rb
+homepage: http://rubygems.org/gems/cash_out
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: A gem to ease setup of Stripe Marketplace Payments
+test_files: []