moesif_api 1.0.0

data/lib/moesif_api/exceptions/api_exception.rb

@@ -0,0 +1,16 @@
+
+
+module MoesifApi
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason)
+      @context = context
+	  @response_code = context.response.status_code
+    end
+  end
+end

data/lib/moesif_api/http/http_call_back.rb

@@ -0,0 +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
+end

data/lib/moesif_api/http/http_client.rb

@@ -0,0 +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

data/lib/moesif_api/http/http_context.rb

@@ -0,0 +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
+end

data/lib/moesif_api/http/http_method_enum.rb

@@ -0,0 +1,7 @@
+
+
+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

@@ -0,0 +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

data/lib/moesif_api/http/http_response.rb

@@ -0,0 +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

data/lib/moesif_api/http/unirest_client.rb

@@ -0,0 +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
+end

data/lib/moesif_api/models/base_model.rb

@@ -0,0 +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

data/lib/moesif_api/models/event_model.rb

@@ -0,0 +1,71 @@
+
+
+module MoesifApi
+  class EventModel < BaseModel
+    # API request object
+    # @return [EventRequestModel]
+    attr_accessor :request
+
+    # API response Object
+    # @return [ResponseModel]
+    attr_accessor :response
+
+    # End user's auth/session token
+    # @return [String]
+    attr_accessor :session_token
+
+    # comma separated list of tags, see documentation
+    # @return [String]
+    attr_accessor :tags
+
+    # End user's user_id string from your app
+    # @return [String]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["request"] = "request"
+        @hash["response"] = "response"
+        @hash["session_token"] = "session_token"
+        @hash["tags"] = "tags"
+        @hash["user_id"] = "user_id"
+      end
+      @hash
+    end
+
+    def initialize(request = nil,
+                   response = nil,
+                   session_token = nil,
+                   tags = nil,
+                   user_id = nil)
+      @request = request
+      @response = response
+      @session_token = session_token
+      @tags = tags
+      @user_id = user_id
+    end
+
+    # Creates an instance of the object from a hash
+    def self.from_hash(hash)
+      if hash == nil
+        nil
+      else
+        # Extract variables from the hash
+        request = EventRequestModel.from_hash(hash["request"]) if hash["request"]
+        response = ResponseModel.from_hash(hash["response"]) if hash["response"]
+        session_token = hash["session_token"]
+        tags = hash["tags"]
+        user_id = hash["user_id"]
+
+        # Create object from extracted values
+        EventModel.new(request,
+                             response,
+                             session_token,
+                             tags,
+                             user_id)
+      end
+    end
+  end
+end

data/lib/moesif_api/models/event_request_model.rb

@@ -0,0 +1,90 @@
+
+
+require 'date'
+module MoesifApi
+  class EventRequestModel < BaseModel
+    # Time when request was made
+    # @return [DateTime]
+    attr_accessor :time
+
+    # full uri of request such as https://www.example.com/my_path?param=1
+    # @return [String]
+    attr_accessor :uri
+
+    # verb of the API request such as GET or POST
+    # @return [String]
+    attr_accessor :verb
+
+    # Key/Value map of request headers
+    # @return [Object]
+    attr_accessor :headers
+
+    # Optionally tag the call with your API or App version
+    # @return [String]
+    attr_accessor :api_version
+
+    # IP Address of the client if known.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Request body
+    # @return [Object]
+    attr_accessor :body
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["time"] = "time"
+        @hash["uri"] = "uri"
+        @hash["verb"] = "verb"
+        @hash["headers"] = "headers"
+        @hash["api_version"] = "api_version"
+        @hash["ip_address"] = "ip_address"
+        @hash["body"] = "body"
+      end
+      @hash
+    end
+
+    def initialize(time = nil,
+                   uri = nil,
+                   verb = nil,
+                   headers = nil,
+                   api_version = nil,
+                   ip_address = nil,
+                   body = nil)
+      @time = time
+      @uri = uri
+      @verb = verb
+      @headers = headers
+      @api_version = api_version
+      @ip_address = ip_address
+      @body = body
+    end
+
+    # Creates an instance of the object from a hash
+    def self.from_hash(hash)
+      if hash == nil
+        nil
+      else
+        # Extract variables from the hash
+        time = DateTime.iso8601(hash["time"]) if hash["time"]
+        uri = hash["uri"]
+        verb = hash["verb"]
+        headers = hash["headers"]
+        api_version = hash["api_version"]
+        ip_address = hash["ip_address"]
+        body = hash["body"]
+
+        # Create object from extracted values
+        EventRequestModel.new(time,
+                                    uri,
+                                    verb,
+                                    headers,
+                                    api_version,
+                                    ip_address,
+                                    body)
+      end
+    end
+  end
+end