RubyGems - spiffy_stores_app - Versions diffs - 8.2.6 - Mend

spiffy_stores_app 8.2.6

Files changed (68) hide show

data/app/controllers/spiffy_stores_app/webhooks_controller.rb ADDED

@@ -0,0 +1,36 @@
+module SpiffyStoresApp
+  class WebhooksController < ActionController::Base
+    include SpiffyStoresApp::WebhookVerification
+    class SpiffyStoresApp::MissingWebhookJobError < StandardError; end
+    def receive
+      params.permit!
+      job_args = {shop_domain: shop_domain, webhook: webhook_params.to_h}
+      webhook_job_klass.perform_later(job_args)
+      head :no_content
+    end
+    private
+    def webhook_params
+      params.except(:controller, :action, :type)
+    end
+    def webhook_job_klass
+      webhook_job_klass_name.safe_constantize or raise SpiffyStoresApp::MissingWebhookJobError
+    end
+    def webhook_job_klass_name(type = webhook_type)
+      [webhook_namespace, "#{type}_job"].compact.join('/').classify
+    end
+    def webhook_type
+      params[:type]
+    end
+    def webhook_namespace
+      SpiffyStoresApp.configuration.webhook_jobs_namespace
+    end
+  end
+end

data/app/views/spiffy_stores_app/sessions/new.html.erb ADDED

