magnetik 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35a46c9a2d11334ebca571e3fe836d3d8bf656a8
+  data.tar.gz: 350300551b7c0ee49b9c408efaf1f14112cb401d
+SHA512:
+  metadata.gz: 56d4e8c1739fe928d6db5f4b401665d484e132804b050a819cede53ed4ae09de8e473f82331c33a71fc58f000759f456b8cc04adfc583c013b142554d9946d77
+  data.tar.gz: 5f919801c65fedf55aee44084ae326859714656ff750adb51085e9f3ae353d3ec1cb06ff90138705734987639357f548104c6491a86347b8715319bc1398baae

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Anton Ivanopoulos
+
+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/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+  require 'appraisal'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/javascripts/magnetik/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/magnetik/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/magnetik/application_controller.rb

@@ -0,0 +1,4 @@
+module Magnetik
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/magnetik/credit_cards_controller.rb

@@ -0,0 +1,74 @@
+require_dependency "magnetik/application_controller"
+
+module Magnetik
+  class CreditCardsController < ApplicationController
+    before_filter :authenticate!
+
+    respond_to :json
+
+    def index
+      render json: { credit_cards: collection }
+    end
+
+    def create
+      @token = create_params[:token]
+      @use_case = CreateCreditCard.perform(user, @token)
+
+      if @use_case.success?
+        render json: { credit_card: @use_case.local_card }, status: :ok
+      else
+        render json: { errors: @use_case.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      @credit_card = CreditCard.find(params[:id])
+      @use_case = UpdateCreditCard.perform(@credit_card, update_params)
+
+      if @use_case.success?
+        render json: { credit_card: @credit_card }, status: :ok
+      else
+        render json: { errors: @use_case.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @credit_card = CreditCard.find(params[:id])
+      @use_case = DestroyCreditCard.perform(@credit_card)
+
+      if @use_case.success?
+        render nothing: true, status: :no_content
+      else
+        render json: { errors: @use_case.errors }, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def authenticate!
+      method(Magnetik.authentication_method).call
+    end
+
+    def user
+      @user ||= method(Magnetik.current_user_method).call
+    end
+
+    def collection
+      @credit_cards ||= user.credit_cards.limit(30)
+    end
+
+    def create_params
+      params.require(:credit_card).permit(
+        :token
+      )
+    end
+
+    def update_params
+      params.require(:credit_card).permit(
+        :exp_month,
+        :exp_year,
+        :is_default
+      )
+    end
+  end
+end

data/app/helpers/magnetik/application_helper.rb

@@ -0,0 +1,4 @@
+module Magnetik
+  module ApplicationHelper
+  end
+end

data/app/models/magnetik/credit_card.rb

@@ -0,0 +1,15 @@
+module Magnetik
+  class CreditCard < ActiveRecord::Base
+    # Associations:
+    belongs_to :customer, polymorphic: true
+
+    # Validations:
+    validates :customer_id, presence: true
+    validates :customer_type, presence: true
+    validates :stripe_card_id, presence: true
+    validates :last_4_digits, presence: true
+    validates :exp_month, presence: true
+    validates :exp_year, presence: true
+    validates :brand, presence: true
+  end
+end

data/app/use_cases/magnetik/create_credit_card.rb

@@ -0,0 +1,69 @@
+module Magnetik
+  class CreateCreditCard
+    include UseCase
+
+    attr_reader :local_card
+
+    def initialize(user, token)
+      @token    = token
+      @user     = user
+      @remote_customer = nil
+    end
+
+    def perform
+      if @user.has_customer?
+        fetch_customer
+      else
+        create_remote_customer
+        create_local_customer
+      end
+
+      if @remote_customer && create_remote_card
+        create_local_card
+      end
+    end
+
+    private
+
+    attr_reader :remote_customer, :remote_card
+
+    def fetch_customer
+      @remote_customer = Stripe::Customer.retrieve(@user.stripe_customer_id)
+    end
+
+    def create_remote_customer
+      @remote_customer = Stripe::Customer.create({
+        description: "Stuff"
+      })
+    end
+
+    def create_local_customer
+      @user.update_attributes(stripe_customer_id: remote_customer.id).tap do |success|
+        errors.add(:base, "User failed to save") unless success
+      end
+    end
+
+    def create_remote_card
+      @remote_card = remote_customer.sources.create(source: @token)
+    rescue Stripe::CardError => e
+      errors.add(:base, "Credit card failed to save")
+      return false
+    end
+
+    def create_local_card
+      @local_card = CreditCard.new({
+        customer: @user,
+        stripe_card_id: remote_card[:id],
+        last_4_digits: remote_card[:last4],
+        exp_month: remote_card[:exp_month],
+        exp_year: remote_card[:exp_year],
+        brand: remote_card[:brand]
+      })
+
+      @local_card.save.tap do |success|
+        errors.add(:base, "Credit card failed to save") unless success
+      end
+    end
+
+  end
+end

data/app/use_cases/magnetik/destroy_credit_card.rb

@@ -0,0 +1,41 @@
+module Magnetik
+  class DestroyCreditCard
+    include UseCase
+
+    def initialize(card)
+      @card       = card
+    end
+
+    def perform
+      if fetch_customer && fetch_card
+        if destroy_local_card
+          destroy_remote_card
+        end
+      end
+    end
+
+    private
+
+    attr_reader :remote_customer, :remote_card
+
+    def fetch_customer
+      @remote_customer = Stripe::Customer.retrieve(@card.customer.stripe_customer_id)
+    end
+
+    def fetch_card
+      @remote_card = remote_customer.sources.retrieve(@card.stripe_card_id)
+    end
+
+    def destroy_local_card
+      @card.destroy.tap do |success|
+        errors.add(:base, "Credit card failed to delete") unless success
+      end
+    end
+
+    def destroy_remote_card
+      remote_card.delete.tap do |success|
+        errors.add(:base, "Credit card failed to delete") unless success
+      end
+    end
+  end
+end

data/app/use_cases/magnetik/update_credit_card.rb

@@ -0,0 +1,48 @@
+module Magnetik
+  class UpdateCreditCard
+    include UseCase
+
+    attr_reader :local_card
+
+    def initialize(card, params)
+      @card       = card
+      @params     = params
+    end
+
+    def perform
+      if fetch_customer && fetch_card
+        if update_remote_card
+          update_local_card
+        end
+      end
+    end
+
+    private
+
+    attr_reader :remote_customer, :remote_card
+
+    def fetch_customer
+      @remote_customer = Stripe::Customer.retrieve(@card.customer.stripe_customer_id)
+    end
+
+    def fetch_card
+      @remote_card = @remote_customer.sources.retrieve(@card.stripe_card_id)
+    end
+
+    def update_remote_card
+      remote_card.exp_month = @params[:exp_month]
+      remote_card.exp_year  = @params[:exp_year]
+      remote_card.save.tap do |success|
+        errors.add(:base, "Credit card failed to save") unless success
+      end
+    rescue Stripe::CardError => e
+      errors.add(:base, "Credit card failed to save")
+    end
+
+    def update_local_card
+      @card.update_attributes(@params).tap do |success|
+        errors.add(:base, "Credit card failed to save") unless success
+      end
+    end
+  end
+end

data/app/use_cases/use_case.rb

@@ -0,0 +1,21 @@
+module UseCase
+  extend ActiveSupport::Concern
+  include ActiveModel::Validations
+
+  module ClassMethods
+    # The perform method of a UseCase should always return itself
+    def perform(*args)
+      new(*args).tap { |use_case| use_case.perform }
+    end
+  end
+
+  # implement all the steps required to complete this use case
+  def perform
+    raise NotImplementedError
+  end
+
+  # inside of perform, add errors if the use case did not succeed
+  def success?
+    errors.none?
+  end
+end

data/app/views/layouts/magnetik/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Magnetik</title>
+  <%= stylesheet_link_tag    "magnetik/application", media: "all" %>
+  <%= javascript_include_tag "magnetik/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Magnetik::Engine.routes.draw do
+  resources :credit_cards
+end

data/lib/generators/active_record/magnetik_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class MagnetikGenerator < ActiveRecord::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_migrations
+        if (behavior == :invoke && model_exists?)
+          migration_template 'migration_customers.rb', "db/migrate/make_#{table_name}_magnetik_customers.rb"
+          migration_template 'migration_credit_cards.rb', 'db/migrate/magnetik_create_credit_cards.rb'
+        end
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), '%.14d' % next_migration_number].max
+        else
+          '%.3d' % next_migration_number
+        end
+      end
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_credit_cards.rb

