cts-mpx 1.0.1

data/cts-mpx.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cts/mpx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cts-mpx"
+  spec.version       = Cts::Mpx::VERSION
+  spec.authors       = ["Ernie Brodeur"]
+  spec.email         = ["ernest.brodeur@cable.comcast.net"]
+
+  spec.summary       = "Ruby bindings for MPX services."
+  spec.description   = "."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_runtime_dependency "creatable", "1.0.1"
+  spec.add_runtime_dependency "excon"
+  spec.add_runtime_dependency "oj", "3.5.0"
+
+  spec.add_development_dependency 'bump'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "erubis"
+  spec.add_development_dependency "gli"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "guard-yard"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop", "~>0.52.1"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+  spec.add_development_dependency "yard"
+end

data/examples/basic_query.rb

@@ -0,0 +1,23 @@
+require 'cts/mpx'
+
+user = Cts::Mpx::User.create(username: 'username', password: '*****').sign_in
+account = "http://access.auth.theplatform.com/data/Account/0000000000"
+service = 'Media Data Service'
+endpoint = 'Media'
+
+# build our query, and immediately run it.
+q = Query.create(account: account, service: service, endpoint: endpoint, fields: 'id,guid,title').run user: user
+
+### Print out a single entry
+puts q.entries.first.to_h
+
+### Print out just the intries
+puts q.entries.to_h
+
+### Print out the query (including entries)
+puts q.entries.to_h
+
+### Print out the query (without entries)
+puts q.entries.to_h include_entries: false
+
+user.sign_out

data/examples/login.rb

@@ -0,0 +1,7 @@
+require 'cts/mpx'
+
+### You can split the sign_in into it's own line.
+user = Cts::Mpx::User.create(username: 'username', password: '*****').sign_in
+
+### begone token!
+user.sign_out

data/examples/update_media.rb

@@ -0,0 +1,16 @@
+require 'cts/mpx'
+
+user = Cts::Mpx::User.create(username: 'username', password: '*****').sign_in
+account = "http://access.auth.theplatform.com/data/Account/0000000000"
+service = 'Media Data Service'
+endpoint = 'Media'
+
+# build our query, and immediately run it.
+q = Query.create(account: account, service: service, endpoint: endpoint, fields: 'id,guid,title').run user: user
+
+q.entries.each do |entry|
+  entry.title += '!!!'
+  entry.save
+end
+
+user.sign_out

data/examples/update_procedurally.rb

@@ -0,0 +1,20 @@
+require 'cts/mpx'
+
+user = Cts::Mpx::User.create(username: 'username', password: '*****').sign_in
+account = "http://access.auth.theplatform.com/data/Account/0000000000"
+service = 'Media Data Service'
+endpoint = 'Media'
+
+response = Cts::Mpx::Services::Data.get user: user, service: service, endpoint: endpoint, account: account, fields: 'id,guid,title,description'
+media = response.page
+
+# modify them all
+media.entries.each { |e| e["description"] = '1' }
+
+# put them back
+response = Cts::Mpx::Services::Data.put user: user, service: 'Media Data Service', endpoint: endpoint, account: account, page: media
+
+# show response
+puts response.status
+
+user.sign_out

data/lib/cts/mpx.rb

@@ -0,0 +1,42 @@
+require 'base64'
+require 'creatable'
+require 'excon'
+require 'oj'
+require 'uri'
+require 'cts/mpx/version'
+
+# ring 1 (driver)
+require 'cts/mpx/driver'
+require 'cts/mpx/driver/assemblers'
+require 'cts/mpx/driver/connections'
+require 'cts/mpx/driver/exceptions'
+require 'cts/mpx/driver/helpers'
+require 'cts/mpx/driver/page'
+require 'cts/mpx/driver/response'
+require 'cts/mpx/driver/request'
+
+# ring 2 (depends on driver)
+require 'cts/mpx/validators'
+require 'cts/mpx/user'
+require 'cts/mpx/registry'
+require 'cts/mpx/service'
+require 'cts/mpx/services'
+require 'cts/mpx/services/data'
+require 'cts/mpx/services/web'
+require 'cts/mpx/services/ingest'
+
+# ring 3 (depends on ring 2 services)
+require 'cts/mpx/field'
+require 'cts/mpx/fields'
+require 'cts/mpx/entry'
+require 'cts/mpx/entries'
+require 'cts/mpx/query'
+
+# Comcast Technical Solutions
+module Cts
+  # Media Platform
+  module Mpx
+    Services.initialize
+    Registry.initialize
+  end
+end

data/lib/cts/mpx/driver.rb

