moesif_api 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a24cfbdbbe33de56926a0649b0f273ff07757d307467d4b2045c2fb79ed344
-  data.tar.gz: 94454f17f189f05d2130a1e23a7ddb67b293c0fa11a4b9912e5bdd93a8ece779
+  metadata.gz: f03579dcdef101fe45b4f839f3059c77e1079766a116db2d326f672f744fbe08
+  data.tar.gz: 00f963b0abb153bae0bb3c61d61cb7b0e309c7c8e9121cbc164e6e6288fa3582
 SHA512:
-  metadata.gz: 6891179f717910897bac07f725839cd7ec08e0c19ae52e03a75169a274d435e7b0d42d1afea0aff4a0221721a9847cbcecf8fb3c979076d3986c2b8b1680ae36
-  data.tar.gz: 56aea775a0eee3cfad61d6421e43ad2255a59bd4830e4ef04509353807fba56c88b0d88d711298170202395917c29cdde81855ddb959b505b02d4f287807ce35
+  metadata.gz: b8952a4d79b418b0e71161df18b941726324aa8d9efa3b5889f0144f2c5a666e6bf8c40af27fc4e901925f552853e2b28b2f0ca549d0ada1e48f655eb8cfb0e1
+  data.tar.gz: b0fb53a6940026d7cdfcc7bf245bb705ef2591222ce8d5767fd593e909cdba170ee922cab2d64e7a3dca213f6c44e38120d5e973a6e2feb8ccf5a5106ff1fac7

data/lib/moesif_api/configuration.rb

@@ -8,7 +8,7 @@ module MoesifApi
     # Your Application Id for authentication/authorization
     @application_id = 'SET_ME'
 
-    @version = '1.2.4'
+    @version = '1.2.5'
 
     # create the getters and setters
     class << self

data/lib/moesif_api/controllers/api_controller.rb

@@ -132,7 +132,7 @@ module MoesifApi
     end
 
 
-    # Update Data for a Single User
+    # Update Data for multiple Users in a single batch (batch size must be less than 250kb)
     # @param [list of UserModel] body Required parameter.
     # @return void response from the API call
     def update_users_batch(body)
@@ -211,5 +211,83 @@ module MoesifApi
       # Return the response
       return _response
     end
+
+    # Add Data for a Single Company
+    # @param [CompanyModel] body Required parameter.
+    # @return void response from the API call
+    def add_company(body)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/companies'
+
+      # 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,
+        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
+      }
+
+      # 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
+
+    # Update Data for multiple Companies in a single batch (batch size must be less than 250kb)
+    # @param [list of CompanyModel] body Required parameter.
+    # @return void response from the API call
+    def add_companies_batch(body)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/companies/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,
+        'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
+      }
+
+      # 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/models/company_model.rb

@@ -0,0 +1,82 @@
+
+
+require 'date'
+module MoesifApi
+  class CompanyModel < BaseModel
+
+    # company id of the company
+    # @return [String]
+    attr_accessor :company_id
+
+    # Time when modification was made. default to current time on server side.
+    # @return [DateTime]
+    attr_accessor :modified_time
+
+    # ip address associated with user if avaialble.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # session token associated with user if avaialble.
+    # @return [String]
+    attr_accessor :session_token
+
+    # Optionally tag the company with the company domain.
+    # @return [String]
+    attr_accessor :company_domain
+
+    # meta data
+    # @return [Object]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["company_id"] = "company_id"
+        @hash["modified_time"] = "modified_time"
+        @hash["ip_address"] = "ip_address"
+        @hash["session_token"] = "session_token"
+        @hash["company_domain"] = "company_domain"
+        @hash["metadata"] = "metadata"
+      end
+      @hash
+    end
+
+    def initialize(company_id = nil,
+                   modified_time = nil,
+                   ip_address = nil,
+                   session_token = nil,
+                   company_domain = nil,
+                   metadata = nil)
+      @company_id = company_id
+      @modified_time = modified_time
+      @ip_address = ip_address
+      @session_token = session_token
+      @company_domain = company_domain
+      @metadata = metadata
+    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
+        company_id = hash["company_id"]
+        modified_time = DateTime.iso8601(hash["modified_time"]) if hash["modified_time"]
+        ip_address = hash["ip_address"]
+        session_token = hash["session_token"]
+        company_domain = hash["company_domain"]
+        metadata = hash["metadata"]
+
+        # Create object from extracted values
+        UserModel.new(company_id,
+                      modified_time,
+                      ip_address,
+                      session_token,
+                      company_domain,
+                      metadata)
+      end
+    end
+  end
+end

data/lib/moesif_api.rb

@@ -27,6 +27,7 @@ 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'
 require_relative 'moesif_api/models/user_model.rb'
+require_relative 'moesif_api/models/company_model.rb'
 
 # Controllers
 require_relative 'moesif_api/controllers/base_controller.rb'

data/test/controllers/test_api_controller.rb

@@ -134,4 +134,44 @@ class ApiControllerTests < ControllerTestBase
     assert_equal(@response_catcher.response.status_code, 200)
   end
 
+  # Add Single Company via API
+  def test_add_company()
+    # Parameters for the API call
+
+    company_model = CompanyModel.new()
+    company_model.modified_time = Time.now.utc.iso8601
+    company_model.company_id = "1"
+
+    # Perform the API call through the SDK function
+    self.class.controller.add_company(company_model)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 201)
+  end
+
+  # Add Batched Companies via Ingestion API
+  def test_add_companies_batch()
+    # Parameters for the API call
+
+    company_model_A = CompanyModel.new()
+    company_model_A.modified_time = Time.now.utc.iso8601
+    company_model_A.company_id = "1"
+
+    company_model_B = CompanyModel.new()
+    company_model_B.modified_time = Time.now.utc.iso8601
+    company_model_B.company_id = "2"
+    company_model_B.metadata = JSON.parse('{'\
+        '"string_field": "value_1",'\
+        '"name": "ruby api user",'\
+        '"custom": "testdata"'\
+      '}')
+
+    companies = [company_model_A, company_model_B]
+
+    # Perform the API call through the SDK function
+    self.class.controller.add_companies_batch(companies)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 201)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_api
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -78,6 +78,7 @@ files:
 - 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/company_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