trustpilot-business-links 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6019f007c1fb249a3f9ffbad4a40fa679b6909e93f25f3328f7143e45579024
+  data.tar.gz: f35de676468187a17d2fceb5943474d28c97933cde44a82f860e0c87345c232d
+SHA512:
+  metadata.gz: 902d8aa44e88cba2cf1c79beadfbf5a922c88da4e3bd8e2f8d525b0d8402219e5e26d08213654f2366ff53ae4f45df2f9b59cb5537dd7097038c0857b432e50f
+  data.tar.gz: 2d8abaf2a7b0bd976096ad8c6f1e139593ed88e9176c278fdbbe3d7512cb7aced6543d6227c8bde8630f04002e693bd1bcac52fb669e641aa9d4239ad5445730

data/.dockerignore

@@ -0,0 +1 @@
+.git/

data/.gitignore

@@ -0,0 +1,3 @@
+coverage/
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order=random

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 2.3.3
+  - 2.4.0
+
+before_install:
+  - gem update --system # https://github.com/bundler/bundler/issues/5357
+  - make install
+
+script:
+  - make test

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Next version
+- Your contribution!
+
+# Version 1.0.3
+- Bump minimal ruby version to 2.3.0
+
+# Version 1.0.2
+- Initial release

data/Dockerfile

@@ -0,0 +1,31 @@
+FROM ruby:2.4
+
+# System dependencies: Add here any librairies needed for certain gems
+RUN apt-get update \
+  && apt-get install -y libpq-dev \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Application working directory
+WORKDIR /home/trustpilot-business-links
+
+# WARNING The following line is important to keep bundle config
+# inside the app directory
+ENV  BUNDLE_APP_CONFIG /home/trustpilot-business-links/.bundle/
+# Copy dependency file
+COPY ./trustpilot-business-links-client.gemspec /home/trustpilot-business-links/trustpilot-business-links-client.gemspec
+COPY ./lib/trustpilot-business-links/version.rb /home/trustpilot-business-links/lib/trustpilot-business-links/version.rb
+COPY ./Gemfile /home/trustpilot-business-links/Gemfile
+
+# Ensure UTF8 strings can be used
+ENV LANG C.UTF-8
+
+# Bundle
+RUN bundle install
+
+# Copy code
+COPY ./ /home/trustpilot-business-links
+
+# What to launch on container startup
+ENTRYPOINT ["make"]
+CMD        ["run"]

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Trainline.com Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -0,0 +1,24 @@
+# Update the specified dependencies
+install:
+	@command -v ruby >/dev/null 2>&1 || { echo >&2 "I require ruby but it's not installed. Aborting."; exit 1; }
+	@command -v bundle >/dev/null 2>&1 || gem install bundler;
+	bundle check || bundle install
+
+# Run all the tests
+test: bundler
+	bundle exec rake spec
+
+# Build a new package file
+build:
+	bundle exec gem build trustpilot-business-links.gemspec
+
+# Publish a package on https://rubygems.org/gems/trustpilot-business-links
+publish:
+	bundle exec gem push $(PACKAGE_FILE)
+
+# Private - ensure gems are up-to-date
+bundler:
+	bundle check>/dev/null || bundle install
+
+
+.PHONY: install test build publish bundler

data/README.md

