simple_recurring 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecb0437091aaba530f0478afd59a7cbe2bd61ee1
+  data.tar.gz: 3ca37f15e666411b773a49846041a9e96f0c11c3
+SHA512:
+  metadata.gz: 61021dd1163925347fe9696f03d1f8cf70dd8768565d1477ce9016ebb09b829d8ca18f0fd34589379be896e32a2dbe86b7c91173875756c5b94e58ff28086fa4
+  data.tar.gz: 293ecdb586aa47bf131ea41fde634a24fe8f2a17cee52ef3e1122b7d63da39186f0c2e6f88036571a8a9061633e5eaf58d7b645cabcab171fce9d7e5e1819d16

data/README.md

@@ -0,0 +1,64 @@
+# SimpleRecurring
+
+## Overview
+A uniform and simple way to create recurring payments with supported providers.
+
+## Installation
+Add the gem to your Gemfile.
+```
+gem 'SimpleRecurring'
+```
+
+Install any payment gateway adapter gems by following instructions in their README.
+
+## Usage
+Get a list of available adapters (including display name and version, for use in an admin panel or similar):
+```
+SimpleRecurring.adapters
+```
+
+Get the adapter class:
+```
+SimpleRecurring.adapter('adaptername')
+```
+
+Get an instance of the adapter:
+```
+SimpleRecurring.adapter('adaptername').new
+```
+
+Create a subscription:
+```
+# Create a credit card with a test number that expires Jan 2020 and has 123 as it's CVC.
+# CVC is optional when using a card number (although, certain providers may require it).
+credit_card = SimpleRecurring::CreditCard.new('4111111111111111', 1, 2020, 123)
+# For providers that support tokens you can also pass in the token as the first parameter.
+# Only the first parameter should be set when using a token.
+# e.g.
+# credit_card = SimpleRecurring::CreditCard.new('123abc_token_string123')
+
+# Create a representation of the subscription.
+subscription = SimpleRecurring::Subscription.new
+# Set the billing frequency.
+subscription.billing_frequency = :monthly # :daily, :weekly, :monthly or :annually
+# Set the number of billing periods.
+subscription.billing_periods_count = 6 # Length in billing periods, nil or 0 for indefinite
+
+# Get an instance of the adapter.
+adapter = SimpleRecurring.adapter('adaptername').new
+
+# Create the subscription and get a string or integer back to reference it by in the future.
+subscription_reference = adapter.create_subscription(credit_card, subscription)
+```
+
+Canceling a subscription:
+```
+# Subscription reference was returned from create_subscription and should have been stored.
+subscription_reference = '123abc'
+
+# Get an instance of the adapter.
+adapter = SimpleRecurring.adapter('adaptername').new
+
+# Cancel the subscription. Returns true or false for success / failure.
+adapter.create_subscription(subscription_reference)
+```

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/models/simple_recurring/credit_card.rb

@@ -0,0 +1,36 @@
+module SimpleRecurring
+  class CreditCard
+    # String card_number - Credit Card Number
+    # Integer card_expiry_month - Credit Card Expiry Month (1 = January, 12 = December)
+    # Integer card_expiry_year - Credit Card Expiry Year (Full 4 digits, e.g. 2019)
+    # Integer card_cvc - Credit Card Verification Code
+    # String card_token - Token from the provider identifying the credit card.
+    attr_reader :card_number, :card_expiry_month, :card_expiry_year, :card_cvc, :card_token
+
+    # Create a CreditCard object based on a token or card number.
+    #
+    # Params:
+    # String|Integer card_number_or_token
+    # Integer card_expiry_month
+    # Integer card_expiry_year
+    # Integer card_cvc
+    def initialize(card_number_or_token, card_expiry_month = nil, card_expiry_year = nil, card_cvc = nil)
+      if card_expiry_month == nil
+        @card_token = card_number_or_token
+      else
+        @card_number = card_number_or_token
+        @card_expiry_month = card_expiry_month
+        @card_expiry_year = card_expiry_year
+        @card_cvc = card_cvc
+      end
+    end
+
+    # Checks if this CreditCard object uses a token representing the card number on the provider side.
+    #
+    # Returns:
+    # TRUE if a token is used, FALSE if not.
+    def is_token?
+      !@card_token.nil?
+    end
+  end
+end

data/app/models/simple_recurring/promotions.rb

@@ -0,0 +1,8 @@
+module SimpleRecurring
+  class Promotions
+    # Integer trial_period - Trial period in days.
+    # Integer discount_amount - Discount amount as an integer (e.g. 100 = $1.00)
+    # Integer discount_billing_periods - The number of billing periods the discount should apply to, or 0 for indefinite.
+    attr_accessor :trial_period, :discount_amount, :discount_billing_periods
+  end
+end

