compensated 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ef6a5718683783e493fdad36e304f857635c301b12c12bd6ac790259bb39756
+  data.tar.gz: 79de21133b8dc3fc4704b70b98264c6301ab8bb48d113201f0292a4456c8d1be
+SHA512:
+  metadata.gz: e2180e9ef30642ff344db949945aeed11aebba04a5a9e45659b7b80c450a873c55586eabfbef5cec8ac6afe71975b7aa4866edf348c96bee25dc6cb992f7b18a
+  data.tar.gz: 5038cb753bc272195f7354fff615c60961ee707f375d5f846a38cf213deac6c2bf082c794c287dcda620a92d06ca68972f6e2bf9cd2d1682996bd92fe38667e7

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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in compensated-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    compensated (0.1.0.pre1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  compensated!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,68 @@
+# Compensated
+
+Compensated makes it easy to adjust your customer experience based upon whether or not someone has paaaaiiiiiiiid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compensated'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compensated
+
+## Usage
+
+Right now, we do not provide a Rack plugin or Rails engine for use with Compensated; this is because we don't really know what the best interface is. Part of our goal for 1.0 is a very boring set of defaults, but we don't want to codify that yet.
+
+
+### Rails Example
+```rb
+class PaymentProcessorEventsController < ApplicationController
+  def create
+    # We provide a basic request handler that normalizes the payment processor event data
+    # for your convenience.
+    handler = Compensated::PaymentProcessorEventRequestHandler.new(request)
+
+
+    # If you use ActiveRecord, we provide a model for persisting the
+    # events in your database.
+
+    # We strongly encourage keeping payment processor events around
+    # for conflict reconciliation, fraud detection, etc.
+    event = Compensated::PaymentProcessorEvent.create(handler.normalized_event_data)
+    if event.persisted?
+      head :ok
+    else
+      # Some payment processors will retry sending of the event
+      # if you tell them things didn't work out right.
+
+      # We encourage you to return a 5XX status code to trigger
+      # the retry behavior.
+      head :internal_server_error
+    end
+  end
+end
+```
+
+
+## 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/zinc-technology/compensated. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Compensated project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zinc-technology/compensated/blob/primary/CODE_OF_CONDUCT.md).

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 "compensated"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/compensated.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "compensated/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "compensated"
+  spec.version       = Compensated::VERSION
+  spec.authors       = ["Zee"]
+  spec.email         = ["zee@zincma.de"]
+
+  spec.summary       = "Provide value (In Ruby!). Get paid."
+  spec.description   = "Compensated makes handling transactions slightly less of a nightmare."
+  spec.homepage      = "https://github.com/zinc-technology/compensated"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/zinc-technology/compensated"
+    spec.metadata["changelog_uri"] = "https://github.com/zinc-technology/compensated/primary/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/examples/compensated-rails-5/Gemfile

@@ -0,0 +1,36 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "2.6.3"
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem "rails", "~> 5.2.3"
+# Use sqlite3 as the database for Active Record
+gem "sqlite3"
+
+# Core compensated library
+gem "compensated", "../compensated-ruby"
+
+# Plugin to provide stripe integration for compensated
+gem "compensated-stripe", "../compensated-ruby-stripe"
+
+# Plugin to provide gumroad integration for compensated
+gem "compensated-gumroad", "../compensated-ruby-gumroad"
+# Use Puma as the app server
+gem "puma", "~> 3.11"
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem "jbuilder", "~> 2.5"
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem "byebug", platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem "web-console", ">= 3.3.0"
+  gem "listen", ">= 3.0.5", "< 3.2"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/lib/compensated/payment_processor_event_request_handler.rb

@@ -0,0 +1,34 @@
+module Compensated
+  # Normalizes events by passing them to an EventParser
+  # Which transforms them into a hash that can be
+  # persisted to a database.
+  class PaymentProcessorEventRequestHandler
+    attr_accessor :event_request
+    # @param event_request [Request] A rack-compatible HTTP request triggered
+    #                                by the payment processor
+    def initialize(event_request)
+      self.event_request = event_request
+    end
+
+    # @return Hash
+    def normalized_event_data
+      event_parser.parse(event_request_body_data)
+    end
+
+    protected def event_parser
+      return @event_parser unless @event_parser.nil?
+      @event_parser = Compensated.event_parsers.find { |parser| parser.parses?(event_request_body_data) }
+      raise NoParserForEventError, event_request_body_data if @event_parser.nil?
+      @event_parser
+    end
+
+    protected def event_request_body_data
+      @event_request_body_data ||= Compensated.json_adapter.parse(event_request_body)
+    end
+
+    protected def event_request_body
+      return @event_request_body unless @event_request_body.nil?
+      @event_request_body = event_request.body
+    end
+  end
+end

data/lib/compensated/stripe/event_parser.rb

@@ -0,0 +1,23 @@
+module Compensated
+  module Stripe
+    SUPPORTED_EVENTS = %w[charge.succeeded invoice.payment_succeeded]
+    class EventParser
+      def parses?(input_event)
+        return false if input_event.nil? || !input_event.respond_to?(:key)
+        SUPPORTED_EVENTS.include?(input_event[:type])
+      end
+
+      def parse(input_event)
+        {
+          raw_body: Compensated.json_adapter.dump(input_event),
+          raw_event_type: input_event[:type].to_sym,
+          raw_event_id: input_event[:id],
+          payment_processor: :stripe,
+        }
+      end
+    end
+  end
+
+  # Ensure Compensated is aware that the stripe event parser is available.
+  event_parsers.push(Stripe::EventParser.new)
+end

data/lib/compensated/stripe/version.rb

@@ -0,0 +1,5 @@
+module Compensated
+  module Stripe
+    VERSION = "0.1.0"
+  end
+end

data/lib/compensated/stripe.rb

@@ -0,0 +1,8 @@
+require_relative "stripe/version"
+require_relative "stripe/event_parser"
+
+module Compensated
+  module Stripe
+    class Error < Compensated::Error; end
+  end
+end

data/lib/compensated/version.rb

@@ -0,0 +1,3 @@
+module Compensated
+  VERSION = "0.1.0.pre1"
+end

data/lib/compensated.rb

@@ -0,0 +1,70 @@
+require_relative "compensated/version"
+require_relative "compensated/payment_processor_event_request_handler"
+
+module Compensated
+  class Error < StandardError; end
+  class NoParserForEventError < Error; end
+
+  # Collection of parsers useful in the application
+  # Plugins like compensated-stripe, compensated-iap-android,
+  # compensated-iap-apple, and compensated-gumroad.
+  def self.event_parsers
+    @event_parsers ||= []
+  end
+
+  # A singletonesque JSON parser for use in plugins that need to interact
+  # with JSON from IO streams.
+  def self.json_adapter
+    @json_adapter ||= RewindingJSONAdapter.new
+  end
+
+  # Provides an affordance for overriding the built in
+  # rewinding JSON parser/dumper in favor of one that's more appropriate for
+  # your use case
+  def self.json_adapter=(json_adapter)
+    @json_adapter = json_adapter
+  end
+
+  # By default, we use the JSON standard library provided by Ruby.
+  # In cases where the default JSON parser is unacceptable, configure
+  # the json engine using `Compensated.json_engine = <Your preferred JSON parser>`
+  def self.json_engine
+    require "json" unless @json_engine
+    @json_engine ||= JSON
+  end
+
+  def self.json_engine=json_engine
+    @json_engine = json_engine
+  end
+
+  # Wraps the built in JSON library to support IO streams that may
+  # have been read from already, and ensures provided sources are
+  # rewound for later consumption
+  class RewindingJSONAdapter
+    def parse(io_source)
+      # We rewind the IO stream so that if something else has already
+      # read from the stream we get the whole thing
+      io_source.rewind if io_source.respond_to?(:rewind)
+
+      # If the io source responds to read, use the content to parse the json,
+      content = io_source.respond_to?(:read) ? io_source.read : io_source
+      # We default to symbolizing names so plugins don't need to guess about
+      # it.
+      object = engine.parse(content, symbolize_names: true)
+
+      # And we rewind it again when we're done so anyone
+      # downstream can use the stream
+      io_source.rewind if io_source.respond_to?(:rewind)
+      object
+    end
+
+    def dump(object)
+      engine.dump(object)
+    end
+
+    # Ensure we use the json engine specified by the consumer
+    private def engine
+      Compensated.json_engine
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: compensated
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Zee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+description: Compensated makes handling transactions slightly less of a nightmare.
+email:
+- zee@zincma.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- compensated.gemspec
+- examples/compensated-rails-5/Gemfile
+- lib/compensated.rb
+- lib/compensated/payment_processor_event_request_handler.rb
+- lib/compensated/stripe.rb
+- lib/compensated/stripe/event_parser.rb
+- lib/compensated/stripe/version.rb
+- lib/compensated/version.rb
+homepage: https://github.com/zinc-technology/compensated
+licenses: []
+metadata:
+  homepage_uri: https://github.com/zinc-technology/compensated
+  source_code_uri: https://github.com/zinc-technology/compensated
+  changelog_uri: https://github.com/zinc-technology/compensated/primary/CHANGELOG.md
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provide value (In Ruby!). Get paid.
+test_files: []