atpay_tokens 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a0da37b9f59dd6d2a5dd925c3b4fe9a222fbd36
-  data.tar.gz: 9c831dc125d62188bc521c45cb9b948373ac15c3
+  metadata.gz: 4f9e7b7a65d0e4f05625ca9fd5bbf4937fb887fb
+  data.tar.gz: 21fd295ab59fb0ff9de4163a6d1d5c6ba4f9df44
 SHA512:
-  metadata.gz: 58ea9b2e354abf2e707cbd147ff7bac187abbf3a4510ee60a6cfbc34a6c8a65451189dcbb96bc22b9c6ca2097178b738a833f92ab14efc4904c4efa49c662584
-  data.tar.gz: 82d1c9b5b7ae4467926abf9f3dd7d37ef5e66f0ced7d7e62689974f19fb405bec08b2bd141dc128885765267d261e577dc17e5c1e19a670cda9ace1aee20fd56
+  metadata.gz: 8640e0071f39dd7185cccefc5926d07f8dcf64c8ea5bcd8172ee417e459c3f8afad08338d9ccd44882aa93c839588466cf3a5593ad79be403838a95e302377da
+  data.tar.gz: 5a6dcc2f9bd5282ffa11af90320819f583c303c42e6a09e5b02502aef38b957074a771af4ec40f445ebd6a649ed1cd3b3c269ef6d0e220067a9fd330243cfa55

data/README.md

@@ -13,14 +13,18 @@ Interfaces here are implemented after receiving OAuth 2.0
 privileges for the partner/user record. You cannot authenticate
 directly to the API with this library at this moment.
 
+## Requirements
+
+ruby >= 1.9
+
 ## Installation
 
-Add the 'atpay-client' gem to your Gemfile:
+Add the 'atpay_tokens' gem to your Gemfile:
 
 ```ruby
 #Gemfile
 
-gem 'atpay', :github => "atpay/atpay-client"
+gem 'atpay_tokens', :github => "atpay/atpay-client"
 ```
 
 ## Configuration
