tap-rep 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97ad289534c117812255b709866eaedb3c1a632e
+  data.tar.gz: 1bb29d8b7e8296728ed5233eb518b638ed0b8768
+SHA512:
+  metadata.gz: e28a7a36cd99c18faa3a99ffd007bd52758ea23c050f81b26e9881dabc515f04b67b1b90bac514819bf7c1c3c1fffd68701e3cc8bf025f31d2468d1fa29b872d
+  data.tar.gz: 86d94fe2f88ceded233916c5db61a42dd6fa56858a979a6c2dbacfe06aa3965c8dbdb4dd9e11a03768cf75fad0469e23448a0a2ba0bcb03905e145c9ccfc4add

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 follain
+
+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,23 @@
+tap-rep
+========
+
+## A [singer.io](http://singer.io) tap to extract data from [Rep](http://rep.ai) and load into any Singer target, like Stitch or CSV
+
+# Configuration
+
+    {
+      "token":"bearer-token-from-rep"
+    }
+
+# Usage (with [Stitch target](https://github.com/singer-io/target-stitch))
+
+    > bundle exec tap-rep
+    Usage: tap-rep [options]
+        -c, --config config_file         Set config file (json)
+        -s, --state state_file           Set state file (json)
+        -h, --help                       Displays help
+        -v, --verbose                    Enables verbose logging to STDERR
+
+    > pip install target-stitch
+    > gem install tap-rep
+    > bundle exec tap-rep -c config.rep.json -s state.json | target-stitch --config config.stitch.json | tail -1 > state.new.json

data/bin/tap-rep

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+
+Bundler.require
+
+require 'concurrent'
+require 'optparse'
+
+require_relative '../lib/client'
+require_relative '../lib/schema'
+require_relative '../lib/models/base'
+require_relative '../lib/models/session'
+
+config_file = nil
+state_file = nil
+verbose = false
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+  opts.on('-c', '--config config_file', 'Set config file (json)') do |config|
+    config_file = config
+  end
+
+  opts.on('-s', '--state state_file', 'Set state file (json)') do |state|
+    state_file = state
+  end
+
+  opts.on('-h', '--help', 'Displays help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--verbose', 'Enables verbose logging to STDERR') do
+    verbose = true
+  end
+end
+
+parser.parse!
+
+if config_file.nil?
+  puts parser
+  exit
+end
+
+config = JSON.parse(File.read(config_file))
+
+state = {}
+if state_file
+  state = JSON.parse(File.read(state_file))
+end
+
+
+client = TapRep::Client.new(
+  config['token'],
+  verbose,
+  Concurrent::Hash.new.merge!(state),
+  $stdout
+)
+
+TapRep::Models::Base.subclasses.each do |model|
+  client.output model.schema
+end
+
+TapRep::Models::Base.subclasses.each do |model|
+  client.process model
+end

data/lib/client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+
+module TapRep
+  DEFAULT_START_TIME = '0001-01-01T00:00:00+00:00'
+  LIMIT = 50
+  BASE_URL = 'https://app.rep.ai'
+
+  # rubocop:disable Metrics/BlockLength
+  Client = Struct.new(:token, :verbose, :state, :stream) do
+    def initialize(**kwargs)
+      super(*members.map { |k| kwargs[k] })
+    end
+
+    def process(model)
+      records = get(model)
+      return unless records.any?
+
+      output_records model, records
+      output_state model, records.last['end_time']
+      process model
+    end
+
+    def output(hash)
+      stream.puts JSON.generate(hash)
+    end
+
+    private
+
+    def output_records(model, records)
+      records.each do |record|
+        model.new(record, self).records.flatten.each do |model_record|
+          output model_record
+        end
+      end
+    end
+
+    def output_state(model, value)
+      state[model.stream] = value
+      output type: :STATE, value: state
+    end
+
+    def get(model)
+      start_time = state[model.stream] || DEFAULT_START_TIME
+
+      Array(
+        connection.get(
+          "/api/v1.0/reporting/#{model.path}",
+          start_time: start_time,
+          limit: LIMIT
+        ).body
+      )
+    end
+
+    def connection
+      @connection ||= Faraday::Connection.new do |conn|
+        conn.authorization :Bearer, token
+        conn.headers['Accept-Encoding'] = 'application/json'
+        conn.response :json
+        conn.url_prefix = BASE_URL
+        conn.response :logger, ::Logger.new(STDERR), bodies: true if verbose
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/models/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require_relative '../schema'
+
+module TapRep
+  module Models
+    Base = Struct.new(:data, :client) do # rubocop:disable Metrics/BlockLength
+      def self.subclasses
+        ObjectSpace.each_object(Class).select { |klass| klass < self }
+      end
+
+      def self.path
+        name.demodulize.tableize
+      end
+
+      def self.stream
+        name.demodulize.tableize
+      end
+
+      def self.key_property
+        :id
+      end
+
+      def self.schema(&block)
+        @schema ||= ::TapRep::Schema.new(stream, key_property)
+        @schema.instance_eval(&block) if block_given?
+        @schema.to_hash
+      end
+
+      def transform
+        data.dup
+      end
+
+      def base_record
+        {
+          type: 'RECORD',
+          stream: self.class.stream,
+          record: transform
+        }
+      end
+
+      def extra_records
+        []
+      end
+
+      def records
+        [base_record] + extra_records.map(&:records)
+      end
+    end
+  end
+end

