unlock_gateway 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 980ea43877bcb670bca3fd458f8ac2353db2295b
-  data.tar.gz: 70b880d149d425f0626c01c3cc09c619a2d8150a
+  metadata.gz: 1cb7317f716d9074645b160bbbb03c2ad4b35a6e
+  data.tar.gz: a4352f39986625f4148ddc8696bf007f8bae8956
 SHA512:
-  metadata.gz: 762907885a6b2577d1a92995270b7d8b9c569d3aeb15a14c71f9f7929ce7e5cac3f42245af2c6221026373966b57e58d8a328dfc8636861a71369a462f142604
-  data.tar.gz: 3f0f83ec2b34e87abb55e129e21fe3d461b77e6ef1ae75091e0b473bd3db9f981437e6208d50579f6dbfb2a0d165f95a2e3f59bc9dbd22a3fa237ca7ed3ccf4e
+  metadata.gz: cac357585717cc0a38b2122b5cee94222c9e1995ea1aa55e2b42a23becffc9f48bb6b6f2de7af92baab08fdfe75509080f313047f9dd3ee4e0a60562ee5efac2
+  data.tar.gz: bf90f5df27a2fa31a799bee3dbc98a248c0411f4fc059a4557678c05b4db24f1363d4f89843d23e750d4751579389a4ba36331029226c370af0a87912e9820a8

data/lib/unlock_gateway.rb

@@ -1,6 +1,24 @@
 require 'unlock_gateway/setting'
+require "unlock_gateway/controller"
 require "unlock_gateway/models/gateway"
 require "unlock_gateway/models/contribution"
 
 module UnlockGateway
+
+  # Registers the gateway with unlock's Gateway model
+  def self.register(module_name)
+    begin
+      Gateway.register module_name
+    rescue
+    end
+  end
+
+end
+
+class ActionController::Base
+  # Extends and includes UnlockGateway::Controller class and instance methods, preparing a controller to be an unlock gateway controller
+  def self.is_unlock_gateway
+    extend UnlockGateway::Controller::ClassMethods
+    include UnlockGateway::Controller
+  end
 end

data/lib/unlock_gateway/controller.rb

@@ -0,0 +1,114 @@
+module UnlockGateway
+
+  # This module will be extended (ClassMethods) and included by is_unlock_gateway on controllers
+  module Controller
+
+    module ClassMethods
+
+      # This will be executed first, to set the controller up. Then the instance methods will be included
+      def self.extended(base)
+        base.class_eval do
+
+          inherit_resources
+
+          actions :create, :edit
+          respond_to :html
+
+          after_action :verify_authorized
+          after_action :verify_policy_scoped, only: %i[]
+          before_action :authenticate_user!, only: %i[edit]
+
+        end
+      end
+
+    end
+
+    # A second step or final checkout should use this action
+    def edit
+      edit! { authorize resource }
+    end
+
+    # This action will be used when the user requests to activate/reactivate a contribution
+    def activate
+      respond_to do |format|
+        format.html { transition_state(:active) }
+      end
+    end
+    
+    # This action will be used when the user requests to suspend a contribution
+    def suspend
+      respond_to do |format|
+        format.html { transition_state(:suspended) }
+      end
+    end
+
+    private
+
+    # Creates the contribution, sets session[:gateway_id], returns true if successful and renders new action if not
+    def create_contribution
+
+      @initiative = Initiative.find(contribution_params[:initiative_id])
+      @gateways = @initiative.gateways.without_state(:draft).order(:ordering)
+      @contribution = @initiative.contributions.new(contribution_params)
+      @contribution.gateway_state = @contribution.gateway.state
+      current_user.update module_name: @contribution.gateway.module_name
+      authorize @contribution
+
+      if @contribution.save
+        true
+      else
+        render '/initiatives/contributions/new'
+        false
+      end
+
+    end
+
+    # This method authorizes the resource, checks if the contribution can be transitioned to the desired state, calls Contribution#update_state_on_gateway!, transition the contribution's state, and return the proper JSON for Unlock's AJAX calls
+    def transition_state(state)
+      authorize resource
+      @initiative = resource.initiative
+      @user = resource.user
+      state = state.to_sym
+      transition = resource.transition_by_state(state)
+      initial_state = resource.state_name
+      if resource.send("can_#{transition}?")
+        begin
+          if resource.state_on_gateway != state
+            if resource.update_state_on_gateway!(state)
+              resource.send("#{transition}!")
+            else
+              flash[:failure] = "Não foi possível alterar o status de seu apoio."
+            end
+          else
+            resource.send("#{transition}!")
+          end
+        rescue
+          flash[:failure] = "Ooops, ocorreu um erro ao alterar o status de seu apoio."
+        end
+      else
+        flash[:failure] = "Não foi permitido alterar o status deste apoio."
+      end
+      if flash[:failure].present?
+        render 'initiatives/contributions/show'
+      else
+        if initial_state == :pending
+          flash[:success] = "Apoio realizado com sucesso!"
+        else
+          flash[:success] = "Status do apoio alterado com sucesso!"
+        end
+        redirect_to initiative_contribution_path(resource.initiative.id, resource)
+      end
+    end
+
+    # Strong parameters for Contribution. This duplication is due to a inherited_resources problem that requires both
+    def permitted_params
+      params.permit(contribution: policy(@contribution || Contribution.new).permitted_attributes)
+    end
+
+    # Strong parameters for Contribution    
+    def contribution_params
+      params.require(:contribution).permit(*policy(@contribution || Contribution.new).permitted_attributes)
+    end
+
+  end
+end