@@ -0,0 +1,47 @@
+module Cts
+  module Mpx
+    # responsible for low level calls to MPX
+    module Driver
+      module_function
+
+      #
+      # path to our gem directory, includes support for bundled env's.
+      #
+      # @return [String] full path to the root of our gem directory.
+      #
+      def gem_dir
+        return Dir.pwd unless Gem.loaded_specs.include? 'cts-mpx'
+        Gem.loaded_specs['cts-mpx'].full_gem_path
+      end
+
+      #
+      # path to our config files
+      #
+      # @return [String] full path to the root of our gem directory.
+      #
+      def config_dir
+        "#{gem_dir}/config"
+      end
+
+      #
+      # load a json file into a simple hash
+      #
+      # @param [String] filename filename to load
+      #
+      # @raise [RuntimeError] if the filename does not exist.
+      # @raise [RuntimeError] if the file cannot be parsed, supplies the exception.
+      #
+      # @return [Hash] data from the file
+      #
+      def load_json_file(filename)
+        raise "#{filename} does not exist" unless File.exist? filename
+
+        begin
+          Oj.load File.read filename
+        rescue Oj::ParseError => exception
+          raise "#{filename}: #{exception.message}"
+        end
+      end
+    end
+  end
+end

data/lib/cts/mpx/driver/assemblers.rb

@@ -0,0 +1,96 @@
+module Cts
+  module Mpx
+    module Driver
+      #
+      # collection of methods used to assemble various parts of a request.
+      #
+      module Assemblers
+        module_function
+
+        # assembles user service and account_id into a host string
+        # @param [Cts::Mpx::User] user user to make calls with
+        # @param [String] service title of a service
+        # @param [String] account_id long form account_id id (ownerId)
+        # @raise [ArgumentError] if user or service is not supplied
+        # @raise [RuntimeError] if the user token is not set
+        # @return [String] assembled scheme and host
+        def host(user: nil, service: nil, account_id: 'urn:theplatform:auth:root')
+          Helpers.required_arguments %i[user service], binding
+          user.token!
+
+          service = Services[service]
+          u = URI.parse service.url
+
+          [u.scheme, u.host].join('://')
+        end
+
+        # Assembles service, endpoint, extra_path, ids, and account_id into a host path
+        # @param [String] service title of a service
+        # @param [String] endpoint endpoint to make the call against
+        # @param [String] extra_path additional part to add to the path
+        # @param [String] ids comma delimited list of short id's to add to the path.
+        # @param [String] account_id long form account_id id (ownerId)
+        # @raise [ArgumentError] if service or endpoint is not supplied
+        # @return [String] assembled path for a data call
+        def path(service: nil, endpoint: nil, extra_path: nil, ids: nil, account_id: 'urn:theplatform:auth:root')
+          Helpers.required_arguments %i[service endpoint], binding
+          service = Services[service]
+
+          path = "#{URI.parse(service.url(account_id)).path}/#{service.path}/#{endpoint}"
+          path += "/#{extra_path}" if extra_path
+          path += "/feed" if service.type == 'data'
+          path += "/#{ids}" if ids
+          path
+        end
+
+        # Assembles service, endpoint, query, range, count, entries, sort and account_id into a query
+        # @param [Cts::Mpx::User] user user to make calls with
+        # @param [String] account_id long form account_id id (ownerId)
+        # @param [String] service title of a service
+        # @param [String] endpoint endpoint to make the call against
+        # @param [Hash] query any additional parameters to add
+        # @param [String] range string (service) format of a range.
+        # @param [TrueFalse] count ask for a count of objects from the services.
+        # @param [TrueFalse] entries return an array of entries.
+        # @param [String] sort set the sort field
+        # @raise [ArgumentError] if user, service or endpoint is not supplied
+        # @raise [RuntimeError] if the user token is not set
+        # @return [Hash] assembled query for a data call
+        def query(user: nil, account: nil, service: nil, endpoint: nil, query: {}, range: nil, count: nil, entries: nil, sort: nil)
+          Helpers.required_arguments %i[user service endpoint], binding
+          user.token!
+
+          service = Services[service]
+
+          h = {}
+          if service.type == 'data'
+            h.merge!(token: user.token, schema: service.schema, form: service.form)
+            h.merge!(query_data(range: range, count: count, entries: entries, sort: sort))
+          else
+            h.merge!(token: user.token, schema: service.endpoints[endpoint]['schema'], form: service.form)
+          end
+
+          h[:account] = account if account
+          h.delete :token if user.token == 'sign_in_token'
+          h.merge! query
+          h
+        end
+
+        # Assembles range, count, entries, sort into a query
+        # @param [String] range string (service) format of a range.
+        # @param [TrueFalse] count ask for a count of objects from the services.
+        # @param [TrueFalse] entries return an array of entries.
+        # @param [String] sort set the sort field
+        # @return [Hash] assembled query for a data call
+        def query_data(range: nil, count: nil, entries: nil, sort: nil)
+          h = {}
+          h.store :range, range if range
+          h.store :count, count if count
+          h.store :entries, entries if entries
+          h.store :sort, sort if sort
+          h
+        end
+      end
+    end
+  end
+end

data/lib/cts/mpx/driver/connections.rb