data/app/models/simple_recurring/subscription.rb

@@ -0,0 +1,8 @@
+module SimpleRecurring
+  class Subscription
+    # Symbol billing_frequency - Symbol representing billing frequency, :daily, :weekly, :monthly, :annually
+    # Integer billing_periods_count - Length in billing periods, 0 for indefinite
+    # Integer amount - Price as an integer (e.g. 100 - $1.00)
+    attr_accessor :billing_frequency, :billing_periods_count
+  end
+end

data/lib/simple_recurring.rb

@@ -0,0 +1,47 @@
+require 'simple_recurring/engine'
+
+module SimpleRecurring
+  # Load adapter by name.
+  #
+  # Params:
+  # String adapter
+  #
+  # Returns:
+  # Implementation of SimpleRecurring::ProcessorAdapters::BaseAdapter
+  def self.adapter(adapter)
+    "SimpleRecurring::ProcessorAdapters::#{adapter.capitalize}".constantize
+  end
+
+  # Finds all adapters and versions.
+  # Warning: This is appropriate for use in an admin panel where the processor might be selected. It is NOT appropriate
+  # for use on user facing pages as it searches the file system for all available adapters and loads them.
+  #
+  # Returns:
+  # Hash of adapters with their display name and version.
+  def self.adapters
+    require_adapters
+    SimpleRecurring::ProcessorAdapters.constants.select { |c|
+      SimpleRecurring::ProcessorAdapters.const_get(c).is_a?(Class) &&
+          SimpleRecurring::ProcessorAdapters.const_get(c) != SimpleRecurring::ProcessorAdapters::BaseAdapter &&
+          SimpleRecurring::ProcessorAdapters.const_get(c).ancestors.include?(SimpleRecurring::ProcessorAdapters::BaseAdapter)
+    }.reduce({}) { |h, a| h[a] = { display_name: adapter(a).display_name, version: adapter(a).version }; h }
+  end
+
+  protected
+  # Search autoload paths in each engine for all available process adapters.
+  def self.require_adapters
+    autoload_paths = Rails.application.send(:_all_autoload_paths)
+    Rails::Engine.subclasses.map(&:instance).each do |engine|
+      autoload_paths << engine.send(:_all_autoload_paths)
+    end
+    autoload_paths.flatten!
+    adapter_files = []
+    autoload_paths.each do |p|
+      adapter_files << Dir["#{p}simple_recurring/processor_adapters/*.rb"]
+    end
+    adapter_files.flatten!
+    adapter_files.each do |f|
+      require f
+    end
+  end
+end

data/lib/simple_recurring/engine.rb

@@ -0,0 +1,5 @@
+module SimpleRecurring
+  class Engine < ::Rails::Engine
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+  end
+end

data/lib/simple_recurring/processor_adapters/base_adapter.rb

@@ -0,0 +1,45 @@
+module SimpleRecurring
+  module ProcessorAdapters
+    class BaseAdapter
+      # Create the subscription.
+      #
+      # Params:
+      # SimpleRecurring::CreditCard credit_card
+      # SimpleRecurring::Subscription subscription
+      # SimpleRecurring::Promotions promotions (optional)
+      #
+      # Returns:
+      # String|Integer Reference id or string for use in cancelling the subscription.
+      def create_subscription(credit_card, subscription, promotions = nil)
+        raise 'Invalid Provider'
+      end
+
+      # Cancel the subscription.
+      #
+      # Params:
+      # String|Integer Reference
+      #
+      # Returns:
+      # TRUE or FALSE determined by success
+      def cancel_subscription(reference)
+        raise 'Invalid Provider'
+      end
+
+      # Display name of the adapter / provider.
+      #
+      # Returns:
+      # String with the display name of the adapter / provider.
+      def self.display_name
+        raise 'Invalid Provider'
+      end
+
+      # Version of the adapter.
+      #
+      # Returns:
+      # String with version of the adapter.
+      def self.version
+        raise 'Invalid Provider'
+      end
+    end
+  end
+end

data/lib/simple_recurring/version.rb

@@ -0,0 +1,3 @@
+module SimpleRecurring
+  VERSION = '1.0.1'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: simple_recurring
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Matt Dunbar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email: matt@buildrx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/simple_recurring/credit_card.rb
+- app/models/simple_recurring/promotions.rb
+- app/models/simple_recurring/subscription.rb
+- lib/simple_recurring.rb
+- lib/simple_recurring/engine.rb
+- lib/simple_recurring/processor_adapters/base_adapter.rb
+- lib/simple_recurring/version.rb
+homepage: 
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A uniform and simple way to create recurring payments with supported providers.
+test_files: []