Skip to content
This repository was archived by the owner on Dec 9, 2020. It is now read-only.

Commit f1717f3

Browse files
Add deprecation warnings and post install message
1 parent 53c62fd commit f1717f3

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[branch]: http://learn.github.com/p/branching.html
66
[pr]: http://help.github.com/send-pull-requests/
77

8+
This gem has been replaced by the Freshworks gem and will no longer be supported. Please switch to [Freshworks](https://github.com/bonusly/freshworks) as soon as possible.
9+
810
# Natero Gem
911
A Ruby interface for the [Natero Public API][api-docs].
1012

@@ -40,15 +42,15 @@ Modify an account:
4042
```Ruby
4143
account = Natero::Account.retrieve('ACCOUNT_ID')
4244
account.name = 'TEST'
43-
45+
4446
Natero::Account.modify('ACCOUNT_ID', account)
4547
```
4648

4749
Create an event:
4850
```Ruby
4951
event = { id: 'test', name: 'Testing the API.'}
5052
details = 'These details should be associated with the event in Natero'
51-
53+
5254
Natero::Event.create(event, details)
5355
```
5456

@@ -67,7 +69,7 @@ improve this project. Here are some ways *you* can contribute:
6769
#### Submitting an issue:
6870
We use the [GitHub issue tracker][issues] to track bugs and features. Before
6971
submitting a bug report or feature request, check to make sure it hasn't
70-
already been submitted. When submitting a bug report, please include a stack
72+
already been submitted. When submitting a bug report, please include a stack
7173
trace and any details that may be necessary to reproduce
7274
the bug, including your gem version, Ruby version, and operating system.
7375
Ideally, a bug report should include a pull request with failing specs.

lib/natero/account.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
class Natero::Account < Natero::Base
22
def self.retrieve_all
3+
warn "[DEPRECATION] The Natero gem has been deprecated and will no longer be supported. Please switch to using the Freshworks gem. See https://rubygems.org/gems/freshworks and https://github.com/bonusly/freshworks."
34
get
45
end
56

@@ -66,4 +67,4 @@ def self.delete_nps_history(id, timestamp)
6667
def self.endpoint_path
6768
['accounts']
6869
end
69-
end
70+
end

lib/natero/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module Natero
2-
VERSION = '1.2.3'
2+
VERSION = '1.2.4'
33
end

natero.gemspec

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
1212
spec.description = 'Natero is customer success software used to reduce churn and increase B2B SaaS adoption.'
1313
spec.homepage = 'http://bonus.ly'
1414
spec.license = 'MIT'
15+
spec.post_install_message = 'The Natero gem has been deprecated and will no longer be supported. Please switch to using the Freshworks gem. See https://rubygems.org/gems/freshworks and https://github.com/bonusly/freshworks.'
1516

1617
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
1718
spec.bindir = 'exe'

0 commit comments

Comments
 (0)