paymentsjs-rails 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58093a5d42fc9719d526070986a566278d06d341
-  data.tar.gz: 250d8086e14b7587ba637560381ded53de03ba8a
+  metadata.gz: 20b2a489e2799321e472e847081d23691d3de31b
+  data.tar.gz: 4303f77fb38b6f98a6de33fc501d492240fe4371
 SHA512:
-  metadata.gz: 2b824101f01a2cbadf1adefce2dd4a6ce36240ff89b1d667ae803395e1b89be7516ef91bb2245782e3822ceadfa872f5d29c26cbf55f90aa2b4561e059ad96bf
-  data.tar.gz: 7d50c58c307bc5f222e00377d9a243f52d8979b27ed67ff347d5f46061bf8bf1db7d1e3f552665efb082bb9430e627fe3f84667e352a756ac4bf87c2bf41efad
+  metadata.gz: 92b479fcdbec707eb479b86e1a9146199e82dc1f8fcb26228a71e5b05cc3423a36fcbec6e35baaabcd79e5d5244794a419cbeba6dda0df6955117449e0f6f888
+  data.tar.gz: e6b592b12dc855670655d5557da2d5402e6be45bc0a8d36dd677e62831d579805138efd5c614f741b007a2081989b4ab7af0893eeb3318ad15f15eb4fb9f4672

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Joshua Bartlett
+
+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/README.md

@@ -1,13 +1,11 @@
 # Sage PaymentsJS-Rails Gem
 
-####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.
-
-The PaymentsJS-Rails gem simplifies the integration of Sage's PaymentsJS SDK by adding the PaymentsJs model and making configuring environmental variables easy.
+The PaymentsJS-Rails gem simplifies the integration of Sage's PaymentsJS SDK by adding the PaymentsJs class and making configuring environmental variables easy.
 
 ##Installation
-Add it to your Gemfile:
+Add to to your Gemfile:
 ```bash
-gem 'paymentsjs-rails'
+gem 'paymentsjs-rails', ">=1.0.0"
 ```
 	
 Use Bundler to install:
@@ -21,50 +19,98 @@ 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
+//= require payments //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 
+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"
+end
+```
+This will set the stationary variables, however you can also set any variable at this point if you think they won't change dynamically (postback_url is one to consider).
+Restart your rails application at this point.
+
+In one of your views, add a button:
 ```html
-<script type="text/javascript" src="https://www.sagepayments.net/pay/1.0.0/js/pay.min.js"></script>
+<button id="paymentButton">Pay Now</button>
+```
+
+And then in a script tag add:
+```javascript
+PayJS(['PayJS/UI'],
+function($UI) { 
+    $UI.Initialize({
+        apiKey: "myDeveloperId",
+        merchantId: "999999999997",
+        authKey: "ABCD==",
+        requestType: "payment",
+        requestId: "Invoice12345",
+        amount: "1.00",
+        elementId: "paymentButton",
+        nonce: "ThisIsTotallyUnique",
+        debug: true,
+        preAuth: false,
+        environment: "cert",
+        billing: {
+            name: "Will Wade",
+            address: "123 Address St",
+            city: "Denver",
+            state: "CO",
+            postalCode: "12345"
+        }
+    });
+    $UI.setCallback(function(result) {
+        console.log(result.getResponse());
+        var wasApproved = result.getTransactionSuccess();
+        console.log(wasApproved ? "ka-ching!" : "bummer");
+    });
+});
 ```
-part.
+Take a look at the [official guide from Sage](https://github.com/SagePayments/PaymentsJS) for more details.
 
-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 to call the same preloaded variables:
+This plugin works by calling the PaymentsJs.new class to generate all the data needed. In your controller, add this:
+
+```ruby
+@payment = PaymentJs.new(amount: "1.00", request_id: "Invoice12345")
+```
+You can dynamically add any variable, other than the ones set in the initializer. See further down for a list of all variables supported. The only two required for a new object are `amount` and `request_id`.
+
+In your view, add this embedded Ruby:
 
 ```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: "<%= PaymentsJs.api_key %>", // your developer ID
