moesif_rack 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9204370515cc07a90a131af8026d143f8fb666f45fc487b10b3bf21579cc20d9
-  data.tar.gz: 2de61defa7298cd0c70e0a453e3b12242dd249f26334569d326f5e7ab257ea11
+  metadata.gz: 8c8bb62325d278fd7e988de98c2da89a2c70997f0b76a734e28adb817f176816
+  data.tar.gz: 364c201149ab8f9247f3964e3e78743fd6cb56a52de086c57cf1276df9ea51de
 SHA512:
-  metadata.gz: b1f00c41d71b23c436aeab707803af8f8e6e39931560e3179ce7838aeeca121599048a46e936051b4a721499a876c1a5626cad72e78fe0ce034105aa53f15d5f
-  data.tar.gz: b39d08f502436c211ad9851d927395e333a8ef4bd218ff4506aac9386d19fbe165ab15bd2f68d7f6b2df8e5b90353e6cd5c05d7b1e27dae8e22c6a05f57eaddc
+  metadata.gz: fcda4f70277329914b87572d137021b81e7b592810d5850f8a281fd410335faa0388e7f9ab1ec1e5a92422f34e47200b67ab33a01282e1903dc05a1ef672a468
+  data.tar.gz: 9222266c7fbfc1156ce0f91081d377ef0ccaa59ce71479b44c94e177772b7368aa14545a1a4185079d076dfc1a6311bc47e25bb86b538f71af3a147912d38d6d

data/README.md

@@ -20,7 +20,7 @@ gem install moesif_rack
 and if you have a `Gemfile` in your project, please add this line to
 
 ```
-gem 'moesif_rack', '~> 1.2.5'
+gem 'moesif_rack', '~> 1.2.6'
 
 ```
 
