brite_verify_api 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +35 -9
- data/lib/brite_verify_api/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 07faff8fc543e0d67a4865ddf78003abcad9e527
|
|
4
|
+
data.tar.gz: 72093f17fd54718c3660e8dcae9dee63fc44c462
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ed445af8da4d27f64c75bf34169fe0c04d7ec323391809f0b4f7624bfdd8d0c59effa9e4444ccd5de4c88e5dc1b2e60d60034adfa1a293e210a792b3d628e2f3
|
|
7
|
+
data.tar.gz: e5a6313c0419e3dca1b56254b74f0372ee2a96b54001e6fc90ae105cde8d098dc56c131393286926801518f882582e4dd7b0390d98d00423de2f7d374b19c053
|
data/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# BriteVerifyApi
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
|
3
|
+
The un-official BriteVerifyApi API Client for Ruby
|
|
6
4
|
|
|
7
5
|
## Installation
|
|
8
6
|
|
|
@@ -22,17 +20,45 @@ Or install it yourself as:
|
|
|
22
20
|
|
|
23
21
|
## Usage
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
Create a configuration file and put it in your initializers config/initializers/brite_verify_api.rb
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
BriteVerifyApi.configure do |config|
|
|
27
|
+
config.api_key = "-----Api ----- key -----"
|
|
28
|
+
end
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Email Verification
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
brite_verify_api = BriteVerifyApi::Clients::Email.new "johndoe@example.com"
|
|
35
|
+
brite_verify_api.verify
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Testing the integration
|
|
26
39
|
|
|
27
|
-
|
|
40
|
+
Brite charge on per hit basis. On Development Environment you can set up another key in the configure block to prevent that hit (to save money). `default_email_api_reponse` should be hash. It will be returned as it is.
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
BriteVerifyApi.configure do |config|
|
|
44
|
+
config.api_key = "-----Api ----- key -----"
|
|
45
|
+
config.default_email_api_reponse = {
|
|
46
|
+
address: "johndoe@briteverify.com",
|
|
47
|
+
account: "johndoe",
|
|
48
|
+
domain: "briteverify.com",
|
|
49
|
+
status: "valid",
|
|
50
|
+
disposable: false,
|
|
51
|
+
role_address: false,
|
|
52
|
+
duration: 0.104516605
|
|
53
|
+
} if Rails.env.development?
|
|
54
|
+
end
|
|
55
|
+
```
|
|
28
56
|
|
|
29
|
-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
30
57
|
|
|
31
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
32
58
|
|
|
33
59
|
## Contributing
|
|
34
60
|
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
61
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/mohitjain/brite_verify_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
36
62
|
|
|
37
63
|
## License
|
|
38
64
|
|
|
@@ -40,4 +66,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
|
40
66
|
|
|
41
67
|
## Code of Conduct
|
|
42
68
|
|
|
43
|
-
Everyone interacting in the BriteVerifyApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/
|
|
69
|
+
Everyone interacting in the BriteVerifyApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mohitjain/brite_verify_api/blob/master/CODE_OF_CONDUCT.md).
|