atpay_tokens 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65be535209e1614aa04a9fe3ac66eff35db1d6f0
-  data.tar.gz: 4b447781504822cb77f38ebfac727e646dcce417
+  metadata.gz: 8b287a2d69504b635b56368a27f7c2c9c2b6d6d4
+  data.tar.gz: 294d9c0723c657eb277d246aa2a79f238ec7a4b4
 SHA512:
-  metadata.gz: 696b8f3084deadfe089dd1aa33e0ebaad1703019a078619427bd9e70cbd830031ae7e04df46f84a5f032e4e6483c66413a2b2951c960869a81c86489777cb304
-  data.tar.gz: 5dc52cd6a323856d4f985cdbfe293787477870390e1115d33bff226300f6faba67abffa9f718534aa2d8bbcad196bc59d49fadcaaa3fe34e8b1f8942f648b2a4
+  metadata.gz: 257ed967ee374de94b602d2d598d72bac190eb64c2d7612a0bf5b1eb8627ad8c1e5d0cd0229a21252d9e714cfb6e7c12aa01d4bc29efbb82748a5b8bbebcd3a8
+  data.tar.gz: 633db21ac4d51830a0d10019fcb74937104b4151beb60a98e4f4d58268b500d66d6098073cfad2cbbb42b1e2e0fdcb64802f36bbc7b731a51a782fad11642af5

data/README.md

@@ -1,6 +1,6 @@
 # @Pay API Client
 