@@ -0,0 +1,17 @@
+class MagnetikCreateCreditCards < ActiveRecord::Migration
+  def change
+    create_table :magnetik_credit_cards do |t|
+      t.string  :stripe_card_id
+      t.string  :last_4_digits
+      t.string  :exp_month
+      t.string  :exp_year
+      t.string  :brand
+      t.boolean :is_default
+      t.integer :customer_id
+      t.string  :customer_type
+      t.index   [:customer_id, :customer_id]
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_customers.rb

@@ -0,0 +1,7 @@
+class Make<%= table_name.camelize %>MagnetikCustomers < ActiveRecord::Migration
+  def change
+    change_table :<%= table_name %> do |t|
+      t.string  :stripe_customer_id
+    end
+  end
+end

data/lib/generators/magnetik/install/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+module Magnetik
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/magnetik.rb'
+      end
+    end
+  end
+end

data/lib/generators/magnetik/install/templates/initializer.rb

@@ -0,0 +1,7 @@
+Magnetik.setup do |config|
+  # Magnetik will call this within CreditCardsController to ensure the user is authenticated.
+  config.authentication_method = :authenticate_user!
+
+  # Magnetik will call this within CreditCardsController to return the current logged in user.
+  config.current_user_method = :current_user
+end

data/lib/generators/magnetik/magnetik_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/named_base'
+
+module Magnetik
+  module Generators
+    class MagnetikGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "magnetik"
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Generates a credit card model (if it doesn't already exist) plus " <<
+           "a migration convert the model with the given NAME to a magnetik "  <<
+           "customer by adding in the stripe_customer_id field."
+
+      hook_for :orm
+    end
+  end
+end

data/lib/magnetik.rb

@@ -0,0 +1,29 @@
+require 'magnetik/engine'
+require 'responders'
+
+module Magnetik
+  extend ActiveSupport::Autoload
+
+  autoload :ActsAsMagnetikCustomer, 'magnetik/acts_as_magnetik_customer'
+
+  # Method to authenticate a user:
+  mattr_accessor :authentication_method
+  @@authentication_method = nil
+
+  # Method to retrieve the current authenticated user:
+  mattr_accessor :current_user_method
+  @@current_user_method = nil
+
+  private
+
+  # Default way to setup Magnetik:
+  def self.setup
+    yield self
+  end
+end
+
+module ActiveRecord
+  class Base
+    include Magnetik::ActsAsMagnetikCustomer
+  end
+end

data/lib/magnetik/acts_as_magnetik_customer.rb

@@ -0,0 +1,22 @@
+module Magnetik
+  module ActsAsMagnetikCustomer
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_magnetik_customer(_options = {})
+        include Magnetik::ActsAsMagnetikCustomer::LocalInstanceMethods
+
+        has_many :credit_cards, as: :customer, class_name: 'Magnetik::CreditCard'
+      end
+    end
+
+    module LocalInstanceMethods
+      def has_customer?
+        stripe_customer_id.present?
+      end
+    end
+  end
+end

data/lib/magnetik/engine.rb

@@ -0,0 +1,12 @@
+module Magnetik
+  class Engine < ::Rails::Engine
+    isolate_namespace Magnetik
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/magnetik/version.rb

@@ -0,0 +1,3 @@
+module Magnetik
+  VERSION = "0.0.1"
+end

data/lib/tasks/magnetik_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :magnetik do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: magnetik
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Ivanopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: factory_girl_rails
+  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: pry
+  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: appraisal
+  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.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Magnetik is a mountable rails engine that allows a model to be turned
+  into a vessel for a Stripe customer, as well as providing routes for credit card
+  management via Stripe, including creating, updating and deleting credit cards.
+email:
+- ai@papercloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/magnetik/application.js
+- app/assets/stylesheets/magnetik/application.css
+- app/controllers/magnetik/application_controller.rb
+- app/controllers/magnetik/credit_cards_controller.rb
+- app/helpers/magnetik/application_helper.rb
+- app/models/magnetik/credit_card.rb
+- app/use_cases/magnetik/create_credit_card.rb
+- app/use_cases/magnetik/destroy_credit_card.rb
+- app/use_cases/magnetik/update_credit_card.rb
+- app/use_cases/use_case.rb
+- app/views/layouts/magnetik/application.html.erb
+- config/routes.rb
+- lib/generators/active_record/magnetik_generator.rb
+- lib/generators/active_record/templates/migration_credit_cards.rb
+- lib/generators/active_record/templates/migration_customers.rb
+- lib/generators/magnetik/install/install_generator.rb
+- lib/generators/magnetik/install/templates/initializer.rb
+- lib/generators/magnetik/magnetik_generator.rb
+- lib/magnetik.rb
+- lib/magnetik/acts_as_magnetik_customer.rb
+- lib/magnetik/engine.rb
+- lib/magnetik/version.rb
+- lib/tasks/magnetik_tasks.rake
+homepage: http://www.papercloud.com.au
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rails engine for credit card management via Stripe.
+test_files: []