Class: AirshipClient

Inherits:
Object
  • Object
show all
Defined in:
lib/airship-client.rb

Constant Summary collapse

@@api_key = 
nil
@@env_key = 
nil
@@timeout = 
DEFAULT_TIMEOUT
@@fail_gracefully = 
true

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key = nil, env_key = nil) ⇒ AirshipClient

Returns a new instance of AirshipClient.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/airship-client.rb', line 96

def initialize(api_key = nil, env_key = nil)
  if !api_key.nil?
    self.class._validate_api_key(api_key)
  end

  if !env_key.nil?
    self.class._validate_env_key(env_key)
  end

  @api_key = api_key
  @env_key = env_key
  @conn = Faraday.new(:url => API_BASE_ENDPOINT)
  nil
end

Class Method Details

._validate_api_key(api_key) ⇒ Object 



71
72
73
74
75
 
# File 'lib/airship-client.rb', line 71

def _validate_api_key(api_key)
  if !api_key.instance_of?(String)
    raise ArgumentError.new("api_key must be a string")
  end
end

._validate_env_key(env_key) ⇒ Object 



77
78
79
80
81
 
# File 'lib/airship-client.rb', line 77

def _validate_env_key(env_key)
  if !env_key.instance_of?(String)
    raise ArgumentError.new("env_key must be a string")
  end
end

._validate_fail_gracefully(fail_gracefully) ⇒ Object 



89
90
91
92
93
 
# File 'lib/airship-client.rb', line 89

def _validate_fail_gracefully(fail_gracefully)
  if !(fail_gracefully == true || fail_gracefully == false)
    raise ArgumentError.new("fail_gracefully must be true or false")
  end
end

._validate_timeout(timeout) ⇒ Object 



83
84
85
86
87
 
# File 'lib/airship-client.rb', line 83

def _validate_timeout(timeout)
  if !timeout.is_a?(Integer)
    raise ArgumentError.new("timeout must be an integer")
  end
end

.init(api_key, env_key = nil, timeout = DEFAULT_TIMEOUT, fail_gracefully = true) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/airship-client.rb', line 40

def init(api_key, env_key = nil, timeout = DEFAULT_TIMEOUT, fail_gracefully = true)
  if api_key.nil?
    raise ArgumentError.new("api_key cannot be nil")
  end

  if !api_key.nil?
    self._validate_api_key(api_key)
  end

  if !env_key.nil?
    self._validate_env_key(env_key)
  end

  self._validate_timeout(timeout)
  self._validate_fail_gracefully(fail_gracefully)

  @@api_key = api_key
  @@env_key = env_key
  @@timeout = timeout
  @@fail_gracefully = fail_gracefully
  nil
end

.set_env_key(env_key) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/airship-client.rb', line 63

def set_env_key(env_key)
  if env_key.nil?
    raise ArgumentError.new("env_key cannot be nil")
  end
  self._validate_env_key(env_key)
  @@env_key = env_key
end

Instance Method Details

#gate(control_name, obj) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/airship-client.rb', line 133

def gate(control_name, obj)
  is_array = obj.instance_of?(Array)
  begin
    response = @conn.post do |req|
      req.url(V1_GATE_ENDPOINT)
      req.headers["Content-Type"] = "application/json"
      req.headers["api-key"] = @api_key || @@api_key
      req.options.timeout = @@timeout
      request_obj = {}
      request_obj["env_key"] = @env_key || @@env_key
      request_obj["control_short_name"] = control_name
      if is_array
        request_obj["objects"] = obj
      else
        request_obj["object"] = obj
      end
      req.body = request_obj.to_json
    end
    result = JSON.parse(response.body)
    if result.instance_of?(Hash) && result[SERVER_INFO_KEY] == SERVER_STATE_MAINTENANCE
      if @@fail_gracefully
        if is_array
          results = []
          for i in 0...obj.length
            o = obj[i]
            results.push(
              {
                "type" => o["type"],
                "id" => o["id"],
                "display_name" => o["display_name"],
                "control" => {
                  "control_short_name" => control_name,
                  "value" => false,
                  "variation" => nil,
                  "from_server" => false,
                  "from_cache" => false
                }
              }
            )
          end
          return results
        else
          return {
            "type" => obj["type"],
            "id" => obj["id"],
            "display_name" => obj["display_name"],
            "control" => {
              "control_short_name" => control_name,
              "value" => false,
              "variation" => nil,
              "from_server" => false,
              "from_cache" => false
            }
          }
        end
      end
    end
    result
  rescue Faraday::TimeoutError => e
    if @@fail_gracefully
      if is_array
        results = []
        for i in 0...obj.length
          o = obj[i]
          results.push(
            {
              "type" => o["type"],
              "id" => o["id"],
              "display_name" => o["display_name"],
              "control" => {
                "control_short_name" => control_name,
                "value" => false,
                "variation" => nil,
                "from_server" => false,
                "from_cache" => false
              }
            }
          )
        end
        return results
      else
        return {
          "type" => obj["type"],
          "id" => obj["id"],
          "display_name" => obj["display_name"],
          "control" => {
            "control_short_name" => control_name,
            "value" => false,
            "variation" => nil,
            "from_server" => false,
            "from_cache" => false
          }
        }
      end
    else
      raise
    end
  end
end

#get_value(control_name, obj) ⇒ Object 



233
234
235
236
 
# File 'lib/airship-client.rb', line 233

def get_value(control_name, obj)
  result = self.gate(control_name, obj)
  result["control"]["value"]
end

#get_variation(control_name, obj) ⇒ Object 



238
239
240
241
 
# File 'lib/airship-client.rb', line 238

def get_variation(control_name, obj)
  result = self.gate(control_name, obj)
  result["control"]["variation"]
end

#identify(objs) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/airship-client.rb', line 111

def identify(objs)
  if !objs.instance_of?(Array)
    objs = [objs]
  end
  begin
    response = @conn.post do |req|
      req.url(V1_IDENTIFY_ENDPOINT)
      req.headers["Content-Type"] = "application/json"
      req.headers["api-key"] = @api_key || @@api_key
      req.options.timeout = @@timeout
      request_obj = {}
      request_obj["env_key"] = @env_key || @@env_key
      request_obj["objects"] = objs
      req.body = request_obj.to_json
    end
    result = JSON.parse(response.body)
    result
  rescue Faraday::TimeoutError => e
    raise
  end
end