atpay_ruby 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aabb3c212ebc71b0d6117fd03613932e3fdcf95
-  data.tar.gz: 61a5bdf7c452b597c661a014ead7d05b0224ae05
+  metadata.gz: ecb0aa51eec280c6ff9882cb459a0d8368a17198
+  data.tar.gz: bea46f16c8c30d58f9f77080763606582da9f9dd
 SHA512:
-  metadata.gz: 866fcd4e849c8dede243c29cfac999accc57cf10e58f1fe0d8af571568bbcc08bf501997c01d5649e48151187d2164f51210e13ee0f162edeb10f04c6b39cfb3
-  data.tar.gz: 2a6cc9ca6be9c8b862f56a86f78902cc40639eee5115093c05c653010afd514ce862121c247a8c281bdf307dc9fccd44122c499d892c5f17149f6da30418b2ef
+  metadata.gz: 49e4843cb6fed21a8a5fb5a850274c2b115fc86e5f2ec68de850bfd999e8968034768773f2ad8c8536f84db35cf7cb9615da533dee78b40cdb841a5b6ca81c22
+  data.tar.gz: 357a2dc201c26e0a1a731f5a2a491dfeeab0e281fe908c43975ff88afb9f4efa05b7d3c864eccfd8ff45c51154bd5e7bc41f20ad946d78af0e923fd9cb570103

data/README.md

@@ -59,8 +59,8 @@ or a product sales offer, for instance). When a **Token** is sent to
 `transaction@processor.atpay.com` from an address associated with a **Payment Method**,
 it will create a **Transaction**.
 
-There are two classes of **Token** @Pay processes - the **Invoice Token**, which should
-be used for sending invoices or transactions applicable to a single
+There are two classes of **Token** @Pay processes - the **Targeted Token**, which should
+be used for sending transactions applicable to a single
 recipient, and the **Bulk Token**, which is suitable for email marketing lists.
 
 An **Email Button** is a link embedded in an email message. When activated, this link
@@ -69,19 +69,20 @@ prefilled. By default this email contains one of the two token types. Clicking
 'Send' delivers the email to @Pay and triggers **Transaction** processing. The sender will
 receive a receipt or further instructions.
 
-## Invoice Tokens
+## Targeted Tokens
 
-An **Invoice** token is ideal for sending invoices or for transactions that are
-only applicable to a single recipient (shopping cart abandonment, specialized
-offers, etc).
+A **targeted** token is ideal for sending invoices or for transactions that are
+only applicable to a single recipient (specialized offers, etc).
 
 The following creates a token for a 20 dollar transaction specifically for the
 credit card @Pay has associated with 'test@example.com':
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 puts token.to_s
 ```
+*Note: **Targeted** tokens used to be known as **Invoice** tokens. Please use **Targeted** tokens, as **Invoice** tokens will be deprecated.*
+
 
 ## Bulk Tokens
 
@@ -114,7 +115,7 @@ simultaneously. If you're shipping a physical good, or for some other reason
 want to delay the capture, use the `auth_only!` method to adjust this behavior:
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.auth_only!
 email(token.to_s)
 ```
@@ -126,7 +127,7 @@ after the expiration results in a polite error message being sent to the sender.
 To adjust the expiration:
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.expires_in_seconds = 60 * 60 * 24 * 7 # 1 week
  ```
 
@@ -141,7 +142,7 @@ your own site (Enable @Pay Card tokenization on your own page with the
 URL:
 
 ```ruby
-token     = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token     = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.url = 'https://example.com/invoices/123'
 ```
 
@@ -164,7 +165,7 @@ when the URL is requested from @Pay prior to the first use. To request the URL,
 must contact @Pay's server:
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 registration = token.register!
 
 registration.url
@@ -186,7 +187,7 @@ consultation.
 You can set an **item name** that will display on the **Hosted Payment Capture Page**.
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.name = "A Cool Offer"
 email(token.to_s, receipient_address)
  ```
@@ -197,7 +198,7 @@ You can set an **item details** that will display on the **Hosted Payment Captur
 
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.item_details = "Lorem Ipsum ..."
 email(token.to_s, receipient_address)
  ```
@@ -210,7 +211,7 @@ of shipping or billing address with `requires_shipping_address=` and
 `requires_billing_address=`:
 
 ```
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.requires_shipping_address = true
 token.requires_billing_address  = true
 email(token.to_s, receipient_address)
@@ -221,7 +222,7 @@ email(token.to_s, receipient_address)
 If you are using @Pay's webhook for inventory control, you can specify an initial quantity for the offer you are creating.
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.item_quantity = 3
 email(token.to_s, receipient_address)
  ```
@@ -234,7 +235,7 @@ email(token.to_s, receipient_address)
 A Transaction should be Captured only when fulfillment is completed.
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.estimated_fulfillment_days = 3
 email(token.to_s, receipient_address)
 ```
@@ -245,7 +246,7 @@ email(token.to_s, receipient_address)
 response on processing the token. It has a limit of 2500 characters.
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 token.custom_user_data = 'some-value'
 email(token.to_s, receipient_address)
 ```
@@ -256,7 +257,7 @@ email(token.to_s, receipient_address)
 To create a friendly button that wraps your token:
 
 ```ruby
