safecharge 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 731dce76f09887799382bc99ea323db3f8b4877d
-  data.tar.gz: 34341b413962e2d82b748aced85bd66d19e80915
+  metadata.gz: e16fac48537c2dc644f47d804971ff2d239934f2
+  data.tar.gz: 1a800151f2898ae5d67f5e53b0c271c905a278a6
 SHA512:
-  metadata.gz: 949e84937fd2143bf78a34c99b21f78e619ff67e6ad7841dea34908bddc7c694d87b1834e8a88a35a2b41cf0e667d266ba8cf093952a4c861969810582414406
-  data.tar.gz: 3e08c753bb07c7a0fd561f1ce0f929459a592b06243532b0d391d0b744d8fd4120e035f97232e5f891f74710ac3e4da1f6756e0ea6d484ad6ba6c8f39b0727b7
+  metadata.gz: a9ab27671b505cecc2009e3dcfc35d358f06399f5457f610fc8d920008010538e3a7462e5a541fa458ff7ae3b140889ee2838d8887c461bf224f1c16ea19b03c
+  data.tar.gz: a5528c5b61159db404acff2f829fc4b156b64161946a017130a14886d27cdfa7fd7e0d991b92d3e9d30531fe83f03f0e559df9cc9be7907e0013ad815aae4ccd

data/.idea/runConfigurations/safe_change_spec.xml

@@ -0,0 +1,35 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="safe_change_spec" type="RSpecRunConfigurationType" factoryName="RSpec">
+    <predefined_log_file id="RUBY_RSPEC" enabled="true" />
+    <module name="safecharge-api" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="WORK DIR" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SHOULD_USE_SDK" VALUE="false" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ALTERN_SDK_NAME" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="myPassParentEnvs" VALUE="true" />
+    <envs />
+    <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="true" />
+    <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
+    <EXTENSION ID="RubyCoverageRunConfigurationExtension" enabled="false" sample_coverage="true" track_test_folders="true" runner="rcov">
+      <COVERAGE_PATTERN ENABLED="true">
+        <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
+      </COVERAGE_PATTERN>
+    </EXTENSION>
+    <EXTENSION ID="org.jetbrains.plugins.ruby.motion.run.MotionSimulatorRunExtension" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="spec/safecharge_spec.rb" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="USE_CUSTOM_SPEC_RUNNER" VALUE="false" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="DRB" VALUE="false" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ZEUS" VALUE="false" />
+    <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
+    <RunnerSettings RunnerId="RubyRunner" />
+    <ConfigurationWrapper RunnerId="RubyRunner" />
+    <method />
+  </configuration>
+</component>

data/lib/safecharge.rb

@@ -145,4 +145,39 @@ module Safecharge
     end
   end
 
+  # module level method to get the redirection URL given some params.
+  # you must explicitly set the mode to 'live' to generate the production URL.
+  def self.sg_request_url(params = {}, mode = 'test')
+    result = nil
+    url = ''
+    case mode
+      when 'test'
+        url = Safecharge::Constants::SG_SERVER_TEST
+      when 'live'
+        url = Safecharge::Constants::SG_SERVER_LIVE
+      else
+        raise ArgumentError, "Invalid request mode #{mode}"
+    end
+
+    begin
+      request = Safecharge::SgRequest.new(url, params)
+      return request.full_url
+
+    rescue InternalException => e
+      puts "Caught Internal Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Internal server error. Please try again later."
+
+    rescue ValidationException => e
+      puts "Caught Validation Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Validation error: #{e.message} Fix your data and retry."
+
+    rescue SafechargeError => e
+      puts "Caught General Safecharge Error: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Undocumented Internal error: #{e.message}"
+    end
+  end
+
 end

data/lib/safecharge/constants.rb

@@ -4,18 +4,25 @@
 module Safecharge
   class Constants
     API_VERSION = '3.0.0'
+    SG_API_VERSION = '4.0.2'
 
     SERVER_TEST = ENV['SAFECHARGE_SERVER_TEST']                       # provided by SafeCharge
     SERVER_LIVE = ENV['SAFECHARGE_SERVER_LIVE']                       # provided by SafeCharge
-    
+
+    SG_SERVER_TEST = ENV['SAFECHARGE_SG_SERVER_TEST']                       # provided by SafeCharge
+    SG_SERVER_LIVE = ENV['SAFECHARGE_SG_SERVER_LIVE']                       # provided by SafeCharge
+    SG_RESPONSE_FORMAT = 4                                                  # XML
+    SG_DEFAULT_CREDIT_TYPE = 1                                              # Regular Credit
+
     SECRET_KEY = ENV['SAFECHARGE_SECRET_KEY']                         # provided by SafeCharge
     MERCHANT_ID =  ENV['SAFECHARGE_MERCHANT_ID'].to_i                 # provided by SafeCharge
     MERCHANT_SITE_ID = ENV['SAFECHARGE_MERCHANT_SITE_ID'].to_i        # provided by SafeCharge
     MERCHANT_3D_SITE_ID = ENV['SAFECHARGE_MERCHANT_3D_SITE_ID'].to_i  # provided by SafeCharge