@@ -187,6 +187,59 @@ For details for the spec of event model, please see the [Moesif Ruby API Documen
 
 Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.
 
+## Update User
+
+### update_user method
+A method is attached to the moesif middleware object to update the users profile or metadata.
+The metadata field can be any custom data you want to set on the user. The `user_id` field is required.
+
+```ruby
+metadata = JSON.parse('{'\
+      '"email": "testrubyapi@user.com",'\
+      '"name": "ruby api user",'\
+      '"custom": "testdata"'\
+    '}')
+
+user_model = { "user_id" => "testrubyapiuser", 
+                "modified_time" => Time.now.utc.iso8601, 
+                "metadata" => metadata }
+
+update_user = MoesifRack::MoesifMiddleware.new(@app, @options).update_user(user_model)
+```
+
+### update_users_batch method
+A method is attached to the moesif middleware object to update the users profile or metadata in batch.
+The metadata field can be any custom data you want to set on the user. The `user_id` field is required.
+
+```ruby
+metadata = JSON.parse('{'\
+      '"email": "testrubyapi@user.com",'\
+      '"name": "ruby api user",'\
+      '"custom": "testdata"'\
+    '}')
+
+user_models = []
+
+user_model_A = { "user_id" => "testrubyapiuser", 
+                "modified_time" => Time.now.utc.iso8601, 
+                "metadata" => metadata }
+
+user_model_B = { "user_id" => "testrubyapiuser1", 
+                "modified_time" => Time.now.utc.iso8601, 
+                "metadata" => metadata }
+
+user_models << user_model_A << user_model_B
+response = MoesifRack::MoesifMiddleware.new(@app, @options).update_users_batch(user_models)
+```
+
+## How to test
+
+1. Manually clone the git repo
+2. From terminal/cmd navigate to the root directory of the middleware.
+3. Invoke 'gem install moesif_rack'
+4. Add your own application id to 'test/moesif_rack_test.rb'. You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _Installation_
+5. Invoke 'ruby test/moesif_rack_test.rb'
+
 ## Example Code
 
 [Moesif Rack Example](https://github.com/Moesif/moesif-rack-example) is an
@@ -195,7 +248,7 @@ for reference.
 
 ## Other integrations
 
-To view more more documentation on integration options, please visit __[the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).
+To view more more documentation on integration options, please visit [the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).
 
 [ico-built-for]: https://img.shields.io/badge/built%20for-rack-blue.svg
 [ico-version]: https://img.shields.io/gem/v/moesif_rack.svg

data/lib/moesif_rack/client_ip.rb

@@ -0,0 +1,121 @@
+
+def is_ip?(value)
+    if 
+        ipv4 = /^(?:(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])\.){3}(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])$/
+        ipv6 = /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/
+        # We use !! to convert the return value to a boolean
+        !!(value =~ ipv4 or value=~ ipv6)
+    end
+end
+
+def get_client_ip_from_x_forwarded_for(value)
+    begin
+        value = value.encode('utf-8')
+
+        if value.to_s.empty?
+            return nil
+        end
+
+        if !value.instance_of?(String)
+            puts ("Expected a string, got - " + value.class.to_s)
+        else
+            # x-forwarded-for may return multiple IP addresses in the format:
+            # "client IP, proxy 1 IP, proxy 2 IP"
+            # Therefore, the right-most IP address is the IP address of the most recent proxy
+            # and the left-most IP address is the IP address of the originating client.
+            # source: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/x-forwarded-headers.html
+            # Azure Web App's also adds a port for some reason, so we'll only use the first part (the IP)
+            forwardedIps = []
+
+            value.gsub(/\s+/, "").split(',').each do |e|
+               if e.include?(':') 
+                    splitted = e.split(':')
+                    if splitted.length == 2 
+                        forwardedIps << splitted.first
+                    end
+               end
+               forwardedIps << e
+            end
+
+            # Sometimes IP addresses in this header can be 'unknown' (http://stackoverflow.com/a/11285650).
+            # Therefore taking the left-most IP address that is not unknown
+            # A Squid configuration directive can also set the value to "unknown" (http://www.squid-cache.org/Doc/config/forwarded_for/)
+            return forwardedIps.find {|e| is_ip?(e) }
+        end
+    rescue
+        return value.encode('utf-8')
+    end
+end
+
+def get_client_address(env)
+    begin
+        # Standard headers used by Amazon EC2, Heroku, and others.
+        if env.key?('HTTP_X_CLIENT_IP')
+            if is_ip?(env['HTTP_X_CLIENT_IP'])
+                return env['HTTP_X_CLIENT_IP']
+            end
+        end
+
+        # Load-balancers (AWS ELB) or proxies.
+        if env.key?('HTTP_X_FORWARDED_FOR')
+            xForwardedFor = get_client_ip_from_x_forwarded_for(env['HTTP_X_FORWARDED_FOR'])
+            if is_ip?(xForwardedFor)
+                return xForwardedFor
+            end
+        end
+
+        # Cloudflare.
+        # @see https://support.cloudflare.com/hc/en-us/articles/200170986-How-does-Cloudflare-handle-HTTP-Request-headers-
+        # CF-Connecting-IP - applied to every request to the origin.
+        if env.key?('HTTP_CF_CONNECTING_IP')
+            if is_ip?(env['HTTP_CF_CONNECTING_IP'])
+                return env['HTTP_CF_CONNECTING_IP']
+            end
+        end
+
+        # Akamai and Cloudflare: True-Client-IP.
+        if env.key?('HTTP_TRUE_CLIENT_IP')
+            if is_ip?(env['HTTP_TRUE_CLIENT_IP'])
+                return env['HTTP_TRUE_CLIENT_IP']
+            end
+        end
+
+        # Default nginx proxy/fcgi; alternative to x-forwarded-for, used by some proxies.
+        if env.key?('HTTP_X_REAL_IP')
+            if is_ip?(env['HTTP_X_REAL_IP'])
+                return env['HTTP_X_REAL_IP']
+            end
+        end
+
+        # (Rackspace LB and Riverbed's Stingray)
+        # http://www.rackspace.com/knowledge_center/article/controlling-access-to-linux-cloud-sites-based-on-the-client-ip-address
+        # https://splash.riverbed.com/docs/DOC-1926
+        if env.key?('HTTP_X_CLUSTER_CLIENT_IP')
+            if is_ip?(env['HTTP_X_CLUSTER_CLIENT_IP'])
+                return env['HTTP_X_CLUSTER_CLIENT_IP']
+            end
+        end
+
+        if env.key?('HTTP_X_FORWARDED')
+            if is_ip?(env['HTTP_X_FORWARDED'])
+                return env['HTTP_X_FORWARDED']
+            end
+        end
+
+        if env.key?('HTTP_FORWARDED_FOR')
+            if is_ip?(env['HTTP_FORWARDED_FOR'])
+                return env['HTTP_FORWARDED_FOR']
+            end
+        end
+
+        if env.key?('HTTP_FORWARDED')
+            if is_ip?(env['HTTP_FORWARDED'])
+                return env['HTTP_FORWARDED']
+            end
+        end
+
+        return env['REMOTE_ADDR']
+    rescue 
+        return env['REMOTE_ADDR']
+    end
+end

data/lib/moesif_rack/moesif_middleware.rb

@@ -2,6 +2,7 @@ require 'moesif_api'
 require 'json'
 require 'time'
 require 'base64'
+require_relative './client_ip.rb'
 
 module MoesifRack
 
@@ -58,6 +59,61 @@ module MoesifRack
       return sample_rate
     end
 