-token = AtPay::Token::Invoice.new(session, 20.00, 'test@example.com')
+token = AtPay::Token::Targeted.new(session, 20.00, 'test@example.com')
 button = AtPay::Button.new(token.to_s, 20.00, 'My Company', wrap: true).render
 email(button, recipient_address)
 ```
@@ -283,16 +284,16 @@ File.write("code.svg", qr.svg)      # Export SVG
 
 ## Command Line Usage
 
-The `atpay` utility generates **Invoice Tokens**, **Bulk Tokens**, and **Email Buttons**
+The `atpay` utility generates **Targeted Tokens**, **Bulk Tokens**, and **Email Buttons**
 that you can embed in outgoing email. Run `atpay help` for more details.
 
 ```bash
-$ atpay token invoice --partner_id=X --private_key=X --amount=20.55 --target=test@example.com --user-data=sku-123
+$ atpay token targeted --partner_id=X --private_key=X --amount=20.55 --target=test@example.com --user-data=sku-123
 => @...@
 
 $ atpay token bulk --partner_id=X --private-key=X --amount=20.55 --url="http://example.com/product"
 => @...@
 
-$ atpay token invoice --partner_id=X --private_key=X --amount=20.55 --target=test@example.com --user-data=sku-123 | atpay button generic --amount=20.55 --merchant="Mom's"
+$ atpay token targeted --partner_id=X --private_key=X --amount=20.55 --target=test@example.com --user-data=sku-123 | atpay button generic --amount=20.55 --merchant="Mom's"
 => <p>...</p>
 ```

data/atpay_ruby.gemspec

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
 Gem::Specification.new do |s|
   s.name          = 'atpay_ruby'
-  s.version       = '0.0.11'
+  s.version       = '0.0.12'
   s.summary       = 'Ruby bindings for the @Pay API'
   s.description   = ""
   s.authors       = ['James Kassemi', 'Isaiah Baca']

data/bin/atpay

@@ -21,6 +21,14 @@ module AtPay
         puts AtPay::Token::Invoice.new(session, options[:amount], options[:email], options[:user_data]).to_s
       end
 
+      desc 'targeted', 'Generate an targeted token'
+      option :amount, type: :numeric, required: true, desc: "Dollar amount to process"
+      option :email, type: :string, required: true, desc: "Email address expected to complete the transaction"
+      option :user_data, default: nil, desc: "Additional data to append to transaction details"
+      def targeted
+        puts AtPay::Token::Targeted.new(session, options[:amount], options[:email], options[:user_data]).to_s
+      end
+
       desc 'bulk', 'Generate a bulk token'
       option :amount, type: :numeric, required: true, desc: "Dollar amount to process"
       option :user_data, default: '', desc: "Additional data to append to transaction details"

data/lib/atpay.rb

@@ -5,6 +5,7 @@ require 'atpay/error'
 require 'atpay/button'
 require 'atpay/token/invoice'
 require 'atpay/token/bulk'
+require 'atpay/token/targeted'
 require 'atpay/hook'
 require 'atpay/railtie' if defined?(Rails)
 require 'base64'

data/lib/atpay/token/targeted.rb

@@ -0,0 +1,17 @@
+require 'atpay/token/core'
+require 'atpay/token/encoder'
+
+module AtPay
+  module Token
+    class Targeted < Core
+      def initialize(session, amount, email_address, custom_data={})
+        super
+
+        self.session               = session
+        self.amount                = amount
+        self.email_address         = email_address
+        self.user_data.custom_data = custom_data
+      end
+    end
+  end
+end

data/spec/token/targeted_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'atpay/session'
+require 'atpay/token/targeted'
+
+describe AtPay::Token::Targeted do
+  let(:partner_id)        { 1 }
+  let(:private_key)       { 'xx5okSjkqJu30biXEFI/y05B68JRCr7ReSdufmtrILY=' }
+  let(:public_key)        { 'gOVRRMKRwCHD0nkGiQ1/1EKcSUjO/einHq7MZ/AMkzQ=' }
+  let(:atpay_public_key)  { 'x3iJge6NCMx9cYqxoJHmFgUryVyXqCwapGapFURYh18=' }
+  let(:atpay_private_key) { '' }
+
+  let(:session)       { AtPay::Session.new(partner_id, public_key, private_key) }
+  let(:amount)        { 20.0 }
+  let(:email_address) { 'http://example.com/' }
+  let(:user_data)     { 'sku-123' }
+
+  it 'creates a new token without exception' do
+    AtPay::Token::Targeted.new(session, amount, email_address, user_data).to_s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atpay_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - James Kassemi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbnacl-libsodium
@@ -158,6 +158,7 @@ files:
 - lib/atpay/token/encoder.rb
 - lib/atpay/token/invoice.rb
 - lib/atpay/token/registration.rb
+- lib/atpay/token/targeted.rb
 - spec/button/qr_code_spec.rb
 - spec/button_spec.rb
 - spec/hook_spec.rb
@@ -167,6 +168,7 @@ files:
 - spec/token/encoder_spec.rb
 - spec/token/invoice_spec.rb
 - spec/token/registration.rb
+- spec/token/targeted_spec.rb
 homepage: https://atpay.com
 licenses:
 - MIT
@@ -201,3 +203,4 @@ test_files:
 - spec/token/encoder_spec.rb
 - spec/token/invoice_spec.rb
 - spec/token/registration.rb
+- spec/token/targeted_spec.rb