workarea-yotpo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b80de1a1a156c40c8bfed1a1c2d320f8c12ebd044b166a331687487c498864e2
+  data.tar.gz: bcb49c56831060862d49b983dcb6f295da78c8d53d1d116d3c3327df4daf589f
+SHA512:
+  metadata.gz: c43000aa5d2074db6b09c1432a7b7c10fecb7a1bb18efa579f05bd9349402064b6175a54015f2529b7649098df69141d55bed2e049b41eb58ce37935c4fa0183
+  data.tar.gz: 43bcfcbeb05b01598b1456bf08c8930afc54fca02ab7e9a69ee94f6ab8842e3a7b1c81dfc73c19a04d82a76a2ae00396211ad1e24366424055bcf5aaefc9cf7d

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+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!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+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
+
+  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

@@ -0,0 +1,23 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/yarn-error.log
+test/dummy/tmp/
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+node_modules
+package.json
+yarn.lock
+.rubocop-http*

data/.rubocop.yml

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

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+rvm:
+  - 2.6
+
+env:
+  global:
+    - CI=true RAILS_ENV=test WORKAREA_CAPYBARA_MAX_WAIT_TIME=15
+  matrix:
+    - TEST_COMMAND="bin/rails app:workarea:test:admin --trace"
+    - TEST_COMMAND="bin/rails app:workarea:test:core --trace"
+    - TEST_COMMAND="bin/rails app:workarea:test:storefront --trace"
+    - TEST_COMMAND="bin/rails app:workarea:test:plugins --trace"
+    - TEST_COMMAND="bin/rails test test/**/*_test.rb -b"
+    - TEST_COMMAND="script/static_analysis"
+
+services:
+  - docker
+
+addons:
+  chrome: stable
+
+bundler_args: --jobs 3 --retry 3
+
+cache: bundler
+
+script: 'script/travis'
+

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+Workarea Yotpo 1.0.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+*   Create YOPTO plugin
+
+    Curt Howard
+
+
+
+Workarea Yotpo 1.0.0 (2019-09-04)
+--------------------------------------------------------------------------------
+
+*   Releasing v1.0.0
+
+    Yotpo for review UGC. Integration includes review widget, order exports and
+    product export via the Google Product Feed format.
+    Eric Pigeon
+
+
+

data/CODE_OF_CONDUCT.md

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

data/CONTRIBUTING.md

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'workarea', github: 'workarea-commerce/workarea'

data/LICENSE.md

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

data/README.md

@@ -0,0 +1,86 @@
+Workarea Yotpo
+================================================================================
+
+Yotpo plugin for the Workarea platform.
+
+The following features are supported:
+
+  * Yotpo JS SDK included on every page
+  * Order tracking JS on confirmation page
+  * Order export via the API
+  * Review display on PDP and product summaries.
+
+Configuration
+--------------------------------------------------------------------------------
+
+An app key must be set in configuration to enable reviews.
+
+Add the following to an initializer:
+
+    config.yotpo.app_key = nil
+
+A secret must be provided in the secrets to send orders via the API.
+
+Add the following to secrets:
+
+    yotpo:
+      secret_key: YOUR-SECRET-KEY
+
+Additional configuration options are available for displaying reviews:
+
+    # show review summary on PDP
+    config.yotpo.show_review_summary_on_pdp = true #
+
+    # show review summaries on product summaries in search,
+    # browse, and recommendations
+    config.yotpo.show_review_summary_on_product_summary = true
+
+    config.curalate.site_name = 'YOUR_SITE_NAME'
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+To access Workarea gems and source code, you must be an employee or a licensed retailer or partner.
+
+Workarea gems are hosted privately at https://gems.weblinc.com/.
+You must have individual or team credentials to install gems from this server. Add your gems server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-yotpo', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-yotpo'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.workarea.com](http://developer.workarea.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright Workarea 2019. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,60 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Yotpo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/yotpo/version'
+
+desc "Release version #{Workarea::Yotpo::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'
+
+  system "git tag -a v#{Workarea::Yotpo::VERSION} -m 'Tagging #{Workarea::Yotpo::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-yotpo.gemspec"
+  system "gem push workarea-yotpo-#{Workarea::Yotpo::VERSION}.gem"
+  system "gem push workarea-yotpo-#{Workarea::Yotpo::VERSION}.gem --host #{host}"
+  system "rm workarea-yotpo-#{Workarea::Yotpo::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/services/yotpo/order.rb

@@ -0,0 +1,81 @@
+module Workarea
+  module Yotpo
+    class Order
+       module ProductUrl
+        include Workarea::I18n::DefaultUrlOptions
+        include Storefront::Engine.routes.url_helpers
+        extend self
+      end
+
+      module ProductImageUrl
+        include Workarea::ApplicationHelper
+        include Workarea::I18n::DefaultUrlOptions
+        include ActionView::Helpers::AssetUrlHelper
+        include Core::Engine.routes.url_helpers
+        extend self
+
+        def mounted_core
+          self
+        end
+      end
+
+      attr_reader :order_id, :options
+
+      def initialize(order_id, options = {})
+        @order_id = order_id
+        @options = options
+      end
+
+      # Builds an order hash for Yotpo
+      # API consumption
+      #
+      # @return [Hash]
+      def to_h
+        {
+          validate_data: true,
+          platform: "general", # TODO - get on the list of approved yotpo platforms
+          email: order.email,
+          customer_name: order.billing_address.first_name + " " + order.billing_address.last_name,
+          order_id: order.id,
+          order_date: order.placed_at,
+          currency_iso: order.total_price.currency.iso_code,
+          products: products,
+          customer: customer
+        }
+      end
+
+      private
+
+        def order
+          @order ||=
+            begin
+              o = Workarea::Order.find(order_id)
+                Workarea::Storefront::OrderViewModel.new(o)
+            end
+        end
+
+        # @return [Hash]
+        def products
+          order.items.inject({}) do |memo, item|
+            memo[item.product.id] = {
+              url: ProductUrl.product_url(id: item.product.to_param, host: Workarea.config.host),
+              name: item.product.name,
+              description: item.product.description,
+              price: item.original_price.to_s,
+              image: ProductImageUrl.product_image_url(item.image, :detail)
+            }
+            memo
+          end
+        end
+
+        def customer
+          address = order.shipping_address || order.billing_address
+          {
+            state: address.region,
+            country: address.country.alpha2,
+            address: address.street
+          }
+        end
+    end
+  end
+end