+    def update_user(user_profile)
+      if user_profile.any?
+        if user_profile.key?("user_id")
+          begin
+            @api_controller.update_user(MoesifApi::UserModel.from_hash(user_profile))
+            if @debug
+              puts "Update User Successfully"
+            end
+          rescue MoesifApi::APIException => e
+            if e.response_code.between?(401, 403)
+              puts "Unathorized accesss updating user to Moesif. Please verify your Application Id."
+            end
+            if @debug
+              puts "Error updating user to Moesif, with status code: "
+              puts e.response_code
+            end
+          end
+        else 
+          puts "To update an user, an user_id field is required"
+        end
+      else 
+        puts "Expecting the input to be of the type - dictionary while updating user"
+      end
+    end
+
+    def update_users_batch(user_profiles)
+      userModels = []
+      user_profiles.each { |user| 
+      if user.key?("user_id")
+        userModels << MoesifApi::UserModel.from_hash(user)
+      else 
+        puts "To update an user, an user_id field is required"
+      end
+      }
+
+      if userModels.any?
+        begin
+          @api_controller.update_users_batch(userModels)
+          if @debug
+            puts "Update Users Successfully"
+          end
+        rescue MoesifApi::APIException => e
+          if e.response_code.between?(401, 403)
+            puts "Unathorized accesss updating user to Moesif. Please verify your Application Id."
+          end
+          if @debug
+            puts "Error updating user to Moesif, with status code: "
+            puts e.response_code
+          end
+        end
+      else
+        puts "Expecting the input to be of the type - Array of hashes while updating users in batch"
+      end
+    end
+
     def call env
       start_time = Time.now.utc.iso8601
 
@@ -142,7 +198,7 @@ module MoesifRack
           headers["X-Moesif-Transaction-Id"] = transaction_id
         end
 
-        event_req.ip_address = req.ip
+        event_req.ip_address = get_client_address(req.env)
         event_req.headers = req_headers
         event_req.body = req_body
         event_req.transfer_encoding = req_body_transfer_encoding
@@ -205,7 +261,7 @@ module MoesifRack
             end
           else
             if @debug
-              puts("Skipped Event due to sampling percentage: " + @sampling_percentage.to_s + " and random percentage: " + @random_percentage.to_s);
+              puts("Skipped Event due to sampling percentage: " + @sampling_percentage.to_s + " and random percentage: " + @random_percentage.to_s)
             end
           end
         rescue MoesifApi::APIException => e

data/test/moesif_rack_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'rack'
+require_relative '../lib/moesif_rack'
+
+class MoesifRackTest < Test::Unit::TestCase
+  def setup
+    @app = ->(env) { [200, { "Content-Type" => "application/json" }, ["{ \"key\": \"value\"}"]]}
+    @options = { 'application_id' => 'Your Application Id',
+    'debug' => true,
+    'disable_transaction_id' => true}
+    @moesif_rack_app = MoesifRack::MoesifMiddleware.new(@app, @options)
+  end
+
+  def test_new_calls_to_middleware
+    assert_instance_of MoesifRack::MoesifMiddleware, @moesif_rack_app
+  end
+
+  def test_update_user
+    metadata = JSON.parse('{'\
+      '"email": "testrubyapi@user.com",'\
+      '"name": "ruby api user",'\
+      '"custom": "testdata"'\
+    '}')
+
+    user_model = { "user_id" => "testrubyapiuser", 
+                   "modified_time" => Time.now.utc.iso8601, 
+                   "metadata" => metadata }
+
+    response = @moesif_rack_app.update_user(user_model)
+    assert_equal response, nil
+  end
+
+def test_update_users_batch
+    metadata = JSON.parse('{'\
+      '"email": "testrubyapi@user.com",'\
+      '"name": "ruby api user",'\
+      '"custom": "testdata"'\
+    '}')
+
+    user_models = []
+
+    user_model_A = { "user_id" => "testrubyapiuser", 
+                   "modified_time" => Time.now.utc.iso8601, 
+                   "metadata" => metadata }
+    
+    user_model_B = { "user_id" => "testrubyapiuser1", 
+                    "modified_time" => Time.now.utc.iso8601, 
+                    "metadata" => metadata }
+
+    user_models << user_model_A << user_model_B
+    response = @moesif_rack_app.update_users_batch(user_models)
+    assert_equal response, nil
+  end
+
+  def test_log_event
+    response = @moesif_rack_app.call(Rack::MockRequest.env_for("https://acmeinc.com/items/42752/reviews"))
+    assert_equal response, @app.call(nil)
+  end
+
+  def test_get_config
+    assert_operator 100, :>=, @moesif_rack_app.get_config(nil)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-02 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -48,7 +48,9 @@ files:
 - LICENSE
 - README.md
 - lib/moesif_rack.rb
+- lib/moesif_rack/client_ip.rb
 - lib/moesif_rack/moesif_middleware.rb
+- test/moesif_rack_test.rb
 homepage: https://moesif.com
 licenses:
 - Apache-2.0