-    
+
+    SG_CLIENT_LOGIN_ID = ENV['SAFECHARGE_SG_CLIENT_LOGIN_ID']         # provided by SafeCharge
     SG_CLIENT_PASSWORD = ENV['SAFECHARGE_SG_CLIENT_PASSWORD']         # provided by SafeCharge
     SG_3D_CLIENT_PASSWORD = ENV['SAFECHARGE_SG_3D_CLIENT_PASSWORD']   # provided by SafeCharge
-    
+
     CPANEL_PASSWORD = ENV['SAFECHARGE_CPANEL_PASSWORD']               # provided by SafeCharge
 
     APPROVED = 'APPROVED'

data/lib/safecharge/request.rb

@@ -143,6 +143,8 @@ module Safecharge
                 correct_type = p.is_a?(String) && ['true', 'false'].include?(p)
               when 'usertoken'
                 correct_type = p.is_a?(String) && ['register', 'auto'].include?(p)
+              when 'sgtranstype'
+                correct_type = p.is_a?(String) && ['Sale', 'Auth', 'Settle', 'Credit', 'AVSOnly', 'Void', 'Auth3D'].include?(p)
               when 'string'
                 correct_type = p.is_a? String
                 raise ValidationException, sprintf("Value '%s' in field '%s' is too long.", p, name) if p.size > meta[:length]

data/lib/safecharge/sg_request.rb

@@ -0,0 +1,66 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "safecharge"
+require "safecharge/constants"
+
+module Safecharge
+  class SgRequest < Request
+
+    ALLOWED_FIELDS = {
+      'sg_NameOnCard' => {:required => true, :type => 'string', length: 70},
+      'sg_CardNumber' => {:required => false, :type => 'string', length: 20},
+      'sg_ExpMonth' => {:required => true, :type => 'string', length: 2},
+      'sg_ExpYear' => {:required => true, :type => 'string', length: 2},
+      'sg_TransType' => {:required => true, :type => 'sgtranstype'},
+      'sg_Currency' => {:required => true, :type => 'currency_code'},
+      'sg_Amount' => {:required => true, :type => 'currency'},
+      'sg_AuthCode' => {:required => false, :type => 'string', length: 10},
+      'sg_ClientLoginID' => {:required => true, :type => 'string', length: 24},
+      'sg_ClientPassword' => {:required => true, :type => 'string', length: 24},
+      'sg_ClientUniqueID' => {:required => false, :type => 'string', length: 64},
+      'sg_TransactionID' => {:required => false, :type => 'string', length: 32},
+      'sg_CreditType' => {:required => true, :type => 'int'},
+      'sg_ResponseFormat' => {:required => true, :type => 'int'},
+      'sg_Version' => {:required => false, :type => 'string', length: 5},
+      'sg_FirstName' => {:required => true, :type => 'string', length: 30},
+      'sg_LastName' => {:required => true, :type => 'string', length: 40},
+      'sg_Address' => {:required => true, :type => 'string', length: 60},
+      'sg_City' => {:required => true, :type => 'string', length: 30},
+      'sg_State' => {:required => false, :type => 'string', length: 30},
+      'sg_Zip' => {:required => true, :type => 'string', length: 10}, # post code
+      'sg_Country' => {:required => true, :type => 'string', length: 3}, # ISO Code
+      'sg_Phone' => {:required => true, :type => 'string', length: 18},
+      'sg_IPAddress' => {:required => true, :type => 'string', length: 15},
+      'sg_Email' => {:required => true, :type => 'string', length: 100},
+      'sg_CCToken' => {:required => false, :type => 'string', length: 150}
+
+    }
+
+    DEFAULT_PARAMS = {
+      'sg_ClientLoginID' => Safecharge::Constants::SG_CLIENT_LOGIN_ID,
+      'sg_ClientPassword' => Safecharge::Constants::SG_CLIENT_PASSWORD,
+      'sg_Currency' => Safecharge::Constants::DEFAULT_CURRENCY_CODE,
+      'sg_CreditType' => Safecharge::Constants::SG_DEFAULT_CREDIT_TYPE,
+      'sg_Version' => Safecharge::Constants::SG_API_VERSION,
+      'sg_ResponseFormat' => Safecharge::Constants::SG_RESPONSE_FORMAT
+    }
+
+    def initialize(a_url, some_params = {})
+      raise ArgumentError, "missing url" if a_url == nil || a_url.empty?
+      if a_url === Safecharge::Constants::SG_SERVER_TEST
+        self.mode = 'test'
+      elsif a_url === Safecharge::Constants::SG_SERVER_LIVE
+        self.mode = 'live'
+      else
+        raise ArgumentError, "invalid url #{a_url}"
+      end
+      self.url = a_url
+      self.full_url = a_url
+      self.params = DEFAULT_PARAMS.merge(convert_symbols_to_strings(some_params))
+      self.validate_parameters(self.params)
+      self.construct_url
+    end
+
+  end
+end

data/lib/safecharge/version.rb

@@ -2,5 +2,5 @@
 #coding: utf-8
 
 module Safecharge
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safecharge
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Dave Sag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .idea/runConfigurations/safe_change_spec.xml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,6 +82,7 @@ files:
 - lib/safecharge/dmn.rb
 - lib/safecharge/request.rb
 - lib/safecharge/response.rb
+- lib/safecharge/sg_request.rb
 - lib/safecharge/version.rb
 - lib/safecharge/wc_request.rb
 - safecharge.gemspec