appcues_data_uploader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f37ccc95281d68b9a4f6dcd313edc31ad3731c8
+  data.tar.gz: b1290ef67cbcdb17896b5611967a8e1146f04502
+SHA512:
+  metadata.gz: 6352fbd7d9ded12a104dfc61e442bfa8ffb30ce7a7dc17cf7bfaed94a4906d279187c0d2542ed6db9673fddbd0dc61c616e841ce170c828309d9bc339706370f
+  data.tar.gz: 825cdd5adfc0a52489252346a3e78b6683ffd9d751ada29539cf44d5b9f43cd18610b0093faa53d42079102b47d6c5020ec4ec2c22c42fcb59d2e37255d2b8a7

data/bin/appcues-data-uploader

@@ -0,0 +1,4 @@
+#!/usr/bin/env -S ruby -Ilib
+require 'appcues_data_uploader'
+AppcuesDataUploader.main(ARGV)
+

data/lib/appcues_data_uploader.rb

@@ -0,0 +1,258 @@
+#!/usr/bin/env ruby
+#
+# Appcues Data Uploader
+#
+# Uploads CSV-formatted user profile data to the Appcues API.
+# Run `appcues-data-uploader -h` for more information.
+#
+# Homepage: https://github.com/appcues/data-uploader
+#
+# Copyright 2018, Appcues, Inc.
+#
+# Released under the MIT License, whose text is available at:
+# https://opensource.org/licenses/MIT
+
+require 'net/http'
+require 'csv'
+require 'json'
+require 'optparse'
+require 'appcues_data_uploader/version'
+
+class AppcuesDataUploader
+  UserActivity = Struct.new(:account_id, :user_id, :profile_update, :events)
+  UploadOpts = Struct.new(:account_id, :csv_filenames, :quiet, :dry_run)
+
+  attr_reader :opts
+
+  class << self
+    ## Handles command-line invocation.
+    def main(argv)
+      options = UploadOpts.new
+
+      option_parser = OptionParser.new do |opts|
+        opts.banner =  <<-EOT
+Usage: #{$0} [options] -a account_id [filename ...]
+
+Uploads profile data from one or more CSVs to the Appcues API.
+If no filename or a filename of '-' is given, STDIN is used.
+
+Each CSV should start with a row of header names, including one named something
+like "user ID". Other headers will be used verbatim as attribute names.
+
+Attribute values can be boolean ('true' or 'false'), 'null', numeric, or
+string-typed.
+
+For example, giving `appcues-data-uploader -a 999` the following CSV data:
+
+    user_id,first_name,has_posse,height_in_inches
+    123,Pete,false,68.5
+    456,André,true,88
+
+Will result in two profile updates being sent to the API:
+
+    {"account_id": "999", "user_id": "123", "profile_update": {"first_name": "Pete", "has_posse": false, "height_in_inches": 68.5}}
+    {"account_id": "999", "user_id": "456", "profile_update": {"first_name": "André", "has_posse": true, "height_in_inches": 88}}
+        EOT
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on('-a', '--account-id ACCOUNT_ID', 'Set Appcues account ID') do |account_id|
+          options.account_id = account_id
+        end
+
+        opts.on('-d', '--dry-run', 'Write requests to STDOUT instead of sending') do
+          options.dry_run = true
+        end
+
+        opts.on('-q', '--quiet', "Don't write debugging info to STDERR") do
+          options.quiet = true
+        end
+
+        opts.on('-v', '--version', "Print version information and exit") do
+          puts "appcues-data-uploader version #{VERSION} (#{VERSION_DATE})"
+          puts "See https://github.com/appcues/data-uploader for more information."
+          exit
+        end
+
+        opts.on('-h', '--help', 'Print this message and exit') do
+          puts opts
+          exit
+        end
+      end
+
+      csv_filenames = option_parser.parse(argv)
+      csv_filenames = ["-"] if csv_filenames == []
+      options.csv_filenames = csv_filenames
+
+      if !options.account_id
+        STDERR.puts "You must specify an account ID with the -a option."
+        exit 1
+      end
+
+      new(options).perform_uploads()
+    end
+  end
+
+  def initialize(init_opts)
+    @opts = init_opts.is_a?(UploadOpts) ? init_opts : UploadOpts.new(
+      init_opts[:account_id] || init_opts["account_id"],
+      init_opts[:csv_filenames] || init_opts["csv_filenames"],
+      init_opts[:quiet] || init_opts["quiet"],
+      init_opts[:dry_run] || init_opts["dry_run"],
+    )
+
+    if !opts.account_id
+      raise ArgumentError, "account_id is required but missing"
+    end
+
+    if !opts.csv_filenames
+      raise ArgumentError, "csv_filenames must be a list of filenames"
+    end
+  end
+
+  def perform_uploads
+    opts.csv_filenames.each do |filename|
+      upload_profile_csv(filename)
+    end
+  end
+
+private
+
+  ## Uploads the profile data in the given CSV to the Appcues API.
+  ##
+  ## The CSV should begin with a row of headers, and one of these headers
+  ## must be named something like `user_id` or `userId`.
+  ## Other header names are treated as attribute names.
+  ##
+  ## Numeric, boolean, and null values in this CSV will be converted to their
+  ## appropriate data type.
+  def upload_profile_csv(csv_filename)
+    display_filename = csv_filename == '-' ? "STDIN" : "'#{csv_filename}'"
+    input_fh = csv_filename == '-' ? STDIN : File.open(csv_filename, 'r')
+
+    debug "Uploading profiles from #{display_filename} for account #{opts.account_id}..."
+
+    user_id_column = nil
+    user_activities = []
+
+    CSV.new(input_fh, headers: true).each do |row|
+      row_hash = row.to_h
+
+      if !user_id_column
+        user_id_column = get_user_id_column(row_hash)
+      end
+
+      user_id = row_hash.delete(user_id_column)
+      profile_update = cast_data_types(row_hash)
+
+      user_activities << UserActivity.new(opts.account_id, user_id, profile_update, [])
+    end
+
+    input_fh.close
+
+    if opts.dry_run
+      user_activities.each do |ua|
+        puts JSON.dump(ua.to_h)
+      end
+    else
+      make_activity_requests(user_activities)
+    end
+
+    debug "Done processing #{display_filename}."
+  end
+
+  ## Applies the given UserActivity updates to the Appcues API.
+  ## Retries failed requests, indefinitely.
+  def make_activity_requests(user_activities)
+    failed_uas = []
+
+    user_activities.each do |ua|
+      resp = make_activity_request(ua)
+      if resp.code.to_i / 100 == 2
+        debug "Request for user_id #{ua.user_id} was successful"
+      else
+        debug "Request for user_id #{ua.user_id} failed with code #{resp.code} -- retrying later"
+        failed_uas << ua
+      end
+    end
+
+    if failed_uas.count > 0
+      debug "retrying #{failed_uas.count} requests."
+      make_activity_requests(failed_uas)
+    end
+  end
+
+  ## Returns a new profile_update hash where boolean and numeric values
+  ## are cast out of String format.  Leaves other values alone.
+  def cast_data_types(profile_update)
+    output = {}
+    profile_update.each do |key, value|
+      output[key] =
+        case value
+        when 'null'
+          nil
+        when 'true'
+          true
+        when 'false'
+          false
+        when /^ -? \d* \. \d+ (?: [eE] [+-]? \d+)? $/x  # float
+          value.to_f
+        when /^ -? \d+ $/x  # integer
+          value.to_i
+        else
+          value
+        end
+    end
+    output
+  end
+
+  ## Detects and returns the name used in the CSV header to identify user ID.
+  ## Raises an exception if we can't find it.
+  def get_user_id_column(row_hash)
+    row_hash.keys.each do |key|
+      canonical_key = key.gsub(/[^a-zA-Z]/, '').downcase
+      return key if canonical_key == 'userid'
+    end
+    raise ArgumentError, "couldn't detect user ID column"
+  end
+
+  ## Prints a message to STDERR unless we're in quiet mode.
+  def debug(msg)
+    STDERR.puts(msg) unless self.opts.quiet
+  end
+
+  ## Returns the base URL for the Appcues API.
+  def appcues_api_url
+    ENV['APPCUES_API_URL'] || "https://api.appcues.com"
+  end
+
+  ## Returns a URL for the given Appcues API UserActivity endpoint.
+  def activity_url(account_id, user_id)
+    "#{appcues_api_url}/v1/accounts/#{account_id}/users/#{user_id}/activity"
+  end
+
+  ## Makes a POST request to the Appcues API UserActivity endpoint,
+  ## returning the Net::HTTPResponse object.
+  def make_activity_request(user_activity)
+    url = activity_url(user_activity.account_id, user_activity.user_id)
+    post_request(url, {
+      "profile_update" => user_activity.profile_update,
+      "events" => user_activity.events
+    })
+  end
+
+  ## Makes a POST request to the given URL,
+  ## returning the Net::HTTPResponse object.
+  def post_request(url, data, headers = {})
+    uri = URI(url)
+    use_ssl = uri.scheme == 'https'
+    Net::HTTP.start(uri.host, uri.port, use_ssl: use_ssl) do |http|
+      req_headers = headers.merge({'Content-type' => 'application/json'})
+      req = Net::HTTP::Post.new(uri.request_uri, req_headers)
+      req.body = JSON.dump(data)
+      http.request(req)
+    end
+  end
+end
+

data/lib/appcues_data_uploader/version.rb

@@ -0,0 +1,4 @@
+class AppcuesDataUploader
+  VERSION = "0.1.0"
+  VERSION_DATE = "2018-11-08"
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: appcues_data_uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pete gamache
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: pete@gamache.org
+executables:
+- appcues-data-uploader
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/appcues-data-uploader
+- lib/appcues_data_uploader.rb
+- lib/appcues_data_uploader/version.rb
+homepage: https://github.com/appcues/data-uploader
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Upload CSVs of user profile data to the Appcues API
+test_files: []