moesif_api 1.2.17 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbeae4f833a8dd46f08feb1363908774c9cac999361cee7069785a07cf31f049
-  data.tar.gz: a05fe5f642e5b79dae01b37b8eb7cf3912d57ddd2e432693d6514882e4df3bea
+  metadata.gz: d889e01e7b3cc16297fa23ad6ff7a0125ff7689f78bd85647eeca511c606cc09
+  data.tar.gz: 4160000b4f7ae1dd9fd24821dbed4d4fe0f44497f4c9e4deb71ce2d2deefda92
 SHA512:
-  metadata.gz: 58e2ddeafce8e3fe7e1cab639b8621cdbf233ad79f16d399ba7f4bfad633f9d63f57d5da32ca8afeb3abbc1b057fadcc37039b5e6e56ac813be3591a17e3c017
-  data.tar.gz: cff9423f46905fb3951c1bfaaef7a274d3dc54b32327336cbfe3409b0ebba123fcf027fefe13eb79a388f18bdaede1f80d7704bc3c0599503f6341dc4cfda689
+  metadata.gz: 1c11e000cccb456b87cc1857dd5071344254b7b30c2264e44bb0302908fd1ea189368406b244b4c484cbe0eb44f94d448233e64e4c98beb27226206b8b06a898
+  data.tar.gz: 43a7c046d17cdce30a7cf03d0d3a0661bb5418a9d49d0459147a74de851f98faf73e99d2ca214d46910dd85dedbba8e422bb4733f74ddedf7b4325c8babfea11

data/lib/moesif_api/configuration.rb

@@ -8,13 +8,16 @@ module MoesifApi
     # Your Application Id for authentication/authorization
     @application_id = 'SET_ME'
 
-    @version = '1.2.12'
+    @version = '2.0.1'
+
+    @user_agent = "moesifapi-ruby/2.0.1"
 
     # create the getters and setters
     class << self
       attr_accessor :base_uri
       attr_accessor :application_id
       attr_accessor :version
+      attr_accessor :user_agent
     end
   end
 end

data/lib/moesif_api/controllers/api_controller.rb

@@ -90,11 +90,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id,
-        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
-      }
+      _headers = build_request_headers()
 
       # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
       _response, _context = send_moesif(_query_url, _headers, body)
@@ -120,12 +116,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id,
-        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
-      }
-
+      _headers = build_request_headers()
       # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
       _response, _context = send_moesif(_query_url, _headers, body)
 
@@ -148,11 +139,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id,
-        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
-      }
+      _headers = build_request_headers()
 
       # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
       _response, _context = send_moesif(_query_url, _headers, body)
@@ -175,10 +162,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id
-      }
+      _headers = build_request_headers()
 
       # Create the HttpRequest object for the call
       _request = @http_client.get _query_url, headers: _headers
@@ -198,8 +182,7 @@ module MoesifApi
       # Global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return the response
-      return _response
+      return _response.json_body, _context
     end
 
     # Get App Governance Rules
@@ -216,10 +199,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id
-      }
+      _headers = build_request_headers()
 
       # Create the HttpRequest object for the call
       _request = @http_client.get _query_url, headers: _headers
@@ -240,7 +220,7 @@ module MoesifApi
       validate_response(_context)
 
       # Return the response
-      return _response
+      return _response.json_body, _context
     end
 
     # Update Data for a Single Company
@@ -257,11 +237,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'content-type' => 'application/json; charset=utf-8',
-        'X-Moesif-Application-Id' => Configuration.application_id,
-        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
-      }
+      _headers = build_request_headers()
 
       # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
       _response, _context = send_moesif(_query_url, _headers, body)

data/lib/moesif_api/controllers/base_controller.rb

@@ -1,20 +1,27 @@
-
-
 module MoesifApi
   class BaseController
     attr_accessor :http_client, :http_call_back
 
-    @@http_client = UnirestClient.new
+    @@faraday_http_client = FaradayClient.new
 
     def initialize(http_client: nil, http_call_back: nil)
-      @http_client = http_client ||= @@http_client
+      @http_client = http_client ||= @@faraday_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
+    def build_request_headers
+      {
+        'content-type' => 'application/json; charset=utf-8',
+        'X-Moesif-Application-Id' => Configuration.application_id,
+        'User-Agent' => Configuration.user_agent || ('moesifapi-ruby/' +  Configuration.version)
+      }
+    end
+
+    def validate_response(context)
+      return 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

@@ -21,12 +21,7 @@ module MoesifApi
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
-      _headers = {
-        'accept' => 'application/json',
-        'X-Moesif-Application-Id' => Configuration.application_id,
-        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
-      }
-
+      _headers = build_request_headers()
       # Create the HttpRequest object for the call
       _request = @http_client.get _query_url, headers: _headers
 

