Skip to content

Commit

Permalink
Remove SendGrid adapter (#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewmcgarvey authored Apr 8, 2021
1 parent b7c5f4d commit 7a10947
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 277 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,5 @@ jobs:
run: shards install
- name: Create .env file
run: touch .env
- if: env.RUN_INTEGRATION_SPECS == true
name: Run tests with integration
- name: Run tests
run: crystal spec
- if: env.RUN_INTEGRATION_SPECS != true
name: Run tests without integration
run: crystal spec -D skip-integration
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dependencies:
## Adapters
- `Carbon::SendGridAdapter`- Ships with Carbon.
- `Carbon::SendGridAdapter`- See [luckyframework/carbon_sendgrid_adapter](https://github.com/luckyframework/carbon_sendgrid_adapter).
- `Carbon::AwsSesAdapter` - See [keizo3/carbon_aws_ses_adapter](https://github.com/keizo3/carbon_aws_ses_adapter).
- `Carbon::SendInBlueAdapter` - See [atnos/carbon_send_in_blue_adapter](https://github.com/atnos/carbon_send_in_blue_adapter).
- `Carbon::MailgunAdapter` - See [atnos/carbon_mailgun_adapter](https://github.com/atnos/carbon_mailgun_adapter).
Expand All @@ -45,7 +45,7 @@ end

```crystal
BaseEmail.configure do |settings|
settings.adapter = Carbon::SendGridAdapter.new(api_key: "SEND_GRID_API_KEY")
settings.adapter = Carbon::DevAdapter.new(print_emails: true)
end
```

Expand Down Expand Up @@ -201,18 +201,7 @@ end

- `shards install`
- Make changes
- `crystal spec -D skip-integration` (will skip sending test emails to SendGrid)
- `crystal spec` requires a `SEND_GRID_API_KEY` ENV variable. Set this in a .env file:

```
# in .env
# If you want to run tests that actually test emails against the SendGrid server
SEND_GRID_API_KEY=get_from_send_grid
```

> Note: When you open a PR, Github Actions will not run the integration suite.
> If you need the integeration suite to run, the `RUN_INTEGRATION_SPECS` env var must
> be set to `true`.
- `crystal spec`

## Contributing

Expand All @@ -226,4 +215,4 @@ SEND_GRID_API_KEY=get_from_send_grid

## Contributors

- [paulcsmith](https://github.com/paulcsmith]) Paul Smith - creator, maintainer
- [paulcsmith](https://github.com/paulcsmith) Paul Smith - creator, maintainer
123 changes: 0 additions & 123 deletions spec/send_grid_adapter_spec.cr

This file was deleted.

134 changes: 0 additions & 134 deletions src/carbon/adapters/send_grid_adapter.cr

This file was deleted.

0 comments on commit 7a10947

Please sign in to comment.