moesif_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 135adc3a0b9e77788fc3e44c590989af8c6f42b5
+  data.tar.gz: 2cc15b30740683c4c16c68cc68e905a63ccd8310
+SHA512:
+  metadata.gz: 5c7ebe96c975c087ec86a69298bc48d64b0a666c52b6e966e8e6c1a4c02ceb2322c7026932aecc6ff7a7bf7d1e98da1fc97dd09f33a22a571bf19ad377ec7f8f
+  data.tar.gz: 97f1ea4a0f21246e5ce75a7ab3200841ebbff031bc91e82a827a28baaf9f77ca8baf92bf69fd0d6df2a892a7aebac60e489f7271e85c4388ad1e2cf60ca0f32b

data/LICENSE

@@ -0,0 +1,24 @@
+License:
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2016 Moesif, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+MoesifApi
+=================
+
+How to configure:
+=================
+The generated code might need to be configured with your API credentials. To do that,
+open the file "configuration.rb" and edit it's contents.
+
+Alternatively, you can modify the Configuration parameters at run-time through the following:
+```
+MoesifApi::Configuration.your_paramater = YOUR_VALUE
+```
+
+How to build and install:
+=============================
+The generated code depends on a few Ruby gems. The references to these gems are
+added in the gemspec file. The easiest way to resolve the dependencies,
+build the gem and install it is through Rake:
+
+  1. Install Rake if not already installed: `gem install rake`
+  2. Install Bundler if not already installed: `gem install bundler`
+  3. From terminal/cmd navigate to the root directory of the SDK.
+  4. Invoke: `rake install`
+
+Alternatively, you can build and install the gem manually:
+
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Run the build command: `gem build moesif_api.gemspec`
+  3. Run the install command: `gem install ./moesif_api-1.0.0.gem`
+
+Note: You will need to have internet access for this step.
+
+How  to test:
+=============
+You can test the generated SDK and the server with automatically generated test
+cases as follows:
+
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Invoke: `bundle exec rake`
+
+How to use:
+===========
+After having installed the gem, you can easily use the SDK following these steps.
+
+  1. Create a "moesif_api_test.rb" file in the root directory.
+  2. Use any controller as follows:
+```ruby
+require 'moesif_api'
+
+api_client = MoesifApi::MoesifAPIClient.new
+controller = api_client.api_controller
+response = controller.create_event(<required parameters if any>)
+```

data/lib/moesif_api.rb

@@ -0,0 +1,30 @@
+
+require 'openssl'
+require 'json'
+require 'unirest'
+
+# Helper Files
+require_relative 'moesif_api/api_helper.rb'
+require_relative 'moesif_api/configuration.rb'
+require_relative 'moesif_api/moesif_api_client.rb'
+
+# Http
+require_relative 'moesif_api/http/http_call_back.rb'
+require_relative 'moesif_api/http/http_client.rb'
+require_relative 'moesif_api/http/http_method_enum.rb'
+require_relative 'moesif_api/http/http_request.rb'
+require_relative 'moesif_api/http/http_response.rb'
+require_relative 'moesif_api/http/http_context.rb'
+require_relative 'moesif_api/http/unirest_client.rb'
+
+# Models
+require_relative 'moesif_api/models/base_model.rb'
+require_relative 'moesif_api/models/event_request_model.rb'
+require_relative 'moesif_api/models/event_model.rb'
+require_relative 'moesif_api/models/event_response_model.rb'
+require_relative 'moesif_api/models/status_model.rb'
+
+# Controllers
+require_relative 'moesif_api/controllers/base_controller.rb'
+require_relative 'moesif_api/controllers/api_controller.rb'
+require_relative 'moesif_api/controllers/health_controller.rb'

data/lib/moesif_api/api_helper.rb

@@ -0,0 +1,151 @@
+
+
+module MoesifApi
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # iterate and append parameters
+        parameters.each do |key, value|
+          replace_value = ''
+
+          if value.nil?
+            replace_value = ''
+          elsif value.instance_of? Array
+            value.map!{|element| CGI.escape(element.to_s)}
+            replace_value = value.join('/')
+          else
+            replace_value = CGI.escape(value.to_s)
+          end
+
+          # find the template parameter and replace it with its value
+          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        end
+      end
+      return query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        return query_builder
+      else
+        # remove any nil values
+        parameters = parameters.reject { |_key, value| value.nil? }
+
+        # does the query string already has parameters
+        has_params = query_builder.include? '?'
+        separator = has_params ? '&' : '?'
+
+        # append query with separator and parameters and return
+        return query_builder << separator << URI.encode_www_form(parameters)
+      end
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+      
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(index != nil ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = index != nil ? url[url.index('?')...url.length] : ""
+
+      # return processed url
+      return protocol + query  + parameters
+    end	
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      begin
+        return JSON.parse(json)
+      rescue
+        raise TypeError, "Server responded with invalid JSON."
+      end
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = Hash.new
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode value, key)
+      end 
+      return encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = Hash.new
+
+      # If this is a structure, resolve it's field names.
+      if obj.kind_of? BaseModel
+        obj = obj.to_hash
+      end
+      
+      # Create a form encoded hash for this object.
+      if obj == nil
+        nil         
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      return retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/moesif_api/configuration.rb

@@ -0,0 +1,17 @@
+
+
+module MoesifApi
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'https://api.moesif.net'
+
+    # Your Application Id for authentication/authorization
+    @application_id = 'TODO: Replace'
+
+    # create the getters and setters
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :application_id
+    end
+  end
+end

data/lib/moesif_api/controllers/api_controller.rb

@@ -0,0 +1,87 @@
+
+
+module MoesifApi
+  class ApiController < BaseController
+    @@instance = ApiController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Add Single API Event Call
+    # @param [EventModel] body Required parameter: Example:
+    # @return void response from the API call
+    def create_event(body)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/events'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8',
+        'X-Moesif-Application-Id' => Configuration.application_id
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+    end
+
+    # Add multiple API Events in a single batch (batch size must be less than 250kb)
+    # @param [List of EventModel] body Required parameter: Example:
+    # @return void response from the API call
+    def create_events_batch(body)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/events/batch'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8',
+        'X-Moesif-Application-Id' => Configuration.application_id
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+    end
+  end
+end

data/lib/moesif_api/controllers/base_controller.rb

@@ -0,0 +1,20 @@
+
+
+module MoesifApi
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    @@http_client = UnirestClient.new
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client ||= @@http_client
+      @http_call_back = http_call_back
+    end
+
+    def validate_response(context)			
+      if !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', context
+      end
+    end
+  end
+end

data/lib/moesif_api/controllers/health_controller.rb

@@ -0,0 +1,52 @@
+
+
+module MoesifApi
+  class HealthController < BaseController
+    @@instance = HealthController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Health Probe
+    # @return StatusModel response from the API call
+    def get_health_probe
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/health/probe'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'X-Moesif-Application-Id' => Configuration.application_id
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return StatusModel.from_hash(decoded)
+    end
+  end
+end