chartmogul_client 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.travis.yml +13 -0
- data/CHANGELOG.md +0 -0
- data/Gemfile +3 -0
- data/LICENSE +201 -0
- data/README.md +51 -0
- data/Rakefile +23 -0
- data/chartmogul_client.gemspec +24 -0
- data/lib/chartmogul/client.rb +41 -0
- data/lib/chartmogul/v1/base.rb +9 -0
- data/lib/chartmogul/v1/customers.rb +49 -0
- data/lib/chartmogul/v1/import.rb +54 -0
- data/lib/chartmogul/v1/request.rb +64 -0
- data/lib/chartmogul/version.rb +5 -0
- data/lib/chartmogul_client.rb +19 -0
- data/spec/chartmogul/client_spec.rb +26 -0
- data/spec/chartmogul/v1/customers_spec.rb +41 -0
- data/spec/chartmogul/v1/import_spec.rb +41 -0
- data/spec/spec_helper.rb +3 -0
- data/spec/support/shared_examples/chartmogul_api_v1_examples.rb +14 -0
- metadata +155 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 5ae6e660fcc4cb058c2a70613ea0cf11ca47cf63
|
4
|
+
data.tar.gz: eabf01a7704501a601df291ce125bf75c542d9a2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 94af951e1f2745d64ccf452ef850a3d9759ba7cb6e8c47c9824c52e0f6a3162dac53eb2f2fa1dd4478883e96ecff7b9a7eaf46c3a8487e92300cb3d339125567
|
7
|
+
data.tar.gz: f690e36903cca0cabb90b324431c31ca8496b4860d84a613fa3e0d837879ab3043e101e870345beb2b8da5e1a1bf1ef50ab1b3d27f4c14b5dcaac4a3594d6db6
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
File without changes
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# ChartMogul Ruby Gem
|
2
|
+
|
3
|
+
[![Build Status](https://secure.travis-ci.org/Shuttlerock/chartmogul_client.png)](http://travis-ci.org/Shuttlerock/chartmogul_client)
|
4
|
+
[![Code Climate](https://codeclimate.com/github/Shuttlerock/chartmogul_client/badges/gpa.svg)](https://codeclimate.com/github/Shuttlerock/chartmogul_client)
|
5
|
+
|
6
|
+
This is the unofficial Ruby wrapper for the ChartMogul v1 API. It supports not all
|
7
|
+
endpoints currently available on the [ChartMogul API](https://dev.chartmogul.com/docs).
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
``` bash
|
12
|
+
gem install chartmogul_client
|
13
|
+
```
|
14
|
+
|
15
|
+
### Some quick examples
|
16
|
+
|
17
|
+
First, instantiate the Client class:
|
18
|
+
|
19
|
+
``` ruby
|
20
|
+
>> client = Chartmogul.new(account_token: 'token', secret_key: 'secret')
|
21
|
+
```
|
22
|
+
|
23
|
+
Get users by IDs:
|
24
|
+
|
25
|
+
``` ruby
|
26
|
+
>> client.import.customers.list
|
27
|
+
```
|
28
|
+
|
29
|
+
### Contributions and Pull Requests
|
30
|
+
|
31
|
+
No request is too small and I encourage everyone to get involved. So please if
|
32
|
+
you would like to contribute, let me know and throw me a pull request!
|
33
|
+
|
34
|
+
### Requirements
|
35
|
+
|
36
|
+
* Ruby 2.x.x
|
37
|
+
|
38
|
+
---
|
39
|
+
|
40
|
+
Copyright 2015 Shuttlerock Ltd.
|
41
|
+
|
42
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
43
|
+
use this work except in compliance with the License. You may obtain a copy of
|
44
|
+
the License in the LICENSE file, or at:
|
45
|
+
|
46
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
47
|
+
|
48
|
+
Unless required by applicable law or agreed to in writing, software
|
49
|
+
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
50
|
+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
51
|
+
License for the specific language governing permissions and limitations.
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
|
3
|
+
require 'rspec/core/rake_task'
|
4
|
+
require File.dirname(__FILE__) + '/lib/chartmogul/version'
|
5
|
+
|
6
|
+
task :default => :test
|
7
|
+
|
8
|
+
task :build => :test do
|
9
|
+
system 'gem build chartmogul_client.gemspec'
|
10
|
+
end
|
11
|
+
|
12
|
+
task :release => :build do
|
13
|
+
# tag and push
|
14
|
+
system "git tag v#{Chartmogul::VERSION}"
|
15
|
+
system "git push origin --tags"
|
16
|
+
# push the gem
|
17
|
+
system "gem push chartmogul_client-#{Chartmogul::VERSION}.gem"
|
18
|
+
end
|
19
|
+
|
20
|
+
RSpec::Core::RakeTask.new(:test) do |t|
|
21
|
+
t.pattern = 'spec/**/*_spec.rb'
|
22
|
+
fail_on_error = true # be explicit
|
23
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require File.join(File.dirname(__FILE__), 'lib/chartmogul/version')
|
3
|
+
|
4
|
+
Gem::Specification.new do |gem|
|
5
|
+
gem.add_dependency 'typhoeus'
|
6
|
+
gem.add_dependency 'hashie'
|
7
|
+
gem.add_dependency 'multi_json'
|
8
|
+
gem.add_development_dependency 'rake'
|
9
|
+
gem.add_development_dependency 'rspec'
|
10
|
+
gem.add_development_dependency 'webmock'
|
11
|
+
gem.authors = ['Alexey Vokhmin', 'Dave Perrett']
|
12
|
+
gem.description = %q{A Ruby wrapper for the ChartMogul API}
|
13
|
+
gem.email = ['avokhmin@gmail.com', 'dave@recurser.com']
|
14
|
+
gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
|
15
|
+
gem.files = `git ls-files`.split("\n")
|
16
|
+
gem.homepage = "https://github.com/Shuttlerock/chartmogul_client"
|
17
|
+
gem.license = "Apache"
|
18
|
+
gem.name = "chartmogul_client"
|
19
|
+
gem.require_paths = ["lib"]
|
20
|
+
gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
|
21
|
+
gem.summary = %q{ChartMogul API wrapper}
|
22
|
+
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
23
|
+
gem.version = Chartmogul::VERSION
|
24
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
module Chartmogul
|
2
|
+
class Client
|
3
|
+
BASE_URI = 'https://api.chartmogul.com'
|
4
|
+
|
5
|
+
attr_reader :account_token, :secret_key
|
6
|
+
|
7
|
+
# Public: Constructor.
|
8
|
+
#
|
9
|
+
# account_token - The String ChartMogul account token.
|
10
|
+
# secret_key - The String ChartMogul secret key.
|
11
|
+
def initialize(account_token: nil, secret_key: nil)
|
12
|
+
@account_token = account_token
|
13
|
+
@secret_key = secret_key
|
14
|
+
end
|
15
|
+
|
16
|
+
# Public: Get userpwd.
|
17
|
+
#
|
18
|
+
# Returns the String.
|
19
|
+
def userpwd
|
20
|
+
"#{account_token}:#{secret_key}"
|
21
|
+
end
|
22
|
+
|
23
|
+
# Public: Get import API.
|
24
|
+
#
|
25
|
+
# Returns the instance of Chartmogul::V1::Import.
|
26
|
+
def import
|
27
|
+
Chartmogul::V1::Import.new(self)
|
28
|
+
end
|
29
|
+
|
30
|
+
# Public: Get customers API.
|
31
|
+
#
|
32
|
+
# Returns the instance of Chartmogul::V1::Customers.
|
33
|
+
def customers
|
34
|
+
Chartmogul::V1::Customers.new(self)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
require 'chartmogul/v1/base'
|
40
|
+
require 'chartmogul/v1/import'
|
41
|
+
require 'chartmogul/v1/customers'
|
@@ -0,0 +1,49 @@
|
|
1
|
+
module Chartmogul
|
2
|
+
module V1
|
3
|
+
class Customers < Base
|
4
|
+
BASE_URI = "#{BASE_URI}/customers"
|
5
|
+
|
6
|
+
# Public: Get customers API.
|
7
|
+
#
|
8
|
+
# Returns the instance of Chartmogul::V1::Customers::Attributes.
|
9
|
+
def attributes
|
10
|
+
Attributes.new(client)
|
11
|
+
end
|
12
|
+
|
13
|
+
class Attributes < Customers
|
14
|
+
# Public: Create Custom Attributes for a Customer
|
15
|
+
#
|
16
|
+
# See: https://dev.chartmogul.com/docs/create-custom-attributes-for-customer
|
17
|
+
#
|
18
|
+
# customer_id - The String/Integer ChartMogul ID of the customer.
|
19
|
+
# Specified as part of the URL.
|
20
|
+
# options - The Hash options used to create a Attribute (default: {}):
|
21
|
+
# :type - The String data type of the custom attribute.
|
22
|
+
# Can be String, Integer, Timestamp or Boolean.
|
23
|
+
# :key - The String key of the custom attribute.
|
24
|
+
# Accepts alphanumeric characters and underscores.
|
25
|
+
# :value - The value of the custom attribute.
|
26
|
+
# Should be of the data type as specified in *type*.
|
27
|
+
#
|
28
|
+
# Returns the instance of Chartmogul::V1::Request.
|
29
|
+
def create(customer_id, **options)
|
30
|
+
Chartmogul::V1::Request.new "#{BASE_URI}/#{customer_id}/attributes/custom", options.merge(method: :post, userpwd: client.userpwd)
|
31
|
+
end
|
32
|
+
|
33
|
+
# Public: Update Custom Attributes of a Customer.
|
34
|
+
#
|
35
|
+
# See: https://dev.chartmogul.com/docs/update-custom-attributes-of-customer
|
36
|
+
#
|
37
|
+
# customer_id - The String/Integer ChartMogul ID of the customer.
|
38
|
+
# Specified as part of the URL.
|
39
|
+
# options - The Hash options used to refine the Customer attributes (default: {}).
|
40
|
+
#
|
41
|
+
# Returns the instance of Chartmogul::V1::Request.
|
42
|
+
def update(customer_id, **options)
|
43
|
+
Chartmogul::V1::Request.new "#{BASE_URI}/#{customer_id}/attributes/custom", options.merge(method: :put, userpwd: client.userpwd)
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
module Chartmogul
|
2
|
+
module V1
|
3
|
+
class Import < Base
|
4
|
+
BASE_URI = "#{BASE_URI}/import"
|
5
|
+
|
6
|
+
# Public: Get customers API.
|
7
|
+
#
|
8
|
+
# Returns the instance of Chartmogul::V1::Import::Customers.
|
9
|
+
def customers
|
10
|
+
Customers.new(client)
|
11
|
+
end
|
12
|
+
|
13
|
+
class Customers < Import
|
14
|
+
BASE_URI = "#{BASE_URI}/customers"
|
15
|
+
|
16
|
+
# Public: Import a Customer.
|
17
|
+
#
|
18
|
+
# See: https://dev.chartmogul.com/docs/import-customer
|
19
|
+
#
|
20
|
+
# options - The Hash options used to create a Customer (default: {}):
|
21
|
+
# :data_source_uuid - The String ChartMogul UUID of the data
|
22
|
+
# source that this customer comes from.
|
23
|
+
# :external_id - The String unique identifier specified by you for the customer.
|
24
|
+
# Typically an identifier from your internal system.
|
25
|
+
# Accepts alphanumeric characters.
|
26
|
+
# :name - The String name of the customer for display purposes.
|
27
|
+
# Accepts alphanumeric characters.
|
28
|
+
# :email - The String Email address of the customer (optional).
|
29
|
+
# :company - The String customer's company or organisation (optional).
|
30
|
+
# :country - The String Country code of customer's location
|
31
|
+
# as per ISO-3166 alpha-2 standard (optional).
|
32
|
+
# :state - The String State code of customer's location
|
33
|
+
# as per ISO-3166 alpha-2 standard (optional).
|
34
|
+
# :city - The String city of the customer's location (optional).
|
35
|
+
# :zip - The String zip code of the customer's location (optional).
|
36
|
+
#
|
37
|
+
# Returns the instance of Chartmogul::V1::Request.
|
38
|
+
def create(**options)
|
39
|
+
Chartmogul::V1::Request.new "#{BASE_URI}", options.merge(method: :post, userpwd: client.userpwd)
|
40
|
+
end
|
41
|
+
|
42
|
+
# Public: Get list Customers.
|
43
|
+
#
|
44
|
+
# See: https://dev.chartmogul.com/docs/list-all-imported-customers
|
45
|
+
#
|
46
|
+
# Returns the instance of Chartmogul::V1::Request.
|
47
|
+
def list
|
48
|
+
Chartmogul::V1::Request.new "#{BASE_URI}", userpwd: client.userpwd
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
require 'hashie'
|
2
|
+
require 'typhoeus'
|
3
|
+
require 'multi_json'
|
4
|
+
|
5
|
+
module Chartmogul
|
6
|
+
module V1
|
7
|
+
class Request
|
8
|
+
attr_reader :url, :userpwd, :params, :response
|
9
|
+
|
10
|
+
# Public: Constructor.
|
11
|
+
#
|
12
|
+
# url - The String url.
|
13
|
+
# userpwd - The String with credentials for Basic Authentication.
|
14
|
+
# method - The Symbol request method (default: :get).
|
15
|
+
# params - The Hash query params.
|
16
|
+
def initialize(url, userpwd: nil, method: :get, **params)
|
17
|
+
@url = url
|
18
|
+
@userpwd = userpwd
|
19
|
+
@params = params
|
20
|
+
@response = Typhoeus::Request.new(url,
|
21
|
+
userpwd: userpwd,
|
22
|
+
method: method,
|
23
|
+
params: params,
|
24
|
+
connecttimeout: 5,
|
25
|
+
timeout: 10
|
26
|
+
).run
|
27
|
+
end
|
28
|
+
|
29
|
+
# Public: Get next page.
|
30
|
+
#
|
31
|
+
# Returns the instance of Chartmogul::V1::Request.
|
32
|
+
def next_page
|
33
|
+
Request.new url, params.merge(page: params[:page] + 1, userpwd: userpwd)
|
34
|
+
end
|
35
|
+
|
36
|
+
# Returns true at successful request , false otherwise.
|
37
|
+
def ok?
|
38
|
+
[200, 201].include? code
|
39
|
+
end
|
40
|
+
|
41
|
+
# Public: Get response code.
|
42
|
+
#
|
43
|
+
# Returns Integer code of response.
|
44
|
+
def code
|
45
|
+
response.code
|
46
|
+
end
|
47
|
+
|
48
|
+
# Public: Get return code.
|
49
|
+
#
|
50
|
+
# Returns Integer return code.
|
51
|
+
def return_code
|
52
|
+
response.return_code
|
53
|
+
end
|
54
|
+
|
55
|
+
# Public: Get body.
|
56
|
+
#
|
57
|
+
# Returns the instance of Hashie::Mash.
|
58
|
+
def body
|
59
|
+
@body ||= Hashie::Mash.new(MultiJson.load response.body || '')
|
60
|
+
end
|
61
|
+
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'chartmogul/client'
|
2
|
+
|
3
|
+
module Chartmogul
|
4
|
+
|
5
|
+
autoload :VERSION, File.join(File.dirname(__FILE__), 'chartmogul/version')
|
6
|
+
|
7
|
+
class << self
|
8
|
+
# Public: Constructor.
|
9
|
+
#
|
10
|
+
# account_token - The String ChartMogul account token.
|
11
|
+
# secret_key - The String ChartMogul secret key.
|
12
|
+
#
|
13
|
+
# Returns the instance of Chartmogul::Client.
|
14
|
+
def new(account_token: nil, secret_key: nil)
|
15
|
+
Chartmogul::Client.new(account_token: account_token, secret_key: secret_key)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
RSpec.describe Chartmogul::Client do
|
4
|
+
|
5
|
+
let(:client) { Chartmogul::Client.new }
|
6
|
+
|
7
|
+
describe '#import' do
|
8
|
+
subject { client.import }
|
9
|
+
|
10
|
+
it { expect(subject).to be_a Chartmogul::V1::Import }
|
11
|
+
it { expect(subject.client).to eq client }
|
12
|
+
end
|
13
|
+
|
14
|
+
describe '#customers' do
|
15
|
+
subject { client.customers }
|
16
|
+
|
17
|
+
it { expect(subject).to be_a Chartmogul::V1::Customers }
|
18
|
+
it { expect(subject.client).to eq client }
|
19
|
+
end
|
20
|
+
|
21
|
+
describe '#userpwd' do
|
22
|
+
let(:client) { Chartmogul::Client.new(account_token: 'foo', secret_key: 'bar') }
|
23
|
+
|
24
|
+
it { expect(client.userpwd).to eq 'foo:bar' }
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
RSpec.describe Chartmogul::V1::Customers do
|
4
|
+
|
5
|
+
let(:client) { Chartmogul::Client.new }
|
6
|
+
|
7
|
+
describe '#attributes' do
|
8
|
+
subject { client.customers.attributes }
|
9
|
+
|
10
|
+
it { expect(subject).to be_a Chartmogul::V1::Customers::Attributes }
|
11
|
+
it { expect(subject.client).to eq client }
|
12
|
+
end
|
13
|
+
|
14
|
+
describe '::Attributes' do
|
15
|
+
describe '#create' do
|
16
|
+
let(:url) { 'https://api.chartmogul.com/v1/customers/customer-id/attributes/custom' }
|
17
|
+
let(:query) { { foo: 'bar' } }
|
18
|
+
|
19
|
+
before do
|
20
|
+
stub_request(:post, url).with(query: query).to_return(status: 200)
|
21
|
+
end
|
22
|
+
|
23
|
+
subject { client.customers.attributes.create('customer-id', query) }
|
24
|
+
|
25
|
+
it_should_behave_like 'a base ChartMogul API V1 requests', method: :post
|
26
|
+
end
|
27
|
+
|
28
|
+
describe '#update' do
|
29
|
+
let(:url) { 'https://api.chartmogul.com/v1/customers/customer-id/attributes/custom' }
|
30
|
+
let(:query) { { foo: 'bar' } }
|
31
|
+
|
32
|
+
before do
|
33
|
+
stub_request(:put, url).with(query: query).to_return(status: 200)
|
34
|
+
end
|
35
|
+
|
36
|
+
subject { client.customers.attributes.update('customer-id', query) }
|
37
|
+
|
38
|
+
it_should_behave_like 'a base ChartMogul API V1 requests', method: :put
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
RSpec.describe Chartmogul::V1::Import do
|
4
|
+
|
5
|
+
let(:client) { Chartmogul::Client.new }
|
6
|
+
|
7
|
+
describe '#customers' do
|
8
|
+
subject { client.import.customers }
|
9
|
+
|
10
|
+
it { expect(subject).to be_a Chartmogul::V1::Import::Customers }
|
11
|
+
it { expect(subject.client).to eq client }
|
12
|
+
end
|
13
|
+
|
14
|
+
describe '::Customers' do
|
15
|
+
describe '#create' do
|
16
|
+
let(:url) { 'https://api.chartmogul.com/v1/import/customers' }
|
17
|
+
let(:query) { { foo: 'bar' } }
|
18
|
+
|
19
|
+
before do
|
20
|
+
stub_request(:post, url).with(query: query).to_return(status: 201)
|
21
|
+
end
|
22
|
+
|
23
|
+
subject { client.import.customers.create(query) }
|
24
|
+
|
25
|
+
it_should_behave_like 'a base ChartMogul API V1 requests', method: :post
|
26
|
+
end
|
27
|
+
|
28
|
+
describe '#list' do
|
29
|
+
let(:url) { 'https://api.chartmogul.com/v1/import/customers' }
|
30
|
+
let(:query) { { } }
|
31
|
+
|
32
|
+
before do
|
33
|
+
stub_request(:get, url).with(query: query).to_return(status: 200)
|
34
|
+
end
|
35
|
+
|
36
|
+
subject { client.import.customers.list }
|
37
|
+
|
38
|
+
it_should_behave_like 'a base ChartMogul API V1 requests'
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
shared_examples 'a base ChartMogul API V1 requests' do |method: :get|
|
2
|
+
|
3
|
+
it { expect(subject).to be_a Chartmogul::V1::Request }
|
4
|
+
it { expect(subject.ok?).to be_truthy }
|
5
|
+
|
6
|
+
context '400 response code on request' do
|
7
|
+
before do
|
8
|
+
stub_request(method, url).with(query: query).to_return(status: 400)
|
9
|
+
end
|
10
|
+
|
11
|
+
it { expect { subject }.to_not raise_error }
|
12
|
+
it { expect(subject.ok?).to be_falsy }
|
13
|
+
end
|
14
|
+
end
|
metadata
ADDED
@@ -0,0 +1,155 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: chartmogul_client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alexey Vokhmin
|
8
|
+
- Dave Perrett
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2016-03-25 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: typhoeus
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - ">="
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '0'
|
21
|
+
type: :runtime
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - ">="
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '0'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: hashie
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - ">="
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '0'
|
35
|
+
type: :runtime
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - ">="
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: multi_json
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ">="
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
type: :runtime
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ">="
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: rake
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: rspec
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
type: :development
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ">="
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
- !ruby/object:Gem::Dependency
|
85
|
+
name: webmock
|
86
|
+
requirement: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
type: :development
|
92
|
+
prerelease: false
|
93
|
+
version_requirements: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - ">="
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
98
|
+
description: A Ruby wrapper for the ChartMogul API
|
99
|
+
email:
|
100
|
+
- avokhmin@gmail.com
|
101
|
+
- dave@recurser.com
|
102
|
+
executables: []
|
103
|
+
extensions: []
|
104
|
+
extra_rdoc_files: []
|
105
|
+
files:
|
106
|
+
- ".gitignore"
|
107
|
+
- ".travis.yml"
|
108
|
+
- CHANGELOG.md
|
109
|
+
- Gemfile
|
110
|
+
- LICENSE
|
111
|
+
- README.md
|
112
|
+
- Rakefile
|
113
|
+
- chartmogul_client.gemspec
|
114
|
+
- lib/chartmogul/client.rb
|
115
|
+
- lib/chartmogul/v1/base.rb
|
116
|
+
- lib/chartmogul/v1/customers.rb
|
117
|
+
- lib/chartmogul/v1/import.rb
|
118
|
+
- lib/chartmogul/v1/request.rb
|
119
|
+
- lib/chartmogul/version.rb
|
120
|
+
- lib/chartmogul_client.rb
|
121
|
+
- spec/chartmogul/client_spec.rb
|
122
|
+
- spec/chartmogul/v1/customers_spec.rb
|
123
|
+
- spec/chartmogul/v1/import_spec.rb
|
124
|
+
- spec/spec_helper.rb
|
125
|
+
- spec/support/shared_examples/chartmogul_api_v1_examples.rb
|
126
|
+
homepage: https://github.com/Shuttlerock/chartmogul_client
|
127
|
+
licenses:
|
128
|
+
- Apache
|
129
|
+
metadata: {}
|
130
|
+
post_install_message:
|
131
|
+
rdoc_options: []
|
132
|
+
require_paths:
|
133
|
+
- lib
|
134
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - ">="
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: 1.3.6
|
144
|
+
requirements: []
|
145
|
+
rubyforge_project:
|
146
|
+
rubygems_version: 2.5.1
|
147
|
+
signing_key:
|
148
|
+
specification_version: 4
|
149
|
+
summary: ChartMogul API wrapper
|
150
|
+
test_files:
|
151
|
+
- spec/chartmogul/client_spec.rb
|
152
|
+
- spec/chartmogul/v1/customers_spec.rb
|
153
|
+
- spec/chartmogul/v1/import_spec.rb
|
154
|
+
- spec/spec_helper.rb
|
155
|
+
- spec/support/shared_examples/chartmogul_api_v1_examples.rb
|