moesif_api 1.0.0

data/lib/moesif_api/models/event_response_model.rb

@@ -0,0 +1,72 @@
+
+
+require 'date'
+module MoesifApi
+  class ResponseModel < BaseModel
+    # Time when response received
+    # @return [DateTime]
+    attr_accessor :time
+
+    # HTTP Status code such as 200
+    # @return [Integer]
+    attr_accessor :status
+
+    # Key/Value map of response headers
+    # @return [Object]
+    attr_accessor :headers
+
+    # Response body
+    # @return [Object]
+    attr_accessor :body
+
+    # IP Address from the response, such as the server IP Address
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["time"] = "time"
+        @hash["status"] = "status"
+        @hash["headers"] = "headers"
+        @hash["body"] = "body"
+        @hash["ip_address"] = "ip_address"
+      end
+      @hash
+    end
+
+    def initialize(time = nil,
+                   status = nil,
+                   headers = nil,
+                   body = nil,
+                   ip_address = nil)
+      @time = time
+      @status = status
+      @headers = headers
+      @body = body
+      @ip_address = ip_address
+    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"]
+        status = hash["status"]
+        headers = hash["headers"]
+        body = hash["body"]
+        ip_address = hash["ip_address"]
+
+        # Create object from extracted values
+        ResponseModel.new(time,
+                                     status,
+                                     headers,
+                                     body,
+                                     ip_address)
+      end
+    end
+  end
+end

data/lib/moesif_api/models/status_model.rb

@@ -0,0 +1,44 @@
+
+
+module MoesifApi
+  class StatusModel < BaseModel
+    # Status of Call
+    # @return [Boolean]
+    attr_accessor :status
+
+    # Location
+    # @return [String]
+    attr_accessor :region
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["status"] = "status"
+        @hash["region"] = "region"
+      end
+      @hash
+    end
+
+    def initialize(status = nil,
+                   region = nil)
+      @status = status
+      @region = region
+    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
+        status = hash["status"]
+        region = hash["region"]
+
+        # Create object from extracted values
+        StatusModel.new(status,
+                              region)
+      end
+    end
+  end
+end

data/lib/moesif_api/moesif_api_client.rb

@@ -0,0 +1,22 @@
+
+
+module MoesifApi
+  class MoesifAPIClient
+    # Singleton access to api controller
+    # @return [ApiController] Returns the controller instance
+    def api
+      ApiController.instance
+    end
+
+    # Singleton access to health controller
+    # @return [HealthController] Returns the controller instance
+    def health
+      HealthController.instance
+    end
+
+    # Initializer with authentication and configuration parameters
+    def initialize(application_id: nil)
+      Configuration.application_id = application_id
+    end
+  end
+end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,29 @@
+
+
+require 'json'
+require 'test/unit'
+require 'moesif_api.rb'
+require_relative '../test_helper.rb'
+require_relative '../http_response_catcher.rb'
+
+class ControllerTestBase < Test::Unit::TestCase
+  include MoesifApi
+
+  class << self
+    attr_accessor :controller
+  end
+
+  # Called only once for a test class before any test has executed.
+  def self.startup
+    @@api_client = MoesifAPIClient.new
+    @@request_timeout = 30
+    @@assert_precision = 0.01
+    Configuration.application_id = "eyJhcHAiOiIzNjU6NiIsInZlciI6IjIuMCIsIm9yZyI6IjM1OTo0IiwiaWF0IjoxNDczMzc5MjAwfQ.9WOx3D357PGMxrXzFm3pV3IzJSYNsO4oRudiMI8mQ3Q"
+  end
+
+  # Called once before every test case.
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    self.class.controller.http_call_back = @response_catcher
+  end
+end

data/test/controllers/test_api_controller.rb

