ontraport 0.1 → 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/CHANGELOG.md +4 -0
- data/README.md +34 -15
- data/lib/ontraport.rb +3 -1
- data/lib/ontraport/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f7358c600511194ddb7861ee40a01c4a1af0142a
|
|
4
|
+
data.tar.gz: 14239382de51a239eeb3ddc3e0fffb05eb3f46a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 182ea22428b4cbf84f1d4c3d42919330ebb9c65df4812329b9f509fb6e01da13b42465cbf1822c1de3d4196c9611f3be8168f84e02e4f835310e7f729c8c8ac4
|
|
7
|
+
data.tar.gz: 1fb7a36797f0d34e07c31959f7c72370d3983ddb62eddbf4cafcde7299ef3d93036f322503dafcc7424ca686676e6ddf90aa4273b3b6ed501457e575d81454d6
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -1,15 +1,37 @@
|
|
|
1
1
|
# Ruby API client for ONTRAPORT
|
|
2
2
|
|
|
3
|
-
[]
|
|
4
|
-
[]
|
|
3
|
+
[][repo]
|
|
4
|
+
[][rubydoc]
|
|
5
5
|
[](#license)
|
|
6
|
-
<!--
|
|
7
|
-
[](https://travis-ci.org/hamzatayeb/ontraport-ruby)
|
|
8
|
-
-->
|
|
9
6
|
|
|
10
|
-
|
|
7
|
+
Overview
|
|
8
|
+
--------
|
|
11
9
|
|
|
12
|
-
|
|
10
|
+
This Gem implements ONTRAPORT's JSON REST API - that's a lot of capitals... but it's how they stylize their name :)
|
|
11
|
+
|
|
12
|
+
So far, all the [objects API][ontra-objects-api] methods are supported. Forthcoming releases will add support for the other APIs.
|
|
13
|
+
|
|
14
|
+
Usage
|
|
15
|
+
-----
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
Ontraport.get_object :contact, 12345
|
|
19
|
+
#=> #<Ontraport::Response @data=...>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
Ontraport.save_or_update :contact, { email: 'foo@bar.com', firstname: 'Foo' }
|
|
24
|
+
#=> #<Ontraport::Response @data=...>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
Ontraport.tag_objects :contact, { add_list: '11111,22222', ids: '33333,44444' }
|
|
29
|
+
#=> #<Ontraport::Response @data=...>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
See [documentation][rubydoc] for more details/examples.
|
|
33
|
+
|
|
34
|
+
Installation
|
|
13
35
|
------------
|
|
14
36
|
|
|
15
37
|
### Bundler
|
|
@@ -17,7 +39,7 @@ Disclaimer - This Gem is a work in progress.
|
|
|
17
39
|
Add the Ontraport gem to your Gemfile:
|
|
18
40
|
|
|
19
41
|
```ruby
|
|
20
|
-
gem 'ontraport', '~>
|
|
42
|
+
gem 'ontraport', '~> 0.1'
|
|
21
43
|
```
|
|
22
44
|
|
|
23
45
|
### Manual
|
|
@@ -27,7 +49,6 @@ Install the Gem from your terminal -
|
|
|
27
49
|
```bash
|
|
28
50
|
gem install ontraport
|
|
29
51
|
```
|
|
30
|
-
-->
|
|
31
52
|
|
|
32
53
|
Configuration
|
|
33
54
|
-------------
|
|
@@ -47,10 +68,7 @@ end
|
|
|
47
68
|
Contact
|
|
48
69
|
-------
|
|
49
70
|
|
|
50
|
-
If you have a
|
|
51
|
-
|
|
52
|
-
* [file an issue][issues]
|
|
53
|
-
* [send me an email](mailto:hamza.tayeb@gmail.com)
|
|
71
|
+
If you have a suggestion or a bug report, please [file an issue][issues].
|
|
54
72
|
|
|
55
73
|
License
|
|
56
74
|
-------
|
|
@@ -58,5 +76,6 @@ License
|
|
|
58
76
|
The project uses the MIT License. See LICENSE.md for details.
|
|
59
77
|
|
|
60
78
|
[issues]: https://github.com/hamzatayeb/ontraport-ruby/issues
|
|
61
|
-
[
|
|
62
|
-
[
|
|
79
|
+
[rubydoc]: http://rubydoc.info/gems/ontraport
|
|
80
|
+
[repo]: http://github.com/hamzatayeb/ontraport-ruby
|
|
81
|
+
[ontra-objects-api]: https://api.ontraport.com/doc/#!/objects/
|
data/lib/ontraport.rb
CHANGED
|
@@ -125,7 +125,9 @@ module Ontraport
|
|
|
125
125
|
objects_call :put, object_type, endpoint: '/objects/tag', data: params
|
|
126
126
|
end
|
|
127
127
|
|
|
128
|
-
# Remove tags from objects matching the supplied conditions. Interface is identical to +#tag_objects+
|
|
128
|
+
# Remove tags from objects matching the supplied conditions. Interface is nearly identical to +#tag_objects+
|
|
129
|
+
#
|
|
130
|
+
# @note This method expects +remove_list+ as a required parameter.
|
|
129
131
|
#
|
|
130
132
|
# @see tag_objects
|
|
131
133
|
# @see https://api.ontraport.com/doc/#!/objects/removeTag API docs
|
data/lib/ontraport/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ontraport
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Hamza Tayeb
|
|
@@ -55,9 +55,9 @@ require_paths:
|
|
|
55
55
|
- lib
|
|
56
56
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
57
57
|
requirements:
|
|
58
|
-
- - "
|
|
58
|
+
- - ">="
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
|
-
version:
|
|
60
|
+
version: '0'
|
|
61
61
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
62
62
|
requirements:
|
|
63
63
|
- - ">="
|