@@ -0,0 +1,41 @@
+module Cts
+  module Mpx
+    module Driver
+      #
+      # Container for active connections to the data service.
+      #
+      module Connections
+        module_function
+
+        #
+        # Addressable method for active connections.   If you provide a string that is not active, an active one
+        # will be created.
+        #
+        # @param [String] uri uri of a service to connect to, must contain theplatform.
+        #
+        # @return [Excon] assembled excon objects with service defaults.
+        # @return [Excon[]] if nil, an array of all open connections.
+        #
+        def [](uri = nil)
+          return @open_connections unless uri
+          begin
+            parsed_uri = URI.parse uri
+          rescue URI::InvalidURIError
+            raise ArgumentError, "#{uri} is not a uri"
+          end
+
+          raise ArgumentError, "#{uri} does not contain theplatform in it." unless parsed_uri.host.include? "theplatform"
+
+          Excon.new([parsed_uri.scheme, parsed_uri.host].join("://"), persistent: true) unless @open_connections.include? parsed_uri.host
+        end
+
+        Excon.defaults[:headers] = {
+          'Content-Type'     => "application/json",
+          "User-Agent"       => "cts-mpx ruby sdk version #{Cts::Mpx::VERSION}",
+          'Content-Encoding' => 'bzip2,xz,gzip,deflate'
+        }
+        @open_connections = []
+      end
+    end
+  end
+end

data/lib/cts/mpx/driver/exceptions.rb

@@ -0,0 +1,50 @@
+module Cts
+  module Mpx
+    module Driver
+      module Exceptions
+        module_function
+
+        # Raise an ArgumentError if the argument does not pass Validators.account_id?
+        # @param [Object] argument argument to test if it is a valid account_id
+        # @raise [ArgumentError] if the argument is not a valid account_id
+        # @return [nil]
+        def raise_unless_account_id(argument)
+          raise ArgumentError, "#{argument} is not a valid account_id" unless Validators.account_id? argument
+          nil
+        end
+
+        # Raise an ArgumentError if the argument is not of the supplied type
+        # @param [Object] data argument to test if it is the correct type
+        # @param [Object] type type to test for
+        # @raise [ArgumentError] if the argument is not of the correct type
+        # @return [nil]
+        def raise_unless_argument_error?(data, type = nil, &block)
+          msg = "#{data} is not a valid #{type}"
+          if block
+            raise ArgumentError, msg unless Validators.argument_error?(data, type, &block)
+          elsif Validators.argument_error?(data, type, &block)
+            raise ArgumentError, msg
+          end
+          nil
+        end
+
+        # Raise an ArgumentError if the argument does not pass Validators.reference?
+        # @param [Object] argument argument to test if it is a valid reference
+        # @raise [ArgumentError] if the argument is not a valid reference
+        # @return [nil]
+        def raise_unless_reference?(argument)
+          raise ArgumentError, "#{argument} is not a valid reference" unless Validators.reference? argument
+          nil
+        end
+
+        # Raise an ArgumentError if the keyword is not supplied.
+        # @param [Object] keyword keyword to assure is supplied
+        # @raise [ArgumentError] if the keyword is not suppplied
+        # @return [nil]
+        def raise_unless_required_keyword?(keyword: nil)
+          raise ArgumentError, "#{keyword} is a required keyword." unless keyword && keyword
+        end
+      end
+    end
+  end
+end

data/lib/cts/mpx/driver/helpers.rb

@@ -0,0 +1,67 @@
+module Cts
+  module Mpx
+    module Driver
+      #
+      # Collection of simple helpers for the development of the SDK
+      #
+      module Helpers
+        module_function
+
+        #
+        # used to raise an exception if the array of objects is not of the specified type.
+        #
+        # @param [Object[]] objects array of objects to itterate through
+        # @param [Class] type class to check the object array against.
+        #
+        # @raise [ArgumentError] if the argument is not of the specified type
+        #
+        # @return [nil] nil
+        #
+        def raise_if_not_a(objects, type)
+          objects.each { |k| Exceptions.raise_unless_argument_error?(k, type) }
+          nil
+        end
+
+        #
+        # Raise an error if any object in the array is not of a type Array
+        #
+        # @param [Object[]] objects array of objects to test if a valid array
+        #
+        # @raise [ArgumentError] if the argument is not an [Array]
+        # @return [nil] nil
+        #
+        def raise_if_not_an_array(objects)
+          raise_if_not_a(objects, Array)
+          nil
+        end
+
+        #
+        # Raise an error if any object in the array is not of a type Hash
+        #
+        # @param [Object[]] objects array of objects to test if a valid hash
+        #
+        # @raise [ArgumentError] if the argument is not a [Hash]
+        # @return [nil] nil
+        #
+        def raise_if_not_a_hash(objects)
+          raise_if_not_a(objects, Hash)
+          nil
+        end
+
+        #
+        # Raise an error if any keywords are not included inside of a specified binding.
+        #
+        # @param [Object] keywords list of keywords to check.
+        # @param [Binding] a_binding binding to check for local variables
+        #
+        # @raise [ArgumentError] if the argument is not of the specified type.
+        # @return [nil] nil
+        #
+        def required_arguments(keywords, a_binding)
+          keywords.each { |arg| Exceptions.raise_unless_required_keyword?(keyword: a_binding.local_variable_get(arg)) }
+          nil
+        end
+      end
+    end
+  end
+end