@@ -0,0 +1,35 @@
+
+
+require_relative 'controller_test_base'
+
+class ApiControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.api
+  end
+
+  # Add Single Event via Injestion API
+  def test_add_event()
+    # Parameters for the API call
+    body = EventModel.from_hash(JSON.parse('{ 					"request": { 						"time": "2016-09-09T04:45:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:45:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f" 					 }'))
+
+    # Perform the API call through the SDK function
+    self.class.controller.create_event(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 201)
+  end
+
+  # Add Batched Events via Ingestion API
+  def test_add_batched_events()
+    # Parameters for the API call
+    body = JSON.parse('[{ 					"request": { 						"time": "2016-09-09T04:45:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:45:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f" 					 }, { 					"request": { 						"time": "2016-09-09T04:46:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:46:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f" 					 }, { 					"request": { 						"time": "2016-09-09T04:47:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:47:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f" 					 }, { 					"request": { 						"time": "2016-09-09T04:48:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:48:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "exfzweachxjgznvKUYrxFcxv]s98y18cx98q3yhwmnhcfx43f" 					 }, { 					"request": { 						"time": "2016-09-09T04:49:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:49:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "mndug437f43", 					"session_token": "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f" 					 }, { 					"request": { 						"time": "2016-09-09T04:50:42.914", 						"uri": "https://api.acmeinc.com/items/reviews/", 						"verb": "PATCH", 						"api_version": "1.1.0", 						"ip_address": "61.48.220.123", 						"headers": { 							"Host": "api.acmeinc.com", 							"Accept": "*/*", 							"Connection": "Keep-Alive", 							"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)", 							"Content-Type": "application/json", 							"Content-Length": "126", 							"Accept-Encoding": "gzip" 						}, 						"body": { 							"items": [ 								{ 									"direction_type": 1, 									"discovery_id": "fwfrf", 									"liked": false 								}, 								{ 									"direction_type": 2, 									"discovery_id": "d43d3f", 									"liked": true 								} 							] 						} 					}, 					"response": { 						"time": "2016-09-09T04:50:42.914", 						"status": 500, 						"headers": { 							"Date": "Tue, 23 Aug 2016 23:46:49 GMT", 							"Vary": "Accept-Encoding", 							"Pragma": "no-cache", 							"Expires": "-1", 							"Content-Type": "application/json; charset=utf-8", 							"X-Powered-By": "ARR/3.0", 							"Cache-Control": "no-cache", 							"Arr-Disable-Session-Affinity": "true" 						}, 						"body": { 							"Error": "InvalidArgumentException", 							"Message": "Missing field field_a" 						} 					}, 					"user_id": "recvreedfef", 					"session_token": "xcvkrjmcfghwuignrmcmhxdhaaezse4w]s98y18cx98q3yhwmnhcfx43f" 					 } ]').map{|element| EventModel.from_hash(element)}
+
+    # Perform the API call through the SDK function
+    self.class.controller.create_events_batch(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 201)
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,16 @@
+
+
+class HttpResponseCatcher < MoesifApi::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(context)
+    @response = context.response
+  end
+end
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,94 @@
+
+
+require 'tempfile'
+require 'open-uri'
+
+class TestHelper
+
+  @cache = Hash.new
+
+  # Class method to compare the received headers with the expected headers.
+  # @param [Hash] A hash of expected headers (keys in lower case).
+  # @param [Hash] A hash of received headers.
+  # @param [Boolean, optional] A flag which determines if we allow extra headers.
+  def self.match_headers(expected_headers,
+                         received_headers,
+                         allow_extra: true)
+    return false if ((received_headers.length < expected_headers.length) ||
+                    ((allow_extra == false) && (received_headers.length > expected_headers.length)))
+
+    received_headers = Hash[received_headers.map{|k, v| [k.to_s.downcase, v]}]
+    expected_headers.each do |e_key, e_value|
+      return false unless received_headers.key?(e_key)
+      return false if ((e_value != nil) &&
+                       (e_value != received_headers[e_key]))
+    end
+
+    return true
+  end
+
+  # Class method to compare the received body with the expected body.
+  # @param [Dynamic] The expected body.
+  # @param [Dynamic] The received body.
+  # @param [Boolean, optional] A flag which determines if we check values in dictionaries.
+  # @param [Boolean, optional] A flag which determines if we check the order of array elements.
+  # @param [Boolean, optional] A flag which determines if we check the count of array elements.
+  def self.match_body(expected_body,
+                      received_body,
+                      check_values: false,
+                      check_order: false,
+                      check_count: false)
+    if expected_body.instance_of? Hash
+      return False if not received_body.instance_of? Hash
+      for key in expected_body.keys
+        return false if not received_body.keys.include? key
+        if check_values or expected_body[key].instance_of? Hash
+          return false if not TestHelper.match_body(expected_body[key],
+                                                  received_body[key],
+                                                  check_values: check_values,
+                                                  check_order: check_order,
+                                                  check_count: check_count)
+        end
+      end
+    elsif expected_body.instance_of? Array
+      return False if not received_body.instance_of? Array
+      if check_count == true && (expected_body.length != received_body.length)
+        return false
+      else
+        previous_matches = Array.new
+        expected_body.each.with_index do |expected_element, i|
+          matches = (received_body.map.with_index do |received_element, j|
+                      j if TestHelper.match_body(expected_element,
+                                                 received_element,
+                                                 check_values: check_values,
+                                                 check_order: check_order,
+                                                 check_count: check_count)
+                    end).compact
+          return false if matches.length == 0
+          if check_order == true
+            return false if (i != 0 && matches.map{|x| previous_matches.map{|y| y > x}.all?}.all?)
+            previous_matches = matches
+          end
+        end
+      end
+    elsif expected_body != received_body
+      return false
+    end
+    return true
+  end
+
+  # Class method which takes a URL, downloads the file (if not already downloaded
+  # for this test session) and returns a file object for the file in read-binary mode.
+  # @param [String] The URL of the required file.
+  def self.get_file(url)
+    if not @cache.keys.include? url
+      @cache[url] = Tempfile.new('APIMatic')
+      @cache[url].binmode
+      @cache[url].write(open(url, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE}).read)
+    else
+      @cache[url].open
+      @cache[url].binmode
+    end
+    return @cache[url]
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: moesif_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Moesif, Inc
+- Derric Gilling
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  name: test-unit
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  name: unirest
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  name: json_mapper
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: Collection/Data Ingestion API
+email: derric@moesif.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/moesif_api.rb
+- lib/moesif_api/api_helper.rb
+- lib/moesif_api/configuration.rb
+- lib/moesif_api/controllers/api_controller.rb
+- lib/moesif_api/controllers/base_controller.rb
+- lib/moesif_api/controllers/health_controller.rb
+- lib/moesif_api/exceptions/api_exception.rb
+- lib/moesif_api/http/http_call_back.rb
+- lib/moesif_api/http/http_client.rb
+- lib/moesif_api/http/http_context.rb
+- lib/moesif_api/http/http_method_enum.rb
+- lib/moesif_api/http/http_request.rb
+- lib/moesif_api/http/http_response.rb
+- lib/moesif_api/http/unirest_client.rb
+- lib/moesif_api/models/base_model.rb
+- lib/moesif_api/models/event_model.rb
+- lib/moesif_api/models/event_request_model.rb
+- lib/moesif_api/models/event_response_model.rb
+- lib/moesif_api/models/status_model.rb
+- lib/moesif_api/moesif_api_client.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_api_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
+homepage: https://moesif.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: moesif_api
+test_files: []