moesif_api 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcbab0bc81c8ad69b16f525ca72045f26bdba195
-  data.tar.gz: a179486d119680e111d1854fb9156efe73e10a07
+  metadata.gz: 01462788613306a3a2bf85fb84b463c2eabfb1b0
+  data.tar.gz: f0a23fe4992e07c93660f348e48ecdb2ab384a8c
 SHA512:
-  metadata.gz: 24e67161dfec3f3a4348a68442b0586182be0a7dfe0e3197d0d5e7a71841ff6e8c2952059270852fdc059660085f4ecde2f1fe10efece28073a09cee4882d57d
-  data.tar.gz: ecd2171364c8b401dbf0731626b14c6e4cb884af650c843d9a0d5b0070c64ddd445748aff03e5b661b93fea6a1912bd22864606f0764c12e60c2e874067a3efe
+  metadata.gz: 0c2903c1628eeebf0474974ffa716396e4e49aca80135c73f3444e2c46c38c9081ed8f1e67937d2728d7db4a5393143448d3d28f9a065649695dd4836cfd6958
+  data.tar.gz: 3d6f143b151f5bceafcdf80c5cefddd1643bd09ee5b4b349a278fdeacce768e8a53aa8052109587ee181328a007837943eb101242d8f6744a904f316146bb8a3

data/LICENSE

@@ -1,24 +1,216 @@
-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.
+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

@@ -1,117 +1,124 @@
-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
-```
-Install from RubyGems
-=====================
-gem install moesif_api
-
-How to build and install manually:
-==================================
-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(my_application_id)
-api_controller = api_client.api_controller
-
-req_headers = JSON.parse('{'\
-  '"Host": "api.acmeinc.com",'\
-  '"Accept": "*/*",'\
-  '"Connection": "Keep-Alive",'\
-  '"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)",'\
-  '"Content-Type": "application/json",'\
-  '"Content-Length": "126",'\
-  '"Accept-Encoding": "gzip"'\
-'}')
-
-req_body = JSON.parse( '{'\
-  '"items": ['\
-    '{'\
-      '"type": 1,'\
-      '"id": "fwfrf"'\
-    '},'\
-    '{'\
-      '"type": 2,'\
-      '"id": "d43d3f"'\
-    '}'\
-  ']'\
-'}')
-
-rsp_headers = JSON.parse('{'\
-  '"Date": "Tue, 23 Aug 2016 23:46:49 GMT",'\
-                '"Vary": "Accept-Encoding",'\
-  '"Pragma": "no-cache",'\
-  '"Expires": "-1",'\
-  '"Content-Type": "application/json; charset=utf-8",'\
-                '"Cache-Control": "no-cache"'\
-'}')
-
-rsp_body = JSON.parse('{'\
-  '"Error": "InvalidArgumentException",'\
-  '"Message": "Missing field field_a"'\
-'}')
-
-
-event_req = EventRequestModel.new()
-event_req.time = "2016-09-09T04:45:42.914"
-event_req.uri = "https://api.acmeinc.com/items/reviews/"
-event_req.verb = "PATCH"
-event_req.api_version = "1.1.0"
-event_req.ip_address = "61.48.220.123"
-event_req.headers = req_headers
-event_req.body = req_body
-
-event_rsp = EventResponseModel.new()
-event_rsp.time = "2016-09-09T04:45:42.914"
-event_rsp.status = 500
-event_rsp.headers = rsp_headers
-event_rsp.body = rsp_body
-
-event_model = EventModel.new()
-event_model.request = event_req
-event_model.response = event_rsp
-event_model.user_id ="my_user_id"
-event_model.session_token = "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f"
-
-# Perform the API call through the SDK function
-response = api_controller.create_event(event_model)
-```
+MoesifApi Lib for Ruby
+======================
+
+[Source Code on GitHub](https://github.com/moesif/moesifapi-ruby)
+
+__Check out Moesif's
+[Ruby developer documentation](https://www.moesif.com/developer-documentation) to learn more__
+
+(Documentation access requires an active account)
+
+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
+```
+Install from RubyGems
+=====================
+gem install moesif_api
+
+How to build and install manually:
+==================================
+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(my_application_id)
+api_controller = api_client.api_controller
+
+req_headers = JSON.parse('{'\
+  '"Host": "api.acmeinc.com",'\
+  '"Accept": "*/*",'\
+  '"Connection": "Keep-Alive",'\
+  '"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)",'\
+  '"Content-Type": "application/json",'\
+  '"Content-Length": "126",'\
+  '"Accept-Encoding": "gzip"'\
+'}')
+
+req_body = JSON.parse( '{'\
+  '"items": ['\
+    '{'\
+      '"type": 1,'\
+      '"id": "fwfrf"'\
+    '},'\
+    '{'\
+      '"type": 2,'\
+      '"id": "d43d3f"'\
+    '}'\
+  ']'\
+'}')
+
+rsp_headers = JSON.parse('{'\
+  '"Date": "Tue, 23 Aug 2016 23:46:49 GMT",'\
+                '"Vary": "Accept-Encoding",'\
+  '"Pragma": "no-cache",'\
+  '"Expires": "-1",'\
+  '"Content-Type": "application/json; charset=utf-8",'\
+                '"Cache-Control": "no-cache"'\
+'}')
+
+rsp_body = JSON.parse('{'\
+  '"Error": "InvalidArgumentException",'\
+  '"Message": "Missing field field_a"'\
+'}')
+
+
+event_req = EventRequestModel.new()
+event_req.time = "2016-09-09T04:45:42.914"
+event_req.uri = "https://api.acmeinc.com/items/reviews/"
+event_req.verb = "PATCH"
+event_req.api_version = "1.1.0"
+event_req.ip_address = "61.48.220.123"
+event_req.headers = req_headers
+event_req.body = req_body
+
+event_rsp = EventResponseModel.new()
+event_rsp.time = "2016-09-09T04:45:42.914"
+event_rsp.status = 500
+event_rsp.headers = rsp_headers
+event_rsp.body = rsp_body
+
+event_model = EventModel.new()
+event_model.request = event_req
+event_model.response = event_rsp
+event_model.user_id ="my_user_id"
+event_model.session_token = "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f"
+
+# Perform the API call through the SDK function
+response = api_controller.create_event(event_model)
+```