natero 1.0.0

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0c0d7d9f1d088d627aa867e91872c97fd5d834f7
4
+ data.tar.gz: 1af789490d4a356b2d26d8cd696ecc17d078d00c
5
+ SHA512:
6
+ metadata.gz: 6fc72ddc852e37269934cdf7f8cdb4e0b415a3fd7844f30f06c585b980057f1d76e7e9806dc29721c3794418667cc3c081cb061e779a51b486b36a657dff0bf0
7
+ data.tar.gz: e10eb2a505704421142bbe7eaf7bdcb7f17109e497a057c76a456ca970c5815feaa7a133bfbccdfef7803e130c118a4261332ed6a9bec37fcdeb7c2b33fe24e3
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at abbrown22@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in natero.gemspec
4
+ gemspec
@@ -0,0 +1,41 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ natero (0.1.0)
5
+ httparty (~> 0.13)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ diff-lcs (1.2.5)
11
+ httparty (0.13.7)
12
+ json (~> 1.8)
13
+ multi_xml (>= 0.5.2)
14
+ json (1.8.3)
15
+ multi_xml (0.5.5)
16
+ rake (10.5.0)
17
+ rspec (3.4.0)
18
+ rspec-core (~> 3.4.0)
19
+ rspec-expectations (~> 3.4.0)
20
+ rspec-mocks (~> 3.4.0)
21
+ rspec-core (3.4.4)
22
+ rspec-support (~> 3.4.0)
23
+ rspec-expectations (3.4.0)
24
+ diff-lcs (>= 1.2.0, < 2.0)
25
+ rspec-support (~> 3.4.0)
26
+ rspec-mocks (3.4.1)
27
+ diff-lcs (>= 1.2.0, < 2.0)
28
+ rspec-support (~> 3.4.0)
29
+ rspec-support (3.4.1)
30
+
31
+ PLATFORMS
32
+ ruby
33
+
34
+ DEPENDENCIES
35
+ bundler (~> 1.11)
36
+ natero!
37
+ rake (~> 10.0)
38
+ rspec (~> 3.0)
39
+
40
+ BUNDLED WITH
41
+ 1.11.2
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 markovAntony
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,41 @@
1
+ # Natero
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/natero`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'natero'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install natero
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
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
+
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
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/natero. 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
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
@@ -0,0 +1,9 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ # run console with gem loaded
7
+ task :console do
8
+ exec "irb -r natero -I ./lib"
9
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "natero"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,52 @@
1
+ require 'httparty'
2
+ require 'json'
3
+ require 'pry'
4
+
5
+ module Natero
6
+ PRODUCTION_URI = 'https://api.natero.com'
7
+
8
+ API_VERSION_URI = '/api/v2'
9
+
10
+ class Configuration
11
+ attr_accessor :base_uri, :account_api_key, :event_api_key, :event_auth_key
12
+
13
+ def initialize
14
+ self.base_uri = PRODUCTION_URI
15
+ self.account_api_key = nil
16
+ self.event_api_key = nil
17
+ self.event_auth_key = nil
18
+ end
19
+ end
20
+
21
+ def self.configuration
22
+ @configuration ||= Configuration.new
23
+ end
24
+
25
+ def self.configure
26
+ yield(configuration) if block_given?
27
+ end
28
+
29
+ def self.full_endpoint_uri(endpoint, *params)
30
+ base = self.uri + '/' + endpoint
31
+
32
+ params.each { |param| base << '/' + param } unless params.flatten.empty?
33
+
34
+ base + self.api_key_uri
35
+ end
36
+
37
+ def self.uri
38
+ Natero.configuration.base_uri + API_VERSION_URI
39
+ end
40
+
41
+ def self.api_key_uri
42
+ '?api_key=' + Natero.configuration.account_api_key
43
+ end
44
+
45
+ def self.to_records_json(objects)
46
+ "{\"records\": #{Array(objects).map(&:serialize)}}".to_s.delete('\\').gsub('"{', '{').gsub('}"', '}')
47
+ end
48
+ end
49
+
50
+ require_relative 'natero/serializable'
51
+ require_relative 'natero/account'
52
+ require_relative 'natero/response'
@@ -0,0 +1,140 @@
1
+ class Natero::Account
2
+ include HTTParty
3
+ include Serializable
4
+
5
+ attr_reader :account_id, :name, :join_date, :renewal_date,
6
+ :billing_account_id, :support_account_id, :crm_account_id,
7
+ :billing_street, :billing_city, :billing_postal_code,
8
+ :billing_state, :billing_country, :phone, :employees,
9
+ :industry, :tier, :csm_score, :sales_rep_name, :sales_rep_email,
10
+ :source, :stage, :is_deleted, :is_churned, :inactive_time, :inactive_reason,
11
+ :assigned_csms, :custom_label_dimensions, :custom_value_dimensions,
12
+ :custom_event_dimensions, :stage_history, :nps_history, :raw_response
13
+
14
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20all%20accounts
15
+ def self.retrieve_all
16
+ Natero::Response.new(get(endpoint))
17
+ end
18
+
19
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20an%20account
20
+ def self.retrieve(id)
21
+ Natero::Response.new(get(endpoint(id)))
22
+ end
23
+
24
+ # http://apidocs.natero.com/apidoc.html#Accounts_Bulk%20insert%2Fmodify%20accounts
25
+ def self.bulk_insert_modify(accounts)
26
+ body = Natero.to_records_json(accounts)
27
+ Natero::Response.new(post(endpoint, { :body => body }))
28
+ end
29
+
30
+ # http://apidocs.natero.com/apidoc.html#Accounts_Modify%20an%20account
31
+ def self.modify(id, account)
32
+ body = account.to_json
33
+ Natero::Response.new(put(endpoint(id), { :body => body }))
34
+ end
35
+
36
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20custom%20metrics
37
+ def self.retrieve_custom_metrics(id)
38
+ Natero::Response.new(get(endpoint(id, 'metrics')))
39
+ end
40
+
41
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20invoice%20statements
42
+ def self.retrieve_invoice_statements(id)
43
+ Natero::Response.new(get(endpoint(id, 'statements')))
44
+ end
45
+
46
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20subscription%20history
47
+ def self.retrieve_subscription_history(id)
48
+ Natero::Response.new(get(endpoint(id, 'subscriptions')))
49
+ end
50
+
51
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20support%20tickets
52
+ def self.retrieve_support_tickets(id)
53
+ Natero::Response.new(get(endpoint(id, 'support_tickets')))
54
+ end
55
+
56
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20product%20users
57
+ def self.retrieve_product_users(id)
58
+ Natero::Response.new(get(endpoint(id, 'users')))
59
+ end
60
+
61
+ # http://apidocs.natero.com/apidoc.html#Accounts_Retrieve%20contacts
62
+ def self.retrieve_contacts(id)
63
+ Natero::Response.new(get(endpoint(id, 'contacts')))
64
+ end
65
+
66
+ # http://apidocs.natero.com/apidoc.html#Accounts_Deactivate%20an%20account
67
+ def self.deactivate_account(id)
68
+ Natero::Response.new(delete(endpoint(id)))
69
+ end
70
+
71
+ # http://apidocs.natero.com/apidoc.html#Accounts_Delete%20stage%20history
72
+ def self.delete_stage_history(id, name, timestamp)
73
+ Natero::Response.new(delete(endpoint(id, 'stage_history', name, timestamp)))
74
+ end
75
+
76
+ # http://apidocs.natero.com/apidoc.html#Accounts_Delete%20dimension%20values
77
+ def self.delete_dimension_values(id, key)
78
+ Natero::Response.new(delete(endpoint(id, 'dimension_values', key)))
79
+ end
80
+
81
+ # http://apidocs.natero.com/apidoc.html#Accounts_Delete%20dimension%20labels
82
+ def self.delete_dimension_labels(id, key)
83
+ Natero::Response.new(delete(endpoint(id, 'dimension_labels', key)))
84
+ end
85
+
86
+ # http://apidocs.natero.com/apidoc.html#Accounts_Delete%20assigned%20csm%20reps
87
+ def self.delete_assigned_csm_reps(id, email)
88
+ Natero::Response.new(delete(endpoint(id, 'assigned_csms', email)))
89
+ end
90
+
91
+ # http://apidocs.natero.com/apidoc.html#Accounts_Delete%20NPS%20history
92
+ def self.delete_nps_history(id, timestamp)
93
+ Natero::Response.new(delete(endpoint(id, 'nps_history', timestamp)))
94
+ end
95
+
96
+ def self.endpoint(*params)
97
+ Natero.full_endpoint_uri('accounts', params)
98
+ end
99
+
100
+ def initialize(params, raw_response = nil)
101
+ @account_id = params['account_id']
102
+ @name = params['name']
103
+ @join_date = params['join_date']
104
+ @renewal_date = params['renewal_date']
105
+ @billing_account_id = params['billing_account_id']
106
+ @support_account_id = params['support_account_id']
107
+ @crm_account_id = params['crm_account_id']
108
+ @billing_street = params['billing_street']
109
+ @billing_city = params['billing_city']
110
+ @billing_postal_code = params['billing_postal_code']
111
+ @billing_state = params['billing_state']
112
+ @billing_country = params['billing_country']
113
+ @phone = params['phone']
114
+ @employees = params['employees']
115
+ @industry = params['industry']
116
+ @tier = params['tier']
117
+ @csm_score = params['csm_score']
118
+ @sales_rep_name = params['sales_rep_name']
119
+ @sale_rep_email = params['sale_rep_email']
120
+ @source = params['source']
121
+ @stage = params['stage']
122
+ @is_deleted = params['is_deleted']
123
+ @is_churned = params['is_churned']
124
+ @inactive_time = params['inactive_time']
125
+ @inactive_reason = params['inactive_reason']
126
+ @assigned_csms = params['assigned_csms']
127
+ # Key/value #
128
+ @custom_label_dimensions = params['custom_label_dimensions']
129
+ @custom_value_dimensions = params['custom_value_dimensions']
130
+ @custom_event_dimensions = params['custom_event_dimensions']
131
+ #############
132
+ @stage_history = params['stage_history']
133
+ @nps_history = params['nps_history']
134
+ @raw_response = raw_response
135
+ end
136
+
137
+ def to_json
138
+ serialize
139
+ end
140
+ end
@@ -0,0 +1,8 @@
1
+ class Natero::Response
2
+ attr_reader :parsed_response, :code
3
+
4
+ def initialize(raw_response)
5
+ @parsed_response = raw_response.parsed_response
6
+ @code = raw_response.code
7
+ end
8
+ end
@@ -0,0 +1,20 @@
1
+ module Serializable
2
+ @@serializer = JSON
3
+
4
+ def serialize
5
+ obj = {}
6
+ instance_variables.map do |var|
7
+ iv = instance_variable_get(var)
8
+ obj[var.to_s.gsub('@', '')] = iv unless iv.nil?
9
+ end
10
+
11
+ @@serializer.dump obj
12
+ end
13
+
14
+ def unserialize(string)
15
+ obj = @@serializer.parse(string)
16
+ obj.keys.each do |key|
17
+ instance_variable_set(key, obj[key])
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,3 @@
1
+ module Natero
2
+ VERSION = "1.0.0"
3
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'natero/version'
5
+ require 'pry'
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = 'natero'
9
+ spec.version = Natero::VERSION
10
+ spec.authors = 'Andrew Brown'
11
+ spec.email = 'abbrown22@gmail.com'
12
+ spec.summary = 'Wrapper for Natero API'
13
+ spec.description = %q{
14
+ Natero is customer success software used to reduce churn and increase B2B SaaS adoption.
15
+ }
16
+ spec.homepage = 'http://bonus.ly'
17
+ spec.license = 'MIT'
18
+
19
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ spec.bindir = 'exe'
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = 'lib'
23
+
24
+ spec.add_dependency 'httparty', '~> 0.13'
25
+ spec.add_development_dependency 'bundler', '~> 1.11'
26
+ spec.add_development_dependency 'rake', '~> 10.0'
27
+ spec.add_development_dependency 'rspec', '~> 3.0'
28
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: natero
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrew Brown
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: httparty
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.13'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: "\n Natero is customer success software used to reduce churn and increase
70
+ B2B SaaS adoption.\n "
71
+ email: abbrown22@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".rspec"
77
+ - CODE_OF_CONDUCT.md
78
+ - Gemfile
79
+ - Gemfile.lock
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - lib/natero.rb
86
+ - lib/natero/account.rb
87
+ - lib/natero/response.rb
88
+ - lib/natero/serializable.rb
89
+ - lib/natero/version.rb
90
+ - natero.gemspec
91
+ homepage: http://bonus.ly
92
+ licenses:
93
+ - MIT
94
+ metadata: {}
95
+ post_install_message:
96
+ rdoc_options: []
97
+ require_paths:
98
+ - lib
99
+ required_ruby_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ requirements: []
110
+ rubyforge_project:
111
+ rubygems_version: 2.5.1
112
+ signing_key:
113
+ specification_version: 4
114
+ summary: Wrapper for Natero API
115
+ test_files: []