judopay 1.0.2.pre → 2.0.0

data/lib/judopay/model.rb

@@ -9,45 +9,73 @@ module Judopay
   class Model
     send :include, Virtus.model
     include ActiveModel::Validations
-    VALID_PAGING_OPTIONS = [:sort, :offset, :page_size]
+    VALID_PAGING_OPTIONS = [:sort, :offset, :page_size].freeze
 
     class << self
       @resource_path = nil
       @valid_api_methods = []
       attr_accessor :resource_path, :valid_api_methods
-    end
 
-    # List all records
-    #
-    # @param options [Hash] Paging options (sort, offset and page_size)
-    # @return [Judopay::Mash] Mash of the API response
-    def self.all(options = {})
-      check_api_method_is_supported(__method__)
-      api = Judopay::API.new
-      valid_options = self.valid_options(options).camel_case_keys!
-      uri = resource_path + '?' + valid_options.to_query_string
-      api.get(uri)
+      # List all records
+      #
+      # @param options [Hash] Paging options (sort, offset and page_size)
+      # @return [Judopay::Mash] Mash of the API response
+      def all(options = {})
+        check_api_method_is_supported(__method__)
+        api = Judopay::API.new
+        valid_options = self.valid_options(options).camel_case_keys!
+        uri = resource_path + '?' + valid_options.to_query_string
+        api.get(uri)
+      end
+
+      # Retrieve a specific record
+      #
+      # @param receipt_id [Integer] ID of particular transaction
+      # @return [Judopay::Mash] Mash of the API response
+      def find(receipt_id)
+        check_api_method_is_supported(__method__)
+        api = Judopay::API.new
+        api.get(resource_path + receipt_id.to_i.to_s)
+      end
+
+      # Check if the specified API method is supported by the current model
+      #
+      # @raise [Judopay::Error] if the API method is not supported
+      def check_api_method_is_supported(method)
+        raise Judopay::ValidationError, 'API method not supported' if valid_api_methods.nil? || !valid_api_methods.include?(method.to_sym)
+      end
+
+      # Take an paging options hash and filter all but the valid keys
+      def valid_options(options)
+        valid_options = {}
+        options.each do |key, value|
+          next unless VALID_PAGING_OPTIONS.include?(key)
+          valid_options[key] = value
+        end
+        valid_options
+      end
     end
 
-    # Retrieve a specific record
+    # Create a new record
     #
-    # @param receipt_id [Integer] Paging options (sort, offset and page_size)
     # @return [Judopay::Mash] Mash of the API response
-    def self.find(receipt_id)
+    def create
       check_api_method_is_supported(__method__)
+      check_judo_id
+      check_validation
       api = Judopay::API.new
-      api.get(resource_path + receipt_id.to_i.to_s)
+      api.post(resource_path, self)
     end
 
-    # Create a new record
+    # Validates a request
     #
     # @return [Judopay::Mash] Mash of the API response
-    def create
+    def validate
       check_api_method_is_supported(__method__)
       check_judo_id
       check_validation
       api = Judopay::API.new
-      api.post(resource_path, self)
+      api.post(resource_path + '/validate', self)
     end
 
     # Retrieve the current API resource path (e.g. /transactions/payments)
@@ -72,7 +100,7 @@ module Judopay
 
     # Use judo_id from configuration if it hasn't been explicitly set
     def check_judo_id
-      return unless self.respond_to?('judo_id') && judo_id.nil?
+      return unless respond_to?('judo_id') && judo_id.nil?
       self.judo_id = Judopay.configuration.judo_id
     end
 
@@ -84,26 +112,7 @@ module Judopay
     # @return nil
     # @raise [Judopay::ValidationError] if there are validation errors on the model
     def check_validation
-      fail Judopay::ValidationError, errors unless valid?
-    end
-
-    # Check if the specified API method is supported by the current model
-    #
-    # @raise [Judopay::Error] if the API method is not supported
-    def self.check_api_method_is_supported(method)
-      if valid_api_methods.nil? || !valid_api_methods.include?(method.to_sym)
-        fail Judopay::Error, 'API method not supported'
-      end
-    end
-
-    # Take an paging options hash and filter all but the valid keys
-    def self.valid_options(options)
-      valid_options = {}
-      options.each do |key, value|
-        next unless VALID_PAGING_OPTIONS.include?(key)
-        valid_options[key] = value
-      end
-      valid_options
+      raise Judopay::ValidationError.new('Missing required fields', errors) unless valid?
     end
   end
 end

data/lib/judopay/models/card_payment.rb

@@ -6,7 +6,7 @@ require_relative 'consumer_location'
 module Judopay
   class CardPayment < Model
     @resource_path = 'transactions/payments'
-    @valid_api_methods = [:create]
+    @valid_api_methods = [:create, :validate]
 
     attribute :your_consumer_reference, String # required
     attribute :your_payment_reference, String # required
@@ -15,11 +15,12 @@ module Judopay
     attribute :amount, Float # required
     attribute :card_number, String # required for card transactions
     attribute :expiry_date, String # required for card transactions
