workarea-listrak 5.0.2 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5aaea07505fcf5a5d98d1cdd97fd87c078fd158e0b328ee52988bb205b9e237
-  data.tar.gz: 6841e30c1dbe474eea5e8644656621d1992c55bc34e2c43d30406e2e15576023
+  metadata.gz: adc6b2b9f326e598e599a6051a0d31a331c07991160fe644ac56bdf223ebf874
+  data.tar.gz: af9c49ae07e17142cd958332ad3eb87b23e6c0be4c60ced7c071b77830cfe972
 SHA512:
-  metadata.gz: 345c9b02dfcee01da5820c6774548213c6d605f731daf217d5f88b8623d98209f15e3e9e3f7680ce274260363a812093ec64d847fc167addafca1383c6364200
-  data.tar.gz: 27a5b2648753cde1f0a7416d0a3412d7e0ee032a623c49af15a0c72c6e4bc6530fe60f46d5b9c28ae8b2c46f4a538394e607e87adbedf62f84622371fed6b024
+  metadata.gz: 4aeeb4a36e112aba784ae1653ca47e1af635017ebe24fde80636f7ba208f86c6bdb99b3878c52ff9eae3fcbd8efe63d3c7c716753239ba77b82b51dc8ed6c27f
+  data.tar.gz: 3b887af7e5dc99b0b98f85f62c2e31239442b1162ce4572a25de5ab1a2275814f549f32cc19350469fc3b81289f7b271b8991150f5874f960840ba6100adcd6c

