cts-mpx 1.0.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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/NOTICE

@@ -0,0 +1,9 @@
+mpxRubySdk Copyright 2018 Comcast Cable Communications Management,
+LLC 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.
+This product includes software developed at Comcast ( http://www.comcast.com/).

data/README.md

@@ -0,0 +1,60 @@
+# Cts::Mpx
+
+Ruby SDK for communicating with the REST services of MPX.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cts-mpx'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install cts-mpx
+
+## Usage
+
+See EXAMPLES.md
+
+
+## High level architecure
+
+### Uml diagram
+
+![sdk uml](sdk-uml.png)
+
+### SDK ring diagram
+
+![sdk ring diagram](sdk-ring-diagram.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1) fork
+2) code
+3) make specs
+4) make sure your specs pass
+5) make a pull request
+
+## Copyright
+
+Copyright 2018 Comcast Cable Communications Management, LLC
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cts/mpx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/data_services.json

@@ -0,0 +1,423 @@
+{
+    "Access Data Service": {
+        "uri_hint": "access.auth",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "Account",
+            "Account/Field",
+            "AccountSettings",
+            "AccountSettings/Field",
+            "Permission",
+            "Registry",
+            "Role",
+            "SuperUser"
+        ]
+    },
+    "Admin Storefront Service": {
+        "uri_hint": "admin.storefront.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "3.1.0",
+        "endpoints": [
+            "Action",
+            "Contract",
+            "FulfillmentItem",
+            "LedgerEntry",
+            "Order",
+            "orderFulfillment",
+            "OrderHistory",
+            "OrderItem",
+            "OrderSummary",
+            "PaymentInstrumentInfo",
+            "Shipment"
+        ]
+    },
+    "Commerce Configuration Data Service": {
+        "uri_hint": "configuration.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "2.4.0",
+        "endpoints": [
+            "CheckoutConfiguration",
+            "CheckoutConfiguration/Field",
+            "CommerceRegistry",
+            "FulfillmentConfiguration",
+            "FulfillmentConfiguration/Field",
+            "PaymentConfiguration",
+            "PaymentConfiguration/Field",
+            "Rule",
+            "RuleSet",
+            "TaxConfiguration",
+            "TaxConfiguration/Field"
+        ]
+    },
+    "Commerce Event Data Service": {
+        "uri_hint": "event.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.8.0",
+        "endpoints": [
+            "OrderTracking"
+        ]
+    },
+    "Console Data Service": {
+        "uri_hint": "mpx",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.4.0",
+        "endpoints": [
+            "AccountSettings",
+            "AccountSettings/Field",
+            "Command",
+            "Command/Field",
+            "MenuItem",
+            "MenuItem/Field",
+            "Pane",
+            "Pane/Field",
+            "PaneState",
+            "PaneState/Field",
+            "Panel",
+            "Panel/Field",
+            "Shortcut",
+            "Shortcut/Field",
+            "UserAccountSettings",
+            "UserAccountSettings/Field",
+            "View",
+            "View/Field",
+            "ViewLink",
+            "ViewLink/Field"
+        ]
+    },
+    "Cue Point Data Service": {
+        "uri_hint": "event.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "CuePoint",
+            "CuePointType"
+        ]
+    },
+    "Delivery Data Service": {
+        "uri_hint": "delivery",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.8.0",
+        "endpoints": [
+            "AccountSettings",
+            "AccountSettings/Field",
+            "AdPolicy",
+            "AdPolicy/Field",
+            "Restriction",
+            "Restriction/Field",
+            "UserAgent"
+        ]
+    },
+    "Entertainment Data Service": {
+        "uri_hint": "entertainment.tv",
+        "path": "data",
+        "form": "cjson",
+        "schema": "2.10.0",
+        "endpoints": [
+            "AccountSettings",
+            "AccountSettings/Field",
+            "Channel",
+            "Channel/Field",
+            "ChannelSchedule",
+            "ChannelSchedule/Field",
+            "Company",
+            "Company/Field",
+            "Credit",
+            "Credit/Field",
+            "Listing",
+            "Listing/Field",
+            "Location",
+            "Location/Field",
+            "Person",
+            "Person/Field",
+            "Program",
+            "Program/Field",
+            "ProgramAvailability",
+            "ProgramAvailability/Field",
+            "Station",
+            "Station/Field",
+            "Tag",
+            "Tag/Field",
+            "TvSeason",
+            "TvSeason/Field"
+        ]
+    },
+    "Entertainment Ingest Data Service": {
+        "uri_hint": "ingest.tv",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "IngestConfig",
+            "IngestConfig/Field",
+            "IngestResult"
+        ]
+    },
+    "Entitlement Data Service": {
+        "uri_hint": "entitlement",
+        "path": "data",
+        "form": "cjson",
+        "schema": "",
+        "endpoints": []
+    },
+    "FeedReader Data Service": {
+        "uri_hint": "feedreader.ingest",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "FeedRecord",
+            "FeedRecord/Field"
+        ]
+    },
+    "Feeds Data Service": {
+        "uri_hint": "feed",
+        "path": "data",
+        "form": "cjson",
+        "schema": "2.2.0",
+        "endpoints": [
+            "FeedAdapter",
+            "FeedAdapter/Field",
+            "FeedConfig",
+            "FeedConfig/Field"
+        ]
+    },
+    "Ingest Data Service": {
+        "uri_hint": "adapter.ingest",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.2.0",
+        "endpoints": [
+            "Adapter",
+            "Adapter/Field",
+            "AdapterConfiguration",
+            "AdapterConfiguration/Field",
+            "Checksum"
+        ]
+    },
+    "Key Data Service": {
+        "uri_hint": "key.entitlement",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.2.0",
+        "endpoints": [
+            "Key",
+            "Key/Field",
+            "UserKey"
+        ]
+    },
+    "Ledger Data Service": {
+        "uri_hint": "ledger.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "LedgerEntry"
+        ]
+    },
+    "Live Event Service": {
+        "uri_hint": "liveevent",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.4.0",
+        "endpoints": [
+            "LiveEncoder",
+            "LiveEncoder/Field",
+            "LiveEvent",
+            "PhysicalRecording",
+            "PhysicalRecording/Field"
+        ]
+    },
+    "Message Data Service": {
+        "uri_hint": "message",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "EmailTemplate",
+            "EmailTemplate/Field",
+            "MessageInstruction",
+            "MessageQueue",
+            "NotificationFilter"
+        ]
+    },
+    "Comcast Messenger Data Service": {
+        "path": "data",
+        "uri_hint": "messenger.comcast",
+        "form": "cjson",
+        "schema": "1.6.0",
+        "endpoints": [
+            "Message",
+            "NotificationSetting"
+        ]
+    },
+    "Player Data Service": {
+        "uri_hint": "player",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.4.0",
+        "endpoints": [
+            "AccountSettings",
+            "ColorScheme",
+            "Layout",
+            "Player",
+            "Player/Field",
+            "PlayerDefaults",
+            "Plugin",
+            "Skin"
+        ]
+    },
+    "Product Data Service": {
+        "uri_hint": "product",
+        "path": "data",
+        "form": "cjson",
+        "schema": "2.5.0",
+        "endpoints": [
+            "AccountSettings",
+            "AccountSettings/Field",
+            "PricingTemplate",
+            "PricingTemplate/Field",
+            "Product",
+            "Product/Field",
+            "ProductTag",
+            "ProductTag/Field",
+            "Subscription",
+            "Subscription/Field"
+        ]
+    },
+    "Promotion Service": {
+        "uri_hint": "promotion.commerce",
+        "path": "data",
+        "form": "cjson",
+        "schema": "3.1.0",
+        "endpoints": [
+            "Promotion",
+            "Promotion/Field",
+            "PromotionAction",
+            "PromotionAction/Field",
+            "PromotionCondition",
+            "PromotionUseCount"
+        ]
+    },
+    "Publish Data Service": {
+        "uri_hint": "publish",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.8.0",
+        "endpoints": [
+            "Adapter",
+            "AdapterConfiguration",
+            "PublishProfile",
+            "PublishProfile/Field"
+        ]
+    },
+    "Sharing Data Service": {
+        "uri_hint": "share",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.7.0",
+        "endpoints": [
+            "OutletProfile",
+            "OutletProfile/Field",
+            "ProviderAdapter",
+            "ProviderAdapter/Field"
+        ]
+    },
+    "Media Data Service": {
+        "uri_hint": "media",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.7.0",
+        "search_schema": "1.0",
+        "read_only": true,
+        "endpoints": [
+            "AccountSettings",
+            "AccountSettings/Field",
+            "AssetType",
+            "AssetType/Field",
+            "Category",
+            "Category/Field",
+            "Media",
+            "Media/Field",
+            "MediaDefaults",
+            "MediaFile",
+            "MediaFile/Field",
+            "Provider",
+            "Provider/Field",
+            "Release",
+            "Release/Field",
+            "Server",
+            "Server/Field"
+        ]
+    },
+    "Task Service": {
+        "uri_hint": "task",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "Agent",
+            "Batch",
+            "Task",
+            "TaskTemplate",
+            "TaskTemplate/Field",
+            "TaskType"
+        ]
+    },
+    "WatchFolder Data Service": {
+        "uri_hint": "watchfolder.ingest",
+        "path": "data",
+        "form": "json",
+        "schema": "1.2.0",
+        "endpoints": [
+            "WatchFolder",
+            "WatchFolder/Field",
+            "WatchFolderFile",
+            "WatchFolderFile/Field"
+        ]
+    },
+    "Workflow Data Service": {
+        "uri_hint": "workflow",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "ProfileResult",
+            "ProfileStepResult",
+            "WorkflowQueue"
+        ]
+    },
+    "Validation Data Service": {
+        "uri_hint": "validation",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.3.0",
+        "endpoints": [
+            "ConditionalRule",
+            "ConditionalRule/Field",
+            "ValidationRule",
+            "ValidationRule/Field",
+            "Validator",
+            "Validator/Field"
+        ]
+    },
+    "User Data Service master": {
+        "uri_hint": "identity.auth",
+        "path": "data",
+        "form": "cjson",
+        "schema": "1.5.0",
+        "endpoints": [
+            "Directory",
+            "Directory/Field",
+            "Security",
+            "User"
+        ]
+    }
+}