-    attribute :cv2, String  # required for card transactions
+    attribute :cv2, String # required for card transactions
     attribute :card_address, Judopay::CardAddress
     attribute :consumer_location, Judopay::ConsumerLocation
     attribute :mobile_number, String
     attribute :email_address, String
+    attribute :currency, String
 
     validates_presence_of :your_consumer_reference,
                           :your_payment_reference,
@@ -27,13 +28,7 @@ module Judopay
                           :amount,
                           :card_number,
                           :expiry_date,
-                          :cv2
-
-    def validate
-      check_judo_id
-      check_validation
-      api = Judopay::API.new
-      api.post(resource_path + '/validate', self)
-    end
+                          :cv2,
+                          :currency
   end
 end

data/lib/judopay/models/card_preauth.rb

@@ -7,6 +7,6 @@ module Judopay
   # Inherit from CardPayment - attributes are identical
   class CardPreauth < CardPayment
     @resource_path = 'transactions/preauths'
-    @valid_api_methods = [:create]
+    @valid_api_methods = [:create, :validate]
   end
 end

data/lib/judopay/models/collection.rb

@@ -3,7 +3,7 @@ require_relative '../model'
 module Judopay
   class Collection < Model
     @resource_path = 'transactions/collections'
-    @valid_api_methods = [:all, :create]
+    @valid_api_methods = [:all, :create, :validate]
 
     attribute :receipt_id, Integer
     attribute :amount, Float

data/lib/judopay/models/refund.rb

@@ -3,7 +3,7 @@ require_relative '../model'
 module Judopay
   class Refund < Model
     @resource_path = 'transactions/refunds'
-    @valid_api_methods = [:all, :create]
+    @valid_api_methods = [:all, :create, :validate]
 
     attribute :receipt_id, Integer
     attribute :amount, Float

data/lib/judopay/models/register_card.rb

@@ -0,0 +1,28 @@
+require_relative '../model'
+require_relative 'payment'
+require_relative 'card_address'
+require_relative 'consumer_location'
+
+module Judopay
+  class RegisterCard < Model
+    @resource_path = 'transactions/registercard'
+    @valid_api_methods = [:create]
+
+    attribute :your_consumer_reference, String
+    attribute :your_payment_reference, String
+    attribute :card_number, String
+    attribute :expiry_date, String
+    attribute :cv2, String
+    attribute :card_address, Judopay::CardAddress
+    attribute :amount, Float
+    attribute :currency, String
+    attribute :judo_id, String
+    attribute :your_payment_meta_data, Hash
+
+    validates_presence_of :your_consumer_reference,
+                          :your_payment_reference,
+                          :card_number,
+                          :expiry_date,
+                          :cv2
+  end
+end

data/lib/judopay/models/save_card.rb

@@ -0,0 +1,26 @@
+require_relative '../model'
+require_relative 'payment'
+require_relative 'card_address'
+require_relative 'consumer_location'
+
+module Judopay
+  class SaveCard < Model
+    @resource_path = 'transactions/savecard'
+    @valid_api_methods = [:create]
+
+    attribute :your_consumer_reference, String
+    attribute :judo_id, String
+    attribute :card_number, String
+    attribute :expiry_date, String
+    attribute :string_date, String
+    attribute :issue_number, String
+    attribute :cv2, String
+    attribute :card_address, Judopay::CardAddress
+    attribute :currency, String
+
+    validates_presence_of :your_consumer_reference,
+                          :card_number,
+                          :expiry_date,
+                          :cv2
+  end
+end

data/lib/judopay/models/token_payment.rb

@@ -19,6 +19,7 @@ module Judopay
     attribute :consumer_location, Judopay::ConsumerLocation
     attribute :mobile_number, String
     attribute :email_address, String
+    attribute :currency, String
 
     validates_presence_of :your_consumer_reference,
                           :your_payment_reference,

data/lib/judopay/models/void.rb

@@ -0,0 +1,19 @@
+require_relative '../model'
+
+module Judopay
+  class Void < Model
+    @resource_path = 'transactions/voids'
+    @valid_api_methods = [:create, :validate]
+
+    attribute :judo_id, String
+    attribute :receipt_id, Integer
+    attribute :amount, Float
+    attribute :your_payment_reference, String
+    attribute :your_payment_meta_data, Hash
+    attribute :currency, String
+
+    validates_presence_of :receipt_id,
+                          :amount,
+                          :judo_id
+  end
+end

data/lib/judopay/models/web_payments/payment.rb

@@ -1,4 +1,5 @@
 require_relative '../../model'
+require_relative 'web_payment_operation'
 
 module Judopay
   module WebPayments
@@ -14,6 +15,8 @@ module Judopay
       attribute :your_payment_meta_data, Hash
       attribute :client_ip_address, String
       attribute :client_user_agent, String
+      attribute :currency, String
+      attribute :web_payment_operation, Judopay::WebPayments::WebPaymentOperation
 
       validates_presence_of :judo_id,
                             :your_consumer_reference,