-[![Build Status](https://travis-ci.org/atpay/atpay-client.png)](https://travis-ci.org/atpay/atpay-client)
+[![Build Status](https://travis-ci.org/atpay/atpay-client.png)](https://travis-ci.org/atpay/atpay-client) [![Coverage Status](https://coveralls.io/repos/atpay/atpay-client/badge.png?branch=master)](https://coveralls.io/repos/atpay/atpay-client/badge.png?branch=master)
 
 
 Client interface for the @Pay API and key generation for 
@@ -47,34 +47,36 @@ session = AtPay::Session.new({
 
 ## Command Line Usage
 
-    $ atpay-client --help
+    $ atpay_tokens --help
 
 
 ### Parameters
 
-    atpay-token-generator v2.0
+    atpay_tokens v2.1
     Options:
-                 --private-key, -p <s>:   [global] The private key given to you by @Pay
-                  --public-key, -u <s>:   [global] @Pay's public key, given to you by @Pay
-                  --partner-id, -a <i>:   [global] The partner ID given to you by @Pay
-                 --environment, -e <s>:   [global] The environment you want to generate buttons for. Currently sandbox or production (default: production)
-                      --config, -c <s>:   [global] The path to a configuration file in yml format
-                        --type, -t <s>:   [global] The type of token to generate (site,email)
-                        --card, -r <s>:   [site-token, email-token] The card token associated with the recipient of this token. If `type` is site, this must be present
-                       --email, -m <s>:   [email-token] The email associated with the receipt of this token. Incomptible when `type` is 'site'
-                      --amount, -o <f>:   [token] The amount a user should be charged for the transaction you're generating a token for (default: 5.0)
-                   --user-data, -s <s>:   [token] Data to pass back as a reference
-                     --expires, -x <i>:   [token] Expiration date for token, integer value of seconds since epoch
-           --header-user-agent, -h <s>:   [site-token] The HTTP_USER_AGENT from the client's request header (if `type` is 'site')
+             --private-key, -p <s>:   [global] The private key given to you by @Pay
+              --public-key, -u <s>:   [global] @Pay's public key, given to you by @Pay
+              --partner-id, -a <i>:   [global] The partner ID given to you by @Pay
+             --environment, -e <s>:   [global] The environment you want to generate buttons for. Currently sandbox or production (default: production)
+                  --config, -c <s>:   [global] The path to a configuration file in yml format
+                    --type, -t <s>:   [global] The type of token to generate (site,email,universal)
+                    --card, -r <s>:   [site-token, email-token] The card token associated with the recipient of this token. If `type` is site, this must be present
+                   --email, -m <s>:   [email-token] The email associated with the receipt of this token. Incompatible when `type` is 'site'
+                     --url, -l <s>:   [universal-token] The Signup url the recipient should go to if they don't have payment informaiton.  Incompatible when `type` is 'site' or 'email'
+                  --amount, -o <f>:   [token] The amount a user should be charged for the transaction you're generating a token for (default: 5.0)
+               --user-data, -s <s>:   [token] Data to pass back as a reference
+                 --expires, -x <i>:   [token] Expiration date for token, integer value of seconds since epoch
+       --header-user-agent, -h <s>:   [site-token] The HTTP_USER_AGENT from the client's request header (if `type` is 'site')
       --header-accept-language, -d <s>:   [site-token] The HTTP_ACCEPT_LANGUAGE from the client's request header (if `type` is 'site')
-           --header-accept-charset <s>:   [site-token] The HTTP_ACCEPT_CHARSET from the client's request header (if `type` is 'site')
-                  --ip-address, -i <s>:   [site-token] The IP address of the token recipient (if `type` is 'site')
-                         --version, -v:   Print version and exit
-                            --help, -l:   Show this message
+       --header-accept-charset <s>:   [site-token] The HTTP_ACCEPT_CHARSET from the client's request header (if `type` is 'site')
+              --ip-address, -i <s>:   [site-token] The IP address of the token recipient (if `type` is 'site')
+                     --version, -v:   Print version and exit
+                            --help:   Show this message
 
 * Parameters marked as [global] must be passed on the command line
 * Parameters marked with [site-token] are required for site tokens
 * Parameters marked with [email-token] are required for email tokens
+* Parameters marked with [universal-token] are required for universal tokens
 * Parameters marked with [token] are accepted for both site and email tokens
 
 ### CSV via STDIN

data/atpay_tokens.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name          = 'atpay_tokens'
-  s.version       = '2.0.2'
-  s.date          = '2013-07-25'
+  s.version       = '2.1.0'
+  s.date          = '2013-08-12'
   s.summary       = "@Pay Token Generator"
   s.description   = "Client interface for the @Pay API, key generation for performance optimization"
   s.authors       = ["James Kassemi", "Glen Holcomb"]

data/bin/atpay_tokens

@@ -8,7 +8,7 @@ require 'csv'
 require 'trollop'
 
 $opts = Trollop::options do
-  version "atpay-token-generator v2.0"
+  version "atpay_tokens v2.1"
 
   # Global
   opt :private_key, "[global] The private key given to you by @Pay", :type => :string
@@ -16,11 +16,12 @@ $opts = Trollop::options do
   opt :partner_id, "[global] The partner ID given to you by @Pay", :type => :integer
   opt :environment, "[global] The environment you want to generate buttons for. Currently sandbox or production", :default => 'production', :type => :string
   opt :config, "[global] The path to a configuration file in yml format", :type => :string
-  opt :type, "[global] The type of token to generate (site,email)", :type => :string
+  opt :type, "[global] The type of token to generate (site,email,universal)", :type => :string
 
   # Per Token
   opt :card, "[site-token, email-token] The card token associated with the recipient of this token. If `type` is site, this must be present", :type => :string
-  opt :email, "[email-token] The email associated with the receipt of this token. Incomptible when `type` is 'site'", :type => :string
+  opt :email, "[email-token] The email associated with the receipt of this token. Incompatible when `type` is 'site'", :type => :string
+  opt :url, "[universal-token] The Signup url the recipient should go to if they don't have payment informaiton.  Incompatible when `type` is 'site' or 'email'", :type => :string
 
   opt :amount, "[token] The amount a user should be charged for the transaction you're generating a token for", :default => 5.0
   opt :user_data, "[token] Data to pass back as a reference", :type => :string
@@ -64,16 +65,12 @@ module Args
 
   class TokenSet
     def next_token
-      if cli?
-        cli
-      else
-        stdin
-      end
+      cli? ? cli : stdin
     end
 
     private
     def cli?
-      ($opts[:card] or $opts[:email]) and $opts[:type]
+      ($opts[:card] or $opts[:email] or $opts[:url]) and $opts[:type]
     end
 
     def cli
@@ -119,17 +116,20 @@ class Generator
     Trollop::die :ip_address, "must be present for site_tokens" if site? and options[:ip_address].nil?
     Trollop::die :email, "or card must be present for all rows" if email? and (options[:card].nil? and options[:email].nil?)
     Trollop::die :amount, "must be present" if options[:amount].nil?
+    Trollop::die :url, "must be present" if universal? and options[:url].nil?
+    Trollop::die :email, "incompatible with universal tokens" if universal? and options[:email]
+    Trollop::die :card, "incompatible with universal tokens" if universal? and options[:card]
   end
 
   def next
-    return unless options=next_config
+    return unless options = next_config
     options[:amount] = options[:amount].to_f
 
     row_option_check(options)
 
     security_key = session.security_key(options)
 
-    if email?
+    if email? or universal?
       security_key.email_token
     elsif site?
       headers = {
@@ -158,11 +158,15 @@ class Generator
   def site?
     $opts[:type] == "site"
   end
+
+  def universal?
+    $opts[:type] == 'universal'
+  end
 end
 
 config = Args::Main.new
 generator = Generator.new(config)
 
-while token=generator.next
+while token = generator.next
   puts token
 end

data/lib/atpay/security_key.rb

@@ -8,7 +8,7 @@ module AtPay
       raise ArgumentError.new("User Data can't exceed 2500 characters.") if options[:user_data] and options[:user_data].length > 2500
       raise ArgumentError.new("email") unless options[:email].nil? or options[:email] =~ /.+@.+/
       raise ArgumentError.new("amount") unless options[:amount].is_a? Float
-      raise ArgumentError.new("card or email or member required") if options[:email].nil? and options[:card].nil? and options[:member].nil?
+      raise ArgumentError.new("card or email or member or url required") if options[:email].nil? and options[:card].nil? and options[:member].nil? and options[:url].nil?
 
       @session = session
       @options = options
@@ -78,19 +78,11 @@ module AtPay
     end
 
     def target
-      card_format || member_format || email_format
+      format_target [:card, :member, :email, :url].detect { |key| @options[key] }
     end
 
-    def card_format
-      "card<#{@options[:card]}>" if @options[:card]
-    end
-
-    def member_format
-      "member<#{@options[:member]}>" if @options[:member]
-    end
-
-    def email_format
-      "email<#{@options[:email]}>" if @options[:email]
+    def format_target(key)
+      "#{key.to_s}<#{@options[key]}>"
     end
 
     def expires

data/lib/atpay/tokenator.rb

@@ -11,6 +11,13 @@ module AtPay
       :ip,
       :user_data
 
+    TARGETS = {
+      /url<(.*?)>/ => [:@url, 6],
+      /card<(.*?)>/ => [:@card, 7],
+      /email<(.*?)>/ => [:@email, 8],
+      /member<(.*?)>/ => [:@member, 9]
+    }
+
     # A bit clunky but useful for testing token decomposition.
     # If you provide a test session then the config values there 
     # will be used so that decryption will function without @Pay's
@@ -74,7 +81,7 @@ module AtPay
     end
 
     def source
-      {email: @email, card: @card, member: @member}
+      { email: @email, card: @card, member: @member, url: @url }
     end
 
     # Return parts in a hash structure, handy for ActiveRecord.
@@ -165,22 +172,15 @@ module AtPay
       return @user_data
     end
 
-    # Find the target of the token.  This could be a Credit Card
-    # Email Address or Member UUID.
+    # Find the target of the token.  This could be a Credit Card,
+    # Email Address, URL or Member UUID.
     def target(target)
-      case target
-      when /card<(.*?)>/
-        @card = $1
-        @payload.slice!(0, ($1.length + 7))
-      when /email<(.*?)>/
-        @email = $1
-        @payload.slice!(0, ($1.length + 8))
-      when /member<(.*?)>/
-        @member = $1
-        @payload.slice!(0, ($1.length + 9))
-      else
-        raise "No target found"
-      end
+      match = TARGETS.keys.detect { |key| target.match key }
+
+      raise "No target found" if match.nil?
+
+      instance_variable_set TARGETS[match][0], $1.dup
+      @payload.slice!(0, ($1.length + TARGETS[match][1]))
     end
   end
 end

data/spec/atpay/security_key_spec.rb

@@ -42,6 +42,40 @@ describe AtPay::SecurityKey do
         })
       }.to raise_error
     end
+
+    it "fails when not given an email or card or member or url" do
+      expect {
+        AtPay::SecurityKey.new(session, {
+          amount: 25.00
+        })
+      }.to raise_error
+    end
+  end
+
+  describe "#target" do
+    it "builds a card string if card option given" do
+      for_card = AtPay::SecurityKey.new(session, amount: 25.0, card: 'fakecardtoken')
+
+      expect(for_card.send(:target)).to eq("card<fakecardtoken>")
+    end
+
+    it "builds an email string if email option given" do
+      for_email = AtPay::SecurityKey.new(session, amount: 25.0, email: 'bob@bob')
+
+      expect(for_email.send(:target)).to eq("email<bob@bob>")
+    end
+
+    it "builds a member string if member option given" do
+      for_member = AtPay::SecurityKey.new(session, amount: 25.0, member: 'fakemember')
+
+      expect(for_member.send(:target)).to eq("member<fakemember>")
+    end
+
+    it "builds a url string if url option given" do
+      for_url = AtPay::SecurityKey.new(session, amount: 25.0, url: 'http://fake.url.com')
+
+      expect(for_url.send(:target)).to eq("url<http://fake.url.com>")
+    end
   end
 
   describe "#to_s" do

data/spec/atpay/tokenator_spec.rb

@@ -13,6 +13,7 @@ describe AtPay::Tokenator do
   let(:version) { AtPay::Tokenator.new token(50.00, [:email_token], {email: 'email@address', version: 2}), build_session }
   let(:member) { AtPay::Tokenator.new token(50.00, [:email_token], {member: '4DF08A79-C16C-4842-AA1B-AE878C9C6C2C'}), build_session }
   let(:group) { AtPay::Tokenator.new token(50.00, [:email_token], {member: '4DF08A79-C16C-4842-AA1B-AE878C9C6C2C', group: '18', user_data: 'hello from data'}), build_session }
+  let(:url) { AtPay::Tokenator.new token(50.00, [:email_token], {url: 'http://fake.url' }), build_session }
 
   describe "Parsing" do
     it "Uses the key specified in ENCRYPTION if not given a session" do
@@ -58,6 +59,13 @@ describe AtPay::Tokenator do
         group.group.should eq('18')
         group.user_data.should eq('hello from data')
       end
+
+      it "processes a url token" do
+        url.header
+        url.body Base64.decode64(public_key)
+
+        url.source[:url].should eq('http://fake.url')
+      end
     end
 
     describe "Exceptions" do

data/spec/atpay_tokens_spec.rb

@@ -0,0 +1,57 @@
+require 'helper'
+require 'atpay_tokens'
+
+describe "atpay_tokens" do
+  let(:key_pattern) { /@((([A-Za-z0-9+=*]{4})*-)?([A-Za-z0-9+=\/]{4}){5,})/ }
+  let(:base_args) { "--environment test --private-key \"#{private_key}\" --public-key \"#{public_key}\" --partner-id 1 --amount 24.0"}
+  let(:universal_token_args) { "#{base_args} --type universal --url http://bob.com" }
+  let(:site_token_args) { "#{base_args} --type site --card cardtoken --header-user-agent bob --header-accept-language en --header-accept-charset us --ip-address 127.0.0.1" }
+  let(:email_token_args) { "#{base_args} --type email --email bob@bob.com" }
+  let(:command) { File.dirname(__FILE__) + '/../bin/atpay_tokens' }
+
+  describe "Universal Tokens" do
+    it "returns an @Pay Token" do
+      expect(`#{command} #{universal_token_args}`).to match(key_pattern)
+    end
+
+    it "returns a universal token" do
+      tokenator = AtPay::Tokenator.new(`#{command} #{universal_token_args}`, build_session)
+
+      tokenator.header
+      tokenator.body Base64.decode64(public_key)
+
+      expect(tokenator.source[:url]).to eq('http://bob.com')
+    end
+  end
+
+  describe "Site Tokens" do
+    it "returns an @Pay Token" do
+      expect(`#{command} #{site_token_args}`).to match(key_pattern)
+    end
+
+    it "returns a site token" do
+      tokenator = AtPay::Tokenator.new(`#{command} #{site_token_args}`, build_session)
+
+      tokenator.header
+      tokenator.browser_data Base64.decode64(public_key)
+      tokenator.body Base64.decode64(public_key)
+
+      expect(tokenator.source[:card]).to eq('cardtoken')
+    end
+  end
+
+  describe "Email Tokens" do
+    it "returns an @Pay Token" do
+      expect(`#{command} #{email_token_args}`).to match(key_pattern)
+    end
+
+    it "returns an email token" do
+      tokenator = AtPay::Tokenator.new(`#{command} #{email_token_args}`, build_session)
+
+      tokenator.header
+      tokenator.body Base64.decode64(public_key)
+
+      expect(tokenator.source[:email]).to eq('bob@bob.com')
+    end
+  end
+end

data/spec/helper.rb

@@ -8,8 +8,6 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start
 
-require 'rubygems'
-require 'bundler/setup'
 require 'atpay_tokens'
 require 'rspec/core/shared_context'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atpay_tokens
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - James Kassemi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -78,6 +78,7 @@ files:
 - spec/atpay/security_key_spec.rb
 - spec/atpay/session_spec.rb
 - spec/atpay/tokenator_spec.rb
+- spec/atpay_tokens_spec.rb
 - spec/helper.rb
 homepage: https://atpay.com
 licenses: []
@@ -107,4 +108,5 @@ test_files:
 - spec/atpay/security_key_spec.rb
 - spec/atpay/session_spec.rb
 - spec/atpay/tokenator_spec.rb
+- spec/atpay_tokens_spec.rb
 - spec/helper.rb