Class: CreateSend::CreateSend
- Inherits:
-
Object
- Object
- CreateSend::CreateSend
- Includes:
- HTTParty
- Defined in:
- lib/createsend/createsend.rb
Overview
Provides high level CreateSend functionality/data you’ll probably need.
Direct Known Subclasses
Constant Summary collapse
- @@base_uri =
"https://api.createsend.com/api/v3.1"
- @@oauth_base_uri =
"https://api.createsend.com/oauth"
- @@oauth_token_uri =
"#{@@oauth_base_uri}/token"
Instance Attribute Summary collapse
-
#auth_details ⇒ Object
readonly
Returns the value of attribute auth_details.
Class Method Summary collapse
-
.authorize_url(client_id, redirect_uri, scope, state = nil) ⇒ Object
Get the authorization URL for your application, given the application’s client_id, redirect_uri, scope, and optional state data.
-
.exchange_token(client_id, client_secret, redirect_uri, code) ⇒ Object
Exchange a provided OAuth code for an OAuth access token, ‘expires in’ value, and refresh token.
-
.refresh_access_token(refresh_token) ⇒ Object
Refresh an OAuth access token, given an OAuth refresh token.
-
.user_agent(user_agent) ⇒ Object
Set a custom user agent string to be used when instances of CreateSend::CreateSend make API calls.
Instance Method Summary collapse
- #add_auth_details_to_options(args) ⇒ Object
-
#administrators ⇒ Object
Gets the administrators for the account.
-
#auth(auth_details) ⇒ Object
Authenticate using either OAuth or an API key.
-
#billing_details ⇒ Object
Get your billing details.
-
#clients ⇒ Object
Gets your clients.
-
#countries ⇒ Object
Gets valid countries.
- #delete(*args) ⇒ Object (also: #cs_delete)
-
#external_session_url(email, chrome, url, integrator_id, client_id) ⇒ Object
Get a URL which initiates a new external session for the user with the given email.
- #get(*args) ⇒ Object (also: #cs_get)
-
#get_primary_contact ⇒ Object
Gets the primary contact for the account.
-
#handle_response(response) ⇒ Object
:nodoc:.
-
#initialize(*args) ⇒ CreateSend
constructor
A new instance of CreateSend.
- #post(*args) ⇒ Object (also: #cs_post)
- #put(*args) ⇒ Object (also: #cs_put)
-
#refresh_token ⇒ Object
Refresh the current OAuth token using the current refresh token.
-
#set_primary_contact(email) ⇒ Object
Set the primary contect for the account.
-
#systemdate ⇒ Object
Gets the current date in your account’s timezone.
-
#timezones ⇒ Object
Gets valid timezones.
Constructor Details
#initialize(*args) ⇒ CreateSend
Returns a new instance of CreateSend.
106 107 108 109 110 |
# File 'lib/createsend/createsend.rb', line 106 def initialize(*args) if args.size > 0 auth args.first # Expect auth details as first argument end end |
Instance Attribute Details
#auth_details ⇒ Object (readonly)
Returns the value of attribute auth_details.
47 48 49 |
# File 'lib/createsend/createsend.rb', line 47 def auth_details @auth_details end |
Class Method Details
.authorize_url(client_id, redirect_uri, scope, state = nil) ⇒ Object
Get the authorization URL for your application, given the application’s client_id, redirect_uri, scope, and optional state data.
64 65 66 67 68 69 70 |
# File 'lib/createsend/createsend.rb', line 64 def self.(client_id, redirect_uri, scope, state=nil) qs = "client_id=#{CGI.escape(client_id.to_s)}" qs << "&redirect_uri=#{CGI.escape(redirect_uri.to_s)}" qs << "&scope=#{CGI.escape(scope.to_s)}" qs << "&state=#{CGI.escape(state.to_s)}" if state "#{@@oauth_base_uri}?#{qs}" end |
.exchange_token(client_id, client_secret, redirect_uri, code) ⇒ Object
Exchange a provided OAuth code for an OAuth access token, ‘expires in’ value, and refresh token.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/createsend/createsend.rb', line 74 def self.exchange_token(client_id, client_secret, redirect_uri, code) body = "grant_type=authorization_code" body << "&client_id=#{CGI.escape(client_id.to_s)}" body << "&client_secret=#{CGI.escape(client_secret.to_s)}" body << "&redirect_uri=#{CGI.escape(redirect_uri.to_s)}" body << "&code=#{CGI.escape(code.to_s)}" = {:body => body} response = HTTParty.post(@@oauth_token_uri, ) if response.has_key? 'error' and response.has_key? 'error_description' err = "Error exchanging code for access token: " err << "#{response['error']} - #{response['error_description']}" raise err end r = Hashie::Mash.new(response) [r.access_token, r.expires_in, r.refresh_token] end |
.refresh_access_token(refresh_token) ⇒ Object
Refresh an OAuth access token, given an OAuth refresh token. Returns a new access token, ‘expires in’ value, and refresh token.
93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/createsend/createsend.rb', line 93 def self.refresh_access_token(refresh_token) = { :body => "grant_type=refresh_token&refresh_token=#{CGI.escape(refresh_token)}" } response = HTTParty.post(@@oauth_token_uri, ) if response.has_key? 'error' and response.has_key? 'error_description' err = "Error refreshing access token: " err << "#{response['error']} - #{response['error_description']}" raise err end r = Hashie::Mash.new(response) [r.access_token, r.expires_in, r.refresh_token] end |
.user_agent(user_agent) ⇒ Object
Set a custom user agent string to be used when instances of CreateSend::CreateSend make API calls.
user_agent - The user agent string to use in the User-Agent header when
instances of this class make API calls. If set to nil, the
default value of CreateSend::USER_AGENT_STRING will be used.
58 59 60 |
# File 'lib/createsend/createsend.rb', line 58 def self.user_agent(user_agent) headers({'User-Agent' => user_agent || USER_AGENT_STRING}) end |
Instance Method Details
#add_auth_details_to_options(args) ⇒ Object
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/createsend/createsend.rb', line 242 def (args) if @auth_details = {} if args.size > 1 = args[1] end if @auth_details.has_key? :access_token [:headers] = { "Authorization" => "Bearer #{@auth_details[:access_token]}" } elsif @auth_details.has_key? :api_key if not .has_key? :basic_auth [:basic_auth] = { :username => @auth_details[:api_key], :password => 'x' } end end args[1] = end args end |
#administrators ⇒ Object
Gets the administrators for the account.
173 174 175 176 |
# File 'lib/createsend/createsend.rb', line 173 def administrators response = get('/admins.json') response.map{|item| Hashie::Mash.new(item)} end |
#auth(auth_details) ⇒ Object
Authenticate using either OAuth or an API key.
122 123 124 |
# File 'lib/createsend/createsend.rb', line 122 def auth(auth_details) @auth_details = auth_details end |
#billing_details ⇒ Object
Get your billing details.
149 150 151 152 |
# File 'lib/createsend/createsend.rb', line 149 def billing_details response = get('/billingdetails.json') Hashie::Mash.new(response) end |
#clients ⇒ Object
Gets your clients.
143 144 145 146 |
# File 'lib/createsend/createsend.rb', line 143 def clients response = get('/clients.json') response.map{|item| Hashie::Mash.new(item)} end |
#countries ⇒ Object
Gets valid countries.
155 156 157 158 |
# File 'lib/createsend/createsend.rb', line 155 def countries response = get('/countries.json') response.parsed_response end |
#delete(*args) ⇒ Object Also known as: cs_delete
236 237 238 239 |
# File 'lib/createsend/createsend.rb', line 236 def delete(*args) args = (args) handle_response CreateSend.delete(*args) end |
#external_session_url(email, chrome, url, integrator_id, client_id) ⇒ Object
Get a URL which initiates a new external session for the user with the given email. Full details: www.campaignmonitor.com/api/account/#single_sign_on
email - The email address of the Campaign Monitor user for whom
the login session should be created.
chrome - Which ‘chrome’ to display - Must be either “all”,
"tabs", or "none".
url - The URL to display once logged in. e.g. “/subscribers/” integrator_id - The integrator ID. You need to contact Campaign Monitor
support to get an integrator ID.
client_id - The Client ID of the client which should be active once
logged in to the Campaign Monitor account.
Returns An object containing a single field SessionUrl which represents the URL to initiate the external Campaign Monitor session.
207 208 209 210 211 212 213 214 215 216 |
# File 'lib/createsend/createsend.rb', line 207 def external_session_url(email, chrome, url, integrator_id, client_id) = { :body => { :Email => email, :Chrome => chrome, :Url => url, :IntegratorID => integrator_id, :ClientID => client_id }.to_json } response = put("/externalsession.json", ) Hashie::Mash.new(response) end |
#get(*args) ⇒ Object Also known as: cs_get
218 219 220 221 |
# File 'lib/createsend/createsend.rb', line 218 def get(*args) args = (args) handle_response CreateSend.get(*args) end |
#get_primary_contact ⇒ Object
Gets the primary contact for the account.
179 180 181 182 |
# File 'lib/createsend/createsend.rb', line 179 def get_primary_contact response = get('/primarycontact.json') Hashie::Mash.new(response) end |
#handle_response(response) ⇒ Object
:nodoc:
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/createsend/createsend.rb', line 262 def handle_response(response) # :nodoc: case response.code when 400 raise BadRequest.new(Hashie::Mash.new response) when 401 data = Hashie::Mash.new(response) case data.Code when 120 raise InvalidOAuthToken.new data when 121 raise ExpiredOAuthToken.new data when 122 raise RevokedOAuthToken.new data else raise Unauthorized.new data end when 404 raise NotFound.new when 400...500 raise ClientError.new when 500...600 raise ServerError.new else response end end |
#post(*args) ⇒ Object Also known as: cs_post
224 225 226 227 |
# File 'lib/createsend/createsend.rb', line 224 def post(*args) args = (args) handle_response CreateSend.post(*args) end |
#put(*args) ⇒ Object Also known as: cs_put
230 231 232 233 |
# File 'lib/createsend/createsend.rb', line 230 def put(*args) args = (args) handle_response CreateSend.put(*args) end |
#refresh_token ⇒ Object
Refresh the current OAuth token using the current refresh token.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/createsend/createsend.rb', line 127 def refresh_token if not @auth_details or not @auth_details.has_key? :refresh_token or not @auth_details[:refresh_token] raise '@auth_details[:refresh_token] does not contain a refresh token.' end access_token, expires_in, refresh_token = self.class.refresh_access_token @auth_details[:refresh_token] auth({ :access_token => access_token, :refresh_token => refresh_token}) [access_token, expires_in, refresh_token] end |
#set_primary_contact(email) ⇒ Object
Set the primary contect for the account.
185 186 187 188 189 |
# File 'lib/createsend/createsend.rb', line 185 def set_primary_contact(email) = { :query => { :email => email } } response = put("/primarycontact.json", ) Hashie::Mash.new(response) end |
#systemdate ⇒ Object
Gets the current date in your account’s timezone.
161 162 163 164 |
# File 'lib/createsend/createsend.rb', line 161 def systemdate response = get('/systemdate.json') Hashie::Mash.new(response) end |
#timezones ⇒ Object
Gets valid timezones.
167 168 169 170 |
# File 'lib/createsend/createsend.rb', line 167 def timezones response = get('/timezones.json') response.parsed_response end |