@@ -0,0 +1,43 @@
+[![Build Status](https://travis-ci.org/trainline-eu/trustpilot-business-links.svg?branch=master)](https://travis-ci.org/trainline-eu/trustpilot-business-links)
+
+Generate the [Trustpilot Business Generated Links](https://support.trustpilot.com/hc/en-us/articles/115002337108-Trustpilot-s-Business-Generated-Links-) in ruby.
+
+# Requirements
+- Ruby 2.3.0 or newer
+
+# Installation
+`gem install trustpilot-business-links`
+
+# Usage
+~~~ruby
+require 'json'
+require 'trustpilot-business-links'
+
+# Keys generated on https://businessapp.b2b.trustpilot.com/#/invitations/business-generated-links
+encryption_key = 'gn96sJwFRQuQl3bjNIPM0xp+TnK4iBaW0I4DpR0o+cs='
+authentication_key = 'eE4zdEfGNlxjGVjtWpOLAYAM0gKeF5j6Db7ZXd1Bixo='
+trustpilot_bgl = TrustpilotBusinessLinks.new(encryption_key, authentication_key)
+
+review_payload = {
+  email: "customer1@example.net",
+  name: "John Smith",
+  ref: "1234",
+}
+
+encrypted_payload = trustpilot_bgl.encrypt(review_payload.to_json)
+
+puts "https://www.trustpilot.com/evaluate-bgl/www.example.com?p=#{encrypted_payload}"
+~~~
+
+# Test
+~~~bash
+make test
+~~~
+
+100% of the source code should be covered.
+
+# Contributing
+You are warmly welcome to contribute to the project!
+
+# Documentation
+* https://support.trustpilot.com/hc/en-us/articles/115004145087--Business-Generated-Links-for-developers-

data/Rakefile

@@ -0,0 +1,11 @@
+# Test tasks
+begin
+  require "ci/reporter/rake/rspec"
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :rspec => "ci:setup:rspec"
+
+  # Default
+  task :default => :spec
+rescue LoadError
+end

data/lib/trustpilot-business-links.rb

@@ -0,0 +1,42 @@
+require 'openssl'
+require 'base64'
+require 'cgi'
+
+class TrustpilotBusinessLinks
+  ENCRYPTION_CIPHER = 'AES-256-CBC'
+  HMAC_DIGEST = 'SHA256'
+
+  def initialize(encryption_key, authentication_key)
+    @encryption_key = Base64.strict_decode64(encryption_key)
+    @authentication_key = Base64.strict_decode64(authentication_key)
+  end
+
+  def encrypt(payload)
+    encrypted_payload, iv = encrypt_iv(payload)
+    hmac = hmac(iv, encrypted_payload)
+
+    encode(iv + encrypted_payload + hmac)
+  end
+
+  private
+
+  attr_accessor :encryption_key, :authentication_key
+
+  def encrypt_iv(data)
+    cipher = OpenSSL::Cipher.new(ENCRYPTION_CIPHER)
+    cipher.encrypt
+    cipher.key = encryption_key
+    iv = cipher.random_iv
+    encrypted_payload = cipher.update(data) + cipher.final
+
+    [encrypted_payload, iv]
+  end
+
+  def hmac(iv, encrypted_payload)
+    OpenSSL::HMAC.digest(HMAC_DIGEST, authentication_key, iv + encrypted_payload)
+  end
+
+  def encode(payload)
+    CGI.escape(Base64.strict_encode64(payload))
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,15 @@
+require "simplecov"
+require "simplecov-rcov"
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::RcovFormatter
+]
+SimpleCov.start
+require "rspec"
+require "rspec/its"
+require "rack/test"
+
+require 'pry'
+
+# Load libs
+require "trustpilot-business-links"

data/spec/trustpilot_business_links_spec.rb

@@ -0,0 +1,29 @@
+require "helper"
+require "json"
+
+class TrustpilotBusinessLinks
+  describe TrustpilotBusinessLinks do
+    let(:encryption_key) { 'gn96sJwFRQuQl3bjNIPM0xp+TnK4iBaW0I4DpR0o+cs=' }
+    let(:authentication_key) { 'eE4zdEfGNlxjGVjtWpOLAYAM0gKeF5j6Db7ZXd1Bixo=' }
+    let(:iv) { Base64.strict_decode64("vjtBtRC6poWv2GrWd2sXDg==") }
+    let(:trustpilot_generator) { TrustpilotBusinessLinks.new(encryption_key, authentication_key) }
+
+    before do
+      # Fake the IV generation to get a stable encrypted output
+      allow_any_instance_of(OpenSSL::Cipher).to receive(:random_iv).and_return(iv)
+    end
+
+    describe "#encrypt" do
+      it "encrypts and URL encodes correctly the payload" do
+        payload = {
+          email: "test@example.com",
+          name: "John Smith",
+          ref: "1234",
+        }
+        encrypted_payload = trustpilot_generator.encrypt(payload.to_json)
+
+        expect(encrypted_payload).to eq('vjtBtRC6poWv2GrWd2sXDkqw%2FxhXg2kKX7yKDyPPHWyRcdG4gC3YUUFhJ6glpaWcboDO%2FE93H5OCcP20W12rhqcSpQjTcvhcACpiw4awvi0vInbj9PIh8QR00ch%2BsdErA3E1Wy9fEtc5BL8iYWFvgA%3D%3D')
+      end
+    end
+  end
+end

data/trustpilot-business-links.gemspec

@@ -0,0 +1,32 @@
+$: << File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'trustpilot-business-links'
+  s.licenses    = ['MIT']
+  s.version     = '1.0.3'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Théophile Helleboid']
+  s.email       = ['theophile.helleboid@trainline.com']
+  s.homepage    = 'https://github.com/trainline-eu/trustpilot-business-links'
+  s.summary     = %q(Generate Trustpilot Business Generated Links)
+  s.description = %q(This gem generates Trustpilot Business Generated Links described on https://support.trustpilot.com/hc/en-us/articles/115002337108-Trustpilot-s-Business-Generated-Links-)
+  s.metadata    = { "source_code_uri" => "https://github.com/trainline-eu/trustpilot-business-links" }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_dependency 'openssl', '~> 2.1'
+
+  s.add_development_dependency 'pry', '~> 0.11'
+  s.add_development_dependency 'ci_reporter', '~> 2.0'
+  s.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
+  s.add_development_dependency 'rack-test', '~> 0.7'
+  s.add_development_dependency 'rake', '~> 12.2'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rspec-its', '~> 1.2'
+  s.add_development_dependency 'simplecov', '~> 0.15'
+  s.add_development_dependency 'simplecov-rcov', '~> 0.2'
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: trustpilot-business-links
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Théophile Helleboid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: This gem generates Trustpilot Business Generated Links described on https://support.trustpilot.com/hc/en-us/articles/115002337108-Trustpilot-s-Business-Generated-Links-
+email:
+- theophile.helleboid@trainline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE.md
+- Makefile
+- README.md
+- Rakefile
+- lib/trustpilot-business-links.rb
+- spec/helper.rb
+- spec/trustpilot_business_links_spec.rb
+- trustpilot-business-links.gemspec
+homepage: https://github.com/trainline-eu/trustpilot-business-links
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/trainline-eu/trustpilot-business-links
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generate Trustpilot Business Generated Links
+test_files:
+- spec/helper.rb
+- spec/trustpilot_business_links_spec.rb