workarea-salesforce_esp 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +7 -0
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +37 -0
  3. data/.github/ISSUE_TEMPLATE/documentation-request.md +17 -0
  4. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  5. data/.github/workflows/ci.yml +54 -0
  6. data/.gitignore +24 -0
  7. data/.rubocop.yml +2 -0
  8. data/CHANGELOG.md +9 -0
  9. data/Gemfile +17 -0
  10. data/LICENSE +52 -0
  11. data/README.md +60 -0
  12. data/Rakefile +57 -0
  13. data/app/assets/config/salesforce_esp_manifest.js +0 -0
  14. data/app/assets/images/salesforce_esp/.keep +0 -0
  15. data/app/assets/javascripts/salesforce_esp/.keep +0 -0
  16. data/app/assets/stylesheets/salesforce_esp/.keep +0 -0
  17. data/app/controllers/.keep +0 -0
  18. data/app/helpers/.keep +0 -0
  19. data/app/mailers/.keep +0 -0
  20. data/app/models/.keep +0 -0
  21. data/app/views/.keep +0 -0
  22. data/app/workers/workarea/salesforce_esp/save_email_signup.rb +28 -0
  23. data/bin/rails +25 -0
  24. data/config/initializers/workarea.rb +6 -0
  25. data/config/routes.rb +2 -0
  26. data/lib/workarea/salesforce_esp.rb +55 -0
  27. data/lib/workarea/salesforce_esp/bogus_gateway.rb +33 -0
  28. data/lib/workarea/salesforce_esp/engine.rb +10 -0
  29. data/lib/workarea/salesforce_esp/gateway.rb +116 -0
  30. data/lib/workarea/salesforce_esp/response.rb +34 -0
  31. data/lib/workarea/salesforce_esp/subscriber.rb +15 -0
  32. data/lib/workarea/salesforce_esp/version.rb +5 -0
  33. data/test/dummy/.ruby-version +1 -0
  34. data/test/dummy/Rakefile +6 -0
  35. data/test/dummy/app/assets/config/manifest.js +3 -0
  36. data/test/dummy/app/assets/images/.keep +0 -0
  37. data/test/dummy/app/assets/javascripts/application.js +14 -0
  38. data/test/dummy/app/assets/stylesheets/application.css +15 -0
  39. data/test/dummy/app/controllers/application_controller.rb +2 -0
  40. data/test/dummy/app/controllers/concerns/.keep +0 -0
  41. data/test/dummy/app/helpers/application_helper.rb +2 -0
  42. data/test/dummy/app/jobs/application_job.rb +2 -0
  43. data/test/dummy/app/mailers/application_mailer.rb +4 -0
  44. data/test/dummy/app/models/concerns/.keep +0 -0
  45. data/test/dummy/app/views/layouts/application.html.erb +15 -0
  46. data/test/dummy/app/views/layouts/mailer.html.erb +13 -0
  47. data/test/dummy/app/views/layouts/mailer.text.erb +1 -0
  48. data/test/dummy/bin/bundle +3 -0
  49. data/test/dummy/bin/rails +4 -0
  50. data/test/dummy/bin/rake +4 -0
  51. data/test/dummy/bin/setup +28 -0
  52. data/test/dummy/bin/update +28 -0
  53. data/test/dummy/bin/yarn +11 -0
  54. data/test/dummy/config.ru +5 -0
  55. data/test/dummy/config/application.rb +34 -0
  56. data/test/dummy/config/boot.rb +5 -0
  57. data/test/dummy/config/environment.rb +5 -0
  58. data/test/dummy/config/environments/development.rb +52 -0
  59. data/test/dummy/config/environments/production.rb +83 -0
  60. data/test/dummy/config/environments/test.rb +45 -0
  61. data/test/dummy/config/initializers/application_controller_renderer.rb +8 -0
  62. data/test/dummy/config/initializers/assets.rb +14 -0
  63. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  64. data/test/dummy/config/initializers/content_security_policy.rb +25 -0
  65. data/test/dummy/config/initializers/cookies_serializer.rb +5 -0
  66. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  67. data/test/dummy/config/initializers/inflections.rb +16 -0
  68. data/test/dummy/config/initializers/mime_types.rb +4 -0
  69. data/test/dummy/config/initializers/workarea.rb +5 -0
  70. data/test/dummy/config/initializers/wrap_parameters.rb +9 -0
  71. data/test/dummy/config/locales/en.yml +33 -0
  72. data/test/dummy/config/puma.rb +37 -0
  73. data/test/dummy/config/routes.rb +5 -0
  74. data/test/dummy/config/spring.rb +6 -0
  75. data/test/dummy/db/seeds.rb +2 -0
  76. data/test/dummy/lib/assets/.keep +0 -0
  77. data/test/dummy/log/.keep +0 -0
  78. data/test/dummy/package.json +5 -0
  79. data/test/gateways/gateway_test.rb +38 -0
  80. data/test/teaspoon_env.rb +6 -0
  81. data/test/test_helper.rb +10 -0
  82. data/workarea-salesforce_esp.gemspec +22 -0
  83. metadata +152 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a02f6080f1dbff99ccfdda38b559f5870d5b3b540d1e7e28ff07fbd1ba95687b