data/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+    - uses: workarea-commerce/ci/eslint@v1
+      with:
+        args: '**/*.js'
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -13,6 +13,7 @@
 Gemfile.lock
 test/dummy/tmp/export/*.csv
 .DS_Store
+node_modules/
 
 ## Documentation cache and generated files:
 /.yardoc/
@@ -30,3 +31,4 @@ log
 tmp
 test/dummy/public/system/
 coverage
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+

data/.stylelintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "stylelint-config-recommended-scss",
+  "rules": {
+    "block-no-empty": null,
+    "no-descending-specificity": null,
+    "property-no-unknown": [true, { "ignoreProperties": ["mso-hide"] }]
+  }
+}

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+Workarea Listrak 5.0.3 (2020-02-05)
+--------------------------------------------------------------------------------
+
+*   Fix Proxy Usage in OAuth Client
+
+    When obtaining an OAuth access token from Listrak, requests were not
+    being sent through the HTTP proxy set in `$http_proxy` due to the way
+    the `Net::HTTP` library was being used. To resolve this, refactor the
+    `Listrak::OAuth.token` code to make a request using an instance of the
+    `Net::HTTP` client, rather than by using the `.post_form` convenience
+    method, as this is the only way to use the proxy in production.
+
+    Fixes #2
+
+    LISTRAK-1
+    Tom Scott
+
+*   Update README
+
+    Matt Duffy
+
+
+
 Workarea Listrak 5.0.2 (2019-08-22)
 --------------------------------------------------------------------------------
 

data/Gemfile

@@ -1,5 +1,4 @@
 source "https://rubygems.org"
-source "https://gems.weblinc.com"
 
 gemspec
 

data/README.md

@@ -1,4 +1,5 @@
-# Listrak
+Workarea Listrak
+================================================================================
 
 Integrate the [Listrak][] ERP with the Workarea platform. This plugin
 currently implements the following Listrak features:
@@ -8,15 +9,25 @@ currently implements the following Listrak features:
 - Transactional email delivery
 - Automatically subscribing users to a distribution list
 
-## Installation
+Getting Started
+--------------------------------------------------------------------------------
 
-Add the following to Gemfile:
+Add the gem to your application's Gemfile:
 
 ```ruby
-gem 'workarea-listrak', '~> 5.0'
+# ...
+gem 'workarea-listrak'
+# ...
 ```
 
-### Secrets
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Update your `config/secrets.yml` file with your api credentials:
 
 ```yaml
 listrak:
@@ -28,7 +39,8 @@ listrak:
     client_secret:
 ```
 
-### Configuration
+Configuration
+--------------------------------------------------------------------------------
 
 Most listrak configuration is set via the admin; you will need to set the
 `Default List` in the admin after installing the plugin.
@@ -39,19 +51,21 @@ Most listrak configuration is set via the admin; you will need to set the
 Workarea.config do |config|
   config.listrak.analytics = {
     merchant_id: 'LISTRAK MERCHANT ID',
-    email_capture_ids: 'ID's OF EMAIL FIELDS USED FOR JAVASCRIPT ABANDONMENT'
+    email_capture_ids: 'EMAIL FIELD IDS USED FOR JAVASCRIPT ABANDONMENT'
   }
 end
 ```
 
-### Subscribing email addresses to a distribution list
+Subscribing email addresses to a distribution list
+--------------------------------------------------------------------------------
 
 When customers sign up for the newsletter within the popup dialog or
 create a new user account, `Workarea::Listrak` will send the email and
 any other user-specific information to Listrak. This occurs immediately
 in a background job during creation of a `Email::Signup`.
 
-### Data Exporting
+Data Exporting
+--------------------------------------------------------------------------------
 
 The following will be sent to Listrak via API whenever they are created or saved:
 
@@ -59,7 +73,8 @@ The following will be sent to Listrak via API whenever they are created or saved
 * Orders (on order place)
 * Products
 
-### Transactional Email Delivery
+Transactional Email Delivery
+--------------------------------------------------------------------------------
 
 This library is capable of replacing the internal application mailers
 with API calls to Listrak's email delivery service, passing it the data
@@ -110,7 +125,8 @@ To send the message, call the `#deliver` method:
 OrderConfirmationMessage.new(order).deliver
 ```
 
-### JavaScript Analytics Integration
+JavaScript Analytics Integration
+--------------------------------------------------------------------------------
 
 All of Listrak's JS code blocks respond to the `listrakAsyncListener`
 event, which is triggered after Listrak's external "SDK" code is loaded
@@ -128,3 +144,13 @@ To reiterate, **listrak.js needs to be your last initialized JS
 module**.
 
 [Listrak]: http://listrak.com
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Listrak is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -38,13 +38,12 @@ desc "Release version #{Workarea::Listrak::VERSION} of the gem"
 task :release do
   host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
 
-  #Rake::Task['workarea:changelog'].execute
-  #system 'git add CHANGELOG.md'
-  #system 'git commit -m "Update CHANGELOG"'
-  #system 'git push origin HEAD'
+  Rake::Task['workarea:changelog'].execute
+  system 'git add CHANGELOG.md'
+  system 'git commit -m "Update CHANGELOG"'
 
   system "git tag -a v#{Workarea::Listrak::VERSION} -m 'Tagging #{Workarea::Listrak::VERSION}'"
-  system "git push --tags"
+  system "git push origin HEAD --follow-tags"
 
   system "gem build workarea-listrak.gemspec"
   system "gem push workarea-listrak-#{Workarea::Listrak::VERSION}.gem"

data/app/services/workarea/listrak/email_api/contacts.rb

@@ -1,7 +1,6 @@
 module Workarea
   module Listrak
     class EmailApi::Contacts
-
       attr_reader :client
 
       def initialize(client)

data/app/services/workarea/listrak/models/order_item.rb

@@ -2,7 +2,6 @@ module Workarea
   module Listrak
     module Models
       class OrderItem
-
         attr_reader :order, :order_item
 
         def initialize(order, order_item)

data/app/services/workarea/listrak/oauth.rb

@@ -5,28 +5,20 @@ module Workarea
       #
       # @param client_id [String] client id
       # @param client_secret [String] client secret
-      # @param options [Hash] extra options when getting the OAuth token
-      # @option options [Integer] timeout value for open and read timeouts
-      # @option options [Integer] open_timeout value for open timeout
-      # @option options [Integer] read_timeout value for read timeout
-      #
       # @raise [OauthError] raised if generating an Oauth token is unsucessful
-      #
       # @return [String] Oauth token
-      def self.token(client_id:, client_secret:, **options)
+      def self.token(client_id:, client_secret:)
         cache_key = "listrak/api/#{client_id}"
         token = Rails.cache.read(cache_key)
 
         return token if token.present?
 
-        uri = URI('https://auth.listrak.com/OAuth2/Token')
-        params = {
+        payload = {
           grant_type: 'client_credentials',
           client_id: client_id,
           client_secret: client_secret
         }
-
-        response = Net::HTTP.post_form uri, params
+        response = http.post('/OAuth2/Token', payload.to_json)
 
         case response
         when ::Net::HTTPSuccess
@@ -40,6 +32,12 @@ module Workarea
           raise OauthError.new response
         end
       end
+
+      def self.http
+        @http ||= Net::HTTP.new('auth.listrak.com', 443).tap do |client|
+          client.use_ssl = true
+        end
+      end
     end
   end
 end

data/lib/workarea/listrak/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Listrak
-    VERSION = "5.0.2".freeze
+    VERSION = "5.0.3".freeze
   end
 end

data/test/services/workarea/listrak/oauth_test.rb

@@ -5,8 +5,10 @@ module Workarea
     class OauthTest < TestCase
       def test_token_with_valid_credentials
         VCR.use_cassette "listrak/oauth-successful" do
-          token = Oauth.token client_id: 'doyfni0aw64ogd84ld6t',
+          token = Oauth.token(
+            client_id: 'doyfni0aw64ogd84ld6t',
             client_secret: 'LxdEE4Gu4aSJv5tS9osd8WudjGbJ+EIPYvZBS7bc5JU'
+          )
 
           assert token.present?
         end
@@ -15,13 +17,29 @@ module Workarea
       def test_token_with_invalid_credentials
         VCR.use_cassette "listrak/oauth-unsuccessful" do
           error = assert_raises Listrak::OauthError do
-            Oauth.token client_id: 'doyfni0aw64ogd84ld6t',
+            Oauth.token(
+              client_id: 'doyfni0aw64ogd84ld6t',
               client_secret: 'LxdEE4Gu4aSJv5tS9osd8WudjGbJ+EIPYvZBS7bc5J'
+            )
           end
 
           assert_equal({ error: "Invalid Credentials" }.to_json, error.message)
         end
       end
+
+      def test_request_token_through_proxy_when_provided
+        proxy = ENV['http_proxy']
+        ENV['http_proxy'] = '127.0.0.1'
+
+        assert_raises SocketError do
+          Oauth.token(
+            client_id: 'doyfni0aw64ogd84ld6t',
+            client_secret: 'LxdEE4Gu4aSJv5tS9osd8WudjGbJ+EIPYvZBS7bc5J'
+          )
+        end
+      ensure
+        ENV['http_proxy'] = proxy
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-listrak
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
 platform: ruby
 authors:
 - Eric Pigeon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -43,13 +43,15 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/documentation-request.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".stylelintrc.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
-- LICENSE.md
 - README.md
 - Rakefile
 - app/assets/javascripts/workarea/admin/modules/listrak/list_events_select.js
@@ -146,7 +148,6 @@ files:
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/new_framework_defaults.rb
-- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/workarea.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
@@ -155,6 +156,7 @@ files:
 - test/dummy/config/secrets.yml
 - test/dummy/config/spring.rb
 - test/dummy/db/seeds.rb
+- test/dummy/log/.keep
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -220,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Listrak plugin for Workarea

data/LICENSE.md

@@ -1,3 +0,0 @@
-View this plugin's license here: 
-
-<https://github.com/workarea-commerce/workarea/blob/master/LICENSE.md>

data/test/dummy/config/initializers/session_store.rb

@@ -1,3 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-Rails.application.config.session_store :cookie_store, key: "_dummy_session"