data/lib/models/session.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module TapRep
+  module Models
+    # Models a Rep Session
+    class Session < Base
+      def self.key_property
+        :encrypted_id
+      end
+
+      schema do
+        string :encrypted_id, :not_null
+        datetime :first_customer_message_at
+        datetime :end_time
+        number :duration
+        string :responder
+        datetime :start_time
+        string :channel_name
+        object :customer
+        string :channel_type
+        array :categories
+        string :notes
+        datetime :first_agent_message_at
+        number :time_to_first_response
+      end
+    end
+  end
+end

data/lib/runner.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+require 'optparse'
+
+require_relative 'client'
+require_relative 'schema'
+require_relative 'models/base'
+require_relative 'models/session'
+
+module TapRep
+  # Kicks off tap-rep process
+  class Runner
+    attr_reader :config_filename
+    attr_reader :state_filename
+    attr_reader :stream
+    attr_reader :verbose
+
+    def initialize(argv, stream: $stderr, config: nil, state: nil)
+      @stream = stream
+      @config = config
+      @state = state
+      parser.parse! argv
+    end
+
+    def perform
+      return stream.puts(parser) if config.keys.empty?
+      output_schemata
+      process_models
+    end
+
+    def config
+      @config ||= read_json(config_filename)
+    end
+
+    def state
+      @state ||= read_json(state_filename)
+    end
+
+    private
+
+    def output_schemata
+      TapRep::Models::Base.subclasses.each do |model|
+        client.output model.schema
+      end
+    end
+
+    def process_models
+      TapRep::Models::Base.subclasses.each do |model|
+        client.process model
+      end
+    end
+
+    def client
+      @client ||= TapRep::Client.new(
+        token: config['token'],
+        verbose: verbose,
+        state: Concurrent::Hash.new.merge!(state_minus_3_days),
+        stream: stream
+      )
+    end
+
+    # Per Rep, include a "buffer" when we kick off our process
+    # In other words, end_time != session modification time. As a result, just
+    # maintaining a high watermark has the potential to miss certain sessions,
+    # and the probability of missing sessions increases if there's a big gap
+    # between the time of last message in the session and the time it is closed
+    # out by an agent (like, on weekends).
+    #
+    # For example, if you most recently queried all sessions up until time T1,
+    # then set start_time to T1 - 3 days on the next run (and dedupe sessions
+    # based on encrypted_id, which is guaranteed to be unique). This should
+    # account for sessions that happened over the weekend, etc.
+    def state_minus_3_days
+      return state unless state['sessions']
+      state.merge(
+        'sessions' => DateTime.parse(state['sessions']).prev_day(3).iso8601
+      )
+    end
+
+    def read_json(filename)
+      return JSON.parse(File.read(filename)) if filename
+      {}
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+        opts.on('-c', '--config filename', 'Set config file (json)') do |config|
+          @config_filename = config
+        end
+
+        opts.on('-s', '--state filename', 'Set state file (json)') do |state|
+          @state_filename = state
+        end
+
+        opts.on('-v', '--verbose', 'Enables verbose logging to STDERR') do
+          @verbose = true
+        end
+      end
+    end
+  end
+end

data/lib/schema.rb

@@ -0,0 +1,65 @@
+
+# frozen_string_literal: true
+
+module TapRep
+  # Models a JSON Schema required for Singer taps
+  class Schema
+    attr_reader :stream, :key_property
+
+    def initialize(stream, key_property)
+      @stream = stream
+      @key_property = key_property
+    end
+
+    # Models JSON Schema types
+    class Types
+      def self.method_missing(method, *args)
+        return super unless %I[
+          array
+          number
+          object
+          string
+        ].include?(method)
+
+        types = [method.to_sym]
+        types << :null unless args.include?(:not_null)
+
+        {
+          type: types.one? ? types.first : types
+        }.tap do |hash|
+          hash[:format] = 'date-time' if args.include?(:datetime)
+        end
+      end
+
+      def self.respond_to_missing?(_method, *_args)
+        true
+      end
+
+      def self.datetime(*args)
+        args << :datetime
+        string(*args)
+      end
+    end
+
+    %i[string number array object datetime].each do |type|
+      define_method type do |name, *options|
+        properties[name.to_sym] = Types.send(type, *options)
+      end
+    end
+
+    def properties
+      @properties ||= {}
+    end
+
+    def to_hash
+      {
+        type: :SCHEMA,
+        stream: stream,
+        key_properties: [key_property],
+        schema: {
+          properties: properties
+        }
+      }
+    end
+  end
+end

data/lib/tap_rep/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TapRep
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: tap-rep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Lind
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+description: Stream Rep records to a Singer target, such as Stitch
+email: joelind@gmail.com
+executables:
+- tap-rep
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tap-rep
+- lib/client.rb
+- lib/models/base.rb
+- lib/models/session.rb
+- lib/runner.rb
+- lib/schema.rb
+- lib/tap_rep/version.rb
+homepage: https://github.com/Follain/tap-rep
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Singer.io tap for Rep POS
+test_files: []