Git Product home page Git Product logo

solidus_kustomer's Introduction

solidus_kustomer

CircleCI codecov

This extension allows you to integrate your Solidus store with the customer support application Kustomer via solidus_tracking.

Installation

Add solidus_kustomer to your Gemfile:

gem 'solidus_tracking', github: 'solidusio-contrib/solidus_tracking'
gem 'solidus_kustomer', github: 'nebulab/solidus_kustomer'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_kustomer:install

Usage

Once installed the extension will provide access to a SolidusKustomer::Client with the ability to interact with Kustomer KObjects.

This client is used interally via solidus_tracking to track relevant Solidus events to make them appear on customers' timelines.

Preparation

This extension assumes that your Kustomer organization have already present the following Klasses:

  • order

Events tracked

The events tracked by default are:

  • order_finalized

Creating customers on Kustomer

If you want to automatically create a customer on the Kustomer app upon account creation, you can set the identify_customer_on_creation configuration flag to true:

# config/initializers/solidus_kustomer.rb

SolidusKustomer.configure do |config|
  # ...
  config.identify_customer_on_creation = true
end

Newly created users will be automatically identified (registered as customers) on Kustomer.

Development

Testing the extension

First bundle your dependencies, then run bin/rake. bin/rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using bin/rake extension:test_app.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop

Updating the changelog

Before and after releases the changelog should be updated to reflect the up-to-date status of the project:

bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"

Releasing new versions

Your new extension version can be released using gem-release like this:

bundle exec gem bump -v 1.6.0
bin/rake changelog
git commit -a --amend
git push
bundle exec gem release

License

Copyright (c) 2020 Nebulab SRLs, released under the New BSD License.

solidus_kustomer's People

Contributors

aldesantis avatar nirebu avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

solidus_kustomer's Issues

Make Klass names configurable

It can happen that a user has already configured some klasses on their Kustomer organization, and given that they cannot be renamed or edited easily, it could be useful to make the relationship between Solidus classes and Kustomer Klasses configurable.

Initialize required Klasses on Kustomer upon app initialization

To create custom KObjects in Kustomer we first need to have available their Klasses in order to have their endpoints available. Looks like the endpoint is reachable with the singular and plural Klass name, although Kustomer documentation doesn't specify that.

Hitting a non existent Klass will result in a 404.

e. g. To have available the route klasses/orders we first need to create the order klass.

Verify API key permissions

We can check upon initialization that the API key has sufficient permissions to perform the CRUD operations offered by the extension.

So far the needed permissions are:

org.permission.customer
org.permission.klass
org.permission.kobject

Add customer_id to Spree::User

In order to create a KObject belonging to a customer to make it appear on their timeline we need to hit an endpoint such as

"/customers/#{kustomer_customer_UUID}/klasses/#{kobject_klass_name}"

to get that ID we need first to query Kustomer for it. We can get it by querying for a Spree::User id, which usually is used as externalId on Kustomer like so:

"/customers/externalId=#{Spree::User.id"

To reduce the amount of requests to Kustomer could be a good idea to store this ID in the user table.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.