4
+ data.tar.gz: 579181f48463659ffdabb9ed3a57d7ac2f43dfb898174fd6a813075c376ceda3
5
+ SHA512:
6
+ metadata.gz: c894a8ccf8fd1f325e2dd5e168015ebb85b487b21cd3a1909be44fab6f647465a04bdef6c3a3eecf3f03c347c561a62de42938ebc364b99f9a71138829dfa375
7
+ data.tar.gz: 9aa4d23b3f3d8736a03f832f9729a9aaa19460560322496b1769636f21b6059f525b95d2bb5efcb3a59eef9decb92e706f169ab5cd20ce35ce9bf19b93f1f2c8
@@ -0,0 +1,37 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve Workarea
4
+ title: ''
5
+ labels: bug
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ ⚠️**Before you create**⚠️
11
+ Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
12
+
13
+ **Describe the bug**
14
+ A clear and concise description of what the bug is.
15
+
16
+ **To Reproduce**
17
+ Steps to reproduce the behavior:
18
+ 1. Go to '...'
19
+ 2. Click on '....'
20
+ 3. Scroll down to '....'
21
+ 4. See error
22
+
23
+ **Expected behavior**
24
+ A clear and concise description of what you expected to happen.
25
+
26
+ **Workarea Setup (please complete the following information):**
27
+ - Workarea Version: [e.g. v3.4.6]
28
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
29
+
30
+ **Attachments**
31
+ If applicable, add any attachments to help explain your problem, things like:
32
+ - screenshots
33
+ - Gemfile.lock
34
+ - test cases
35
+
36
+ **Additional context**
37
+ Add any other context about the problem here.
@@ -0,0 +1,17 @@
1
+ ---
2
+ name: Documentation request
3
+ about: Suggest documentation
4
+ title: ''
5
+ labels: documentation
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your documentation related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm confused by [...]
12
+
13
+ **Describe the article you'd like**
14
+ A clear and concise description of what would be in the documentation article.
15
+
16
+ **Additional context**
17
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for Workarea
4
+ title: ''
5
+ labels: enhancement
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,54 @@
1
+ name: CI
2
+ on: [push]
3
+
4
+ jobs:
5
+ static_analysis:
6
+ runs-on: ubuntu-latest
7
+ steps:
8
+ - uses: actions/checkout@v1
9
+ - uses: workarea-commerce/ci/bundler-audit@v1
10
+ - uses: workarea-commerce/ci/rubocop@v1
11
+
12
+ admin_tests:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v1
16
+ - uses: actions/setup-ruby@v1
17
+ with:
18
+ ruby-version: 2.6.x
19
+ - uses: workarea-commerce/ci/test@v1
20
+ with:
21
+ command: bin/rails app:workarea:test:admin
22
+
23
+ core_tests:
24
+ runs-on: ubuntu-latest
25
+ steps:
26
+ - uses: actions/checkout@v1
27
+ - uses: actions/setup-ruby@v1
28
+ with:
29
+ ruby-version: 2.6.x
30
+ - uses: workarea-commerce/ci/test@v1
31
+ with:
32
+ command: bin/rails app:workarea:test:core
33
+
34
+ storefront_tests:
35
+ runs-on: ubuntu-latest
36
+ steps:
37
+ - uses: actions/checkout@v1
38
+ - uses: actions/setup-ruby@v1
39
+ with:
40
+ ruby-version: 2.6.x
41
+ - uses: workarea-commerce/ci/test@v1
42
+ with:
43
+ command: bin/rails app:workarea:test:storefront
44
+
45
+ plugins_tests:
46
+ runs-on: ubuntu-latest
47
+ steps:
48
+ - uses: actions/checkout@v1
49
+ - uses: actions/setup-ruby@v1
50
+ with:
51
+ ruby-version: 2.6.x
52
+ - uses: workarea-commerce/ci/test@v1
53
+ with:
54
+ command: bin/rails app:workarea:test:plugins
data/.gitignore ADDED
@@ -0,0 +1,24 @@
1
+ .bundle/
2
+ log/*.log
3
+ pkg/
4
+ test/dummy/log/*.log
5
+ test/dummy/node_modules/
6
+ test/dummy/yarn-error.log
7
+ test/dummy/tmp/
8
+ .DS_Store
9
+ .byebug_history
10
+ .bundle/
11
+ .sass-cache/
12
+ Gemfile.lock
13
+ pkg/
14
+ test/dummy/tmp/
15
+ test/dummy/public/
16
+ log/*.log
17
+ test/dummy/log/*.log
18
+ test/dummy/db/*.sqlite3
19
+ test/dummy/db/*.sqlite3-journal
20
+ node_modules
21
+ yarn.lock
22
+ yarn-error.log
23
+ package-lock.json
24
+ .rubocop-http*
data/.rubocop.yml ADDED
@@ -0,0 +1,2 @@
1
+ inherit_from:
2
+ - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
data/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ Workarea Salesforce Esp 1.0.0 (2020-01-21)
2
+ --------------------------------------------------------------------------------
3
+
4
+ * Support new Oauth token generation when creating a authorization token.
5
+
6
+ Jeff Yucis
7
+
8
+
9
+
data/Gemfile ADDED
@@ -0,0 +1,17 @@
1
+ source 'https://rubygems.org'
2
+ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
3
+
4
+ # Declare your gem's dependencies in salesforce_esp.gemspec.
5
+ # Bundler will treat runtime dependencies like base dependencies, and
6
+ # development dependencies will be added by default to the :development group.
7
+ gemspec
8
+
9
+ # Declare any dependencies that are still in development here instead of in
10
+ # your gemspec. These might include edge Rails or gems from your path or
11
+ # Git. Remember to move these dependencies to your gemspec before releasing
12
+ # your gem to rubygems.org.
13
+
14
+ # To use a debugger
15
+ # gem 'byebug', group: [:development, :test]
16
+
17
+ gem 'workarea', github: 'workarea-commerce/workarea', branch: 'v3.5-stable'
data/LICENSE ADDED
@@ -0,0 +1,52 @@
1
+ WebLinc
2
+ Business Source License
3
+
4
+ Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
5
+
6
+ Licensed Work: Workarea Commerce Platform
7
+ The Licensed Work is (c) 2019 WebLinc Corporation
8
+
9
+ Additional Use Grant:
10
+ You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
11
+
12
+ A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties.
13
+
14
+ For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
15
+
16
+ Change Date: 2019-08-20
17
+
18
+ Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
19
+
20
+ Terms
21
+
22
+ The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
23
+
24
+ Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
25
+
26
+ If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
27
+
28
+ All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
29
+
30
+ You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
31
+
32
+ Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
33
+
34
+ This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
35
+
36
+ Covenants of Licensor
37
+ In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
38
+
39
+ To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
40
+
41
+ To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
42
+
43
+ To specify a Change Date.
44
+
45
+ Not to modify this License in any other way.
46
+
47
+ Notice
48
+ The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
49
+
50
+ For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
51
+
52
+ License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ Workarea Salesforce Esp
2
+ ================================================================================
3
+
4
+ Salesforce Esp plugin for the Workarea platform. Plugin supports adding a user to a default list.
5
+
6
+
7
+ Setup and Configuration
8
+ --------------------------------------------------------------------------------
9
+ To make use of the gateway you must add the following keys to your secrets file:
10
+
11
+ # ...
12
+ salesforce:
13
+ client_id: clientIDabcd....
14
+ secret: secret.....
15
+ # ...
16
+
17
+ You can find this information via the sales force app center.
18
+
19
+ **The following configurations are required:**
20
+
21
+ The default salesforce list ID:
22
+
23
+ # ...
24
+ config.salesforce.default_list = '856'
25
+ # ...
26
+
27
+ The endpoint for generating a token endpoint:
28
+
29
+ # ...
30
+ config.salesforce.token_endpoint = 'https://XXXXXX.auth.marketingcloudapis.com'
31
+ # ...
32
+
33
+
34
+ See [https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/routes.htm](https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/routes.htm) for Salesforce Cloud Marketing platform documentation.
35
+
36
+ **Note!** Some reference material still references ExactTarget. Exacttarget was purchased by Salesforce and can be considered the same entity.
37
+
38
+ Getting Started
39
+ --------------------------------------------------------------------------------
40
+
41
+ This gem contains a Rails engine that must be mounted onto a host Rails application.
42
+
43
+ # ...
44
+ gem 'workarea-salesforce_esp'
45
+ # ...
46
+
47
+ Update your application's bundle.
48
+
49
+ cd path/to/application
50
+ bundle
51
+
52
+ Workarea Commerce Documentation
53
+ --------------------------------------------------------------------------------
54
+
55
+ See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
56
+
57
+ License
58
+ --------------------------------------------------------------------------------
59
+
60
+ Workarea Afterpay is released under the [Business Software License](LICENSE)
data/Rakefile ADDED
@@ -0,0 +1,57 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+ RDoc::Task.new(:rdoc) do |rdoc|
9
+ rdoc.rdoc_dir = 'rdoc'
10
+ rdoc.title = 'Salesforce Esp'
11
+ rdoc.options << '--line-numbers'
12
+ rdoc.rdoc_files.include('README.md')
13
+ rdoc.rdoc_files.include('lib/**/*.rb')
14
+ end
15
+
16
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
17
+ load 'rails/tasks/engine.rake'
18
+ load 'rails/tasks/statistics.rake'
19
+ load 'workarea/changelog.rake'
20
+
21
+ require 'rake/testtask'
22
+ Rake::TestTask.new(:test) do |t|
23
+ t.libs << 'lib'
24
+ t.libs << 'test'
25
+ t.pattern = 'test/**/*_test.rb'
26
+ t.verbose = false
27
+ end
28
+ task default: :test
29
+
30
+ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
31
+ require 'workarea/salesforce_esp/version'
32
+
33
+ desc "Release version #{Workarea::SalesforceEsp::VERSION} of the gem"
34
+ task :release do
35
+ Rake::Task['workarea:changelog'].execute
36
+ system 'git add CHANGELOG.md'
37
+ system 'git commit -m "Update CHANGELOG"'
38
+ system 'git push origin HEAD'
39
+
40
+ system "git tag -a v#{Workarea::SalesforceEsp::VERSION} -m 'Tagging #{Workarea::SalesforceEsp::VERSION}'"
41
+ system 'git push --tags'
42
+
43
+ system "gem build workarea-salesforce_esp.gemspec"
44
+ system "gem push workarea-salesforce_esp-#{Workarea::SalesforceEsp::VERSION}.gem"
45
+ system "rm workarea-salesforce_esp-#{Workarea::SalesforceEsp::VERSION}.gem"
46
+ end
47
+
48
+ desc 'Run the JavaScript tests'
49
+ ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
50
+ task teaspoon: 'app:teaspoon'
51
+
52
+ desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
53
+ task :teaspoon_server do
54
+ Dir.chdir("test/dummy")
55
+ teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
56
+ system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
57
+ end
File without changes
File without changes
File without changes
File without changes
File without changes
data/app/helpers/.keep ADDED
File without changes
data/app/mailers/.keep ADDED
File without changes
data/app/models/.keep ADDED
File without changes
data/app/views/.keep ADDED
File without changes
@@ -0,0 +1,28 @@
1
+ module Workarea
2
+ module SalesforceEsp
3
+ class SaveEmailSignup
4
+ include Sidekiq::Worker
5
+ include Sidekiq::CallbacksWorker
6
+
7
+ sidekiq_options(
8
+ enqueue_on: { Workarea::Email::Signup => :create },
9
+ queue: 'low'
10
+ )
11
+
12
+ def perform(id)
13
+ signup = Workarea::Email::Signup.find(id)
14
+ add_subscription(signup.email, {}, list_id)
15
+ end
16
+
17
+ private
18
+
19
+ def add_subscription(email, attrs = {}, list_ids = nil)
20
+ Workarea::SalesforceEsp.gateway.subscribe(email, attrs, list_ids)
21
+ end
22
+
23
+ def list_id
24
+ Workarea::config.salesforce[:default_list]
25
+ end
26
+ end
27
+ end
28
+ end
data/bin/rails ADDED
@@ -0,0 +1,25 @@
1
+ #!/usr/bin/env ruby
2
+ # This command will automatically be run when you run "rails" with Rails gems
3
+ # installed from the root of your application.
4
+
5
+ ENGINE_ROOT = File.expand_path('..', __dir__)
6
+ ENGINE_PATH = File.expand_path('../lib/workarea/salesforce_esp/engine', __dir__)
7
+ APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
8
+
9
+ # Set up gems listed in the Gemfile.
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
11
+ require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
12
+
13
+ require "rails"
14
+ # Pick the frameworks you want:
15
+ require "active_model/railtie"
16
+ require "active_job/railtie"
17
+ # require "active_record/railtie"
18
+ # require "active_storage/engine"
19
+ require "action_controller/railtie"
20
+ require "action_mailer/railtie"
21
+ require "action_view/railtie"
22
+ # require "action_cable/engine"
23
+ require "sprockets/railtie"
24
+ require "rails/test_unit/railtie"
25
+ require 'rails/engine/commands'