teilashare 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abb4351dd7c047c4acefb060e5e2c52bc026c7c8ce1a798896d97c5cb19dabaf
+  data.tar.gz: 72e5f25e1ab0813313c16c790586f1ea0dae7575f1037db2698a44db979c4547
+SHA512:
+  metadata.gz: 2a96dfa2b30317efdf9e97cb6acad582110bc1e0a01be270dae400a17933ff6ffd1973597a122af8ddb33d5505ecf0d1bbcc14ec36aa9e00f55782e25bb053a0
+  data.tar.gz: 93568b6160b12d35cb4f1406841494945dc0f24a742886274bcf2899d3c5915bec4a6abd7f5e6d6c5e6b4dd1e9ebd828b2cbc371545e7b181116a747bf9b86e7

data/.github/workflows/checks.yml

@@ -0,0 +1,26 @@
+name: Tests and Linter
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 3.0.0
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        env:
+          TOKEN: rand-token-not-real
+          AFFILIATE_ID: 123456789
+          API_SECRET: very-secret-secret
+        run: bundle exec rspec
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/git 
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'spec/*'
+Layout/LineLength:
+  Max: 150
+Metrics/BlockLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shareasale.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Thomas Carney
+
+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,460 @@
+# Teilashare
+
+This is an *unofficial* client library for the ShareaSale affiliate reporting API. It does not include the publisher API or any other APIs at the moment. Please see below for the supported endpoints as well as a required and optional parameters on each endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teilashare'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install teilashare
+```
+
+## Usage
+
+Instantiate a client via:
+
+```ruby
+credentials = {
+  token: ENV['TOKEN'],
+  api_secret: ENV['API_SECRET'],
+  affiliate_id: ENV['affiliate_id']
+}
+
+client = Teilashare.new(credentials)
+```
+
+You can then request reports on this client via:
+
+```ruby
+result = client.today_stats(format: 'xml')
+```
+
+Please refer to the Teilashare documentation for required and optional parameters
+for your desired report. The default format is CSV, but you can request XML format or pipe formatted data (PSV?) via the format option.
+
+### Activity Details
+
+required params:
+- action
+- version
+- affiliateId
+- token
+- dateStart
+
+optional
+- dateEnd
+- merchantId
+- lockDate,
+- paidDate
+- sortCol
+- sortDir
+- XMLFormat
+- xml_format
+
+```ruby
+client.activity_details(
+  start_date: '07-31-2020',
+  end_date: '08-31-2020',
+  merchant_id: 234234234
+)
+```
+
+### Activity Summary
+required params:
+- action
+- version
+- affiliateId
+- token
+
+optional params
+-	merchantId	Merchant Id Value
+- filterCol	hits, sales, OR commissions
+-	filterSpan	month OR total
+-	filterValue	Number
+-	sortCol	hitsmonth, salesmonth, salestotal, commissionsmonth, commissionstotal, organization
+- sortDir	asc or desc
+-	XMLFormat	0 or 1
+- format	pipe, xml, csv
+
+```ruby
+client.activity_summary(sort_col: 'salestotal', sort_dir: 'asc')
+```
+
+### Merchant Timespan Report
+required params:
+- dateStart
+
+optional params
+-	dateEnd	mm/dd/yyyy
+-	merchantId	Merchant Id Value
+-	sortCol	hits, grosssales, reversals, netsales, sales, mcredits, commissions
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+- format	pipe, xml, csv
+
+```ruby
+csv = client.merchant_timespan(date_start: '12/31/2020')
+```
+
+### Today's Stats
+required params
+- none
+
+optional params
+- 	distinctlink	1 or 0
+- sortCol	commissions, hits, sales
+-	sortDir	asc or desc
+- XMLFormat	0 or 1
+- format	pipe, xml, csv
+
+
+```ruby
+client.today_stats(
+  distinct_link: 1,
+  sort_col: 'commissions',
+  sort_dir: 'asc'
+)
+```
+
+### Monthly Summary
+required params
+-	dateMonth	mm/dd/yyyy
+
+optional params
+-	sortCol	merchantId, commissionsum, salesum
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+
+```ruby
+client.monthly_summary(
+  date_month: '12/01/2020',
+  sort_col: 'commissions',
+  sort_dir: 'asc'
+)
+```
+
+
+### Void Trail
+required params
+-	dateStart	mm/dd/yyyy
+
+optional params
+-	dateEnd	mm/dd/yyyy
+-	merchantID	Valid merchant ID.
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.void_trail(
+  date_start: '12/01/2020'
+)
+```
+
+### Traffic
+required params
+- dateStart
+
+optional params
+-	dateEnd	mm/dd/yyyy
+-	groupBy	bannerID or afftrack
+-	bannerID	Valid bannerID value. MerchantID must also be specified when using this parameter. BannerType must also be specified when using this parameter.
+-	afftrack	Valid afftrack value. MerchantID must also be specified when using this parameter.
+-	sortCol	hits, commissions, numberOfSales, numberOfVoids, conversion, epc
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+conditionally required
+-	bannerType	Click for values.
+-	merchantId	Valid Merchant Id
+
+```ruby
+client.traffic(
+  date_start: '12/01/2020'
+)
+```
+
+### API Token Count
+required params
+- n/a
+
+optional params
+- XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.api_token_count
+
+```
+
+
+### Products
+required params
+-	keyword	Word or Phrase
+
+optional params
+-	merchantId	Valid Merchant Id
+-	excludeMerchants	List of Merchant Id
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.products(
+  keyword: 'wool hats'
+)
+```
+
+### Invalid Links
+required params
+- n/a
+
+optional params
+-	merchantIdList	Comma delimited list of valid Merchant IDs
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.invalid_links(
+  merchantIdList: 12342,1234234,234234
+)
+```
+
+### Order Inquiry
+required params
+-	merchantId	Valid Merchant Id
+-	orderDate	mm/dd/yyyy
+-	orderNumber	Merchant's order number (alpha-numeric)
+
+optional params
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.order_inquiry(
+  merchant_id: 1234,
+  order_date: '12/31/2020',
+  order_number: abcdef234
+)
+```
+
+### Merchant Datafeeds
+required params
+- n/a
+
+optional params
+-	blnMemberOf	1 or 0
+-	blnNotMemberOf	1 or 0
+-	category	Click for values.
+-	updateDate	mm/dd/yyyy
+-	keyword	word or phrase
+-	sortCol	7DayEpc, 30DayEpc, saleCommissionAmount, productcount, datafeedupdated, organization
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.merchant_datafeed
+```
+
+### Coupon Deals
+required params
+- n/a
+
+optional params
+-	current	1
+-	modifiedSince	mm/dd/yyyy
+-	merchantId	Valid Merchant Id number.
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.coupon_deal
+```
+
+### Merchant Status
+required params
+- n/a
+
+optional params
+-	merchantId	List of Merchant Id
+-	category	Click for values.
+-	programStatus	online, offline, lowfunds, onlineNotLowFunds
+-	keyword	word or phrase
+-	sortCol	organization, salescommission, hitcommission, leadcommission, merchantStatus, category, applydate
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.merchant_status
+```
+
+### Merchant Creatives
+required params
+- n/a
+
+optional params
+-	sortCol	bannerId, bannerHeight, bannerWidth, category, type
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+conditional params
+-	merchantId	Valid Merchant Id. Required unless modifiedDate is present.
+-	modifiedDate	Valid date no more than 31 days in the past. Required unless merchantID is present. Format MM/DD/YYYY
+
+
+```ruby
+client.merchant_creative
+```
+
+
+### Merchant Gift Cards
+required params
+- n/a
+
+optional params
+-	sortCol	giftcardId, publishdate, title, merchantId, organization
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.merchant_gift_cards
+```
+
+### Edit Trail
+required params
+-	dateStart	mm/dd/yyyy
+
+optional params
+-	dateEnd	mm/dd/yyyy
+-	merchantID	Valid merchant ID.
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.edit_trail
+```
+
+### Payment Summary
+required params
+-	paymentDate	mm/dd/yyyy must be 20th of month in the last 12 months
+
+optional params
+
+-	sortCol	organization, merchantID, commissions, numberofsales
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.payment_summary
+```
+
+### Merchant Search
+required params
+- n/a
+
+optional params
+-	Keyword	Word or Phrase
+-	Category	Click for values.
+-	activatedSince	mm/dd/yyyy
+-	-tjoined	1 or 0
+-	datafeed	1 or 0
+-	autodeposit	1 or 0
+-	autoapprove	1 or 0
+-	epc	Any number
+-	avgsale	Any number
+-	reversalrate	Any number
+-	cookielength	Any Number
+-	sortCol	a7dayepc,a30dayepc,salecommission,leadcommission,hitcommission,organization,organization,startdate,cookielength,powerrank,relationshipID
+-	sortDir	asc or desc
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.merchant_search(keyword: 'wool')
+```
+
+### Merchant Search by Product
+required params
+-	keyword	Word or Phrase
+
+optional params
+-	-tjoined	1 or 0
+-	merchantId	Valid Merchant Id
+-	excludeMerchants	List of Merchant Id
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.merchant_search_by_product(keyword: 'shoes')
+```
+
+### Ledger Report
+required params
+- n/a
+
+optional params
+-	dateStart	mm/dd/yyyy
+-	dateEnd	mm/dd/yyyy
+-	includeOrderDetails	0 or 1
+-	includeMerchantDetails	0 or 1
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.ledger_report
+```
+
+### Balance Inquiry
+required params
+- n/a
+
+optional params
+-	XMLFormat	0 or 1
+-	format	pipe, xml, csv
+
+```ruby
+client.balance_inquiry
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+If you want to record API requests, you'll need to export environment variables in the format:
+
+```bash
+export TOKEN=abc
+export AFFILIATE_ID=123456789
+export API_SECRET=def
+export API_VERSION=2.3
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tommycarney/partagerasale.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'teilashare'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teilashare/api_resource.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Teilashare
+  class APIResource
+    PATH = '/x.cfm'
+    HOST = 'api.shareasale.com'
+
+    attr_reader :client, :opts
+
+    def initialize(client, opts = {})
+      @client = client
+      @opts = default_opts.merge(opts).with_indifferent_access
+      validate_required_opts
+    end
+
+    def call
+      response = Request.new(client, self).call
+      # the API returns 200 OK on invalid authentication GET requests, so need to parse error from body instead
+      raise Errors::InvalidRequestError, response.body if response.body.match?(/\AInvalid Request/)
+
+      parser.parse(response.body)
+    end
+
+    def action_verb
+      raise NotImplementedError, 'please define in a subclass'
+    end
+
+    private
+
+    def validate_required_opts
+      missing_opts = []
+      required_opts.each { |opt| missing_opts << opt if opts[opt].nil? }
+      return if missing_opts.empty?
+
+      raise ArgumentError, "#{missing_opts.join(', ')} are missing"
+    end
+
+    def required_opts
+      []
+    end
+
+    def parser
+      case @opts[:format]
+      when 'csv'
+        Parsers::CsvParser
+      when 'xml'
+        Parsers::XmlParser
+      when 'pipe'
+        Parsers::PipeParser
+      else
+        raise Teilashare::Errors::UnsupportedFormat, "Format: #{@opts[:format]} not supported."
+      end
+    end
+
+    def default_opts
+      {
+        format: 'csv'
+      }
+    end
+  end
+end

data/lib/teilashare/authentication.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Teilashare
+  class Authentication
+    attr_reader :client, :action_verb
+
+    def initialize(client, action_verb)
+      @client = client
+      @action_verb = action_verb
+    end
+
+    def hash
+      Digest::SHA256.hexdigest(authentication_string).upcase
+    end
+
+    def date_string
+      date.strftime('%a, %d %b %Y %H:%M:%S GMT')
+    end
+
+    private
+
+    def authentication_string
+      "#{client.token}:#{date_string}:#{action_verb}:#{client.api_secret}"
+    end
+
+    def date
+      @date ||= Time.now.utc
+    end
+  end
+end