@@ -41,6 +45,63 @@ session = AtPay::Session.new({
 })
 ```
 
+## Command Line Usage
+
+    $ atpay-client --help
+
+
+### Parameters
+
+    atpay-token-generator v2.0
+    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')
+      --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
+
+* 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 [token] are accepted for both site and email tokens
+
+### CSV via STDIN
+
+All token arguments (arguments not marked as [global]) may be passed
+to the command line utility via STDIN in CSV format. The first line of
+the incoming CSV must be the headers for each column, using the full
+option names above. For instance, to pass a CSV with amount, card tokens,
+user_data, and email address:
+
+```
+  $ atpay_tokens --private-key="XYZ" --partner-id=999 --type=email < data.csv
+```
+
+```
+  amount,user-data,card,email
+  50.00,refid1,XbsfrYUjAHh0lWSoWS0q3ahIpxohpcM=,james@example.com
+  100.00,refid2,XbsfrYUjAHh0lWSoWS0q3ahIpxohpcM=,james@example.com
+  200.00,refid3,XbsfrYUjAHh0lWSoWS0q3ahIpxohpcM=,james@example.com
+```
+
+The above will print 3 tokens for amounts between 50 and 200 dollars,
+all to charge the same credit card at the same email address. 
+
+If you need to change the keys, partner id, or type, you'll need to
+start a new instance of the utility for each change.
+
 ## Usage
 
 In order for an @Pay user to make a purchase via email, they'll

data/atpay_tokens.gemspec

@@ -1,15 +1,16 @@
 Gem::Specification.new do |s|
   s.name          = 'atpay_tokens'
-  s.version       = '1.0.2'
+  s.version       = '2.0.0'
   s.date          = '2013-07-25'
   s.summary       = "@Pay Token Generator"
   s.description   = "Client interface for the @Pay API, key generation for performance optimization"
   s.authors       = ["James Kassemi", "Glen Holcomb"]
-  s.email         = 'james@atpay.com'
+  s.email         = 'dev@atpay.com'
   s.files         = `git ls-files`.split($/)
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.homepage      = "https://atpay.com"
-  s.executables   << 'atpay_tokens'
+  s.executables  = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.add_runtime_dependency 'ffi'
   s.add_runtime_dependency 'rbnacl'
+  s.add_runtime_dependency 'trollop'
 end

data/bin/atpay_tokens

@@ -4,215 +4,159 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'atpay_tokens'
 require 'yaml'
-
-
-class Arguments
-  attr_reader :values
-
-  def initialize
-    @values = YAML.load_file(File.expand_path('../../config/credentials.yml', __FILE__))
-  end
-end
-
-module Usage
-  USAGE = <<-EOS
-
-    The @Pay Client will generate @Pay Tokens for you.  You can use this tool to generate both email
-    and site tokens.  There are quite a few arguments but only a handfull are required:
-
-
-    Examples:
-      atpay_tokens email_token targets bob@bob.com amount 8.0 expires 1454673223
-      atpay_tokens email_token targets bob@bob.com group "8.0 9.5 23.28"
-      atpay_tokens email_token cards OGQ3OWE0OWNhMFFTL4mMpQA= amount 12.0
-      atpay_tokens email_token cards OGQ3OWE0OWNhMFFTL4mMpQA= targets bob@bob.com amount 12.0
-
-      atpay_tokens site_token cards OGQ3OWE0OWNhMFFTL4mMpQA= amount 5.0 user_agent "curl/7.9.8" lang "en-US,en;q=0.8" charset "utf8" addr 173.163.242.213
-
-
-    Required:
-      site_token|email_token    You must specify the type of token you wish to generate
-      cards|targets             You must at least specify a card or email address.  For a site token
-                                you must provide a card.  If you are building multiple tokens ensure
-                                that you provide a card token for each email and that the order is
-                                correct.
-      amount|group              You also need to specify either a single amount or a group of amounts.
-
-
-    Required (for site token):
-      user_agent                The HTTP_USER_AGENT from the client's request header.
-      lang                      The HTTP_ACCEPT_LANGUAGE from the client's request header.
-      charset                   The HTTP_ACCEPT_CHARSET from the client's request header.
-      addr                      The IP address corresponding to the requesting source (The user's IP)
-
-
-    Optional:
-      expires                   This is the expiration date.  This should be an integer value of
-                                seconds since epoch.
-
-  EOS
+require 'csv'
+require 'trollop'
+
+$opts = Trollop::options do
+  version "atpay-token-generator v2.0"
+
+  # Global
+  opt :private_key, "[global] The private key given to you by @Pay", :type => :string
+  opt :public_key, "[global] @Pay's public key, given to you by @Pay", :type => :string
+  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
+
+  # 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 :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
+  opt :expires, "[token] Expiration date for token, integer value of seconds since epoch", :type => :integer
+
+  # Site Token Specific
+  opt :header_user_agent, "[site-token] The HTTP_USER_AGENT from the client's request header (if `type` is 'site')", :type => :string
+  opt :header_accept_language, "[site-token] The HTTP_ACCEPT_LANGUAGE from the client's request header (if `type` is 'site')", :type => :string
+  opt :header_accept_charset, "[site-token] The HTTP_ACCEPT_CHARSET from the client's request header (if `type` is 'site')", :type => :string
+  opt :ip_address, "[site-token] The IP address of the token recipient (if `type` is 'site')", :type => :string
 end
 
+Trollop::die :amount, "must not be negative" if $opts[:amount] < 0
+Trollop::die :private_key, "required" if $opts[:private_key].nil?
+Trollop::die :partner_id, "required" if $opts[:partner_id].nil?
 
-class ClientRunner
-  OPTIONS = %w(expires group amount)
-  HEADERS = %w(HTTP_USER_AGENT HTTP_ACCEPT_LANGUAGE HTTP_ACCEPT_CHARSET)
-  EMAIL = /[\w\d\.]+@[\w\.]+[\w]+/
-  CARD = /.*=$/
+module Args
+  class Main
+    def to_hash
+      read_from_file.update(read_from_cli)   
+    end
 
-  def initialize(args)
-    @config = Arguments.new
-    @session = AtPay::Session.new(@config.values)
-    @options = {}
-    @site_params = [{}]
-    @targets = []
+    def tokens
+      @token_set ||= TokenSet.new
+    end
+  
+    private
+    def read_from_file
+      {} || (YAML.load_file($opts[:config]) if $opts[:config])
+    end
 
-    parse args
+    def read_from_cli
+      %w(
+        private_key
+        public_key
+        partner_id
+        environment
+      ).inject({}) { |h,v| h[v]=$opts[v.to_sym]; h }
+    end
   end
 
-  # Parse our arguments for all of our values
-  def parse(args)
-    OPTIONS.each do |option|
-      @options[option.to_sym] = args[args.index(option) + 1] unless args.grep(option).empty?
+  class TokenSet
+    def next_token
+      if cli?
+        cli
+      else
+        stdin
+      end
     end
 
-    site_params args if ARGV[0] == 'site_token'
-    convert_amounts
-    convert_expiration
-    get_emails args
-    get_cards args
-
-    unless @options[:card] or @options[:email]
-      puts USAGE and exit
+    private
+    def cli?
+      ($opts[:card] or $opts[:email]) and $opts[:type]
     end
-  end
 
-  # Build our list of email addresses to generate tokens for
-  def get_emails(args)
-    return unless args.index('targets')
+    def cli
+      return nil if @cli_read
+      @cli_read = true
 
-    args[args.index('targets') + 1].split(' ')[0].match(EMAIL) ? @options[:email] = args[(args.index('targets') + 1)].split(' ') : @options[:email] = File.read(args[args.index('targets') + 1]).split("\n")
-  end
-
-  # Grab all the card tokens
-  def get_cards(args)
-    return unless args.index('cards')
+      $opts
+    end
 
-    args[args.index('cards') + 1].split(' ')[0].match(CARD) ? @options[:card] = args[(args.index('cards') + 1)].split(' ') : @options[:card] = File.read(args[args.index('cards') + 1]).split("\n")
-  end
+    def csv
+      @csv ||= CSV.new($stdin, :headers => true)
+    end
 
-  # Need expiration as an integer
-  def convert_expiration
-    @options[:expires] = @options[:expires].to_i if @options[:expires]
+    def stdin
+      unless csv.eof?
+        csv.shift.to_hash
+      end
+    end
   end
+end
 
-  # Convert any amounts to floats.
-  def convert_amounts
-    @options[:amount] = @options[:amount].to_f if @options[:amount]
-    @options[:amount] = @options[:group].split(' ').map(&:to_f) if @options[:group]
-
-    @options.delete :group
+class Generator
+  def initialize(config)
+    @config = config
   end
 
-  # Check our input for site params.
-  def site_params(args)
-    if args.grep('addr').empty?
-      puts "You must provide an IP Address for a site token.\n" + USAGE
-      exit
-    end
-
-    @site_params[1] = args[args.index('addr') + 1]
+  def session
+    options = @config.to_hash
 
-    headers(args)
+    @session ||= AtPay::Session.new({
+      :private_key => options["private_key"],
+      :public_key => options["public_key"],
+      :partner_id => options["partner_id"].to_i,
+      :environment => options["environment"].to_sym
+    })
   end
 
-  def headers(args)
-    if args.grep('user_agent').empty? or args.grep('charset').empty? or args.grep('lang').empty?
-      puts "You must provide a user_agent, charset, and lang for a site token.\n" + USAGE
-      exit
-    end
-
-    @site_params[0][HEADERS[0]] = args[args.index('user_agent') + 1]
-    @site_params[0][HEADERS[1]] = args[args.index('lang') + 1]
-    @site_params[0][HEADERS[2]] = args[args.index('charset') + 1]
+  def row_option_check(options)
+    Trollop::die :card, "must be present for site tokens" if site? and options[:card].nil?
+    Trollop::die :header_user_agent, "must be present for site_tokens" if site? and options[:header_user_agent].nil?
+    Trollop::die :header_accept_language, "must be present for site_tokens" if site? and options[:header_accept_language].nil?
+    Trollop::die :header_accept_charset, "must be present for site_tokens" if site? and options[:header_accept_charset].nil?
+    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?
   end
 
-  # Generate multiple site tokens
-  def site_tokens
-    options = @options.clone
+  def next
+    return unless options=next_config
+    options[:amount] = options[:amount].to_f
 
-    @options[:card].each_with_index do |card, index|
-      options[:card] = card
-      options[:email] = @options[:email][index] if @options[:email]
+    row_option_check(options)
 
-      site_token options
-    end
-  end
+    security_key = session.security_key(options)
 
-  # Generate a site token
-  def site_token(options = @options)
-    if options[:card].is_a? Array
-      site_tokens
-      return
-    end
-
-    keys = security_key(options)
-
-    if keys.is_a? Array
-      puts keys.map { |key| key.site_token @site_params[1], @site_params[0] }
-    else
-      puts keys.site_token @site_params[1], @site_params[0]
+    if email?
+      security_key.email_token
+    elsif site?
+      security_key.site_token
     end
   end
 
-  # Generate multiple email tokens
-  def email_tokens
-    options = @options.clone
-
-    @options[:email].each_with_index do |email, index|
-      options[:email] = email
-      options[:card] = @options[:card][index] if @options[:card]
+  private
+  def next_config
+    options = @config.tokens.next_token
 
-      email_token options
-    end
+    options.inject({}){|h,(k,v)| 
+      h[k.to_sym] = v; h 
+    } if options
   end
 
-  # Generate an email token
-  def email_token(options = @options)
-    if options[:email].is_a? Array
-      email_tokens
-      return
-    end
-
-    keys = security_key(options)
-
-    if keys.is_a? Array
-      puts keys.map { |key| key.email_token }
-    else
-      puts keys.email_token
-    end
+  def email?
+    $opts[:type] == "email"
   end
 
-  # Get a security key object we can ask to generate keys for us.
-  def security_key(options = @options)
-    @session.security_key(options)
+  def site?
+    $opts[:type] == "site"
   end
 end
 
+config = Args::Main.new
+generator = Generator.new(config)
 
-operation = ARGV[0]
-arguments = ARGV[1..-1]
-
-unless operation
-  puts Usage::USAGE
-  exit
-end
-
-unless arguments.length > 0 and arguments.length % 2 == 0
-  puts Usage::USAGE
-  exit
+while token=generator.next
+  puts token
 end
-
-runner = ClientRunner.new arguments
-
-runner.send operation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atpay_tokens
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - James Kassemi
@@ -39,8 +39,22 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Client interface for the @Pay API, key generation for performance optimization
-email: james@atpay.com
+email: dev@atpay.com
 executables:
 - atpay_tokens
 extensions: []