tap-clutch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b98dba7a611e56ae431cb914fb2bd85d57030f6c
+  data.tar.gz: aaf74f13fca725477914f512df762bf2f11cc942
+SHA512:
+  metadata.gz: fe07a0c3165b12aaddd0922463434d4a90a9145acd0bb9cc4829ad27684ee33511769ae0f0664386b5756b0994425e68fb75f3e98d1254e5c269a44c140fad13
+  data.tar.gz: f60047ee073300619cb378b39b6f44d4e8077c8d01db1ae36923b99af092f400123f7223f69c8ae6b18eb131c6dfacfa74e6347956b0bc2eda40c8f1f01986ae

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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,31 @@
+tap-clutch
+==========
+
+## A [singer.io](http://singer.io) tap to extract data from [Clutch](http://clutch.com) and load into any Singer target, like Stitch or CSV
+
+# Configuration
+
+    {
+      "api_key": "api_key",
+      "api_secret": "secret",
+      "api_base": "https://api.clutch.com/merchant/",
+      "brand": "clutch_brand",
+      "location": "clutch_location",
+      "card_set_id": "clutch_card_set_id",
+      "terminal": "clutch_terminal",
+      "username": "clutch_portal_user_id",
+      "password": "clutch_portal_password"
+    }
+
+# Usage (with [Stitch target](https://github.com/singer-io/target-stitch))
+
+    > bundle exec tap-clutch
+    Usage: tap-clutch [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-clutch
+    > bundle exec tap-clutch -c config.clutch.json -s state.json | target-stitch --config config.stitch.json | tail -1 > state.new.json

data/bin/tap-clutch

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+
+Bundler.require
+
+require_relative '../lib/runner'
+
+TapClutch::Runner.new(ARGV, stream: $stdout).perform

data/lib/client.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'clutch'
+require 'faraday-cookie_jar'
+require 'faraday_middleware'
+require 'active_support/time'
+
+require_relative 'models/card'
+
+module TapClutch
+  LIMIT = 25
+  KEYS = %i[
+    api_key
+    api_secret
+    api_base
+    brand
+    location
+    terminal
+    verbose
+    state
+    stream
+    username
+    password
+  ].freeze
+
+  # rubocop:disable Metrics/BlockLength
+  Client = Struct.new(*KEYS) do
+    def initialize(**kwargs)
+      super(*members.map { |k| kwargs[k] })
+      Clutch.configure do |c|
+        c.clutch_api_key = api_key
+        c.clutch_api_secret = api_secret
+        c.clutch_api_base = api_base
+        c.clutch_brand = brand
+        c.clutch_location = location
+        c.clutch_terminal = terminal
+      end
+    end
+
+    def faraday
+      @faraday ||= build_faraday.tap do |f|
+        f.post '/authenticate/userpass', username: username, password: password
+      end
+    end
+
+    def build_faraday
+      # TODO: Extract clutch portal URL to config.json
+      Faraday.new(url: 'https://portal.clutch.com') do |builder|
+        builder.use :cookie_jar
+        builder.request :url_encoded
+        builder.response :json
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def process(start_date = '2018-01-11')
+      start_date = Date.parse(start_date) if start_date.is_a? String
+      (start_date..Time.current.getlocal.to_date).each do |date|
+        process_date date
+      end
+    end
+
+    def output(hash)
+      stream.puts JSON.generate(hash)
+    end
+
+    private
+
+    def process_date(date)
+      response = search(date)
+      card_numbers = response.body['lookerData']['data'].map { |x| x[2] }.uniq
+      cards = card_numbers.map { |n| Models::Card.fetch(n) }
+      output_records Models::Card, cards
+      output_state date
+    end
+
+    def search(date)
+      faraday.post do |req|
+        req.url  '/transactions/search.json'
+        req.body = {
+          searchType: 'processed',
+          brandId: 7532,
+          groupId: 7533,
+          transactionTypes: '3,5,9',
+          currentRange: 'Custom Range',
+          timeFrom: '00:00:00 am',
+          timeTo: '00:00:00 am',
+          dateFrom: date.strftime('%Y-%m-%d'),
+          dateTo: (date + 1).strftime('%Y-%m-%d')
+        }
+      end
+    end
+
+    def output_records(_model, records)
+      records.compact.each do |record|
+        record.records.flatten.each do |model_record|
+          output model_record
+        end
+      end
+    end
+
+    def output_state(date)
+      output type: :STATE, value: { start_date: date }
+    end
+
+    def get(model, offset)
+      model.fetch offset
+    end
+  end
+end

data/lib/models/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../schema'
+
+module TapClutch
+  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.stream
+        raise 'Implement #stream in a subclass'
+      end
+
+      def self.key_property
+        :id
+      end
+
+      def self.schema(&block)
+        @schema ||= ::TapClutch::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.compact.flat_map(&:records)
+      end
+    end
+  end
+end

data/lib/models/card.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'transaction'
+
+module TapClutch
+  module Models
+    # Models a Clutch Card
+    class Card < Base
+      def self.key_property
+        :cardNumber
+      end
+
+      def self.stream
+        'cards'
+      end
+
+      schema do
+        string :cardNumber, :not_null
+        string :cardSetId
+        array :balances
+      end
+
+      def self.fetch(card_number)
+        response = Clutch.client.post(
+          '/search',
+          limit: 1,
+          offset: 0,
+          filters: {
+            cardNumber: card_number
+          },
+          returnFields: {
+            balances: true,
+            activationDate: true
+          }
+        )
+
+        new(response.cards.first) if response.cards.first
+      end
+
+      def extra_records
+        Transaction.history(data.cardNumber)
+      end
+    end
+  end
+end

data/lib/models/transaction.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'byebug'
+require 'active_support/time'
+
+module TapClutch
+  module Models
+    # Models a Clutch Transaction
+    class Transaction < Base
+      def self.key_property
+        :transactionId
+      end
+
+      def self.stream
+        'transactions'
+      end
+
+      def self.history(card_number)
+        response = Clutch.client.post(
+          '/cardHistory',
+          limit: 100,
+          offset: 0,
+          cardNumber: card_number,
+          restrictTransactionTypes: %w[ALLOCATE UPDATE_BALANCE]
+        )
+
+        response.transactions.map do |transaction|
+          new(transaction.merge(cardNumber: card_number))
+        end
+      end
+
+      schema do
+        string :transactionId, :not_null
+        string :cardNumber, :not_null
+        string :requestRef
+        string :callType
+        boolean :isLegacy
+        string :location
+        string :transactionTime
+        array :balanceUpdates
+      end
+
+      def transform
+        Time.zone = Time.now.zone
+
+        super.tap do |data|
+          data.merge! 'transactionTime' =>
+            Time.zone.at(data['transactionTime'] / 1000)
+        end
+      end
+    end
+  end
+end

data/lib/runner.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+require 'optparse'
+
+require_relative 'client'
+require_relative 'schema'
+require_relative 'models/base'
+require_relative 'models/transaction'
+
+module TapClutch
+  # Kicks off tap-clutch 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
+      client.process state['start_date']
+    end
+
+    def config
+      @config ||= read_json(config_filename)
+    end
+
+    def state
+      @state ||= read_json(state_filename)
+    end
+
+    private
+
+    def output_schemata
+      TapClutch::Models::Base.subclasses.each do |model|
+        client.output model.schema
+      end
+    end
+
+    # rubocop: disable Metrics/AbcSize
+    def client
+      @client ||= TapClutch::Client.new(
+        api_key: config['api_key'],
+        api_secret: config['api_secret'],
+        api_base: config['api_base'],
+        brand: config['brand'],
+        location: config['location'],
+        terminal: config['terminal'],
+        username: config['username'],
+        password: config['password'],
+        verbose: verbose,
+        state: Concurrent::Hash.new.merge!(state),
+        stream: stream
+      )
+    end
+    # rubocop: enable Metrics/AbcSize
+
+    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,66 @@
+
+# frozen_string_literal: true
+
+module TapClutch
+  # 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
+          boolean
+        ].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 boolean].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_clutch/version.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: tap-clutch
+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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: clutch-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: Stream Clutch records to a Singer target, such as Stitch
+email: joelind@gmail.com
+executables:
+- tap-clutch
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tap-clutch
+- lib/client.rb
+- lib/models/base.rb
+- lib/models/card.rb
+- lib/models/transaction.rb
+- lib/runner.rb
+- lib/schema.rb
+- lib/tap_clutch/version.rb
+homepage: https://github.com/Follain/tap-clutch
+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 Clutch Loyalty
+test_files: []