moesif_rack 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec9a7d8a1458019f25ec5638b642921be4c8be50
+  data.tar.gz: cbe40d5f9f92844428f20fc8b974b53856d364a0
+SHA512:
+  metadata.gz: 5dd232e683be3c8e32898719a2f40725e0f66ced2b0453acec6fabcaeb72e3853959c00325f553847a5e7695d640a391a7b3f18920f41cd7269e3cd8dada1ada
+  data.tar.gz: eb6a52983cec544bbca557b0fac4ef4b7a7d197861e833b7077c5aac28dd38110581bd2dcc8b5bcbd807e7d241b440302d8c65daaa90eb8ca0eaaedbb4530276

data/LICENSE

@@ -0,0 +1,216 @@
+Copyright (c) 2016 Moesif, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,123 @@
+Moesif Middleware for Ruby on Rails and Rack
+======================
+
+Middleware that logs APIs built on Ruby on Rails and Rack.
+
+[Source Code on GitHub](https://github.com/moesif/moesif-rack)
+
+__Check out Moesif's
+[Ruby developer documentation](https://www.moesif.com/developer-documentation) to learn more__
+
+
+
+Install from RubyGems
+=====================
+
+```bash
+gem install moesif_rack
+```
+How to use:
+===========
+
+Create the options
+
+```ruby
+moesif_options = {
+  'application_id' => 'Your application Id'
+}
+```
+
+Add to Middleware
+
+
+within `config/application.rb`
+
+```ruby
+
+
+  class Application < Rails::Application
+    # snip
+
+    config.middleware.use "MoesifRack::MoesifMiddleware", moesif_options
+
+    # snip
+  end
+
+```
+
+
+How to configure:
+=================
+
+options is a hash with these possible key value pairs.
+
+#### application_id
+
+Required. String. This is the Moesif application_id under settings
+from your [Moesif account.](https://www.moesif.com)
+
+
+#### api_version
+
+Optional. String. Tag requests with the version of your API.
+
+
+#### identify_user
+
+Optional.
+identify_user is a function that takes env, headers, and body as arguments and returns a user_id string. This helps us attribute requests to unique users. Even though Moesif can automatically retrieve the user_id without this, this is highly recommended to ensure accurate attribution.
+
+```ruby
+
+moesif_options['identify_user'] = Proc.new { |env, headers, body|
+
+  #snip
+
+  'the_user_id'
+}
+
+```
+
+@api_version = options['api_version']
+@identify_user = options['identify_user']
+@identify_session = options['identify_session']
+@mask_data = options['mask_data']
+@debug = options['debug']
+
+#### identify_session
+
+Optional. A Proc that takes env, headers, body and returns a string.
+
+```ruby
+
+moesif_options['identify_session'] = Proc.new { |env, headers, body|
+
+  #snip
+
+  'the_session_token'
+}
+
+```
+
+#### mask_data
+
+Optional. A Proc that takes event_model as an argument and returns event_model.
+With mask_data, you can make modifications to headers or body of the event before it is sent to Moesif.
+
+```ruby
+
+moesif_options['mask_data'] = Proc.new { |event_model|
+
+  #snip
+
+  event_model
+}
+
+```
+
+For details for the spec of event model, please see the [moesifapi-ruby git](https://github.com/Moesif/moesifapi-ruby)
+
+
+#### debug
+
+Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.

data/lib/moesif_rack/moesif_middleware.rb

@@ -0,0 +1,131 @@
+require 'moesif_api'
+require 'json'
+require 'time'
+
+module MoesifRack
+
+  class MoesifMiddleware
+    def initialize app, options = {}
+      @app = app
+      if not options['application_id']
+        raise 'application_id requird for Moesif Middleware'
+      end
+      @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'])
+      @api_controller = @api_client.api
+
+      @api_version = options['api_version']
+      @identify_user = options['identify_user']
+      @identify_session = options['identify_session']
+      @mask_data = options['mask_data']
+      @debug = options['debug']
+    end
+
+    def call env
+      start_time = Time.now.utc.iso8601
+
+      if @debug
+        puts 'inside moesif middleware'
+      end
+
+      status, headers, body = @app.call env
+      end_time = Time.now.utc.iso8601
+
+      process_send = lambda do
+        req = Rack::Request.new(env)
+        complex_copy = env.dup
+
+        req_headers = {}
+        complex_copy.select {|k,v| k.start_with? 'HTTP_'}.each do |key, val|
+          req_headers[key.sub(/^HTTP_/, '')] = val
+        end
+
+        req_body_string = req.body.read
+        req.body.rewind
+
+        if req_body_string && req_body_string.length != 0
+          begin
+            req_body = JSON.parse(req_body_string)
+          rescue
+            req_body = {
+              'msg' => 'error parsing body',
+              'body' => req_body_string
+            }
+          end
+        end
+
+        rsp_headers = headers.dup
+
+        content_type = rsp_headers['Content-Type'];
+
+        if body && body.body
+          begin
+            rsp_body = JSON.parse(body.body)
+          rescue
+            if content_type && (content_type.include? "json")
+              rsp_body = {
+                'msg' => 'error parsing json',
+                'body' => body.body
+              }
+            end
+          end
+        end
+
+        event_req = MoesifApi::EventRequestModel.new()
+        event_req.time = start_time
+        event_req.uri = req.url
+        event_req.verb = req.request_method
+
+        if @api_version
+          event_req.api_version = @api_version
+        end
+        event_req.ip_address = req.ip
+        event_req.headers = req_headers
+        event_req.body = req_body
+
+        event_rsp = MoesifApi::EventResponseModel.new()
+        event_rsp.time = end_time
+        event_rsp.status = status
+        event_rsp.headers = rsp_headers
+        event_rsp.body = rsp_body
+
+        event_model = MoesifApi::EventModel.new()
+        event_model.request = event_req
+        event_model.response = event_rsp
+        if @identify_user
+          if @debug
+            puts "calling identify user proc"
+          end
+          event_model.user_id = @identify_user.call(env, headers, body)
+        end
+        if @identify_session
+          if @debug
+            puts "calling identify session proc"
+          end
+          event_model.session_token = @identify_session.call(env, headers, body)
+        end
+        if @mask_data
+          if @debug
+            puts "calling mask_data proc"
+          end
+          event_model = @mask_data.call(event_model)
+        end
+
+        if @debug
+          puts "sending data to moesif"
+          puts event_model.to_json
+        end
+        # Perform the API call through the SDK function
+        @api_controller.create_event(event_model)
+
+      end
+
+      if @debug
+        process_send.call
+      else
+        Thread.start(&process_send)
+      end
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/moesif_rack.rb

@@ -0,0 +1,6 @@
+
+require 'openssl'
+require 'json'
+require 'unirest'
+
+require_relative 'moesif_rack/moesif_middleware.rb'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: moesif_rack
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Moesif, Inc
+- Xing Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: json_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: moesif_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: Collection/Data Ingestion SDK for Rack (also Rails) Middleware / RoR
+email: xing@moesif.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/moesif_rack.rb
+- lib/moesif_rack/moesif_middleware.rb
+homepage: https://moesif.com
+licenses:
+- Apache-2.0
+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.6.7
+signing_key: 
+specification_version: 4
+summary: moesif_rack
+test_files: []