-		merchantId: "<%= PaymentsJs.mid %>", // your 12-digit account identifier
-		authKey: "<%= PaymentsJs.encrypt %>", // covered in the next section!
-		requestType: "<%= PaymentsJs.request_type %>", // use can use "vault" to tokenize a card without charging it
-		requestId: "<%= PaymentsJs.req_id %>", // an order number, customer or account identifier, etc.
-		amount: "<%= PaymentsJs.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: "<%= PaymentsJs.salt %>", // a unique identifier, used as salt
-		debug: true, // enables verbose console logging
-		preAuth: <%= PaymentsJs.pre_auth %>, // run a Sale, rather than a PreAuth
-		environment: "<%= PaymentsJs.environment %>", // hit the certification environment
-		addFakeData: true,
-		billing: {
-			name: "Shaka Smart",
-			address: "",
-			City: "Denver",
-			state: "CO",
-			postalCode: "80205"
-		}
-	});
-	$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");
-	});
+PayJS(['PayJS/UI'],
+function($UI) { 
+    $UI.Initialize({
+        apiKey: "<%= @payment.api_key %>",
+        merchantId: "<%= @payment.mid %>",
+        authKey: "<%= @payment.get_auth_key %>", // Calls the get_auth_key method which will generate the auth key
+        requestType: "payment",
+        requestId: "<%= @payment.request_id %>",
+        amount: "<%= @payment.amount %>",
+        elementId: "paymentButton",
+        nonce: "<%= @payment.get_salt %>", // Calls the get_salt method which will inject the salt used for the auth key
+        debug: true,
+        preAuth: false,
+        environment: "cert",
+        billing: {
+            name: "Will Wade",
+            address: "123 Address St",
+            city: "Denver",
+            state: "CO",
+            postalCode: "12345"
+        }
+    });
+    $UI.setCallback(function(result) {
+        console.log(result.getResponse());
+        var wasApproved = result.getTransactionSuccess();
+        console.log(wasApproved ? "ka-ching!" : "bummer");
+    });
 });
 ```
 
@@ -72,26 +118,15 @@ 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.
+Here are the required dynamic variables:
 
-##Integration
+Variable | Default Value
+--- | ---
+`amount:` | nil
+`request_id:` | nil
+`request_type:` | "payment"
+`pre_auth:` | false
+`postback_url:` | "https://www.example.com"
+`environment:` | "cert" 
 
-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. 
+You may also want to add billing data to the object to dynamically load everything in the form, but it's your call. 

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaymentsjsRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/helpers/configuration.rb

@@ -0,0 +1,27 @@
+module Configuration
+
+ 	def configuration
+ 		yield self
+ 	end
+	
+ 	def define_setting(name, default = nil)
+ 		class_variable_set("@@#{name}", default)
+	
+ 		define_class_method "#{name}=" do |value|
+ 			class_variable_set("@@#{name}", value)
+ 		end
+	
+ 		define_class_method name do
+ 			class_variable_get("@@#{name}")
+ 		end
+ 	end
+	
+ 	private
+	
+ 		def define_class_method(name, &block)
+ 			(class << self; self; end).instance_eval do
+ 				define_method name, &block
+ 			end
+ 		end
+
+end

data/lib/paymentsjs-rails.rb

@@ -1,51 +1,61 @@
+module PaymentsjsRails
+	require 'paymentsjs-rails/engine'
+end
+
 class PaymentsJs
-	#require 'helpers/configuration'
+	require 'helpers/configuration'
 	require 'openssl'
 	require 'base64'
 	require 'json'
-  	require 'paymentsjs-rails/rails/engine'
 	
-	attr_reader :address, :city, :state, :zip, :amount, :req_id, :name, :request_type, :pre_auth, :environment, :api_key, :salt, :mid, :postback_url, :auth_key
+	extend Configuration
 	
-	def initialize(order)
-		
-		p order
-		
-		@order        = order
-		@address      = @order[:address]
-		@city         = @order[:city]
-		@state        = @order[:state]
-		@zip          = @order[:zip]
-		@amount       = @order[:total]
-		@req_id       = @order[:req_id]
-		@name         = @order[:name]
-		@request_type = @order[:request_type]
-		@pre_auth     = @order[:pre_auth]
-		@environment  = @order[:environment]
-		@mid          = @order[:mid]
-		@mkey         = @order[:mkey]
-		@api_key      = @order[:api_key]
-		@api_secret   = @order[:api_secret]
-		@postback_url = @order[:postback_url]
-		
-		cipher = OpenSSL::Cipher::AES.new(256, :CBC)
-		cipher.encrypt
-
-		iv = OpenSSL::Random.pseudo_bytes(16)
+	# Generate a salt 
+	def generate_salt(iv)
 		salt = iv.unpack('H*').first
 		salt = salt.bytes.to_a
 		salt = salt.pack('U*')
-		@salt = Base64.strict_encode64(salt)
-		
-		p @salt
-		p @api_secret
+		Base64.strict_encode64(salt)
+	end
+	
+	# Set defaults for testing, these will be overwritten in the config
+	define_setting :request_type, "payment"
+	define_setting :pre_auth, false
+	define_setting :postback_url, "https://www.example.com"
+	define_setting :environment, "cert"
+	
+	attr_accessor :address, :city, :state, :zip, :amount, :request_id, :name, :request_type, :pre_auth, :environment, :api_key, :salt, :mid, :postback_url, :auth_key
+
+	def initialize(args = {})
+
+		@api_key      = PaymentsJs.api_key
+		@mid          = PaymentsJs.mid
+		@mkey         = PaymentsJs.mkey
+		@api_secret   = PaymentsJs.api_secret
+
+		@request_type = args[:request_type].present? ? args[:request_type] : PaymentsJs.request_type
+		@request_id   = args[:request_id]
+		@postback_url = args[:postback_url].present? ? args[:postback_url] : PaymentsJs.postback_url
+		@amount       = args[:amount]
+		@pre_auth     = args[:pre_auth].present? ? args[:pre_auth] : PaymentsJs.pre_auth
+		@environment  = args[:environment].present? ? args[:environment] : PaymentsJs.environment
+
+		# Generate the salt and iv at initialization so they can be consistently called
+		@iv = OpenSSL::Random.pseudo_bytes(16)
+		@salt = generate_salt(@iv)
+
+	end
+
+	def get_auth_key
+		cipher = OpenSSL::Cipher::AES.new(256, :CBC)
+		cipher.encrypt
 
 		req  = {
 			"apiKey"      => @api_key,
 			"merchantId"  => @mid,
 			"merchantKey" => @mkey,
 			"requestType" => @request_type,
-			"requestId"   => @req_id,
+			"requestId"   => @request_id,
 			"postbackUrl" => @postback_url,
 			"amount"      => @amount,
 			"nonce"       => @salt,
@@ -56,10 +66,13 @@ class PaymentsJs
 		data       = JSON.generate(req)
 		key        = OpenSSL::PKCS5.pbkdf2_hmac_sha1(@api_secret, @salt, 1500, 32)
 		cipher.key = key
-		cipher.iv  = iv
-		authKey    = cipher.update(data) + cipher.final()
-		@auth_key   = Base64.strict_encode64(authKey)
-		
+		cipher.iv  = @iv
+		auth_key    = cipher.update(data) + cipher.final()
+
+		Base64.strict_encode64(auth_key)
 	end
-	
-end
+
+	def get_salt
+		@salt
+	end
+end

data/lib/paymentsjs-rails/engine.rb

@@ -0,0 +1,6 @@
+module PaymentsjsRails
+	module Rails
+    	class Engine < ::Rails::Engine
+    	end
+	end
+end

data/lib/paymentsjs-rails/version.rb

@@ -0,0 +1,3 @@
+module PaymentsjsRails
+  VERSION = '1.0.0'
+end

data/lib/tasks/paymentsjs_rails_tasks.rake

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

metadata

@@ -1,26 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: paymentsjs-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Joshua Bartlett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
-dependencies: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !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'
 description: A gem to simplify the encryption of data for the Sage PaymentsJS SDK
   for usage in Rails apps.
-email: joshua.r.bartlett@gmail.com
+email:
+- joshua.r.bartlett@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
-- lib/assets/javascripts/pay.js
+- Rakefile
+- lib/helpers/configuration.rb
 - lib/paymentsjs-rails.rb
-- lib/paymentsjs-rails/rails/engine.rb
+- lib/paymentsjs-rails/engine.rb
+- lib/paymentsjs-rails/version.rb
+- lib/tasks/paymentsjs_rails_tasks.rake
+- vendor/assets/javascripts/payments.js
 homepage: http://rubygems.org/gems/paymentjs-rails
 licenses:
 - MIT

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

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