portals_api 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 978e30dd5d37062734eefc4901c69be201a9e20d
+  data.tar.gz: 96bdc6b9fe354ac38fe55f1318d521e42b9ad4c4
+SHA512:
+  metadata.gz: 3f00e0244805b0e44791a4cf17f3037c17a6fcffcabdc82ba30a673bd505d9745710aaf6e35eb84d2d956fa1ac5ee0a6f43ee88c57a52b1772e7a326ef204f50
+  data.tar.gz: d8fe5aaac1aa0d12cfe25b56caece0cdfa98cab1cbec35e0bf8ad6e3ffa11887c24b770c4804abc57ad660d1604d5f790e56ac93e4ae1975a6e9a5a060121645

data/Gemfile

@@ -0,0 +1 @@
+gem 'trollop'

data/README.md

@@ -0,0 +1,37 @@
+# Portals Run and Portals API
+# Portals API.rb
+`portals_api.rb`
+
+portals_api.rb Ruby file is provides the interface to the portals API.  It contains the following Class info:
+class PortalsAPI
+@access_token - the instance attribute the access_token provided to the constructor
+#initialize - constructor that sets access_token
+#retrieve_portal_status - provides the portal status
+#start_stop_portal - toggles the portal from started or stopped to the opposite
+#retrieve_checkedout_patchset - gets the name of the checked out patchset, else false
+#checkout_patchset - sends the command to checkout a specific patchset
+#cancel_portal_request - cancels whatever request has been send, if any
+private
+#get_request - uses HTTP GET request to make the calls to the API
+
+## Portals Run Command
+`portals_run`
+
+portals_run is a Ruby tool that provides a command line interface to the portals API (via portals_api.rb).  Here is the usages for portals_run:
+portal_api.rb is an awesome program starts and stops portals
+Usage:
+portal_api.rb [options] <filenames>+
+where [options] are:
+
+-a, --accesstoken=<s> Portals Access Token
+-p, --portalstat Retrieve portal status
+-s, --startportal Start Portal
+-t, --stopportal Stop portal
+--psstat Retrieve patchset status
+-c, --checkoutps=<s> Checkout Patchset xx.xxxxx.x format (default: master)
+-u, --user=<s> Portal User (default: rkuss2)
+-h, --phost=<s> Portal Host (default: https://portal2-beta.instructure.com/)
+-d, --dbcreate Drop and recreate db
+-n, --cancelportal Cancel Portal Request
+-v, --version Print version and exit
+-e, --help Show this message

data/bin/portals_run

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+require 'net/https'
+require 'uri'
+require 'trollop'
+require 'portals_api'
+
+opts = Trollop.options do
+  version '1.0'
+  banner <<-EOS
+      portal_api.rb is an awesome program starts and stops portals
+
+      Usage:
+               portal_api.rb [options] <filenames>+
+               where [options] are:
+EOS
+
+  opt :accesstoken, 'Portals Access Token', type: :string
+  opt :portalstat, 'Retrieve portal status'
+  opt :startportal, 'Start Portal'
+  opt :stopportal, 'Stop portal'
+  opt :psstat, 'Retrieve patchset status'
+  opt :checkoutps, 'Checkout Patchset xx.xxxxx.x format', default: 'master'
+  opt :user, 'Portal User', default: 'rkuss2'
+  opt :phost, 'Portal Host', default: 'https://portal2-beta.instructure.com/'
+  opt :dbcreate, 'Drop and recreate db'
+  opt :cancelportal, 'Cancel Portal Request'
+end
+
+Trollop.die :accesstoken, 'Access Token for portal must be provided' \
+  unless opts[:accesstoken_given]
+Trollop.die :portalstat, 'Cannot check portal status and perform activity at the same time' \
+  if opts[:portalstat] && (opts[:startportal_given] || opts[:stopportal_given] || opts[:checkoutps_given])
+Trollop.die :psstat, 'Cannot check patchset status and perform activity at the same time' \
+  if opts[:psstat] && (opts[:startportal_given] || opts[:stopportal_given] || opts[:checkoutps_given])
+Trollop.die :startportal, 'cannot start portal and checkout ps at same time' \
+  if opts[:startportal_given] && opts[:stopportal_given]
+Trollop.die :startportal, 'cannot start portal and checkout ps at same time' \
+  if opts[:startportal_given] && opts[:checkoutps_given]
+Trollop.die :stopportal, 'cannot start portal and checkout ps at same time' \
+  if opts[:stopportal_given] && opts[:checkoutps_given]
+
+portal_api = PortalsAPI.new(opts[:accesstoken])
+
+if opts[:portalstat]
+  puts portal_api.retrieve_portal_status(opts[:phost], opts[:user])
+end
+
+if opts[:startportal] && portal_api.retrieve_portal_status(opts[:phost], opts[:user])
+  portal_api.start_stop_portal(opts[:phost], opts[:user])
+end
+
+portal_api.start_stop_portal(opts[:phost], opts[:user]) if opts[:stopportal]
+
+if opts[:psstat]
+  puts portal_api.retrieve_checkedout_patchset(opts[:phost], opts[:user])
+end
+
+if opts[:checkoutps_given]
+  portal_api.checkout_patchset(opts[:checkoutps], opts[:dbcreate], opts[:phost], opts[:user])
+end
+
+if opts[:cancelportal]
+  portal_api.cancel_portal_request(opts[:phost], opts[:user])
+end

data/lib/portals_api.rb

@@ -0,0 +1,53 @@
+require 'net/https'
+require 'uri'
+require 'trollop'
+class PortalsAPI
+  attr_accessor :access_token
+
+  PORTALS_HOST = 'https://portal2-beta.instructure.com/'.freeze
+  PORTALS_USER = 'rkuss2'.freeze
+
+  def initialize(portal_access_token)
+    @access_token = portal_access_token
+  end
+
+  def retrieve_portal_status(portals_host = PORTALS_HOST, portals_user = PORTALS_USER)
+    portal_endpoint = portals_host + 'canvas/isStarted/' + portals_user
+    get_request(portal_endpoint).body
+  end
+
+  def start_stop_portal(portals_host = PORTALS_HOST, portals_user = PORTALS_USER)
+    portal_endpoint = portals_host + 'canvas/startStopPortal/' + portals_user
+    get_request(portal_endpoint).body
+  end
+
+  def retrieve_checkedout_patchset(portals_host = PORTALS_HOST, portals_user = PORTALS_USER)
+    portal_endpoint = portals_host + 'canvas/isCheckedOut/' + portals_user
+    get_request(portal_endpoint).body
+  end
+
+  def checkout_patchset(patchset_name = 'master', dbcreate = false,
+    portals_host = PORTALS_HOST, portals_user = PORTALS_USER)
+    portal_endpoint = portals_host + 'canvas/checkoutPatchset?user=' + portals_user + '&patchset=' + patchset_name
+    portal_endpoint += '&db_created=0' if dbcreate
+    get_request(portal_endpoint).body
+  end
+
+  def cancel_portal_request(portals_host = PORTALS_HOST, portals_user = PORTALS_USER)
+    portal_endpoint = portals_host + 'canvas/cancelRequest?user=' + portals_user
+    get_request(portal_endpoint).body
+  end
+
+  private
+
+  def get_request(endpoint)
+    uri = URI.parse(endpoint)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Get.new(uri.request_uri)
+    request['Access_token'] = @access_token
+    http.request(request)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: portals_api
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Robin Kuss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies: []
+description: A simple gem to access Portals
+email: rkuss@instructure.com
+executables:
+- portals_run
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/portals_run
+- lib/portals_api.rb
+homepage: http://rubygems.org/gems/portals_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: API for Canvas Portals
+test_files: []