data/lib/unlock_gateway/models/contribution.rb

@@ -4,8 +4,36 @@ module UnlockGateway
     # Your module UnlockMyGatewayName::Models::Contribution, that should implement this interface, will be included in Unlock's Contribution model. All methods will run in the context of an instance of Contribution model.
     module Contribution
 
-      # This method should implement a way to check the state of the subscription with the gateway and update the contribution's state according to it's real state within the gateway.
+      # This method should return the unique identifier of the contribution on the gateway
+      def gateway_identifier
+      end
+
+      # This method should return the actual state of a contribution on the gateway, with name according to Contribution's state machine, as a Symbol.
+      def state_on_gateway
+      end
+
+      # This method should change the state of a contribution on the gateway, according to the new desired state.
+      def update_state_on_gateway!(state)
+      end
+
+      # Updates the contribution's state according to it's actual state within the gateway, based on each gateway's implementation of state_on_gateway.
       def update_state_from_gateway!
+        return unless gateway_state = self.state_on_gateway
+        if self.state_name != gateway_state
+          transition = self.transition_by_state(gateway_state)
+          self.send("#{transition}!") if self.send("can_#{transition}?")
+        end
+      end
+
+      # Helper method to find transition name by the desired new state name
+      def transition_by_state(state)
+        state = state.try(:to_sym)
+        case state
+          when :active
+            :activate
+          when :suspended
+            :suspend
+        end
       end
 
     end

data/lib/unlock_gateway/models/gateway.rb

@@ -17,6 +17,10 @@ module UnlockGateway
       def image
       end
 
+      # This method should return the gateways institutional website URL, to which Unlock will refer users.
+      def url
+      end
+
       # This method should return the path for the routes generated by the gateway, such as '/my_gateway'.
       def path
       end

data/lib/unlock_gateway/version.rb

@@ -1,3 +1,3 @@
 module UnlockGateway
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unlock_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.6
-description: Abstract gateway for Unlock's payment gateway integrations
+description: Base gateway for Unlock's payment gateway integrations
 email:
 - danielweinmann@gmail.com
 executables: []
@@ -35,6 +35,7 @@ files:
 - Rakefile
 - lib/tasks/unlock_gateway_tasks.rake
 - lib/unlock_gateway.rb
+- lib/unlock_gateway/controller.rb
 - lib/unlock_gateway/models/contribution.rb
 - lib/unlock_gateway/models/gateway.rb
 - lib/unlock_gateway/setting.rb
@@ -62,5 +63,5 @@ rubyforge_project:
 rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: Abstract gateway for Unlock's payment gateway integrations
+summary: Base gateway for Unlock's payment gateway integrations
 test_files: []