duodealer_app 1.0.0

data/docs/Quickstart.md

@@ -0,0 +1,103 @@
+Quickstart
+==========
+
+Get started building and deploying a new Duo Dealer App to Heroku in just a few minutes. This guide assumes you have Ruby/Rails installed on your computer already; if you haven't done that already start with [this guide.](https://guides.rubyonrails.org/v5.0/getting_started.html#installing-rails)
+
+1. New Rails App (with postgres)
+--------------------------------
+
+To create a new Rails app and use this generator, open your terminal and run the following commands:
+
+```sh
+$ rails new test-app --database=postgresql
+$ cd test-app
+$ git init
+$ git add .
+$ git commit -m 'new rails app'
+```
+
+2. Create a new Heroku app
+--------------------------
+
+The next step is to create a new Heroku app to host your application. If you haven't got a Heroku account yet, create a free account [here](https://www.heroku.com/). 
+
+Head to the Heroku dashboard and create a new app, or run the following commands with the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli#download-and-install) installed, substituting `name` for the name of your own app:
+
+CLI:
+```sh
+$ heroku create name
+$ heroku git:remote -a name
+```
+
+Once you have created an app on Heroku, we need to let Git know where the Heroku server is so we can deploy to it later. Copy the app's name from your Heroku dashboard and substitute `appname.git` with the name you chose earlier:
+
+web:
+```sh
+# https://dashboard.heroku.com/new
+$ git remote add heroku git@heroku.com:appname.git
+```
+
+3. Create a new App in the Duo Dealer Partner dashboard
+-----------------------------------------
+* Create a Duo Dealer app in the [Partners dashboard](https://partner.duodealer.com). For this tutorial, you can choose either a public or custom app, but you can [learn about App Types here.](https://help.duodealer.com/en/manual/apps/app-types)
+[https://app.duodealer.com/services/partners/api_clients](https://app.duodealer.com/services/partners/api_clients)
+* Set the callback url to `https://<appname>.herokuapp.com/`
+* Choose an embedded app
+* Set the app's `redirect_uri` to `https://<appname>.herokuapp.com/auth/duodealer/callback`
+
+4. Add DuodealerApp to Gemfile
+----------------------------
+
+Run these commands to add the `duodealer_app` Gem to your app:
+
+```sh
+$ echo "gem 'duodealer_app'" >> Gemfile
+$ bundle install
+```
+
+**Note:** we recommend using the latest version of Duo Dealer Gem. Check the [Git tags](https://gitlab.com/duodealer/duodealer_app/tags) to see the latest release version and then add it to your Gemfile e.g `gem 'duodealer_app', '~> 7.0.0'`
+
+5. Run the DuodealerApp generator
+-------------------------------
+
+Generate the code for your app by running these commands: 
+
+```sh
+# Use the keys from your app you created in the partners area
+$ rails generate duodealer_app --api_key <duodealer_api_key> --secret <duodealer_api_secret>
+$ git add .
+$ git commit -m 'generated duodealer app'
+```
+
+If you forget to set your keys or redirect uri above, you will find them in the duodealer_app initializer at: `/config/initializers/duodealer_app.rb`.
+
+We recommend adding a gem or utilizing environment variables (`.env`) to handle your keys before releasing your app. [Learn more about using environment variables.](https://www.honeybadger.io/blog/ruby-guide-environment-variables/)
+
+6. Deploy your app
+---------
+
+Once you've generated your app, push it into your Heroku environment to see it up and running:
+```sh
+$ git push heroku
+$ heroku run rake db:migrate
+```
+
+7. Install the App!
+-------------------
+
+Ensure you have created a [development store](https://help.duodealer.com/en/api/getting-started/making-your-first-request#create-a-development-store) using the Duo Dealer Partner Dashboard. If you don't already have one, [create one by following these instructions](https://help.duodealer.com/en/api/getting-started/making-your-first-request#create-a-development-store).
+
+##### Note: The following step will cause your store to become `transfer-disabled.` Read more about store transfer and why it's important [here](https://help.duodealer.com/en/api/guides/store-transfers#transfer-disabled-stores). This is an irreversible change, so be sure you don't plan to transfer this store to a merchant.
+
+Install the app onto your new development store using the Partner Dashboard. Log in to your account, visit the apps page, click the app you created earlier, and looking for the `Test your app` instructions where you can select a store to install your app on.
+
+![Installing an app on the partners dashboard dropdown](/docs/install-on-dev-shop.png)
+
+### OR
+
+![Installing an app on the partners dashboard card](/docs/test-your-app.png)
+
+8. Great work!
+-------------------
+
+You're done creating your first app on Duo Dealer. Keep going and learn more.

data/docs/Releasing.md

@@ -0,0 +1,17 @@
+Releasing DuodealerApp
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Create a pull request with the following changes:
+  * Update the version of DuodealerApp in lib/duodealer_app/version.rb
+  * Add a CHANGELOG entry for the new release with the date
+  * Change the title of the PR to something like: "Packaging for release X.Y.Z"
+3. Merge your pull request
+4. Pull from master so you have the latest version of the duodealer_app
+5. Tag the HEAD with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z
+6. Push out your tags
+  $ git push --tags
+7. Use Shipit to build and push the gem
+
+If you see an error like 'You need to create the vX.Y.X tag first', clear GIT
+cache in Shipit settings

data/docs/Troubleshooting.md

@@ -0,0 +1,16 @@
+Troubleshooting Duo Dealer App
+===========
+
+### Generator duodealer_app:install hangs
+
+Rails uses spring by default to speed up development. To run the generator, spring has to be stopped:
+
+```sh
+$ bundle exec spring stop
+```
+
+Run duodealer_app generator again.
+
+### App installation fails with 'The page you’re looking for could not be found' if the app was installed before
+
+This issue can occur when the session (the model you set as `DuodealerApp::SessionRepository.storage`) isn't deleted when the user uninstalls your app. A possible fix for this is listening to the `app/uninstalled` webhook and deleting the corresponding session in the webhook handler.

data/duodealer_app.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push(File.expand_path("../lib", __FILE__))
+require "duodealer_app/version"
+
+Gem::Specification.new do |s|
+  s.name        = "duodealer_app"
+  s.version     = DuodealerApp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Eric Raio"
+  s.summary     = "This gem is used to get quickly started with the Duo Dealer API"
+
+  s.required_ruby_version = ">= 2.3.1"
+
+  s.add_runtime_dependency("browser_sniffer", "~> 1.1.3")
+  s.add_runtime_dependency("rails", "> 5.2.1")
+  s.add_runtime_dependency("duodealer_api", "~> 1.0")
+  s.add_runtime_dependency("omniauth-duodealer-oauth2", "~> 1.0.0")
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("byebug")
+  s.add_development_dependency("pry")
+  s.add_development_dependency("pry-nav")
+  s.add_development_dependency("pry-stack_explorer")
+  s.add_development_dependency("rb-readline")
+  s.add_development_dependency("sqlite3", "~> 1.4")
+  s.add_development_dependency("minitest")
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("webmock")
+
+  s.files         = %x(git ls-files).split("\n").reject { |f| f.match(%r{^(test|example)/}) }
+  s.test_files    = %x(git ls-files -- {test}/*).split("\n")
+  s.require_paths = ["lib"]
+end

data/karma.conf.js

@@ -0,0 +1,44 @@
+const karmaReporters = ['mocha-clean'];
+
+function isDebug(argument) {
+  return argument === '--debug';
+}
+
+module.exports = function(config) {
+  config.set({
+    mode: 'development',
+    basePath: '',
+    frameworks: ['mocha-debug', 'mocha', 'chai-sinon'],
+    files: [
+      'app/assets/javascripts/**/*.js',
+      'test/javascripts/**/*test.js',
+    ],
+    exclude: [
+      // Exclude JS files that create 'DOMContentLoaded' event listeners
+      'app/assets/javascripts/**/redirect.js',
+      'app/assets/javascripts/**/storage_access_redirect.js',
+      'app/assets/javascripts/**/top_level_interaction.js',
+      'app/assets/javascripts/**/partition_cookies.js',
+    ],
+    mochaReporter: {
+      output: 'autowatch',
+    },
+    preprocessors: {
+      'test/javascripts/**/*test.js': ['webpack'],
+    },
+    webpack: {},
+    reporters: karmaReporters,
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_WARN,
+    autoWatch: false,
+    browsers: ['ChromeHeadless'],
+    singleRun: true,
+    client: {
+      mocha: {
+        ui: 'tdd',
+        grep: config.grep,
+      },
+    },
+  });
+};

data/lib/duodealer_app.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "duodealer_app/version"
+
+# deps
+require "duodealer_api"
+require "omniauth-duodealer-oauth2"
+
+module DuodealerApp
+  def self.rails6?
+    Rails::VERSION::MAJOR >= 6
+  end
+
+  def self.use_webpacker?
+    rails6? &&
+      defined?(Webpacker) == "constant" &&
+      !configuration.disable_webpacker
+  end
+
+  # config
+  require "duodealer_app/configuration"
+
+  # engine
+  require "duodealer_app/engine"
+
+  # utils
+  require "duodealer_app/utils"
+
+  # controller concerns
+  require "duodealer_app/controller_concerns/localization"
+  require "duodealer_app/controller_concerns/itp"
+  require "duodealer_app/controller_concerns/login_protection"
+  require "duodealer_app/controller_concerns/embedded_app"
+  require "duodealer_app/controller_concerns/webhook_verification"
+  require "duodealer_app/controller_concerns/app_proxy_verification"
+
+  # jobs
+  require "duodealer_app/jobs/webhooks_manager_job"
+  require "duodealer_app/jobs/scripttags_manager_job"
+
+  # managers
+  require "duodealer_app/managers/webhooks_manager"
+  require "duodealer_app/managers/scripttags_manager"
+
+  # middleware
+  require "duodealer_app/middleware/same_site_cookie_middleware"
+
+  # session
+  require "duodealer_app/session/storage_strategies/shop_storage_strategy"
+  require "duodealer_app/session/storage_strategies/user_storage_strategy"
+  require "duodealer_app/session/session_storage"
+  require "duodealer_app/session/session_repository"
+  require "duodealer_app/session/in_memory_session_store"
+end

data/lib/duodealer_app/configuration.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module DuodealerApp
+  class Configuration
+    # Duo Dealer App settings. These values should match the configuration
+    # for the app in your Duo Dealer Partners page. Change your settings in
+    # `config/initializers/duodealer_app.rb`
+    attr_accessor :application_name
+    attr_accessor :api_key
+    attr_accessor :secret
+    attr_accessor :old_secret
+    attr_accessor :scope
+    attr_accessor :embedded_app
+    alias_method  :embedded_app?, :embedded_app
+    attr_accessor :webhooks
+    attr_accessor :scripttags
+    attr_accessor :after_authenticate_job
+    attr_reader :session_repository
+    attr_accessor :per_user_tokens
+    alias_method :per_user_tokens?, :per_user_tokens
+    attr_accessor :api_version
+
+    # customise urls
+    attr_accessor :root_url
+    attr_accessor :login_url
+
+    # customise ActiveJob queue names
+    attr_accessor :scripttags_manager_queue_name
+    attr_accessor :webhooks_manager_queue_name
+
+    # configure duodealer domain for local duodealer development
+    attr_accessor :duodealer_domain
+
+    # ability to have webpacker installed but not used in this gem and the generators
+    attr_accessor :disable_webpacker
+
+    # allow namespacing webhook jobs
+    attr_accessor :webhook_jobs_namespace
+
+    # allow enabling of same site none on cookies
+    attr_accessor :enable_same_site_none
+
+    def initialize
+      @root_url = "/"
+      @duodealer_domain = "duodealer.com"
+      @scripttags_manager_queue_name = Rails.application.config.active_job.queue_name
+      @webhooks_manager_queue_name = Rails.application.config.active_job.queue_name
+      @per_user_tokens = false
+      @disable_webpacker = ENV["DUODEALER_APP_DISABLE_WEBPACKER"].present?
+    end
+
+    def login_url
+      @login_url || File.join(@root_url, "login")
+    end
+
+    def session_repository=(klass)
+      @session_repository = klass
+      DuodealerApp::SessionRepository.storage = klass
+    end
+
+    def has_webhooks?
+      webhooks.present?
+    end
+
+    def has_scripttags?
+      scripttags.present?
+    end
+
+    def enable_same_site_none
+      !Rails.env.test? && (@enable_same_site_none.nil? ? embedded_app? : @enable_same_site_none)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end