{"id":23765816,"url":"https://github.com/solidusio-contrib/solidus_kustomer","last_synced_at":"2025-10-07T20:23:48.600Z","repository":{"id":142760007,"uuid":"299923603","full_name":"solidusio-contrib/solidus_kustomer","owner":"solidusio-contrib","description":"Kustomer integration for the Solidus eCommerce platform.","archived":false,"fork":false,"pushed_at":"2020-10-07T11:16:56.000Z","size":34,"stargazers_count":1,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-01T18:59:02.933Z","etag":null,"topics":["customer-success","customer-support","ecommerce","kustomer","solidus","tracking"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/solidusio-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-09-30T13:12:53.000Z","updated_at":"2025-01-11T08:56:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"b5a8a401-4dac-4332-a0c6-6efa0bd7f54d","html_url":"https://github.com/solidusio-contrib/solidus_kustomer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/solidusio-contrib/solidus_kustomer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_kustomer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_kustomer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_kustomer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_kustomer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidusio-contrib","download_url":"https://codeload.github.com/solidusio-contrib/solidus_kustomer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_kustomer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278839047,"owners_count":26054848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["customer-success","customer-support","ecommerce","kustomer","solidus","tracking"],"created_at":"2024-12-31T23:18:01.557Z","updated_at":"2025-10-07T20:23:48.594Z","avatar_url":"https://github.com/solidusio-contrib.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# solidus_kustomer\n\n[![CircleCI](https://circleci.com/gh/nebulab/solidus_kustomer.svg?style=shield)](https://circleci.com/gh/nebulab/solidus_kustomer)\n[![codecov](https://codecov.io/gh/nebulab/solidus_kustomer/branch/master/graph/badge.svg)](https://codecov.io/gh/nebulab/solidus_kustomer)\n\nThis extension allows you to integrate your [Solidus](https://solidus.io) store with the customer\nsupport application [Kustomer](https://kustomer.com) via [solidus_tracking](https://github.com/solidusio-contrib/solidus_tracking).\n\n## Installation\n\nAdd solidus_kustomer to your Gemfile:\n\n```ruby\ngem 'solidus_tracking', github: 'solidusio-contrib/solidus_tracking'\ngem 'solidus_kustomer', github: 'nebulab/solidus_kustomer'\n```\n\nBundle your dependencies and run the installation generator:\n\n```shell\nbin/rails generate solidus_kustomer:install\n```\n\n## Usage\n\nOnce installed the extension will provide access to a `SolidusKustomer::Client` with the ability to\ninteract with Kustomer `KObjects`.\n\nThis client is used interally via [solidus_tracking](https://github.com/solidusio-contrib/solidus_tracking)\nto track relevant Solidus events to make them appear on customers' timelines.\n\n### Preparation\n\nThis extension assumes that your Kustomer organization have already present the following Klasses:\n\n- `order`\n\n### Events tracked\n\nThe events tracked by default are:\n\n- `order_finalized`\n\n### Creating customers on Kustomer\n\nIf you want to automatically create a customer on the Kustomer app upon account creation, you can\nset the `identify_customer_on_creation` configuration flag to `true`:\n\n```ruby\n# config/initializers/solidus_kustomer.rb\n\nSolidusKustomer.configure do |config|\n  # ...\n  config.identify_customer_on_creation = true\nend\n```\n\nNewly created users will be automatically identified (registered as customers) on Kustomer.\n\n## Development\n\n### Testing the extension\n\nFirst bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy\napp if it does not exist, then it will run specs. The dummy app can be regenerated by using\n`bin/rake extension:test_app`.\n\n```shell\nbin/rake\n```\n\nTo run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run\n\n```shell\nbundle exec rubocop\n```\n\n### Running the sandbox\n\nTo run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for\nthe sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to\n`sandbox/bin/rails`.\n\nHere's an example:\n\n```\n$ bin/rails server\n=\u003e Booting Puma\n=\u003e Rails 6.0.2.1 application starting in development\n* Listening on tcp://127.0.0.1:3000\nUse Ctrl-C to stop\n```\n\n### Updating the changelog\n\nBefore and after releases the changelog should be updated to reflect the up-to-date status of\nthe project:\n\n```shell\nbin/rake changelog\ngit add CHANGELOG.md\ngit commit -m \"Update the changelog\"\n```\n\n### Releasing new versions\n\nYour new extension version can be released using `gem-release` like this:\n\n```shell\nbundle exec gem bump -v 1.6.0\nbin/rake changelog\ngit commit -a --amend\ngit push\nbundle exec gem release\n```\n\n## License\n\nCopyright (c) 2020 Nebulab SRLs, released under the New BSD License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_kustomer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidusio-contrib%2Fsolidus_kustomer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_kustomer/lists"}