workarea-yotpo 1.0.0

data/app/views/workarea/storefront/_yotpo_tracking.html.haml

@@ -0,0 +1,3 @@
+- if Workarea::Yotpo.app_key.present?
+  %script{ type: "text/javascript" }
+    (function e(){var e=document.createElement("script");e.type="text/javascript",e.async=true,e.src="//staticw2.yotpo.com/#{Workarea::Yotpo.app_key}/widget.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();

data/app/views/workarea/storefront/checkouts/_yotpo_order_tracking.html.haml

@@ -0,0 +1,7 @@
+- if Workarea::Yotpo.app_key.present?
+  :javascript
+    (function e(){var e=document.createElement("script");e.type="text/javascript",e.async=true,e.src="//staticw2.yotpo.com/#{Workarea::Yotpo.app_key}/widget.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();
+  :javascript
+    yotpoTrackConversionData = {orderId: "#{@order.id}", orderAmount: "#{@order.total_price}", orderCurrency: "#{@order.total_price.currency.iso_code}"}
+  %noscript
+    %img{:height => "1", :src => "//api.yotpo.com/conversion_tracking.gif?app_key=#{Workarea::Yotpo.app_key}&order_id=#{@order.id}&order_amount=#{@order.total_price}&order_currency=#{@order.total_price.currency.iso_code}", :width => "1"}/

data/app/views/workarea/storefront/products/_yotpo_product_summary.html.haml

@@ -0,0 +1,2 @@
+- if Workarea::Yotpo.app_key.present? && Workarea.config.yotpo.show_review_summary_on_pdp
+  .yotpo.bottomLine{"data-product-id" => "#{product.id}", "data-url" => "#{product_url(product)}"}

data/app/views/workarea/storefront/products/_yotpo_reviews.html.haml

@@ -0,0 +1,2 @@
+- if Workarea::Yotpo.app_key.present?
+  .yotpo.yotpo-main-widget{"data-currency" => "#{product.sell_min_price.currency}", "data-image-url" => "#{product_image_url(product.primary_image, :small)}", "data-name" => "#{product.name}", "data-price" => "#{product.pricing.sell_min_price}", "data-product-id" => "#{product.id}", "data-url" => "#{product_url(product)}" }

data/app/views/workarea/storefront/products/_yotpo_summary.html.haml

@@ -0,0 +1,2 @@
+- if Workarea::Yotpo.app_key.present? && Workarea.config.yotpo.show_review_summary_on_product_summary
+  .yotpo.bottomLine{"data-product-id" => "#{product.id}", "data-url" => "#{product_url(product)}"}

data/app/workers/workarea/yotpo/save_order.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module Yotpo
+    class SaveOrder
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::Order => [:place] },
+        unique: :until_executing
+      )
+
+      def perform(id)
+        order = Workarea::Order.find(id)
+        yotpo_order = Workarea::Yotpo::Order.new(order.id)
+
+        Workarea::Yotpo.gateway.create_order(yotpo_order.to_h)
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/workarea/yotpo/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,24 @@
+Workarea.append_partials(
+  'storefront.document_head',
+  'workarea/storefront/yotpo_tracking'
+)
+
+Workarea.append_partials(
+  'storefront.product_show',
+  'workarea/storefront/products/yotpo_reviews'
+)
+
+Workarea.append_partials(
+  'storefront.product_details',
+  'workarea/storefront/products/yotpo_product_summary'
+)
+
+Workarea.append_partials(
+  'storefront.product_summary',
+  'workarea/storefront/products/yotpo_summary'
+)
+
+Workarea.append_partials(
+  'storefront.checkout_confirmation',
+  'workarea/storefront/checkouts/yotpo_order_tracking'
+)

data/config/initializers/workarea.rb

@@ -0,0 +1,11 @@
+Workarea.configure do |config|
+  config.yotpo = ActiveSupport::Configurable::Configuration.new
+  config.yotpo.app_key = nil # js sdk integration
+
+  # show review summary on PDP
+  config.yotpo.show_review_summary_on_pdp = true
+
+  # show review summaries on product summaries in search,
+  # browse, and recomendation
+  config.yotpo.show_review_summary_on_product_summary = true
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/workarea/yotpo.rb

@@ -0,0 +1,41 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/yotpo/engine'
+require 'workarea/yotpo/version'
+
+require 'workarea/yotpo/authentication'
+require 'workarea/yotpo/gateway'
+require 'workarea/yotpo/bogus_gateway'
+require 'workarea/yotpo/response'
+
+require 'faraday'
+
+module Workarea
+  module Yotpo
+    def self.credentials
+      (Rails.application.secrets.yotpo || {}).deep_symbolize_keys
+    end
+
+    def self.config
+      Workarea.config.yotpo
+    end
+
+    def self.app_key
+      config.app_key
+    end
+
+    def self.secret_key
+      credentials[:secret_key]
+    end
+
+    def self.gateway
+      if credentials.present?
+        Workarea::Yotpo::Gateway.new(app_key: app_key, secret_key: secret_key)
+      else
+        Workarea::Yotpo::BogusGateway.new
+      end
+    end
+  end
+end

data/lib/workarea/yotpo/authentication.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Yotpo
+    module Authentication
+      class NoTokenError < StandardError; end
+
+      def token
+        response = get_token
+        raise NoTokenError unless response.present? && response.success?
+
+        body = JSON.parse(response.body)
+        body['access_token']
+      end
+
+      private
+
+        def get_token
+          conn = Faraday.new(url: auth_endpoint)
+          conn.post do |req|
+            req.url '/oauth/token', token_params
+            req.headers['Content-Type'] = 'application/json'
+          end
+        end
+
+        def token_params
+          {
+            client_id: client_id,
+            client_secret: client_secret,
+            grant_type: 'client_credentials'
+          }
+        end
+
+        def auth_endpoint
+          "https://api.yotpo.com"
+        end
+
+        def client_id
+          options[:app_key]
+        end
+
+        def client_secret
+          options[:secret_key]
+        end
+    end
+  end
+end

data/lib/workarea/yotpo/bogus_gateway.rb

@@ -0,0 +1,33 @@
+module Workarea
+  module Yotpo
+    class BogusGateway
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def create_order(order_details)
+        Response.new(response)
+      end
+
+      private
+        def response
+          response = Faraday.new do |builder|
+            builder.adapter :test do |stub|
+              stub.get('/rest/bogus.json') { |env| [ 200, {}, response_body ] }
+            end
+          end
+          response.get('/rest/bogus.json')
+        end
+
+        def response_body
+          {
+            code: 200,
+            message: "OK",
+            uuid: "4161933d-9213-45ee-beb4-cb3ac2844345"
+          }.to_json
+        end
+    end
+  end
+end

data/lib/workarea/yotpo/engine.rb

@@ -0,0 +1,10 @@
+require 'workarea/yotpo'
+
+module Workarea
+  module Yotpo
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::Yotpo
+    end
+  end
+end

data/lib/workarea/yotpo/gateway.rb

@@ -0,0 +1,64 @@
+module Workarea
+  module Yotpo
+    class Gateway
+      include Yotpo::Authentication
+      class YotpoGatewayError < StandardError; end
+
+      attr_reader :options
+
+      def initialize(options = {})
+        requires!(options, :app_key, :secret_key)
+        @options = options
+      end
+
+      def create_order(order_details)
+        auth_creds = {
+          utoken: token,
+          app_key: client_id
+        }
+
+        body = order_details.merge(auth_creds).to_json
+
+        response = connection.post do |req|
+          req.url "apps/#{client_id}/purchases/"
+          req.body = body
+        end
+
+        Response.new(response)
+      end
+
+      private
+
+        def rest_endpoint
+          'https://api.yotpo.com'
+        end
+
+        def connection
+          headers = {
+            'Content-Type' => 'application/json',
+            'Authorization' => "Bearer #{token}"
+          }
+
+          request_timeouts = {
+            timeout: Workarea.config.yotpo.api_timeout,
+            open_timeout: Workarea.config.yotpo.open_timeout
+          }
+
+          Faraday.new(url: rest_endpoint, headers: headers, request: request_timeouts)
+        end
+
+        def requires!(hash, *params)
+          params.each do |param|
+            if param.is_a?(Array)
+              raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+              valid_options = param[1..-1]
+              raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(words_connector: 'or')}") unless valid_options.include?(hash[param.first])
+            else
+              raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+            end
+          end
+        end
+    end
+  end
+end

data/lib/workarea/yotpo/response.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Yotpo
+    class Response
+      def initialize(response)
+        @response = response
+      end
+
+      def success?
+        @response.success?
+      end
+
+      def body
+        @body ||= JSON.parse(@response.body)
+      end
+    end
+  end
+end

data/lib/workarea/yotpo/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Yotpo
+    VERSION = "1.0.0"
+  end
+end

data/script/static_analysis

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+echo "*************************************************************************"
+echo "Running Bundler Audit..."
+bundle exec bundle-audit check --update
+rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi
+
+echo ""
+echo ""
+echo "*************************************************************************"
+echo "Running Rubocop..."
+bundle exec rubocop
+rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi
+
+yarn init -yp --silent
+
+echo ""
+echo ""
+echo "*************************************************************************"
+echo "Running ESLint..."
+yarn add --silent --dev eslint@4.19.1 --loglevel error
+yarn run eslint admin/app/**/*.js admin/**/test/**/*.js core/app/**/*.js core/**/test/**/*.js storefront/app/**/*.js storefront/**/test/**/*.js
+rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi
+
+echo ""
+echo "*************************************************************************"
+echo "Running Stylelint..."
+yarn add --silent --dev stylelint@9.2.1 stylelint-scss@3.1.0 stylelint-config-recommended-scss@3.2.0
+yarn run stylelint admin/app/**/*.scss core/app/**/*.scss storefront/app/**/*.scss

data/script/travis

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bundle exec rake workarea:services:up
+sleep 10 # to let Elasticsearch prepare itself
+
+eval $TEST_COMMAND

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end