data/lib/moesif_api/http/faraday_client.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'faraday/net_http_persistent'
+require 'faraday/retry'
+require 'json'
+
+module MoesifApi
+  class FaradayClient < HttpClient
+    def initialize
+      super()
+      retry_options = {
+        max: 3,
+        interval: 0.1,
+        interval_randomness: 0.5,
+        backoff_factor: 2
+      }
+
+      @connection = Faraday.new({}) do |f|
+        f.request :retry, retry_options
+        f.adapter :net_http_persistent, pool_size: 5 do |http|
+          http.idle_timeout = 100
+        end
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.run_request(http_request.http_method.downcase.to_sym,
+                                         http_request.query_url,
+                                         http_request.parameters, # body
+                                         http_request.headers)
+
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      if response.body.is_a?(String)
+        raw_body = response.body
+      elsif !response.body.nil?
+        raw_body = JSON.generate(response.body)
+      end
+
+      HttpResponse.new(response.status, response.headers.dup, raw_body)
+    end
+  end
+end

data/lib/moesif_api/http/http_response.rb

@@ -2,9 +2,9 @@
 
 module MoesifApi
   class HttpResponse
-    attr_accessor :status_code, :headers, :raw_body
-    
-    # The constructor.	
+    attr_accessor :status_code, :headers, :raw_body, :json_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.
@@ -14,6 +14,16 @@ module MoesifApi
       @status_code = status_code
       @headers = headers
       @raw_body = raw_body
+
+      begin
+        if !raw_body.nil? and raw_body.is_a?(String) and (raw_body.start_with?("{") || raw_body.start_with?("["))
+          @json_body = JSON.parse(raw_body)
+        end
+      rescue StandardError => e
+        # we can't parse json body
+        # but it is ok, move forward anyways
+        # print "can't parse json " + e.to_s
+      end
     end
   end
 end

data/lib/moesif_api/moesif_api_client.rb

@@ -15,8 +15,11 @@ module MoesifApi
     end
 
     # Initializer with authentication and configuration parameters
-    def initialize(application_id)
+    def initialize(application_id, user_agent=nil)
       Configuration.application_id = application_id
+      unless user_agent.nil?
+        Configuration.user_agent = user_agent
+      end
     end
   end
 end

data/lib/moesif_api.rb

@@ -1,7 +1,6 @@
 
 require 'openssl'
 require 'json'
-require 'unirest'
 
 # Exceptions
 require_relative 'moesif_api/exceptions/api_exception.rb'
@@ -18,7 +17,7 @@ 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'
+require_relative 'moesif_api/http/faraday_client.rb'
 
 # Models
 require_relative 'moesif_api/models/base_model.rb'

data/test/controllers/test_api_controller.rb

@@ -164,11 +164,20 @@ class ApiControllerTests < ControllerTestBase
 
   # Get the application configuration
   def test_get_app_config()
-
     # Perform the API call through the SDK function
-    app_config = self.class.controller.get_app_config()
+    app_config, _context = self.class.controller.get_app_config()
+    print "gonna print the app_cofig\n"
+    print app_config.to_s + "\n"
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 200)
+  end
 
+  def test_get_rules()
+     # Perform the API call through the SDK function
+    rules, _context = self.class.controller.get_rules()
     # Test response code
+    print 'gonna print the rules'
+    print rules.to_s
     assert_equal(@response_catcher.response.status_code, 200)
   end
 

data/test/http_response_catcher.rb

@@ -9,8 +9,11 @@ class HttpResponseCatcher < MoesifApi::HttpCallBack
   # Catching the response
   def on_after_response(context)
     @response = context.response
+    # print "I am here in on after response\n"
+    # print "response raw_body is a string " + @response.raw_body.is_a?(String).to_s + "\n"
+    # print @response.raw_body + "\n"
+    # print "response json_body is a hash" + @response.json_body.is_a?(Hash).to_s
+    # print @response.json_body.to_s
+    # print "\nfnished printing json body"
   end
 end
-
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_api
 version: !ruby/object:Gem::Version
-  version: 1.2.17
+  version: 2.0.1
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -31,6 +31,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json_mapper
   requirement: !ruby/object:Gem::Requirement
@@ -52,19 +112,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: moesif_unirest
+  name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 description: Collection/Data Ingestion API
 email: derric@moesif.com
 executables: []
@@ -80,13 +146,13 @@ files:
 - 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/faraday_client.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/campaign_model.rb
 - lib/moesif_api/models/company_model.rb
@@ -112,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/moesif_api/http/unirest_client.rb

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