paymentsjs-rails 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3889dd1072cc5e7b629af8e043c51033e23d281f
-  data.tar.gz: bbc3ed2a5792caee64575a8fceb6d7c6b2ecabbd
+  metadata.gz: 796d4c3a2a054b2f93c1bf04e985c67b84220706
+  data.tar.gz: 1bffe60b7cd17a2a4c025d2b99ac5521a4008c7d
 SHA512:
-  metadata.gz: c410e6b1b3bc4cc506cbbed6e0c6ca13dabe3643a8db44458c849c64aebc8fe23c4d4b117cfc15c0759693dff7ccefdfa84bc68ef149f016e3dc577137f1ca33
-  data.tar.gz: b73988b407681c24889b9a9f13884bccd976cf04913271625f12470ca590ca4d39cd7ca1eec4c1bc80d7ca9ed5673e96d775dd07639353119882a68f2be6dc41
+  metadata.gz: 565459b4b11c908244ce7f46d5aeaf690483a0c59b5b78eebe1e53bc16f5eef20e197181b298779d1a310adb93a92dfb48b615c033695cceb278c8076a2b2667
+  data.tar.gz: cb4e010bc3023dcf6d1f1d791b7ab810c7bdce7e8f6a4776c5727053132ce1211cca541491e82b5f8fd6c17039295a526e9bc330ebc7acd7838217b2b8e86663

data/README.md

