vantiv_sftp_reports 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfe911dff287b7ee8893c86f18dfc091e11bbe03
+  data.tar.gz: c68689b05a2b7d9f084d08460e4cd51eeecbfd4d
+SHA512:
+  metadata.gz: b864cf767f98c214bf50bba248199e7fa43fad8bfc74344adf7d714efc1b8de8d0b373f4f91d400986ecc9bec9a5ef70ef84ebe28cb0d7ec2eaaf1e29e71e7e4
+  data.tar.gz: 348b2b5bd79c83d8c126cbb814db3cc455c4725b0baec0ab5d39f2e0c70f298121ca255ebd5b6e052ce841f6f44356a23cf4257e26062405f815cf2618bc08ac

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joshua Hansen
+
+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

@@ -0,0 +1,118 @@
+# Vantiv SFTP Reports
+
+Are you using WorldPay/Vantiv/LitleOnline and need to actually resolve what happened with a particular transaction or just need to be able to consume data about what's going on in a programmatic way? Funny story about that...
+
+The eCommerce "solution" (Vantiv's CNP API aka LitleOnline) provides no APIs for handling this because who on earth would actually want to get to their data via an API and have historical access, right? It gets better though because their hosted payments solution---a solution designed for people trying to avoid API integrations---actually has an API for this sort of thing. Does this make any sense? No. No, it does not.
+
+With that said, let's party like it's 1999! (At least SFTP was made in this century I guess.) You can make like a digital Neanderthal and download report files over SFTP, parse CSVs, and get whatever you need.
+
+(If you ever wondered why [Stripe](https://stripe.com) is so successful, this sort of absurdity has something to do with it. They actually get that developers are a thing.)
+
+This library is meant to be pretty low level. It just handles some basic configuration, downloading, and parsing. It is not meant to care about the particulars of how those reports are consumed, related, or even which reports you have enabled.
+
+## Installation
+
+The usual:
+
+    $ gem install vantiv_sftp_reports
+
+## Configuration
+
+As there is no sandbox for testing this, you're going to need to do a bit of configuring to get anything out of this. This gem supports managing multiple configurations, but the vast majority of use cases revolve around a single default configuration.
+
+I can be set one of two ways:
+
+## Use a Hash
+
+```ruby
+VantivSFTPReports.configure(
+  host:,            # SFTP host, defaults to 'reports.iq.vantivcnp.com'
+  organization_id:, # Organization ID for reports, leave blank if you only have one organization
+  password:,        # Your SFTP username
+  path:,            # Directory where reports are stored, defaults to 'reports'
+  username:         # Your SFTP username
+)
+```
+
+This sets the default configuration (`VantivSFTPReports.default_config`).
+
+## Infer Values from `ENV`
+
+Prefix any configuration option with `vantiv_sftp_` and it will be automatically set:
+
+* `ENV['vantiv_sftp_host']`
+* `ENV['vantiv_sftp_organization_id']`
+* `ENV['vantiv_sftp_password']`
+* `ENV['vantiv_sftp_path']`
+* `ENV['vantiv_sftp_username']`
+
+## Usage
+
+The `VantivSFTPReports::Fetch` class is used for actually getting reports. In a nutshell it takes information about the reports you're looking for, downloads the files, and parses the CSVs provided into [`CSV::Table`](https://ruby-doc.org/stdlib-2.2.7/libdoc/csv/rdoc/CSV/Table.html) objects. Each instance of `Fetch` can be loaded with a custom configuration, but if none is given will use the default global configuration.
+
+So, if you're supporting multiple logins you can use:
+
+```ruby
+fetch1 = VantivSFTPReports::Fetch.new(username: 'user1')
+fetch2 = VantivSFTPReports::Fetch.new(username: 'user2')
+```
+
+A fetch object will pull down reports by name, date, and organization ID. So, if you wanted to get a report named `Transactional_Detail_SessionByActivityDate` for the last 3 days for organization `1234` you could do the following:
+
+```ruby
+reports = VantivSFTPReports::Fetch.new.call(
+  'Transactional_Detail_SessionByActivityDate',
+  by_date: (Date.today - 2)..Date.today,
+  by_organization_id: '1234'
+)
+```
+
+If you're using a single configuration and don't need to anything particularly sophisticated, you can use the following abreviated method:
+
+```ruby
+reports = VantivSFTPReports.fetch(*args)
+```
+
+## A Specific Example
+
+Let's say I wanted to get the batch ID associated with a transaction ID from yesterday:
+
+```ruby
+report = VantivSFTPReports.first(
+  'Transactional_Detail_SessionByActivityDate',
+  by_date: (Date.today - 1)
+) # returns only one report regardless of results
+
+report.each_with_object({}) { |r, h| h[r[:vantiv_payment_id]] = r[:batch_id] }
+```
+
+## Testing with Sandbox or Prelive
+
+So far as I know, there is no way to test the reporting features with the sandbox. There are no sample reports. Furthermore, while this **might** be possible using Prelive, the customer service team I've dealt with is still "looking into that™".
+
+## What about the actual APIs that do exist?
+
+I have a [low dependency gem for that](https://github.com/binarypaladin/vanitv_lite) that doesn't force you to use ActiveSupport and is XML library agnostic.
+
+Or, you can always use [the official one](https://github.com/Vantiv/litle-sdk-for-ruby).
+
+## Contributing
+
+### Issue Guidelines
+
+GitHub issues are for bugs, not support. As of right now, there is no official support for this gem. You can try reaching out to the author, [Joshua Hansen](mailto:joshua@epicbanality.com?subject=VantivSFTPReports) if you're really stuck, but there's a pretty high chance that won't go anywhere at the moment or you'll get a response like this:
+
+> Hi. I'm super busy. It's nothing personal. Check the README first if you haven't already. If you don 't find your answer there, it's time to start reading the source. Have fun! Let me know if I screwed something up.
+
+### Pull Request Guidelines
+
+* Include tests with your PRs.
+* Run `rubocop` to ensure your style fits with the rest of the project.
+
+## License
+
+See [`LICENSE.txt`](LICENSE.txt).
+
+## What if I stop maintaining this?
+
+The codebase isn't huge. If you opt to rely on this code and I die/get bored/find enlightenment you should be able to maintain it. Sadly, that's the only guarantee at the moment!

data/lib/vantiv_sftp_reports/config.rb

@@ -0,0 +1,36 @@
+# frozen-string-literal: true
+
+module VantivSFTPReports
+  class Config
+    def self.with_obj(config)
+      config.is_a?(self) ? config : new(config)
+    end
+
+    def initialize(**opts)
+      @opts = opts.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      @sftp_opts = opts.reject { |k, _| %i[host organization_id path username].include?(k) }
+      defaults!
+    end
+
+    def opts
+      @opts.dup
+    end
+
+    def sftp_opts
+      @sftp_opts.dup
+    end
+
+    def with(**opts)
+      self.class.new(@opts.merge(opts))
+    end
+
+    %i[host organization_id password path username].each { |o| define_method(o) { @opts[o] } }
+
+    private
+
+    def defaults!
+      @opts[:host] ||= 'reports.iq.vantivcnp.com'
+      @opts[:path] ||= 'reports'
+    end
+  end
+end

data/lib/vantiv_sftp_reports/fetch.rb

@@ -0,0 +1,80 @@
+# frozen-string-literal: true
+
+require 'csv'
+require 'vantiv_sftp_reports/config'
+
+module VantivSFTPReports
+  class Fetch
+    class << self
+      %i[call download list].each do |m|
+        define_method(m) { |*args| new.__send__(m, *args) }
+      end
+    end
+
+    attr_reader :config
+
+    def initialize(config = VantivSFTPReports.default_config)
+      @config = Config.with_obj(config)
+    end
+
+    def call(*args)
+      download(*list(*args)).each_with_object({}) do |(filename, csv), h|
+        next unless csv
+        h[filename] = parse_report(csv)
+      end
+    end
+
+    def download(*filenames)
+      {}.tap do |h|
+        session do |sftp|
+          filenames.each { |fname| h[fname] = sftp.download!("#{path}/#{fname}") }
+        end
+      end
+    end
+
+    def first(*args)
+      (report = call(*args).first) && report.last
+    end
+
+    def list(pattern = nil, by_date: Date.today, by_organization_id: organization_id)
+      [].tap do |list|
+        session { |sftp| sftp.dir.foreach(path) { |e| list << e.name unless e.name[0] == '.' } }
+        filter_by_date!(list, by_date) if by_date
+        filter_by_organization_id!(list, by_organization_id) if organization_id
+        filter_by_pattern!(list, pattern) if pattern
+      end
+    end
+
+    def session
+      Net::SFTP.start(config.host, config.username, config.sftp_opts) { |sftp| yield(sftp) }
+    end
+
+    %i[organization_id path].each { |m| define_method(m) { config.__send__(m) } }
+
+    private
+
+    def date_str(obj)
+      obj.respond_to?(:strftime) ? obj.strftime('%Y%m%d') : obj.to_s
+    end
+
+    def filter_by_date!(list, dates)
+      list.select! { |r| r =~ /_(#{Array(dates).map { |d| date_str(d) }.join('|')})\.CSV\Z/ }
+    end
+
+    def filter_by_organization_id!(list, organization_id)
+      list.select! { |r| r =~ /_#{organization_id}_/ }
+    end
+
+    def filter_by_pattern!(list, pattern)
+      pattern = pattern.is_a?(Regexp) ? pattern : /^#{pattern}/i
+      list.select! { |r| r =~ pattern }
+    end
+
+    # To avoid numberic conversion, IDs from Vantiv are prefixed with a single
+    # quote. Since no conversions are done here, this is nothing but an
+    # inconvenience and is stripped.
+    def parse_report(str)
+      CSV.parse(str.gsub(/'(\d{18})/, '\1'), headers: true, header_converters: :symbol)
+    end
+  end
+end

data/lib/vantiv_sftp_reports/version.rb

@@ -0,0 +1,12 @@
+# frozen-string-literal: true
+
+module VantivSFTPReports
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+  VERSION = [MAJOR, MINOR, TINY].join('.').freeze
+
+  def self.version
+    VERSION
+  end
+end

data/lib/vantiv_sftp_reports.rb

@@ -0,0 +1,35 @@
+# frozen-string-literal: true
+
+require 'csv'
+require 'net/sftp'
+require 'vantiv_sftp_reports/config'
+require 'vantiv_sftp_reports/fetch'
+require 'vantiv_sftp_reports/version'
+
+module VantivSFTPReports
+  class << self
+    attr_reader :default_config, :default_fetch
+
+    def call(*args)
+      default_fetch.(*args)
+    end
+    alias fetch call
+
+    def configure(config = env_config)
+      @default_config = Config.with_obj(config)
+      @default_fetch = Fetch.new(@default_config)
+    end
+
+    def env_config
+      ENV.each_with_object({}) do |(k, v), h|
+        next unless k.index('vantiv_sftp_') == 0
+        h[k[12..-1].to_sym] = v
+      end
+    end
+
+    def first(*args)
+      default_fetch.first(*args)
+    end
+  end
+  configure
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: vantiv_sftp_reports
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua
+- Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+description: Report Processing for WorldPay/Vantiv/LitleOnline
+email:
+- joshua@epicbanality.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/vantiv_sftp_reports.rb
+- lib/vantiv_sftp_reports/config.rb
+- lib/vantiv_sftp_reports/fetch.rb
+- lib/vantiv_sftp_reports/version.rb
+homepage: https://github.com/binarypaladin/vantiv_sftp_reports
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.4
+signing_key: 
+specification_version: 4
+summary: Report Processing for WorldPay/Vantiv/LitleOnline
+test_files: []