data/lib/judopay/models/web_payments/web_payment_operation.rb

@@ -0,0 +1,8 @@
+module Judopay
+  module WebPayments
+    module WebPaymentOperation
+      PAYMENT = 0
+      REGISTER = 1
+    end
+  end
+end

data/lib/judopay/request.rb

@@ -15,7 +15,7 @@ module Judopay
     end
 
     # Perform an HTTP PUT request
-    def put(path, options = {},  raw = false)
+    def put(path, options = {}, raw = false)
       request(:put, path, options, raw)
     end
 

data/lib/judopay/serializer.rb

@@ -19,11 +19,7 @@ module Judopay
         next if value.nil?
 
         # Is this a Virtus model object that we need to hashify?
-        if value.class.included_modules.include?(Virtus::Model::Core)
-          output_hash[key] = hashify(value)
-        else
-          output_hash[key] = value
-        end
+        output_hash[key] = value.class.included_modules.include?(Virtus::Model::Core) ? hashify(value) : value
       end
       output_hash
     end

data/lib/judopay/version.rb

@@ -1,3 +1,4 @@
 module Judopay
-  VERSION = '1.0.2.pre'
+  SDK_VERSION = '2.0.0'.freeze
+  API_VERSION = '5.2.0'.freeze
 end

data/spec/factories.rb

@@ -8,32 +8,39 @@ models = %w(
   web_payments/payment
   market/collection
   market/refund
+  save_card
+  register_card
+  void
 )
 models.each { |model| require_relative '../lib/judopay/models/' + model }
 
 FactoryGirl.define do
-  trait :valid_card_details do
+  trait :payment_details do
     your_consumer_reference 123
     your_payment_reference 456
-    judo_id '123-456'
     amount 1.01
+  end
+
+  trait :valid_card do
     card_number '4976000000003436'
-    expiry_date '12/15'
+    expiry_date '12/20'
     cv2 452
   end
 
+  trait :declined_card do
+    card_number '4221690000004963'
+    expiry_date '12/20'
+    cv2 125
+  end
+
   trait :valid_token_details do
-    your_consumer_reference '123'
-    your_payment_reference '456'
-    judo_id '123-456'
-    amount 1.01
     consumer_token '3UW4DV9wI0oKkMFS'
     card_token 'SXw4hnv1vJuEujQR'
-    cv2 '452'
+    cv2 452
   end
 
   trait :valid_judo_id do
-    judo_id '123-456'
+    judo_id '100435-197'
   end
 
   trait :valid_collection_or_refund_details do
@@ -48,13 +55,27 @@ FactoryGirl.define do
   end
 
   factory :card_payment, :class => Judopay::CardPayment do
-    valid_card_details
+    payment_details
     valid_judo_id
+    valid_card
+    currency 'GBP'
+
+    trait :declined do
+      card_number '4221690000004963'
+      cv2 125
+    end
   end
 
   factory :card_preauth, :class => Judopay::CardPreauth do
-    valid_card_details
+    payment_details
+    valid_card
     valid_judo_id
+    currency 'GBP'
+
+    trait :declined do
+      card_number '4221690000004963'
+      cv2 125
+    end
   end
 
   factory :collection, :class => Judopay::Collection do
@@ -66,31 +87,33 @@ FactoryGirl.define do
   end
 
   factory :token_payment, :class => Judopay::TokenPayment do
+    payment_details
     valid_token_details
     valid_judo_id
+    currency 'GBP'
   end
 
   factory :token_preauth, :class => Judopay::TokenPreauth do
+    payment_details
     valid_token_details
     valid_judo_id
+    currency 'GBP'
   end
 
   factory :web_payment, :class => Judopay::WebPayments::Payment do
     valid_judo_id
-    amount 12.34
-    partner_service_fee 1.00
-    your_payment_reference '123'
-    your_consumer_reference '456'
+    payment_details
     client_ip_address_and_user_agent
+
+    partner_service_fee 1.00
   end
 
   factory :web_preauth, :class => Judopay::WebPayments::Payment do
     valid_judo_id
-    amount 12.34
-    partner_service_fee 1.00
-    your_payment_reference '123'
-    your_consumer_reference '456'
+    payment_details
     client_ip_address_and_user_agent
+
+    partner_service_fee 1.00
   end
 
   factory :market_collection, :class => Judopay::Market::Collection do
@@ -100,4 +123,26 @@ FactoryGirl.define do
   factory :market_refund, :class => Judopay::Market::Refund do
     valid_collection_or_refund_details
   end
+
+  factory :save_card, :class => Judopay::SaveCard do
+    valid_card
+
+    your_consumer_reference 123
+  end
+
+  factory :register_card, :class => Judopay::RegisterCard do
+    payment_details
+    valid_card
+    valid_judo_id
+    currency 'GBP'
+
+    trait :declined do
+      card_number '4221690000004963'
+      cv2 125
+    end
+  end
+
+  factory :void, :class => Judopay::Void do
+    valid_collection_or_refund_details
+  end
 end