@@ -1 +1,89 @@
-Coming soon
+# Sage PaymentsJS-Rails Gem
+
+The PaymentsJS-Rails gem simplifies the integration of Sage's PaymentsJS SDK by adding the PaymentsJs model and making configuring environmental variables easy.
+
+##Installation
+Add it to your Gemfile:
+```bash
+gem 'paymentsjs-rails'
+```
+	
+Use Bundler to install:
+```bash	
+bundle install
+```
+	
+And add the following file:
+```ruby
+config/initializers/paymentsjs-rails.rb
+```	
+Then, in your `app/assets/javascripts/application.js` file, add:
+```javascript
+//= require pay //this adds the pay.min.js file provided via Sage CDN
+```
+	
+Currently this gem is only intended for those using the PayJS(['PayJS/UI']) module. With time it will be extended to other modules. 
+
+##Quick Start
+
+Follow the [PaymentsJS GitHub Quick Start guide](https://github.com/SagePayments/PaymentsJS "PaymentsJS"), minus the 
+```html
+<script type="text/javascript" src="https://www.sagepayments.net/pay/1.0.0/js/pay.min.js"></script>
+```
+part.
+
+PaymentsJS requires several variables to be added to the `$UI.Initialize()` function in order to work. The Quick Start comes with several variables preloaded. We'll replace these with embedded ruby and the smae preloaded variables:
+
+```javascript
+PayJS(['PayJS/UI'], // the name of the module we want to use
+function($UI) { // assigning the module to a variable
+	$UI.Initialize({ // configuring the UI
+		apiKey: "<%= PaymentJs.api_key %>", // your developer ID
+		merchantId: "<%= PaymentJs.mid %>", // your 12-digit account identifier
+		authKey: "<%= PaymentJs.encrypt %>", // covered in the next section!
+		requestType: "<%= PaymentJs.request_type %>", // use can use "vault" to tokenize a card without charging it
+		requestId: "<%= PaymentJs.req_id %>", // an order number, customer or account identifier, etc.
+		amount: "<%= PaymentJs.amount %>", // the amount to charge the card. in test mode, different amounts produce different results.
+		elementId: "paymentButton", // the page element that will trigger the UI
+		nonce: "<%= PaymentJs.salt %>", // a unique identifier, used as salt
+		debug: true, // enables verbose console logging
+		preAuth: <%= PaymentJs.pre_auth %>, // run a Sale, rather than a PreAuth
+		environment: "<%= PaymentJs.environment %>" // hit the certification environment
+	});
+	$UI.setCallback(function(result) { // custom code that will execute when the UI receives a response
+		console.log(result.getResponse()); // log the result to the console
+		var wasApproved = result.getTransactionSuccess();
+		alert(wasApproved ? "ka-ching!" : "bummer");
+	});
+});
+```
+
+Reload the page and the payment system should work.
+
+##Configuring
+
+In your `config/initializers/paymentsjs-rails.rb` file, add this:
+```ruby
+PaymentsJs.configuration do |config|
+	config.mid          = "YOUR MERCHANT ID"
+	config.mkey         = "YOUR MERCHANT KEY"
+	config.api_key      = "YOUR API KEY"
+	config.api_secret   = "YOUR SECRET KEY"
+	config.postback_url = "YOUR POSTBACK URL"
+end
+```
+This will override the default variables.
+
+##Integration
+
+Integrating is easy and very variable. There are several values that will need to be dynamically set, and in a semi-order. Before you can call `PaymentsJs.encrypt` the following variables need to be set:
+```ruby
+PaymentsJs.amount       = "ORDER PRICE" #note, this needs to be a string, not a float/integer
+PaymentsJs.req_id       = "ORDER NUMBER" #if blank, "invoice(xx)" with xx being a random integer between 10 and 42 will be generated
+PaymentsJs.request_type = "ORDER REQUEST TYPE"
+PaymentsJs.pre_auth     = boolean
+PaymentsJs.environment  = "ORDER ENVIRONMENT"
+```
+The other variables are generated by encryption. 
+
+####NOTE: This gem is not yet finished and has not been extensively tested, be very careful using this gem until v.1.0 is released.

data/lib/paymentsjs-rails.rb

@@ -4,6 +4,10 @@ class PaymentsJs
 	require 'base64'
 	require 'json'
 	
+	module PaymentsJs
+  		require 'paymentsjs-rails/rails/engine'
+	end
+	
 	extend Configuration
 	
 	def self.generate_req_id
@@ -26,7 +30,6 @@ class PaymentsJs
 	define_setting :amount, "1.00"
 	define_setting :pre_auth, false
 	define_setting :environment, "cert"
-	define_setting :secret, "wtC5Ns0jbtiNA8sP"
 	define_setting :iv, PaymentsJs.iv
 	
 	def self.salt
@@ -50,7 +53,7 @@ class PaymentsJs
 		environment  = PaymentsJs.environment
 		secret       = PaymentsJs.secret
 		
-		req = {mid: mid, mkey: mkey, api_key: api_key, api_secret: api_secret, req_id: req_id, request_type: request_type, postback_url: postback_url, amount: amount, pre_auth: pre_auth, environment: environment, secret: secret }
+		req = {mid: mid, mkey: mkey, api_key: api_key, api_secret: api_secret, req_id: req_id, request_type: request_type, postback_url: postback_url, amount: amount, pre_auth: pre_auth, environment: environment }
 		
 		req
 	end
@@ -59,7 +62,7 @@ class PaymentsJs
 		cipher     = OpenSSL::Cipher::AES.new(256, :CBC)
 		cipher.encrypt
 		req        = PaymentsJs.req
-		secret     = PaymentsJs.secret
+		secret     = PaymentsJs.api_secret
 		data       = JSON.generate(req)
 		salt       = PaymentsJs.salt
 		key        = OpenSSL::PKCS5.pbkdf2_hmac_sha1(secret, salt, 1500, 32)

data/lib/paymentsjs-rails/rails/engine.rb

@@ -0,0 +1,7 @@
+module PaymentsJs
+  module Rails
+    class Engine < ::Rails::Engine
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paymentsjs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Joshua Bartlett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies: []
 description: A gem to simplify the encryption of data for the Sage PaymentsJS SDK
   for usage in Rails apps.
@@ -18,9 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/assets/javascripts/pay.js
 - lib/helpers/configuration.rb
 - lib/paymentsjs-rails.rb
-- vendor/assets/javascripts/pay.js
+- lib/paymentsjs-rails/rails/engine.rb
 homepage: http://rubygems.org/gems/paymentjs-rails
 licenses:
 - MIT