Class: SubscriptionApi

Inherits:
Object
  • Object
show all
Includes:
Validation
Defined in:
lib/tacklebox/apis/subscription_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Validation

#is_valid_data, #is_valid_event_data, #is_valid_id, #is_valid_name, #is_valid_subscription_data

Constructor Details

#initialize(config) ⇒ SubscriptionApi

Returns a new instance of SubscriptionApi.



10
11
12
13
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 10

def initialize(config)
  self.base_url = config[:base_url]
  self.http_client = HttpClient.new(config[:api_key])
end

Instance Attribute Details

#base_url ⇒ Object

Returns the value of attribute base_url.



8
9
10
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 8

def base_url
  @base_url
end

#http_client ⇒ Object

Returns the value of attribute http_client.



8
9
10
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 8

def http_client
  @http_client
end

Instance Method Details

#create_subscription(service_id, user_id, subscription_data) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 34

def create_subscription(service_id, user_id, subscription_data)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The create_subscription method must be invoked with a non-empty string service_id argument."
    )
  end
  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The create_subscription method must be invoked with a non-empty string user_id argument."
    )
  end
  if !self.is_valid_subscription_data(subscription_data)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The create_subscription method must be invoked with non-empty url and event_types arguments."
    )
  end

  path = "services/#{service_id}/users/#{user_id}/subscriptions"
  request = HttpRequest.new("POST", @base_url, path, subscription_data)
  @http_client.send(request)
end

#delete_subscription(service_id, user_id, subscription_id) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 84

def delete_subscription(service_id, user_id, subscription_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The delete_subscription method must be invoked with a non-empty string service_id argument."
    )
  end
  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The delete_subscription method must be invoked with a non-empty string user_id argument."
    )
  end
  if !self.is_valid_id(subscription_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The delete_subscription method must be invoked with a non-empty string subscription_id argument."
    )
  end
  
  path = "services/#{service_id}/users/#{user_id}/subscriptions/#{subscription_id}"
  request = HttpRequest.new("DELETE", @base_url, path)
  @http_client.send(request)
end

#get_subscription(service_id, user_id, subscription_id) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 59

def get_subscription(service_id, user_id, subscription_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The get_subscription method must be invoked with a non-empty string service_id argument."
    )
  end
  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The get_subscription method must be invoked with a non-empty string user_id argument."
    )
  end
  if !self.is_valid_id(subscription_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The get_subscription method must be invoked with a non-empty string subscription_id argument."
    )
  end
  
  path = "services/#{service_id}/users/#{user_id}/subscriptions/#{subscription_id}"
  request = HttpRequest.new("GET", @base_url, path)
  @http_client.send(request)
end

#list_subscriptions(service_id, user_id) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/tacklebox/apis/subscription_api.rb', line 15

def list_subscriptions(service_id, user_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The list_subscriptions method must be invoked with a non-empty string service_id argument."
    )
  end
  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The list_subscriptions method must be invoked with a non-empty string user_id argument."
    )
  end

  path = "services/#{service_id}/users/#{user_id}/subscriptions"
  request = HttpRequest.new("GET", @base_url, path)
  @http_client.send(request)
end