{"id":20672099,"url":"https://github.com/workarea-commerce/workarea-mailchimp","last_synced_at":"2025-03-10T17:27:07.086Z","repository":{"id":56898480,"uuid":"203641402","full_name":"workarea-commerce/workarea-mailchimp","owner":"workarea-commerce","description":"Integrate MailChimp E-Commerce and E-Mail Subscriptions with the Workarea Platform","archived":false,"fork":false,"pushed_at":"2020-06-22T12:16:56.000Z","size":112,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-18T08:40:01.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workarea-commerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-21T18:22:52.000Z","updated_at":"2020-06-22T12:16:56.000Z","dependencies_parsed_at":"2022-08-20T17:40:38.548Z","dependency_job_id":null,"html_url":"https://github.com/workarea-commerce/workarea-mailchimp","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-mailchimp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-mailchimp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-mailchimp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-mailchimp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workarea-commerce","download_url":"https://codeload.github.com/workarea-commerce/workarea-mailchimp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242891300,"owners_count":20202323,"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","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":[],"created_at":"2024-11-16T20:32:01.846Z","updated_at":"2025-03-10T17:27:07.042Z","avatar_url":"https://github.com/workarea-commerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Workarea MailChimp\n================================================================================\n\nMailChimp plugin for the Workarea e-commerce platform\n\nThis plugin creates a basic integration between the Workarea platform and\nMailChimp's v3 API.\n\nIt requires a mailchimp access token which can be generated by following\nMailChimp's OAuth2 Flow here:\n\u003chttp://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/\u003e.\n\nThis access token should be used as the **API Key** in your secrets.\n\nScope and Dependencies\n--------------------------------------------------------------------------------\n\nThis plugin currently wraps functionality for subscribing and unsubscribing users by email, as well as retrieving interest groups (or categories) for users and lists\n\nIt is dependant on the [gibbon rubygem](https://github.com/amro/gibbon) which provides a basic wrapper for the MailChimp v3 API.\n\nGetting Started\n--------------------------------------------------------------------------------\n\nAdd the gem to your application's Gemfile:\n\n```ruby\n# ...\ngem 'workarea-mail_chimp'\n# ...\n```\n\nUpdate your application's bundle.\n\n```bash\ncd path/to/application\nbundle\n```\n\nAfter deploying for the first time, run this on your production server\nto seed products/orders into MailChimp:\n\n```bash\nrails workarea:mail_chimp:install\n```\n\nAdditional tasks can be discovered by running `rails --tasks`.\n\nConfiguration\n--------------------------------------------------------------------------------\n\nThis plugin requires gateway configuration in order to function.\n\nIn your secrets file:\n\n    mail_chimp:\n      :api_key: YOUR_OAUTH_ACCESS_TOKEN_OR_API_KEY\n      :default_list_id: LIST_ID\n      :list_preferences_id: LIST_PREFERENCES_ID\n\n### To find your default list ID, in the mailchimp admin:\n\n1. Go to the list you wish to use\n2. Click the settings dropdown menu\n3. Choose the 'List name and defaults' menu item\n4. You will find the List ID on this page, at the time of writing it is displayed\n    at the top left of the page.\n\n### To find your list preferences ID via the API playground:\n\n1. Visit [API playground](https://us16.api.mailchimp.com/playground/)\n2. Enter your API key\n3. Click on the 'Lists' Link\n4. Find the subresources dropdown for your default list\n5. Choose 'interest-categories' from the subresources dropdown\n6. Click the name of your interest group\n7. Use the ID field shown in the details section, the 'list_id' field should\n    correspond with your default_list_id\n\nIf you're using MailChimp's own abandoned cart email functionality, you\nshould also disable Workarea's internal emailer by including this in\nyour initializers:\n\n```ruby\nunless Workarea.config.skip_service_connections\n  Sidekiq::Cron::Job.destroy('Workarea::OrderReminder')\nend\n```\n\nTesting \u0026 Maintenance\n--------------------------------------------------------------------------------\n\nEnsure that the gateway credentials within application secrets are set in\n`spec/dummy/config/secrets.yml` for test mode\n\nTo get specs to pass, you will need to configure a MailChimp account with the\nfollowing data\n\n* A group/category with the same information as what is configured in\n    `HelperMethods#email_all_interests_hash` in `spec/fixtures/helper_methods.rb`\n\n* A user that was unsubscribed with the following email: `test-unsubscribed@weblinc.com`\n\n* A subscribed user with the following email: `mdalton-simonpearce@weblinc.com`\n\nThe specs use VCR cassettes to record http requests, so maintainers will need to flush the cassettes when modifying the requests.\n\nWorkarea Commerce Documentation\n--------------------------------------------------------------------------------\n\nSee [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.\n\nLicense\n--------------------------------------------------------------------------------\n\nWorkarea Mailchimp is released under the [Business Software License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-mailchimp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkarea-commerce%2Fworkarea-mailchimp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-mailchimp/lists"}