@@ -0,0 +1,123 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>Spiffy Stores App — Installation</title>
+  <meta http-equiv="x-ua-compatible" content="ie=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <style>
+    * {
+      -moz-box-sizing: border-box;
+      -webkit-box-sizing: border-box;
+      box-sizing: border-box;
+    }
+    body {
+      padding: 2.5em 0;
+      color: #212b37;
+      font-family: -apple-system,BlinkMacSystemFont,San Francisco,Roboto,Segoe UI,Helvetica Neue,sans-serif;
+    }
+    .container {
+      width: 100%;
+      text-align: center;
+      margin-left: auto;
+      margin-right: auto;
+    }
+    @media screen and (min-width: 510px) {
+      .container {
+        width: 510px;
+      }
+    }
+    .title {
+      font-size: 1.5em;
+      margin: 2em auto;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      word-break: break-all;
+    }
+    .subtitle {
+      font-size: 0.8em;
+      font-weight: 500;
+      color: #64737f;
+      line-height: 2em;
+    }
+    .error {
+      line-height: 1em;
+      padding: 0.5em;
+      color: red;
+    }
+    input.marketing-input {
+      width: 100%;
+      height: 52px;
+      padding: 0 15px;
+      box-shadow: 0 0 0 1px #ddd;
+      border: 0;
+      border-radius: 5px;
+      background-color: #fff;
+      font-size: 1em;
+      margin-bottom: 15px;
+    }
+    input.marketing-input:focus {
+      color: #000;
+      outline: 0;
+      box-shadow: 0 0 0 2px #5e6ebf;
+    }
+    button.marketing-button {
+      display: inline-block;
+      width: 100%;
+      padding: 1.0625em 1.875em;
+      background-color: #5e6ebf;
+      color: #fff;
+      font-weight: 700;
+      font-size: 1em;
+      text-align: center;
+      outline: none;
+      border: 0 solid transparent;
+      border-radius: 5px;
+      cursor: pointer;
+    }
+    button.marketing-button:hover {
+      background: linear-gradient(to bottom, #5c6ac4, #4959bd);
+      border-color: #3f4eae;
+    }
+    button.marketing-button:focus {
+      box-shadow: 0 0 0.1875em 0.1875em rgba(94,110,191,0.5);
+      background-color: #223274;
+      color: #fff;
+    }
+  </style>
+</head>
+<body>
+  <main class="container" role="main">
+    <% application_name = SpiffyStoresApp.configuration.application_name %>
+    <h3 class="title">
+      <%= application_name.presence || 'Spiffy Stores App - Installation' %>
+    </h3>
+    <p class="subtitle">
+      <label for="store">Please enter the name of your "spiffystores.com" store</label>
+    </p>
+    <%= form_tag login_path do %>
+      <% if flash[:error] %>
+        <div class="error"><%= flash[:error] %></div>
+      <% end %>
+      <input id="store" name="store" type="text" autofocus="autofocus" placeholder="mystore.spiffystores.com" class="marketing-input">
+      <button type="submit" class="marketing-button">Install</button>
+    <% end %>
+  </main>
+</body>
+</html>

data/app/views/spiffy_stores_app/shared/redirect.html.erb ADDED

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <base target="_top">
+  <title>Redirecting…</title>
+  <%= javascript_include_tag('spiffy_stores_app/redirect', crossorigin: 'anonymous', integrity: true) %>
+</head>
+<body>
+  <%=
+  content_tag(:div, nil,
+    id: 'redirection-target',
+    data: {
+      target: {
+        myspiffyUrl: "https://#{current_spiffy_stores_domain}",
+        url: url,
+      },
+    },
+  )
+  %>
+</body>
+</html>

data/config/locales/de.yml ADDED

@@ -0,0 +1,3 @@
+de:
+  logged_out: 'Erfolgreich ausgelogt'
+  could_not_log_in: 'Spiffy Stores Store Login fehlgeschlagen'

data/config/locales/en.yml ADDED

@@ -0,0 +1,4 @@
+en:
+  logged_out: 'Successfully logged out'
+  could_not_log_in: 'Could not log in to Spiffy Stores store'
+  invalid_shop_url: 'Invalid store domain'

data/config/locales/es.yml ADDED

@@ -0,0 +1,3 @@
+es:
+  logged_out: 'Cerrar sesión'
+  could_not_log_in: 'No se pudo iniciar sesión en tu tienda de Spiffy Stores'

data/config/locales/fr.yml ADDED

@@ -0,0 +1,4 @@
+fr:
+  logged_out: 'Vous êtes déconnecté(e)'
+  could_not_log_in: 'Impossible de se connecter à la boutique Spiffy Stores'
+  invalid_shop_url: 'Url invalide'

data/config/locales/ja.yml ADDED

@@ -0,0 +1,3 @@
+ja:
+  logged_out: 'ログインに成功しました'
+  could_not_log_in: 'Spiffy Stores ストアにログインできませんでした'

data/config/routes.rb ADDED

@@ -0,0 +1,12 @@
+SpiffyStoresApp::Engine.routes.draw do
+  controller :sessions do
+    get 'login' => :new, :as => :login
+    post 'login' => :create, :as => :authenticate
+    get 'auth/spiffy/callback' => :callback
+    get 'logout' => :destroy, :as => :logout
+  end
+  namespace :webhooks do
+    post ':type' => :receive
+  end
+end

data/docs/Quickstart.md ADDED

@@ -0,0 +1,76 @@
+Quickstart
+==========
+Build and deploy a new Spiffy Stores App to Heroku in minutes
+1. New Rails App (with postgres)
+--------------------------------
+```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. Pull up your heroku dashboard and make a new app!
+cli:
+```sh
+$ heroku create name
+$ heroku git:remote -a name
+```
+now we need to let git know where the remote server is so we'll be able to deploy later
+web:
+```sh
+# https://dashboard.heroku.com/new
+$ git remote add heroku git@heroku.com:appinfive.git
+```
+3. Contact Spiffy Stores to create app
+--------------------------------------
+You will be given the app credentials and the redirect_uri will be set to the required value.
+* set the callback url to `https://<name>.herokuapp.com/`
+* choose an embedded app
+* set the redirect_uri to `https://<name>.herokuapp.com/auth/spiffy/callback`
+4. Add SpiffyStoresApp to gemfile
+----------------------------
+```sh
+$ echo "gem 'spiffy_stores_app'" >> Gemfile
+$ bundle install
+```
+Note - its recommended to use the latest released version. Check the git tags to see the latest release and then add it to your Gemfile e.g `gem 'spiffy_stores_app', '~> 7.0.0'`
+5. Run the SpiffyStoresApp generator
+------------------------------------
+```sh
+# use the keys for your app that have been provided to you
+$ rails generate spiffy_stores_app --api_key <spiffy_stores_api_key> --secret <spiffy_stores_api_secret>
+$ git add .
+$ git commit -m 'generated spiffy stores app'
+```
+If you forget to set your keys or redirect uri above, you will find them in the spiffy_stores_app initializer at: `/config/initializers/spiffy_stores_app.rb`.
+We recommend adding a gem or utilizing ENV variables to handle your keys before releasing your app.
+6. Deploy
+---------
+```sh
+$ git push heroku
+$ heroku run rake db:migrate
+```
+7. Install the App!
+-------------------
+`https://<name>.herokuapp.com/`

data/images/app-proxy-screenshot.png ADDED

Binary file

data/lib/generators/spiffy_stores_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb ADDED

@@ -0,0 +1,43 @@
+require 'rails/generators/base'
+module SpiffyStoresApp
+  module Generators
+    class AddAfterAuthenticateJobGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      hook_for :test_framework, as: :job, in: :rails do |instance, generator|
+        instance.invoke generator, [ instance.send(:job_file_name) ]
+      end
+      def init_after_authenticate_config
+        initializer = load_initializer
+       after_authenticate_job_config = "  config.after_authenticate_job = { job: SpiffyStores::AfterAuthenticateJob, inline: false }\n"
+        inject_into_file(
+          'config/initializers/spiffy_stores_app.rb',
+          after_authenticate_job_config,
+          before: 'end'
+        )
+        unless initializer.include?(after_authenticate_job_config)
+          shell.say "Error adding after_authneticate_job to config. Add this line manually: #{after_authenticate_job_config}", :red
+        end
+      end
+      def add_after_authenticate_job
+        template 'after_authenticate_job.rb', "app/jobs/#{job_file_name}_job.rb"
+      end
+      private
+      def load_initializer
+        File.read(File.join(destination_root, 'config/initializers/spiffy_stores_app.rb'))
+      end
+      def job_file_name
+        'spiffy_stores/after_authenticate'
+      end
+    end
+  end
+end

data/lib/generators/spiffy_stores_app/add_after_authenticate_job/templates/after_authenticate_job.rb ADDED

@@ -0,0 +1,10 @@
+module SpiffyStores
+  class AfterAuthenticateJob < ActiveJob::Base
+    def perform(shop_domain:)
+      shop = Shop.find_by(short_name: shop_domain)
+      shop.with_spiffy_stores_session do
+      end
+    end
+  end
+end

data/lib/generators/spiffy_stores_app/add_webhook/add_webhook_generator.rb ADDED

@@ -0,0 +1,68 @@
+require 'rails/generators/base'
+module SpiffyStoresApp
+  module Generators
+    class AddWebhookGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :topic, type: :string, aliases: "-t", required: true
+      class_option :address, type: :string, aliases: "-a", required: true
+      hook_for :test_framework, as: :job, in: :rails do |instance, generator|
+        instance.invoke generator, [ instance.send(:job_file_name) ]
+      end
+      def init_webhook_config
+        initializer = load_initializer
+        return if initializer.include?("config.webhooks")
+        inject_into_file(
+          'config/initializers/spiffy_stores_app.rb',
+          "  config.webhooks = [\n  ]\n",
+          before: 'end'
+        )
+      end
+      def inject_webhook_to_spiffy_stores_app_initializer
+        inject_into_file(
+          'config/initializers/spiffy_stores_app.rb',
+          webhook_config,
+          after: "config.webhooks = ["
+        )
+        initializer = load_initializer
+        unless initializer.include?(webhook_config)
+          shell.say "Error adding webhook to config. Add this line manually: #{webhook_config}", :red
+        end
+      end
+      def add_webhook_job
+        @job_file_name = job_file_name + '_job'
+        @job_class_name  = @job_file_name.classify
+        template 'webhook_job.rb', "app/jobs/#{@job_file_name}.rb"
+      end
+      private
+      def job_file_name
+        address.split('/').last
+      end
+      def load_initializer
+        File.read(File.join(destination_root, 'config/initializers/spiffy_stores_app.rb'))
+      end
+      def webhook_config
+        "\n    {topic: '#{topic}', address: '#{address}', format: 'json'},"
+      end
+      def topic
+        options['topic']
+      end
+      def address
+        options['address']
+      end
+    end
+  end
+end

data/lib/generators/spiffy_stores_app/add_webhook/templates/webhook_job.rb ADDED

@@ -0,0 +1,8 @@
+class <%= @job_class_name %> < ActiveJob::Base
+  def perform(shop_domain:, webhook:)
+    shop = Shop.find_by(spiffy_stores_domain: shop_domain)
+    shop.with_spiffy_stores_session do
+    end
+  end
+end

data/lib/generators/spiffy_stores_app/app_proxy_controller/app_proxy_controller_generator.rb ADDED

@@ -0,0 +1,25 @@
+require 'rails/generators/base'
+module SpiffyStoresApp
+  module Generators
+    class AppProxyControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def create_app_proxy_controller
+        template 'app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb'
+      end
+      def create_app_proxy_index_view
+        copy_file 'index.html.erb', 'app/views/app_proxy/index.html.erb'
+      end
+      def add_app_proxy_route
+        inject_into_file(
+          'config/routes.rb',
+          File.read(File.expand_path(find_in_source_paths('app_proxy_route.rb'))),
+          after: "mount SpiffyStoresApp::Engine, at: '/'\n"
+        )
+      end
+    end
+  end
+end