moesif_api 1.0.3 → 1.0.4

data/lib/moesif_api/http/http_call_back.rb

@@ -1,17 +1,17 @@
-
-
-module MoesifApi
-  class HttpCallBack
-    # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] The HttpRequest object which the HttpClient will execute.
-    def on_before_request(http_request)
-      raise NotImplementedError, "This method needs to be implemented in a child class."
-    end
-    
-    # A controller will call this method after making an HTTP Request.
-    # @param [HttpResponse] The HttpResponse object received from the HttpClient.
-    def on_after_response(http_response)
-      raise NotImplementedError, "This method needs to be implemented in a child class."
-    end
-  end
+
+
+module MoesifApi
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient will execute.
+    def on_before_request(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpResponse object received from the HttpClient.
+    def on_after_response(http_response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+  end
 end

data/lib/moesif_api/http/http_client.rb

@@ -1,112 +1,112 @@
-
-
-module MoesifApi
-  class HttpClient
-    # Execute an HttpRequest when the response is expected to be a string.
-    # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_string(http_request)
-      raise NotImplementedError, "This method needs to be implemented in a child class."
-    end
-    
-    # Execute an HttpRequest when the response is expected to be binary.
-    # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_binary(http_request)
-      raise NotImplementedError, "This method needs to be implemented in a child class."
-    end
-    
-    # Converts the HTTP Response from the client to an HttpResponse object.
-    # @param [Dynamic] The response object received from the client.
-    def convert_response(response)
-      raise NotImplementedError, "This method needs to be implemented in a child class."
-    end
-
-    # Get a GET HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def get(query_url,
-            headers: nil,
-            username: nil,
-            password: nil)
-      return HttpRequest.new(HttpMethodEnum::GET,
-                             query_url,
-                             headers: headers,
-                             username: username,
-                             password: password)
-    end
-    
-    # Get a POST HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def post(query_url,
-             headers: nil,
-             parameters: nil,
-             username: nil,
-             password: nil)
-      return HttpRequest.new(HttpMethodEnum::POST,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
-    end
-    
-    # Get a PUT HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def put(query_url,
-            headers: nil,
-            parameters: nil,
-            username: nil,
-            password: nil)
-      return HttpRequest.new(HttpMethodEnum::PUT,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
-    end
-    
-    # Get a PATCH HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def patch(query_url,
-              headers: nil,
-              parameters: nil,
-              username: nil,
-              password: nil)
-      return HttpRequest.new(HttpMethodEnum::PATCH,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
-    end
-    
-    # Get a DELETE HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def delete(query_url,
-               headers: nil,
-               username: nil,
-               password: nil)
-      return HttpRequest.new(HttpMethodEnum::DELETE,
-                             query_url,
-                             headers: headers,
-                             username: username,
-                             password: password)
-    end
-  end
-end
+
+
+module MoesifApi
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def get(query_url,
+            headers: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::GET,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def post(query_url,
+             headers: nil,
+             parameters: nil,
+             username: nil,
+             password: nil)
+      return HttpRequest.new(HttpMethodEnum::POST,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def put(query_url,
+            headers: nil,
+            parameters: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::PUT,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def patch(query_url,
+              headers: nil,
+              parameters: nil,
+              username: nil,
+              password: nil)
+      return HttpRequest.new(HttpMethodEnum::PATCH,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def delete(query_url,
+               headers: nil,
+               username: nil,
+               password: nil)
+      return HttpRequest.new(HttpMethodEnum::DELETE,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+  end
+end

data/lib/moesif_api/http/http_context.rb

@@ -1,15 +1,15 @@
-
-
-module MoesifApi
-  class HttpContext
-    attr_accessor :request, :response
-
-    # The constructor.
-    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
-    # @param [HttpResponse] An HttpResponse object representing the HTTP response.
-    def initialize(request, response)
-      @request = request
-      @response = response
-    end
-  end
+
+
+module MoesifApi
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
 end

data/lib/moesif_api/http/http_method_enum.rb

@@ -1,7 +1,7 @@
-
-
-module MoesifApi
-  class HttpMethodEnum
-    HTTPMETHODENUM = [GET = "GET", POST = "POST", PUT = "PUT", PATCH = "PATCH", DELETE = "DELETE"]
-  end
-end
+
+
+module MoesifApi
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = "GET", POST = "POST", PUT = "PUT", PATCH = "PATCH", DELETE = "DELETE"]
+  end
+end

data/lib/moesif_api/http/http_request.rb

@@ -1,28 +1,28 @@
-
-
-module MoesifApi
-  class HttpRequest
-    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
-
-    # The constructor.	
-    # @param [HttpMethodEnum] The HTTP method.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
-    def initialize(http_method,
-                   query_url,
-                   headers: nil,
-                   parameters: nil,
-                   username: nil,
-                   password: nil)
-      @http_method = http_method
-      @query_url = query_url
-      @headers = headers
-      @parameters = parameters
-      @username = username
-      @password = password
-    end
-  end
-end
+
+
+module MoesifApi
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
+
+    # The constructor.	
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def initialize(http_method,
+                   query_url,
+                   headers: nil,
+                   parameters: nil,
+                   username: nil,
+                   password: nil)
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/moesif_api/http/http_response.rb

@@ -1,19 +1,19 @@
-
-
-module MoesifApi
-  class HttpResponse
-    attr_accessor :status_code, :headers, :raw_body
-    
-    # The constructor.	
-    # @param [Integer] The status code returned by the server.
-    # @param [Hash] The headers sent by the server in the response.
-    # @param [String] The raw body of the response.
-    def initialize(status_code,
-                   headers,
-                   raw_body)
-      @status_code = status_code
-      @headers = headers
-      @raw_body = raw_body
-    end
-  end
-end
+
+
+module MoesifApi
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+    
+    # The constructor.	
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end

data/lib/moesif_api/http/unirest_client.rb

@@ -1,36 +1,36 @@
-
-
-module MoesifApi
-  class UnirestClient < HttpClient
-    # Method overridden from HttpClient.
-    def execute_as_string(http_request)
-      if http_request.username || http_request.password
-        auth = {:user=>http_request.username, :password=>http_request.password}
-      end 
-
-      response = Unirest.method(http_request.http_method.downcase).call(http_request.query_url, 
-        headers: http_request.headers, parameters: http_request.parameters,
-        auth: auth)
-
-      return convert_response(response)
-    end
-
-    # Method overridden from HttpClient.
-    def execute_as_binary(http_request)
-      if http_request.username || http_request.password
-        auth = {:user=>http_request.username, :password=>http_request.password}
-      end 
-
-      response = Unirest.method(http_request.http_method.downcase).call(http_request.query_url, 
-        headers: http_request.headers, parameters: http_request.parameters,
-        auth: auth)
-
-      return convert_response(response)
-    end
-
-    # Method overridden from HttpClient.
-    def convert_response(response)
-      return HttpResponse.new(response.code, response.headers.dup, response.raw_body.dup)
-    end
-  end
+
+
+module MoesifApi
+  class UnirestClient < HttpClient
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      if http_request.username || http_request.password
+        auth = {:user=>http_request.username, :password=>http_request.password}
+      end 
+
+      response = Unirest.method(http_request.http_method.downcase).call(http_request.query_url, 
+        headers: http_request.headers, parameters: http_request.parameters,
+        auth: auth)
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      if http_request.username || http_request.password
+        auth = {:user=>http_request.username, :password=>http_request.password}
+      end 
+
+      response = Unirest.method(http_request.http_method.downcase).call(http_request.query_url, 
+        headers: http_request.headers, parameters: http_request.parameters,
+        auth: auth)
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      return HttpResponse.new(response.code, response.headers.dup, response.raw_body.dup)
+    end
+  end
 end

data/lib/moesif_api/models/base_model.rb

@@ -1,32 +1,32 @@
-
-
-module MoesifApi
-  class BaseModel
-    # Returns a Hash representation of the current object
-    def to_hash
-      hash = {}
-      self.instance_variables.each do |name|
-        value = self.instance_variable_get(name)
-        name = name[1..-1]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
-        if value.instance_of? Array
-          hash[key] = value.map{|v| v.kind_of?(BaseModel) ? v.to_hash : v}
-        elsif value.instance_of? Hash
-          hash[key] = {}
-          value.each do |k, v|
-            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : v
-          end
-        else
-          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : value
-        end
-      end
-      hash
-    end
-
-    # Returns a JSON representation of the curent object
-    def to_json(options = {})
-      hash = to_hash
-      hash.to_json(options)
-    end
-  end
-end
+
+
+module MoesifApi
+  class BaseModel
+    # Returns a Hash representation of the current object
+    def to_hash
+      hash = {}
+      self.instance_variables.each do |name|
+        value = self.instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map{|v| v.kind_of?(BaseModel) ? v.to_hash : v}
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end